MSFT_SIPUCPhoneConfigSetting
This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.
Enables you to specify the location profile and QoS settings that the Front End Servers in this pool will use for Enterprise Voice. Also lets you specify personal identification number (PIN) and security settings for Office Communicator Phone Edition devices.
Some of the property values for the MSFT_SIPUCPhoneConfigSetting class map to the settings found on the Voice tab of the Front End Properties dialog box. You can access these values in the Office Communications Server 2007 R2 Administration Tool by right-clicking the name of a Standard Edition server or Enterprise Edition pool, pointing to Properties, and then clicking Front End Properties. In the Front End Properties dialog box, click the Voice tab. Note that these settings apply only to the specified pool or server.
Other settings are mapped to the Advanced Voice Options dialog box. You can access these settings by clicking Configure on the Voice tab.
MSFT_SIPUCPhoneConfigSetting
The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties. Properties are listed in alphabetic order, not MOF order.
Syntax
class MSFT_SIPUCPhoneConfigSetting
{
uint32 AllowCalendarAccess;
[key] string Backend;
uint32 DiffServVoice;
string EnableSIPSecurityMode;
boolean EnableUserLogging;
boolean EnforcePhoneLock;
[key] string InstanceID;
uint32 MinPhonePinLength;
uint32 PhoneLockTimeout;
uint32 Voice802_1p;
};
Methods
This class does not define any methods.
Properties
The MSFT_SIPUCPhoneConfigSetting class has the following properties.
AllowCalendarAccess
Data type: uint32Access type: Read/Write
Required. Specifies the polling interval in minutes for the UC device to query Exchange Web Services for Message Waiting Indicator (MWI) and call logs-related information.
The minimum value for this property is 0 and the maximum value is 60.
The default value is 3.
The AllowCalendarAccess property does not map to the Office Communications Server 2007 R2 Administration Tool user interface.
Backend
Data type: [key] stringAccess type: Read-only
Required: When accessing data from any role that belongs to a pool. This property must be empty when accessing data from Edge Server or Proxy Server roles.
This property identifies the instance of SQL Server that manages the back-end database for Office Communications Server.
The value for this property depends upon the topology of Office Communications Server.
Topology
Value
Standard Edition
(local)\rtc
Enterprise Edition
(consolidated or expanded configuration)
computername\instancename
or
computername
For Enterprise Edition, computername identifies either the FQDN or the NetBIOS name of the host computer for SQL Server, and instancename identifies a named instance of SQL Server on the host computer. The value computername by itself specifies the default instance of SQL Server on the host computer.
The Backend property does not map to the Office Communications Server 2007 R2 Administration Tool user interface.
DiffServVoice
Data type: uint32Access type: Read/Write
Required. Specifies the decimal representation of the 6-bit DiffServ Code Point (DSCP) priority marking that defines the Per Hop Behavior (PHB) for IP packets passed by the UC phones that are managed by this server.
The minimum value for this property is 0 and the maximum value is 63.
The default value is 40.
The DiffServVoice property maps to the Voice QoS text box in the Advanced Voice Options dialog box.
EnableSIPSecurityMode
Data type: stringAccess type: Read/Write
Required. Specifies the level of security that the server applies to SIP sessions initiated by a UC phone.
The value of this property is not case-sensitive.
The maximum length of the string is 6 characters.
Value
Description
Low
Allow any type of authorization or transport.
High
NTLM or Kerberos is required for user authentication.
Medium
NTLM or Kerberos is required for user authentication and TLS is required for SIP connections.
The EnableSIPSecurityMode property maps to the SIP security mode dropdown list in the Advanced Voice Options dialog box.
EnableUserLogging
Data type: booleanAccess type: Read/Write
Required. Enables logging on the UC device.
The default value is True.
The EnableUserLogging property does not map to the Office Communications Server 2007 R2 Administration Tool user interface.
EnforcePhoneLock
Data type: booleanAccess type: Read/Write
Required. Controls whether or not UC phones are automatically locked after the number of minutes specified by PhoneLockTimeout.
The default value is True.
The EnforcePhoneLock property maps to the Enforce phone lock checkbox in the Front End Properties dialog box.
InstanceID
Data type: [key] stringAccess type: Read-only
Required. A GUID value that uniquely identifies an instance of this class.
The GUID must be encapsulated between the "{" and "}" braces; for example: "{01234567-0123-4567-89AB-CDEF01234567}".
The InstanceID property does not map to the Office Communications Server 2007 R2 Administration Tool user interface.
MinPhonePinLength
Data type: uint32Access type: Read/Write
Required. Specifies the minimum number of digits required for Personal Identification Numbers (PINs).
Users configure their own PIN and can use this number to unlock their phone. The minimum value for this property is 4 and the maximum value is 15.
The default value is 6.
The MinPhonePinLength property maps to the Minimum PIN length text box in the Front End Properties dialog box.
PhoneLockTimeout
Data type: uint32Access type: Read/Write
Required. Specifies the length of time in minutes that a UC phone will remain idle before automatically locking.
The minimum value for this property is 0 and the maximum value is 60.
The default value is 10.
The PhoneLockTimeout property maps to the Minimum timeout (minutes) text box in the Front End Properties dialog box.
Voice802_1p
Data type: uint32Access type: Read/Write
Required. Specifies the user priority value (the 802.1p value) for voice traffic within the Office Communications Server deployment.
This setting is effective only within networks in which switches and bridges are 802.1p-capable. The minimum value for this property is 0 and the maximum value is 7.
The default value is 0.
The Voice802_1p property maps to the 802.1p Voice text box in the Advanced Voice Options dialog box.
Remarks
This class gets and sets information at the following level: SQL.
Only one instance of this class can be present in the pool.
Instances of this class support the following interface methods:
Provider::EnumerateInstances();
Provider::GetObject();
Provider::PutInstance();
Where PutInstance() supports the following flags:
WBEM_FLAG_CREATE_ONLY
WBEM_FLAG_UPDATE_ONLY
WBEM_FLAG_CREATE_OR_UPDATE
Requirements
Server: Installed on computers serving the following roles: Administrative Tools Server and Front End Server.
Namespace: Defined in \root\cimv2.