Skip to content

Commit 6aadce1

Browse files
rautsikrautsik
committed
Adding documentation for *-CSOnlinePSTNGateway commands. I belong to team developing those commands.
1 parent a3118f3 commit 6aadce1

File tree

4 files changed

+400
-0
lines changed

4 files changed

+400
-0
lines changed

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

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml
3+
applicable: Skype for Business Online
4+
title: Get-CSOnlinePSTNGateway
5+
schema: 2.0.0
6+
---
7+
8+
# Get-CSOnlinePSTNGateway
9+
10+
## SYNOPSIS
11+
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.
12+
13+
## SYNTAX
14+
15+
```
16+
Get-CSOnlinePSTNGateway -Identity <SBCFQDN>
17+
```
18+
19+
## DESCRIPTION
20+
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).
21+
22+
## EXAMPLES
23+
24+
### -------------------------- Example 1 --------------------------
25+
```
26+
Get-CSOnlinePSTNGateway
27+
```
28+
29+
This example shows all SBCs paired with the tenant
30+
31+
### -------------------------- Example 2 --------------------------
32+
```
33+
Get-CsOnlinePSTNGateway | ?{$_.Identity -like "*.contoso.com"}
34+
```
35+
36+
This example selects all SBC with names matching the pattern *.contoso.com. For example: sbc1.contoso.com, sbc2.contoso.com etc
37+
38+
39+
## PARAMETERS
40+
41+
### -Identity
42+
The parameter is optional for the cmdlet. If not set all SBC paired to the tenant are listed.
43+
44+
```yaml
45+
Required: False
46+
Default value: None
47+
Accept pipeline input: False
48+
Accept wildcard characters: False
49+
```
50+
51+
## RELATED LINKS
52+
53+
[Set-CSOnlinePSTNGateway](Set-CSOnlinePSTNGateway.md)
54+
[New-CSOnlinePSTNGateway](New-CSOnlinePSTNGateway.md)
55+
[Remove-CSOnlinePSTNGateway](Remove-CSOnlinePSTNGateway.md)

‎skype/skype-ps/skype/New-CSOnlinePSTNGateway.md

