MSFT_SIPUCPhoneConfigSetting class

MSFT_SIPUCPhoneConfigSetting

Specifies the configuration settings for a UC device.

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.

class MSFT_SIPUCPhoneConfigSetting
{
  uint32 AllowCalendarAccess;
  [key] string Backend;
  uint32 DiffServVoice;
  string EnableSIPSecurityMode;
  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: uint32

  Access 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.

• Backend
  Data type: [key] string

  Access type: Read-only

  Must be empty when accessing data from Edge Server or Proxy Server roles. Required when accessing data from any role that belongs to a pool.

  The computer name (either the FQDN or NetBIOS name) and SQL Server instance name of the Office Communications Server 2007, back-end database (configuration data is stored in the same SQL instance as user data, but in a different database). Indicates where this class is stored, which varies depending on the server role.

  Server Role	Acceptable Values
  Enterprise Edition	SQL_Instance_Name
  Standard Edition	(local)\rtc
  Access Edge Server and Forwarding Proxy	Empty string

• DiffServVoice
  Data type: uint32

  Access 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.

• EnableSIPSecurityMode
  Data type: string

  Access 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.

• EnforcePhoneLock
  Data type: boolean

  Access 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.

• InstanceID
  Data type: [key] string

  Access 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}".

• MinPhonePinLength
  Data type: uint32

  Access 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.

• PhoneLockTimeout
  Data type: uint32

  Access 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.

• Voice802_1p
  Data type: uint32

  Access 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.

Remarks

This class gets and sets information at the following level(s): 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 flag(s):

  • WBEM_FLAG_CREATE_ONLY
  • WBEM_FLAG_UPDATE_ONLY
  • WBEM_FLAG_CREATE_OR_UPDATE

Requirements

Server: Installed on computers serving the following role(s): Administrative Tools Server, Front End Server.
Namespace: Defined in \root\cimv2.

See Also

Communications Server WMI Reference