MSFT_SIPMediationServerConfigSetting class

Article
08/31/2009

Communications Server 2007 Server SDK Documentation

MSFT_SIPMediationServerConfigSetting

Exposes the locally stored configuration settings for a Mediation 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_SIPMediationServerConfigSetting
{
  string DefaultCodec;
  string EncryptionLevel;
  string GatewayListeningAddress;
  uint32 GatewayListeningPort;
  string GatewayNextHopAddress;
  uint32 GatewayNextHopPort;
  [key] string InstanceID;
  uint32 MediaPortRangeFrom;
  uint32 MediaPortRangeTo;
  string ProxyListeningAddress;
  uint32 ProxyListeningPort;
  string ProxyNextHopFQDN;
  uint32 ProxyNextHopPort;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPMediationServerConfigSetting class has the following properties.

DefaultCodec
Data type: string

Access type: Read/Write

Reserved. Do not use.

EncryptionLevel
Data type: string

Access type: Read/Write

Required. Specifies the level of encryption to apply.

The value of this property is not case-sensitive.

Value	Description
"SupportEncryption"	Inbound and outbound audio connections to this Mediation Server from UC clients can be encrypted using Secure Real-Time Transport Protocol (SRTP). The actual level of encryption depends of the security option offered by the UC client.
"RequireEncryption"	Inbound and outbound audio connections to this Mediation Server from UC clients must be encrypted using SRTP. If specified, any UC clients that do not support encryption or that have disabled encryption will be unable to establish calls through Mediation Server. Note???? Office Communicator 2007 clients support SRTP encryption. Legacy clients, such as Office Communicator 2005, support 3DES encryption.
"DoNotSupportEncryption"	Inbound and outbound audio connections to this Mediation Server from UC clients are not encrypted. If a UC client requires encryption, an audio connection might not be established.

The default value is SupportEncryption.

GatewayListeningAddress
Data type: string

Access type: Read/Write

Required. Specifies the IP address on which Mediation Server is listening for incoming SIP connections from the Gateway (or IP-PBX).

The value might be different from the value of ProxyListeningAddress in scenarios where the Gateway resides in a private network (for security purposes).

The value must be a valid IPv4 address represented in the following format: "nnn.nnn.nnn.nnn". An FQDN is not allowed.
GatewayListeningPort
Data type: uint32

Access type: Read/Write

Required. The port number on which Mediation Server is listening for incoming SIP (TCP) connections from the Gateway (or IP-PBX).

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

The default value is 5060.
GatewayNextHopAddress
Data type: string

Access type: Read/Write

Required. The IP address of the Gateway.

The value must be a valid IPv4 address represented in the following format: "nnn.nnn.nnn.nnn". An FQDN is not allowed.
GatewayNextHopPort
Data type: uint32

Access type: Read/Write

Required. The port number on which the Gateway is listening for SIP connections.

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

The default value is 5060.
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}".
MediaPortRangeFrom
Data type: uint32

Access type: Read/Write

Required. The beginning of the server port range from which Mediation Server allocates media ports (RTP and RTCP listening ports).

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

The default value is 60000.
MediaPortRangeTo
Data type: uint32

Access type: Read/Write

Required. The end of the server port range from which Mediation Server allocates media ports.

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

The default value is 64000.
ProxyListeningAddress
Data type: string

Access type: Read/Write

Required. The IP address on which Mediation Server is listening for incoming SIP connections from the Office Communication Server Front End.

The value must be a valid IPv4 address represented in the following format: "nnn.nnn.nnn.nnn". An FQDN is not allowed.
ProxyListeningPort
Data type: uint32

Access type: Read/Write

Required. The port number on which Mediation Server is listening for incoming SIP connections from the Office Communication Server Front End.

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

The default value is 5061.
ProxyNextHopFQDN
Data type: string

Access type: Read/Write

Required. The FQDN of the Office Communications Server Front End.

The value must be an FQDN. An IP address is not allowed.
ProxyNextHopPort
Data type: uint32

Access type: Read/Write

Required. The port number on which the Office Communications Server Front End is listening for SIP (TLS) connections.

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

The default value is 5061.

Remarks

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

Only one instance of this class can be present on a Mediation Server.

A change in the value of any of the following properties requires a restart of the Mediation Server: EncryptionLevel, GatewayListeningAddress, GatewayListeningPort, GatewayNextHopAddress, GatewayNextHopPort, ProxyListeningAddress, ProxyListeningPort, ProxyNextHopFQDN, ProxyNextHopPort.

Instances of this class support the following interface methods:

Provider::EnumerateInstances();
Provider::GetObject();
Provider::PutInstance();

Where PutInstance() supports the following flag(s):
- WBEM_FLAG_UPDATE_ONLY
- WBEM_FLAG_CREATE_OR_UPDATE

Requirements

Server: Installed on computers serving the following role(s): Mediation Server.
Namespace: Defined in \root\cimv2.