|
| 1 | +--- |
| 2 | +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml |
| 3 | +online version: |
| 4 | +applicable: Skype for Business Online |
| 5 | +title: Get-CSOnlinePSTNGateway |
| 6 | +schema: 2.0.0 |
| 7 | +--- |
| 8 | + |
| 9 | +# Get-CSOnlinePSTNGateway |
| 10 | + |
| 11 | +## SYNOPSIS |
| 12 | +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. |
| 13 | + |
| 14 | +## SYNTAX |
| 15 | + |
| 16 | +### Identity (Default) |
| 17 | +``` |
| 18 | +Get-CSOnlinePSTNGateway [-Tenant <System.Guid>] [[-Identity] <XdsGlobalRelativeIdentity>] [-LocalStore] |
| 19 | + [<CommonParameters>] |
| 20 | +``` |
| 21 | + |
| 22 | +### Filter |
| 23 | +``` |
| 24 | +Get-CSOnlinePSTNGateway [-Tenant <System.Guid>] [-Filter <String>] [-LocalStore] [<CommonParameters>] |
| 25 | +``` |
| 26 | + |
| 27 | +## DESCRIPTION |
| 28 | +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). |
| 29 | + |
| 30 | +## EXAMPLES |
| 31 | + |
| 32 | +### Example 1 |
| 33 | +```powershell |
| 34 | +PS C:\> Get-CSOnlinePSTNGateway |
| 35 | +``` |
| 36 | + |
| 37 | +This example shows all SBCs paired with the tenant |
| 38 | + |
| 39 | +### Example 2 |
| 40 | +```powershell |
| 41 | +PS C:\> Get-CsOnlinePSTNGateway | ?{$_.Identity -like "*.contoso.com"} |
| 42 | +``` |
| 43 | + |
| 44 | +This example selects all SBC with names matching the pattern *.contoso.com. For example: sbc1.contoso.com, sbc2.contoso.com etc |
| 45 | + |
| 46 | +## PARAMETERS |
| 47 | + |
| 48 | +### -Filter |
| 49 | + |
| 50 | +```yaml |
| 51 | +Type: String |
| 52 | +Parameter Sets: Filter |
| 53 | +Aliases: |
| 54 | +Applicable: Skype for Business Online |
| 55 | +Required: False |
| 56 | +Position: Named |
| 57 | +Default value: None |
| 58 | +Accept pipeline input: False |
| 59 | +Accept wildcard characters: False |
| 60 | +``` |
| 61 | +
|
| 62 | +### -Identity |
| 63 | +The parameter is optional for the cmdlet. If not set all SBC paired to the tenant are listed. |
| 64 | +
|
| 65 | +```yaml |
| 66 | +Type: XdsGlobalRelativeIdentity |
| 67 | +Parameter Sets: Identity |
| 68 | +Aliases: |
| 69 | +Applicable: Skype for Business Online |
| 70 | +Required: False |
| 71 | +Position: 1 |
| 72 | +Default value: None |
| 73 | +Accept pipeline input: False |
| 74 | +Accept wildcard characters: False |
| 75 | +``` |
| 76 | +
|
| 77 | +### -LocalStore |
| 78 | +
|
| 79 | +```yaml |
| 80 | +Type: SwitchParameter |
| 81 | +Parameter Sets: (All) |
| 82 | +Aliases: |
| 83 | + |
| 84 | +Required: False |
| 85 | +Position: Named |
| 86 | +Default value: None |
| 87 | +Accept pipeline input: False |
| 88 | +Accept wildcard characters: False |
| 89 | +``` |
| 90 | +
|
| 91 | +### -Tenant |
| 92 | +
|
| 93 | +```yaml |
| 94 | +Type: System.Guid |
| 95 | +Parameter Sets: (All) |
| 96 | +Aliases: |
| 97 | + |
| 98 | +Required: False |
| 99 | +Position: Named |
| 100 | +Default value: None |
| 101 | +Accept pipeline input: False |
| 102 | +Accept wildcard characters: False |
| 103 | +``` |
| 104 | +
|
| 105 | +### CommonParameters |
| 106 | +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. |
| 107 | +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). |
| 108 | +
|
| 109 | +## INPUTS |
| 110 | +
|
| 111 | +### None |
| 112 | +
|
| 113 | +
|
| 114 | +## OUTPUTS |
| 115 | +
|
| 116 | +### System.Object |
| 117 | +
|
| 118 | +## NOTES |
| 119 | +
|
| 120 | +## RELATED LINKS |
| 121 | +
|
| 122 | +[Set-CSOnlinePSTNGateway](Set-CSOnlinePSTNGateway.md) |
| 123 | +
|
| 124 | +[New-CSOnlinePSTNGateway](New-CSOnlinePSTNGateway.md) |
| 125 | +
|
| 126 | +[Remove-CSOnlinePSTNGateway](Remove-CSOnlinePSTNGateway.md) |
0 commit comments