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>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Optional |
Xds Identity |
Service location of the Edge Server to be modified. For example: Redmond-EdgeServer-1. |
|
Registrar |
Optional |
String |
Service location of the Registrar to be associated with the Edge Server. For example: Redmond-Registrar-1. |
|
AccessEdgeInternalSipPort |
Optional |
Integer |
Port used for internal SIP (Session Initiation Protocol) traffic. |
|
AccessEdgeExternalSipPort |
Optional |
Integer |
Port used for external SIP traffic. |
|
AccessEdgeClientSipPort |
Optional |
Integer |
Port used for SIP communications between the Edge Server and client devices. |
|
DataPsomServerPort |
Optional |
Integer |
Port used for PSOM (Persistent Object Model) communications between the Edge Server and other servers. |
|
DataPsomClientPort |
Optional |
Integer |
Port used for PSOM communications between the Edge Server and client devices. |
|
MediaRelayAuthEdgePort |
Optional |
Integer |
Port used for media relay authentication. |
|
MediaRelayInternalTurnTcpPort |
Optional |
Integer |
Port used for internal media relay traffic using TCP (Transmission Control Protocol). |
|
MediaRelayExternalTurnTcpPort |
Optional |
Integer |
Port used for external media relay traffic using TCP. |
|
MediaRelayInternalTurnUdpPort |
Optional |
Integer |
Port used for internal media relay traffic using UDP (User Datagram Protocol). |
|
MediaRelayExternalTurnUdpPort |
Optional |
Integer |
Port used for external media relay traffic using UDP. |
|
MediaCommunicationPortCount |
Optional |
Integer |
|
|
MediaCommunicationPortStart |
Optional |
Integer |
|
|
Force |
Optional |
Switch Parameter |
|
|
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. |
Detailed Description
Connectivity with the outside world (that is, with the Internet) is an important aspect of Microsoft Communications Server 2010. Without this connectivity, users would have to log on to the internal network in order to access Communications Server; that would make things extremely difficult for users working off-site, and preclude the ability of anonymous users (that is, users who do not have accounts in your domain) from being invited to online conferences and meetings. Likewise, without connectivity with the outside world 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 Windows Live.
Edge Servers are used to help provide connectivity between your internal network and the Internet. In turn, the Set-CsEdgeServer cmdlet enables you to modify configuration settings for your Edge Servers. This typically involves changing the port numbers used for transmitting network traffic.
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.
Examples
-------------------------- Example 1 ------------------------
 Copy Code |
|
|---|---|
Set-CsEdgeServer -Identity Redmond-EdgeServer-1 -AccessInternalSipPort 5062 -AccessExternalSipPort 5062 |
|
The command shown in Example 1 modifies the internal and external SIP ports for the Edge Server Redmond-EdgeServer-1.
-------------------------- Example 2 ------------------------
| Copy Code |
|
|---|---|
Get-CsService -EdgeServer | Where-Object {$_.SiteId -eq "site:Redmond"} | Set-CsEdgeServer-AccessInternalSipPort 5062 -AccessExternalSipPort 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 servers from the Redmond site; that is, where the SiteId property is equal to (-eq) site:Redmond. This filtered collection is then piped to the Set-CsEdgeServer cmdlet, which takes each server in the collection and changes the values assigned to the AccessInternalSipPort and AccessExternalSipPort properties.