MSFT_SIPMediationServerConfigSetting

Article
05/23/2014

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.

Exposes the locally stored configuration settings for a Mediation Server.

The property values for the MSFT_SIPMediationServerSetting class map to the settings found on the General and Next Hop Connections tabs of the mediation server Properties dialog box. You can access these values in the Office Communications Server 2007 R2 Administration Tool by expanding the Mediation Servers node. From there, right-click the name of a mediation server and then click Properties.

MSFT_SIPMediationServerConfigSetting

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_SIPMediationServerConfigSetting
{
  string DefaultCodec;
  string GatewayEncryptionLevel;
  string GatewayListeningAddress;
  uint32 GatewayListeningPort;
  string GatewayNextHopAddress;
  uint32 GatewayNextHopPort;
  string GatewayTransportType;
  [key] string InstanceID;
  uint32 MediaPortRangeFrom;
  uint32 MediaPortRangeTo;
  string ProxyListeningAddress;
  uint32 ProxyListeningPort;
  string ProxyNextHopFQDN;
  uint32 ProxyNextHopPort;
  boolean QoSEnabled;
  boolean RemovePlusFromRequestURI;
};

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

Required: The default codec offered and accepted by Mediation Server for PSTN calls.

Reserved. Do not use.

The DefaultCodec property does not map to the Properties dialog box.

GatewayEncryptionLevel
Data type: string

Access type: Read/Write

Required. Specifies the level of encryption between Mediation Server and the Gateway.

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. Office Communicator 2007 R2 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. This value must be used if GatewayTransportType is set to TCP.

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.

Office Communicator 2007 R2 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.

This value must be used if GatewayTransportType is set to TCP.

The default value is SupportEncryption.

The GatewayEncryptionLevel property maps to the Encryption level dropdown list on the Next Hop Connections tab of the Office Communications Server Global Properties dialog box.

GatewayListeningAddress
Data type: string

Access type: Read/Write

Required. Specifies the IP address or 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.

The GatewayListeningAddress property maps to the Gateway listening IP address dropdown list on the General tab of the Office Communications Server Global Properties dialog box.
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.

The GatewayListeningPort property maps to the Port text box on the General tab of the Office Communications Server Global Properties dialog box.
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.

The GatewayNextHopAddress property maps to the Address text box on the Next Hop Connections tab of the Office Communications Server Global Properties dialog box.
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.

The GatewayNextHopPort property maps to the PSTN Gateway next hop -- Port text box on the Next Hop Connections tab of the Office Communications Server Global Properties dialog box.

GatewayTransportType
Data type: string

Access type: Read/Write

Required: Specifies the protocol used by SIP signaling between the IP Gateway and the Mediation Server.

Value	Description
TCP	SIP signaling between the IP Gateway and the Mediation Server uses the Transmission Control Protocol (TCP) for unencrypted signaling.
TLS	SIP signaling between the IP Gateway and the Mediation Server uses the Transport Layer Security (TLS) protocol for encrypted signaling. This is the default setting.

TCP

SIP signaling between the IP Gateway and the Mediation Server uses the Transmission Control Protocol (TCP) for unencrypted signaling.

TLS

SIP signaling between the IP Gateway and the Mediation Server uses the Transport Layer Security (TLS) protocol for encrypted signaling.

This is the default setting.

The GatewayTransportType property maps to the Transport dropdown list on the Next Hop Connections tab of the Office Communications Server Global 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 Properties dialog box.
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.

The MediaPortRangeFrom property maps to the Media port range from text box on the General tab of the Office Communications Server Global Properties dialog box.
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.

The MediaPortRangeTo property maps to the Media port range to text box on the General tab of the Office Communications Server Global Properties dialog box.
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.

The ProxyListeningAddress property maps to the Communications Server listening IP address dropdown list on the General tab of the Office Communications Server Global Properties dialog box.
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.

The ProxyListeningPort property does not map to the Properties dialog box.
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.

The ProxyNextHopFQDN property maps to the FQDN dropdown list on the Next Hop Connections tab of the Office Communications Server Global Properties dialog box.
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.

The ProxyNextHopPort property maps to the Office Communications Server next hop -- Port text box on the Next Hop Connections tab of the Office Communications Server Global Properties dialog box.
QoSEnabled
Data type: boolean

Access type: Read/Write

Required: Specifies whether to enable QoS marking on Mediation Server.

When this property is set to True, Mediation Server performs Differentiated Services Code Point (DSCP) marking on voice packets.

In a network that has been properly provisioned for voice transmission, packet prioritization is not necessary. However, if you are unsure of bandwidth capacity, setting this property to True assures good voice quality even in suboptimal environments.

The default value is False.

The QoSEnabled property does not map to the Properties dialog box.
RemovePlusFromRequestURI
Data type: boolean

Access type: Read/Write

Required. Specifies whether to strip the plus sign (+) prefixed to E.164 numbers in the Request Uniform Resource Identifier (URI) for outgoing calls.

Set this value to True when the Private Branch eXchange (PBX) does not accept numbers prefixed with a plus sign. When this value is False, Mediation Server passes the outgoing INVITE's Request to URI, To URI, and From URI unchanged.

The default value is False.

The RemovePlusFromRequestURI property does not map to the Properties dialog box.

Remarks

This class gets and sets information at the following level: 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, and ProxyNextHopPort.

Instances of this class support the following interface methods:

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

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

Requirements

Server: Installed on computers serving the following role: Mediation Server.

Namespace: Defined in \root\cimv2.

Share via

MSFT_SIPMediationServerConfigSetting

MSFT_SIPMediationServerConfigSetting

Syntax

Methods

Properties

Remarks

Requirements

See Also

Concepts

Additional resources