Enables you to modify the properties of one or more Mediation Servers. Mediation Servers are used to route traffic between your internal Enterprise Voice infrastructure and a Public Switched Telephone Network (PSTN) gateway or a SIP trunk.
Syntax
Set-CsMediationServer [-Identity <XdsGlobalRelativeIdentity>] [-AudioPortCount <UInt16>] [-AudioPortStart <UInt16>] [-Confirm [<SwitchParameter>]] [-EdgeServer <String>] [-Force <SwitchParameter>] [-Registrar <String>] [-SipClientTcpPort <UInt16>] [-SipClientTlsPort <UInt16>] [-SipServerPort <UInt16>] [-WhatIf [<SwitchParameter>]] |
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
Identity |
Optional |
Xds Identity |
Service location of the Mediation Server to be modified. For example: -Identity "MediationServer:atl-cs-001.litwareinc.com". |
Registrar |
Optional |
String |
Service location of the Registrar to be associated with the Mediation Server. For example: -Registrar "Registrar:atl-cs-001.litwareinc.com". |
EdgeServer |
Optional |
String |
Service location of the Edge Server to be associated with the Mediation Server. For example: -EdgeServer "EdgeServer:atl-edge-001.litwareinc.com". |
SipServerPort |
Optional |
Integer |
Port used for communicating with SIP servers. |
SipClientTcpPort |
Optional |
Integer |
Port used for communicating with client devices using the TCP protocol (Transmission Control Protocol). |
SipClientTlsPort |
Optional |
Integer |
Port used for communicating with client devices using the TLS (Transport Layer Security) protocol. |
AudioPortStart |
Optional |
Integer |
First port in the range of ports allocated for sending and receiving audio traffic. For example –AudioPortStart 60000. |
AudioPortCount |
Optional |
Integer |
Total number of ports allocated for sending and receiving audio traffic. The actual ports to be opened will start with the value configured for AudioPortStart and continue through the number of ports specified for AudioPortCount. For example, if the AudioPortStart is set to 60000 and the AudioPortCount is set to 100 then ports 600000 through 60099 will be used for audio traffic. |
Force |
Optional |
Switch Parameter |
Suppresses the display of any non-fatal error message that might arise when running the command. |
WhatIf |
Optional |
Switch Parameter |
Describes what would happen if you executed the command without actually executing the command. |
Confirm |
Optional |
Switch Parameter |
Prompts you for confirmation before executing the command. |
Detailed Description
Mediation Servers act as a bridge between your internal Enterprise Voice configuration and either a PSTN Gateway or a SIP trunk; in turn, this provides a way for your Enterprise Voice users (who are using Voice over IP devices) to communicate with people using standard land-line telephones or cell phones. The Set-CsMediationServer cmdlet provides a way for you to make changes to an existing Mediation Server; in particular, you can modify the ports used for communicating with client devices, for communicating with front-end servers, or for transmitting audio traffic. If necessary, Set-CsMediationServer can also be used to associate a Mediation Server with a new Registrar or a new Edge Server.
Return Types
Set-CsMediationServer does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.Xds.DisplayMediationServer object.
Examples
-------------------------- Example 1 ------------------------
Copy Code | |
---|---|
Set-CsMediationServer -Identity "MediationServer:atl-cs-001.litwareinc.com" -SipClientTcpPort 5072 |
The command shown in Example 1 sets the SIP client TCP port to 5072 for the Mediation Server MediationServer:atl-cs-001.litwareinc.com.
-------------------------- Example 2 ------------------------
Copy Code | |
---|---|
Set-CsMediationServer -Identity "MediationServer:atl-cs-001.litwareinc.com" -AudioPortStart 60000 -AudioPortCount 1000 |
The preceding command configures audio port settings for the Mediation Server MediationServer:atl-cs-001.litwareinc.com. In this example the starting audio port is set to 60000 and the total number of ports allocated for audio is 1000