Lines changed: 145 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,145 @@
1+
---
2+
external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml
3+
applicable: Skype for Business Online
4+
title: New-CSOnlinePSTNGateway
5+
schema: 2.0.0
6+
---
7+
8+
# New-CSOnlinePSTNGateway
9+
10+
## SYNOPSIS
11+
Creates a new Session Border Controller (SBC) Configuration that describes the settings for the peer entity. This cmdlet was introduced with Microsoft Phone System Direct Routing.
12+
13+
## SYNTAX
14+
15+
```
16+
New-CSOnlinePSTNGateway -Identity <SBCFQDN> [-FQDN <SBCFQDN>] [-SipSignallingPort <0 to 65535>] [-MediaBypass <$true | $false>] [-FailoverTimerSeconds <Int32>] [-ForwardCallHistory <$true | $false> ] [-ForwardPAI <$true | $false> ] [-SendSIPOptions <$true| $false>] [ - MaxConcurrentSessions <Int32>] | [-Enabled <$true | $false>]
17+
```
18+
19+
## DESCRIPTION
20+
Use this cmdlet to create a new Session Border Controller (SBC) 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 is set to $false, the SBC will continue existing calls, but all new calls will be routed to another SBC in a route (if exists).
21+
22+
## EXAMPLES
23+
24+
### -------------------------- Example 1 --------------------------
25+
```
26+
New-CSOnlinePSTNGateway - FQDN sbc.contoso.com -SIPSignallingPort 5061
27+
```
28+
29+
This example creates an SBC with FQDN sbc.contoso.com and signaling port 5061. All others parameters will stay default. Note the SBC will be in the disabled state.
30+
31+
### -------------------------- Example 2 --------------------------
32+
```
33+
New-CSOnlinePSTNGateway - FQDN sbc.contoso.com -SIPSignallingPort 5061 -ForwardPAI $true -Enabled $true
34+
```
35+
36+
This example creates an SBC with FQDN sbc.contoso.com and signaling port 5061. For each outbound to SBC session, the Direct Routing interface will report in P-Asserted-Identity fields the TEL URI and SIP address of the user who made a call. This is useful when a tenant administrator set identity of the caller as "Anonymous" or a general number of the company, but for the billing purposes the real identity of the user should be reported.
37+
38+
39+
## PARAMETERS
40+
41+
### -Identity
42+
The parameter is not mandatory when creating a new SBC, the identity must be identical to the -FQDN parameter, described below. If the parameter not defined the Idetity will be copied from the -FQDN parameter.
43+
44+
```yaml
45+
Required: False
46+
Default value: None
47+
Accept pipeline input: False
48+
Accept wildcard characters: False
49+
```
50+
51+
### -FQDN
52+
Limited to 63 characters, the FQDN registered for the SBC. Copied automatically to Identity of the SBC field.
53+
54+
```yaml
55+
Required: True
56+
Default value: None
57+
Accept pipeline input: False
58+
Accept wildcard characters: False
59+
```
60+
61+
### -MediaBypass
62+
Parameter indicated of the SBC supports Media Bypass and the administrator wants to use it for this SBC.
63+
64+
```yaml
65+
Required: False
66+
Default value: $false
67+
Accept pipeline input: False
68+
Accept wildcard characters: False
69+
```
70+
71+
### -SipSignallingPort
72+
Listening port used for communicating with Direct Routing services by using the Transport Layer Security (TLS) protocol.
73+
74+
```yaml
75+
Required: True
76+
Default value: 5061
77+
Accept pipeline input: False
78+
Accept wildcard characters: False
79+
```
80+
81+
### -FailoverTimerSeconds
82+
When set to 10 (default value), outbound calls that are not answered by the gateway within 10 seconds are routed to the next available trunk; if there are no additional trunks, then the call is automatically dropped. In an organization with slow networks and gateway responses, that could potentially result in calls being dropped unnecessarily. The default value is 10.
83+
84+
```yaml
85+
Required: False
86+
Default value: 10
87+
Accept pipeline input: False
88+
Accept wildcard characters: False
89+
```
90+
91+
### -ForwardCallHistory
92+
Indicates whether call history information will be forwarded through the trunk. If enabled, the Office 365 PSTN Proxy sends two headers: History-info and Referred-By. The default value is False ($False).
93+
94+
```yaml
95+
Required: False
96+
Default value: $false
97+
Accept pipeline input: False
98+
Accept wildcard characters: False
99+
```
100+
101+
### -ForwardPAI
102+
Indicates whether the P-Asserted-Identity (PAI) header will be forwarded along with the call. The PAI header provides a way to verify the identity of the caller. The default value is False ($False).
103+
104+
```yaml
105+
Required: False
106+
Default value: $false
107+
Accept pipeline input: False
108+
Accept wildcard characters: False
109+
```
110+
111+
### -SendSIPOptions
112+
Defines if an SBC will or will not send the SIP options. If disabled, the SBC will be excluded from Monitoring and Alerting system. We highly recommend that you enable SIP options. Default value is True.
113+
114+
```yaml
115+
Required: False
116+
Default value: $true
117+
Accept pipeline input: False
118+
Accept wildcard characters: False
119+
```
120+
121+
### -MaxConcurrentSessions
122+
Used by alerting system. When any value is set, the alerting system will generate an alert to the tenant administrator when the number of concurrent session is 90% or higher than this value. If parameter is not set, the alerts are not generated. However, the monitoring system will report number of concurrent session every 24 hours.
123+
124+
```yaml
125+
Required: False
126+
Default value: None
127+
Accept pipeline input: False
128+
Accept wildcard characters: False
129+
```
130+
131+
### -Enabled
132+
Used to enable this SBC for outbound calls. Can be used to temporarily remove the SBC, while it is being updated or during maintenance. Note of the parameter not set the SBC will be created as disabled (default value -Enabled $false).
133+
134+
```yaml
135+
Required: False
136+
Default value: $false
137+
Accept pipeline input: False
138+
Accept wildcard characters: False
139+
```
140+
141+
## RELATED LINKS
142+
143+
[Set-CSOnlinePSTNGateway](Set-CSOnlinePSTNGateway.md)
144+
[Get-CSOnlinePSTNGateway](Get-CSOnlinePSTNGateway.md)
145+
[Remove-CSOnlinePSTNGateway](Remove-CSOnlinePSTNGateway.md)

‎skype/skype-ps/skype/Remove-CSOnlinePSTNGateway.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml
3+
applicable: Skype for Business Online
4+
title: Remove-CSOnlinePSTNGateway
5+
schema: 2.0.0
6+
---
7+
8+
# Remove-CSOnlinePSTNGateway
9+
10+
## SYNOPSIS
11+
Removes 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.
12+
13+
## SYNTAX
14+
15+
```
16+
Remove-CSOnlinePSTNGateway -Identity <SBCFQDN>
17+
```
18+
19+
## DESCRIPTION
20+
Use this cmdlet to remove the configuration of the previously created Session Border Controller(s) (SBC(s)) configuration. Note the SBC must be removed from all voice routes before executing this cmdlet
21+
22+
## EXAMPLES
23+
24+
### -------------------------- Example 1 --------------------------
25+
```
26+
Remove-CSOnlinePSTNGateway -Identity sbc.contoso.com
27+
```
28+
29+
This example removes SBC with Identity (and FQDN) sbc.contoso.com
30+
31+
### -------------------------- Example 2 --------------------------
32+
```
33+
Removes-CsOnlinePSTNGateway | ?{$_.Identity -like "*.contoso.com"}
34+
```
35+
36+
This example removes the SBC with identities (and FQDNs) matching the pattern *.contoso.com. For example: sbc1.contoso.com, sbc2.contoso.com etc
37+
38+
39+
## PARAMETERS
40+
41+
### -Identity
42+
The parameter is mandatory for the cmdlet. The Identity is the same as the SBC FQDN.
43+
44+
```yaml
45+
Required: True
46+
Default value: None
47+
Accept pipeline input: False
48+
Accept wildcard characters: False
49+
```
50+
51+
## RELATED LINKS
52+
53+
[Set-CSOnlinePSTNGateway](Set-CSOnlinePSTNGateway.md)
54+
[New-CSOnlinePSTNGateway](New-CSOnlinePSTNGateway.md)
55+
[Get-CSOnlinePSTNGateway](Get-CSOnlinePSTNGateway.md)

0 commit comments

Comments
 (0)