MSFT_SIPProxySetting class

MSFT_SIPProxySetting

The MSFT_SIPProxySetting class defines the settings for a SIP server.

The following syntax is simplified from MOF code and includes all inherited properties.

class MSFT_SIPProxySetting
{
  boolean AcceptCompression;
  [key] string Backend;
  boolean ClientToServerCompression;
  [key] string InstanceID;
  uint32 MaxBodySizeClientMsg;
  uint32 MaxBodySizeServerMsg;
  uint32 MaxClientCompressions;
  uint32 MaxServerCompressions;
  uint32 OutgoingTLSCount;
  boolean RequestCompression;
  string RouteToEnterpriseEdge;
  int RouteToEnterpriseEdgePort;
  string ServerRole;
  boolean WhiteSpaceKeepAliveEnabled;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPProxySetting class has the following properties.

• AcceptCompression
  Data type: boolean

  If true, the server accepts requests for compression on the connections it receives. If false, it does not. The default value is true. This property cannot be NULL.

  This property is required on creation and can be updated.

• Backend
  Data type: [key] string

  The computer name (either the FQDN or NetBIOS name) and SQL Server instance name of the Microsoft® Office Live Communications Server 2005 with SP1, 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.

  This property cannot be updated.

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

• ClientToServerCompression
  Data type: boolean

  If true, compression is performed on all connections handled by the server. If false, it is not. The default value is true. This property cannot be NULL.

  This property is required on creation and can be updated.

• InstanceID
  Data type: [key] string

  A GUID value that uniquely identifies this proxy service to WMI. The GUID must be encapsulated between the "{" and "}" braces; for example: "{01234567-0123-4567-89AB-CDEF01234567}".

  This property is required on creation and cannot be updated.

• MaxBodySizeClientMsg
  Data type: uint32

  The maximum message body size, in kilobytes, for messages sent by a client. The valid range of values is 64K to 256K. The default value is 128K. This property cannot be NULL.

  This property is required on creation and can be updated.

• MaxBodySizeServerMsg
  Data type: uint32

  The maximum message body size, in kilobytes, for messages received by the server. The valid range of values is 1000 to 20000. The default value is 5000. This property cannot be NULL.

  This property is required on creation and can be updated.

• MaxClientCompressions
  Data type: uint32

  The maximum number of client-to-server connections that can be compressed at a given moment. If there are more than this number, client-to-server connections that occur after the maximum has been reached are not compressed.

  The valid range of values is 0 to 65535. The default value is 5000. This property cannot be NULL.

  This property is required on creation and can be updated.

• MaxServerCompressions
  Data type: uint32

  The maximum number of server-to-server connections that can be compressed at a given moment. If there are more than this number, server-to-server connections that occur after the maximum has been reached are not compressed.

  The valid range of values is between 0 and 65535. The default value is 1024. This property cannot be NULL.

  This property is required on creation and can be updated.

• OutgoingTLSCount
  Data type: uint32

  The maximum number of TLS connections established by the server. The valid range of values is between 1 and 256. The default value is 4. This value cannot be NULL

  This property is required on creation and can be updated.

• RequestCompression
  Data type: boolean

  If true, the server requests compression for the connections it initiates. If false, it does not. The default value is false.

  This property is required on creation and can be updated.

• RouteToEnterpriseEdge
  Data type: string

  A specific route for internal servers to reach an Access Proxy. If set, this value overwrites the a default route in the global settings that all internal servers use to reach the Access Proxy. If the string is empty, the global settings default route is used. For an Access Proxy, this setting should be left as NULL. Validation rules for FQDNs apply.

  This property is required on creation and can be updated.

• RouteToEnterpriseEdgePort
  Data type: int

  The port on the Access Proxy to which this server pool will route messages. Valid values are 1 to 65535. The default value is 5061.

  This property is required on creation and can be updated.

• ServerRole
  Data type: string

  The role of this server in Live Communications Server 2005 with SP1, Standard Edition or Enterprise Edition. This value is set during installation. Valid values are as follows:

  Value	Role
  HS	Live Communications Server 2005 with SP1, Standard Edition
  FE	Live Communications Server 2005 with SP1, Enterprise Edition
  EP	Access Proxy
  FP	Proxy

  This value cannot be NULL. This property is required on creation and cannot be updated.

• WhiteSpaceKeepAliveEnabled
  Data type: boolean

  If true the server expects clients to send white-space (that is, empty) messages to indicate they are still alive. This property should not be enabled on Access Proxies because outside and federated clients use REGISTRATION refresh requests, rather than white-space messages, for this purpose. The default value is true. This property cannot be NULL.

  This property is required on creation and can be updated.

Remarks

Only one instance of this class can be defined on a Live Communications Server installation.

Available actions for an instance of this class:

• Creation: The administrator cannot create the instance of this class.
• Updates: The administrator can update the instance of this class.
• Deletion: The administrator cannot delete the instance of this class.

Requirements

Server: Installed on Windows Server 2003 with Microsoft Live Communications Server 2005 with SP1.
Namespace: Defined in \root\cimv2.

See Also

MSFT_SIPProxySecuritySetting, Live Communications Server WMI Reference