Skip to content

Commit 09e4777

Browse files
committed
Used PlatyPS to generate documentation instead of copy-paste from other examples.
1 parent 97305d3 commit 09e4777

File tree

4 files changed

+507
-70
lines changed

4 files changed

+507
-70
lines changed

skype/skype-ps/skype/Get-CSOnlinePSTNGateway.md

Lines changed: 77 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml
3+
online version:
34
applicable: Skype for Business Online
45
title: Get-CSOnlinePSTNGateway
56
schema: 2.0.0
@@ -12,42 +13,110 @@ Shows the configuration of the previously defined Session Border Controller(s) (
1213

1314
## SYNTAX
1415

16+
### Identity (Default)
1517
```
16-
Get-CSOnlinePSTNGateway -Identity <SBCFQDN>
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>]
1725
```
1826

1927
## DESCRIPTION
2028
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).
2129

2230
## EXAMPLES
2331

24-
### -------------------------- Example 1 --------------------------
25-
```
26-
Get-CSOnlinePSTNGateway
32+
### Example 1
33+
```powershell
34+
PS C:\> Get-CSOnlinePSTNGateway
2735
```
2836

2937
This example shows all SBCs paired with the tenant
3038

31-
### -------------------------- Example 2 --------------------------
32-
```
33-
Get-CsOnlinePSTNGateway | ?{$_.Identity -like "*.contoso.com"}
39+
### Example 2
40+
```powershell
41+
PS C:\> Get-CsOnlinePSTNGateway | ?{$_.Identity -like "*.contoso.com"}
3442
```
3543

3644
This example selects all SBC with names matching the pattern *.contoso.com. For example: sbc1.contoso.com, sbc2.contoso.com etc
3745

38-
3946
## PARAMETERS
4047

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+
4162
### -Identity
4263
The parameter is optional for the cmdlet. If not set all SBC paired to the tenant are listed.
4364
4465
```yaml
66+
Type: XdsGlobalRelativeIdentity
67+
Parameter Sets: Identity
68+
Aliases:
69+
Applicable: Skype for Business Online
4570
Required: False
71+
Position: 1
4672
Default value: None
4773
Accept pipeline input: False
4874
Accept wildcard characters: False
4975
```
5076
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+
51120
## RELATED LINKS
52121
53122
[Set-CSOnlinePSTNGateway](Set-CSOnlinePSTNGateway.md)

0 commit comments

Comments
 (0)