[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

Modifies the properties of a Public Switched Telephone Network (PSTN) gateway. PSTN gateways help route calls between devices on the external PSTN network and devices on your internal Enterprise Voice network.

Syntax


Set-CsPstnGateway [-Identity <XdsGlobalRelativeIdentity>] [-AlternateByPassId <String>] [-Confirm [<SwitchParameter>]] [-Default <$true \| $false>] [-Force <SwitchParameter>] [-GatewaySipClientTcpPort <Nullable>] [-GatewaySipClientTlsPort <Nullable>] [-MediationServer <String>] [-RepresentativeMediaIP <String>] [-Routable <$true \| $false>] [-WhatIf [<SwitchParameter>]]

Set-CsPstnGateway [-Identity <XdsGlobalRelativeIdentity>] [-AlternateByPassId <String>] [-Confirm [<SwitchParameter>]] [-Default <$true | $false>] [-Force <SwitchParameter>] [-GatewaySipClientTcpPort <Nullable>] [-GatewaySipClientTlsPort <Nullable>] [-MediationServer <String>] [-RepresentativeMediaIP <String>] [-Routable <$true | $false>] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter	Required	Type	Description
Identity	Required	Xds Identity	Service location of the PSTN gateway to be modified. For example: Redmond-PstnGateway-1.
Instance	Optional	DisplayPstnGateway object	Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values.
AlternateBypassId	Optional	Guid	Globally unique identifier (GUID) for the gateway. The bypass ID is used by Mediation Servers when handling "hairpin" scenarios. A hairpin scenario occurs when an inbound call from the PSTN network is routed to another PSTN phone via call forwarding or simultaneous ringing.
Routable	Optional	Boolean	If set to True, the gateway can be used in outbound routing roués.
Default	Optional	Boolean	If set to True, the gateway will handle calls sent from Office Communications Server 2007 R2. There can only be ne default gateway in the collection of gateways managed by a single Mediation Server.
RepresentativeMediaIP	Optional	String	IP address of the media termination point associated with the gateway.
MediationServer	Optional	String	Service location of the Mediation Server to be associated with the PSTN gateway. For example: Redmond-MediationServer-1.
GatewaySipClientTcpPort	Optional	Integer	Port used for communicating with client devices using TCP (Transmission Control Protocol).
GatewaySipClientTlsPort	Optional	Integer	Port used for communicating with client devices using the TLS (Transport Layer Security) protocol.
LocalStore	Optional	Switch Parameter	This parameter is for testing purposes only.
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

PSTN gateways enable your Enterprise Voice users to make phone calls to, and receive phone calls from, people on the PSTN network. These gateways are required because the PSTN network and an Enterprise Voice network use different signaling technologies. It’s the job of the gateway to translate a PSTN call into a call that Enterprise Voice can understand, and vice-versa.

After your PSTN gateways have been installed and configured, they can be managed using the Set-CsPstnGateway cmdlet. This cmdlet enables you to modify port settings and routing configuration settings for any of the PSTN gateways in your organization.

Return Types

Set-CsPstnGateway does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.Xds.DisplayPstnGateway object.

Examples

-------------------------- Example 1 ------------------------

	Copy Code
Set-CsPstnGateway -Identity Redmond-PstnGateway-1 -Default $True

The command shown in Example 1 configures the gateway Redmond-PstnGateway-1 to be the default gateway. That means that Redmond-PstnGateway-1 can be used to handle calls originating from Office Communications Server 2007 R2.

-------------------------- Example 2 ------------------------

	Copy Code
Get-CsService -PstnGateway \| Set-CsPstnGateway -Routable $True

The preceding command configures all the PSTN gateways in the organization, ensuring that each of these gateways can be used in outbound routing. To do this, the command first uses the Get-CsService cmdlet and the –PstnGateway parameter to return a collection of all the PSTN gateways currently in use. This collection is then piped to the Set-CsPstnGateway cmdlet, which sets the Routable property of each gateway in the collection to True ($True).