Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All
Expand Minimize

MSFT_SIPProxySetting

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.

Defines the settings for a SIP proxy server, including server cmpression properties.

The property values for the MSFT_SIPProxySetting class map to the settings found on the Compression 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 Compression tab. Note that these settings apply only to the specified pool or 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.

Syntax


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.

The AcceptCompression property does not map to the Front End Properties dialog box.

Backend

Data type: [key] string

Access 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 Front End Properties dialog box.

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.

The ClientToServerCompression property maps to the Enable compression on client-to-server connections checkbox in the Front End Properties dialog box.

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

The InstanceID property does not map to the Front End Properties dialog box.

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.

The MaxBodySizeClientMsg property does not map to the Front End Properties dialog box.

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.

The MaxBodySizeServerMsg property does not map to the Front End Properties dialog box.

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.

The MaxClientCompressions property does not map to the Front End Properties dialog box.

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.

The MaxServerCompressions property maps to the Maximum number of serverto-server connections text box in the Front End Properties dialog box.

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.

The OutgoingTLSCount property does not map to the Front End Properties dialog box.

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.

The RequestCompression property maps to the Request compression on outgoing server-to-server connections checkbox in the Front End Properties dialog box.

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.

The RouteToEnterpriseEdge property does not map to the Front End Properties dialog box.

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.

The RouteToEnterpriseEdgePort property does not map to the Front End Properties dialog box.

ServerRole

Data type: string

Access type: Read-only

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

This value is set during installation.

Value

Description

HS

Office Communications Server 2007 R2, Standard Edition

FE

Office Communications Server 2007 R2, Enterprise Edition

EP

Access Edge Server

FP

Proxy Server

The ServerRole property does not map to the Front End Properties dialog box.

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.

The WhiteSpaceKeepAlive property does not map to the Front End Properties dialog box.

Remarks

This class gets and sets information at the following levels: 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 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, Access Edge Server, Front End Server, Proxy Server.

Namespace: Defined in \root\cimv2.

Show:
© 2015 Microsoft