Set-CsEdgeServer
Topic Last Modified: 2012-03-26
Modifies the property values for one or more Edge Servers. Edge Servers are used to provide connectivity between your internal network and the Internet.
Syntax
Set-CsEdgeServer [-Identity <XdsGlobalRelativeIdentity>] [-AccessEdgeClientSipPort <UInt16>] [-AccessEdgeExternalSipPort <Nullable>] [-AccessEdgeInternalSipPort <UInt16>] [-Confirm [<SwitchParameter>]] [-DataPsomClientPort <Nullable>] [-DataPsomServerPort <UInt16>] [-Force <SwitchParameter>] [-MediaCommunicationPortCount <UInt16>] [-MediaCommunicationPortStart <UInt16>] [-MediaRelayAuthEdgePort <UInt16>] [-MediaRelayExternalTurnTcpPort <UInt16>] [-MediaRelayExternalTurnUdpPort <UInt16>] [-MediaRelayInternalTurnTcpPort <UInt16>] [-MediaRelayInternalTurnUdpPort <UInt16>] [-Registrar <String>] [-WhatIf [<SwitchParameter>]]
Detailed Description
Connectivity with the outside world (that is, with the Internet) is an important aspect of Microsoft Lync Server 2010. Without this connectivity, users would have to log on to the internal network in order to access Lync Server 2010. This would make it difficult for users working off-site to use the software, and preclude the ability of users who do not have accounts in your domain from being able to participate in conferences. Likewise, without connectivity outside of the organization users would be unable to exchange instant messages with federated partners or with people who have accounts on a public instant messaging system such as Yahoo!, AOL, or MSN.
Edge Servers are used to help provide connectivity between your internal network and the Internet. The Set-CsEdgeServer cmdlet enables you to modify configuration settings for your Edge Servers, a task that primarily involves changing the port numbers used for transmitting network traffic.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Set-CsEdgeServer cmdlet locally: RTCUniversalServerAdmins. To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt:
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Set-CsEdgeServer"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Optional |
Xds Identity |
Service location of the Edge Server to be modified. For example: -Identity "EdgeServer:atl-edge-001.litwareinc.com". Note that you can leave off the prefix "EdgeServer:" when specifying an Edge server. For example: -Identity "atl-cs-001.litwareinc.com". |
AccessEdgeClientSipPort |
Optional |
Integer |
Port used for SIP communications between the Edge Server and client devices. The initial value is set in Topology Builder but can be changed by specifying a new value for this parameter. |
AccessEdgeExternalSipPort |
Optional |
Integer |
Port used for external SIP traffic. The default value is 5061. |
AccessEdgeInternalSipPort |
Optional |
Integer |
Port used for internal SIP traffic. The default value is 5061. |
DataPsomClientPort |
Optional |
Integer |
Port used for Persistent Shared Object Model (PSOM) communications between the Edge Server and client devices. The initial value is set in Topology Builder but can be changed by specifying a new value for this parameter. |
DataPsomServerPort |
Optional |
Integer |
Port used for PSOM communications between the Edge Server and other servers. |
MediaCommunicationPortCount |
Optional |
Integer |
Total number of ports allocated on the external Edge for media communications. The default value is 10000. |
MediaCommunicationPortStart |
Optional |
Integer |
Starting port number on the external Edge for media communications. The default value is 50000. |
MediaRelayAuthEdgePort |
Optional |
Integer |
Port used for media relay authentication. The default value is 5062. |
MediaRelayExternalTurnTcpPort |
Optional |
Integer |
Port used for external media relay traffic using the Transmission Control Protocol (TCP). The default value is 444 if your Edge server has a single IP address. If your Edge server has multiple IP addresses then the default value is 443. These values are initially set in Topology Builder but can be changed by specifying a new value for this parameter. |
MediaRelayExternalTurnUdpPort |
Optional |
Integer |
Port used for external media relay traffic using the User Datagram Protocol (UDP). The default value is 3478. |
MediaRelayInternalTurnTcpPort |
Optional |
Integer |
Port used for internal media relay traffic using TCP. The default value is 443. |
MediaRelayInternalTurnUdpPort |
Optional |
Integer |
Port used for internal media relay traffic using UDP. The default value is 3478. |
Registrar |
Optional |
String |
Service location of the Registrar to be associated with the Edge Server. For example: -Registrar "Registrar:atl-cs-001.litwareinc.com". |
Force |
Optional |
Switch Parameter |
Suppresses the display of any non-fatal error message that might occur when running the command. |
WhatIf |
Optional |
Switch Parameter |
Describes what would happen if you executed the command without actually executing the command. |
Confirm |
Switch Parameter |
Prompts you for confirmation before executing the command. |
Input Types
None. Set-CsEdgeServer does not accept pipelined input.
Return Types
Set-CsEdgeServer does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.Xds.DisplayEdgeServer object.
Example
-------------------------- Example 1 ------------------------
Set-CsEdgeServer -Identity "EdgeServer:atl-edge-001.litwareinc.com" -AccessEdgeInternalSipPort 5062 -AccessEdgeExternalSipPort 5062
The command shown in Example 1 modifies the internal and external SIP ports for the Edge Server "EdgeServer:atl-edge-001.litwareinc.com".
-------------------------- Example 2 ------------------------
Get-CsService -EdgeServer | Where-Object {$_.SiteId -eq "site:Redmond"} | ForEach-Object {Set-CsEdgeServer Identity $_.Identity -AccessEdgeInternalSipPort 5062 -AccessEdgeExternalSipPort 5062}
Example 2 modifies the internal and external SIP ports for all the Edge Servers located in the Redmond site. To do this, the command first uses Get-CsService and the EdgeServer parameter to return a collection of all the Edge Servers currently in use in the organization. That collection is then piped to the Where-Object cmdlet, which selects only those Edge servers from the Redmond site; that is, servers where the SiteId property is equal to site:Redmond. This filtered collection is then piped to the For-Each-Object cmdlet. That cmdlet runs Set-CsEdgeServer against each server in the collection, changing the values assigned to the AccessInternalSipPort and AccessExternalSipPort properties.