Edit

Get-CsOnlinePSTNGateway

  • Reference
Module:
MicrosoftTeamsPowerShell
Applies to:
Microsoft Teams

Shows the configuration of the previously defined Session Border Controller(s) (SBC(s)) that describes the settings for the peer entity. This cmdlet was introduced with Microsoft Phone System Direct Routing.

Syntax

Get-CsOnlinePSTNGateway
   [[-Identity] <string>]
   [<CommonParameters>]
Get-CsOnlinePSTNGateway
   [-Filter <string>]
   [<CommonParameters>]

Description

Use this cmdlet to show the configuration of the previously created Session Border Controller(s) (SBC(s)) configuration. Each configuration contains specific settings for an SBC. These settings configure such entities as SIP signaling port, whether media bypass is enabled on this SBC, will the SBC send SIP options, specify the limit of maximum concurrent sessions, The cmdlet also let drain the SBC by setting parameter -Enabled to true or false state. When the Enabled parameter set to $false, the SBC will continue existing calls, bit all new calls routed to another SBC in a route (if exists).

Examples

Example 1

PS C:\> Get-CsOnlinePSTNGateway

This example shows all SBCs paired with the tenant.

Example 2

PS C:\> Get-CsOnlinePSTNGateway -Filter "*.contoso.com"

This example selects all SBCs with identities matching the pattern *.contoso.com, such as sbc1.contoso.com and sbc2.contoso.com.

Parameters

-Filter

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Microsoft Teams

-Identity

The parameter is optional for the cmdlet. If not set all SBCs paired to the tenant are listed.

Type:String
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Microsoft Teams

Inputs

None

Outputs

System.Object