MSFT_SIPProxySetting class

MSFT_SIPProxySetting

Defines the settings for a SIP proxy server.

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_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;
  uint32 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

  Access type: Read/Write

  Required. Controls whether the proxy accepts requests by other servers for compression on incoming connections.

  If true, the server accepts requests for compression on incoming connections from other servers. If false, it does not. The default value is true.

• 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

• ClientToServerCompression
  Data type: boolean

  Access type: Read/Write

  Required. Controls whether the proxy accepts requests by clients for compression on incoming connections.

  If true, the server accepts requests for compression on incoming connections from clients. If false, it does not.

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

• MaxBodySizeClientMsg
  Data type: uint32

  Access type: Read/Write

  Required. The maximum message body size in kilobytes for messages sent by a client.

  The minimum value for this property is 64 and the maximum value is 256.

  The default value is 128.

• MaxBodySizeServerMsg
  Data type: uint32

  Access type: Read/Write

  Required. The maximum message body size in kilobytes for messages received by the server.

  The minimum value for this property is 1000 and the maximum value is 20000.

  The default value is 5000.

• MaxClientCompressions
  Data type: uint32

  Access type: Read/Write

  Required. The maximum number of client-to-server connections that can be compressed at a given moment.

  Client-to-server connections that are established after the maximum has been reached are not compressed.

  The minimum value for this property is 0 and the maximum value is 65535.

  The default value is 5000.

• MaxServerCompressions
  Data type: uint32

  Access type: Read/Write

  Required. 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 minimum value for this property is 0 and the maximum value is 65535.

  The default value is 1024.

• OutgoingTLSCount
  Data type: uint32

  Access type: Read/Write

  Required. The maximum number of TLS connections established by the server to each destination.

  The minimum value for this property is 1 and the maximum value is 256.

  The default value is 4.

• RequestCompression
  Data type: boolean

  Access type: Read/Write

  Required. Controls whether the proxy requests compression for outgoing connections to other servers.

  If true, the server requests compression for the connections it initiates. If false, it does not.

  The default value is false.

• RouteToEnterpriseEdge
  Data type: string

  Access type: Read/Write

  Optional. The fully qualified domain name (FQDN) of a specific route for internal servers to use to reach a Director or an Access Edge Server (in cases where a Director is not deployed).

  The value must be an FQDN. An IP address is not allowed.

  If set, this value overwrites the a default route in the global settings that all internal servers use to reach the Access Edge Server. If the string is empty, the global settings default route is used. For an Access Edge Server, leave the value of this setting NULL. Validation rules for FQDNs apply.

• RouteToEnterpriseEdgePort
  Data type: uint32

  Access type: Read/Write

  Optional. The port on the Access Edge Server to which this server pool will route messages.

  The minimum value for this property is 1 and the maximum value is 65535.

  The default value is 5061.

• ServerRole
  Data type: string

  Access type: Read-only

  Required. The role of this server in an Office Communications Server 2007, Standard Edition or Enterprise Edition topology.

  This value is set during installation.

  Value	Description
  "HS"	Office Communications Server 2007, Standard Edition
  "FE"	Office Communications Server 2007, Enterprise Edition
  "EP"	Access Edge Server
  "FP"	Proxy Server

• WhiteSpaceKeepAliveEnabled
  Data type: boolean

  Access type: Read/Write

  Required. Controls whether the server expects clients to send whitespace (empty) messages to indicate that they are still alive.

  If true the server expects clients to send whitespace messages.

  Do not enable this property on Access Proxies because outside clients use REGISTRATION refresh requests for this purpose rather than whitespace messages.

  The default value is true.

Remarks

This class gets and sets information at the following level(s): WMI, SQL.

If this class is installed on a server whose role has "Pool" scope, the scope of this class is "Pool" and settings are stored in SQL. In this case, only one instance of this class can be present in the pool. For a list of server roles and their corresponding WMI class scopes, see WMI Class Management Scopes and Roles.

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, Access Edge Server, Front End Server, Proxy Server.
Namespace: Defined in \root\cimv2.

See Also

MSFT_SIPProxySecuritySetting, Communications Server WMI Reference