Skip to content

Commit a2470ea

Browse files
tiburdtiburd
authored
Merge pull request MicrosoftDocs#8674 from JensTrier/TrunkParameters
Updated OnlinePstnGateway with new parameters
2 parents c3e22cc + 6633dd6 commit a2470ea

File tree

2 files changed

+197
-123
lines changed

2 files changed

+197
-123
lines changed

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

Lines changed: 101 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml
33
online version: https://docs.microsoft.com/powershell/module/skype/new-csonlinepstngateway
4-
applicable: Skype for Business Online
4+
applicable: Microsoft Teams
55
title: New-CsOnlinePSTNGateway
66
schema: 2.0.0
77
manager: bulenteg
@@ -18,11 +18,11 @@ Creates a new Session Border Controller (SBC) Configuration that describes the s
1818
## SYNTAX
1919

2020
```
21-
New-CsOnlinePSTNGateway [-Tenant <System.Guid>] [-Fqdn <String>] [-SipSignalingPort <Int32>]
22-
[-CodecPriority <String>] [-ExcludedCodecs <String>] [-FailoverTimeSeconds <Int32>]
21+
New-CsOnlinePSTNGateway [-Tenant <System.Guid>] [-Description <String>] [-Fqdn <String>] [-SipSignalingPort <Int32>]
22+
[-CodecPriority <String>] [-ExcludedCodecs <String>] [-FailoverResponseCodes <String>] [-FailoverTimeSeconds <Int32>]
2323
[-ForwardCallHistory <Boolean>] [-ForwardPai <Boolean>] [-SendSipOptions <Boolean>]
2424
[-MaxConcurrentSessions <System.Int32>] [-Enabled <Boolean>] [-MediaBypass <Boolean>]
25-
[-GatewaySiteId <String>] [-GatewaySiteLbrEnabled <Boolean>] [-BypassMode <String>]
25+
[-GatewaySiteId <String>] [-GatewaySiteLbrEnabled <Boolean>] [-GatewayLbrEnabledUserOverride <Boolean>] [-BypassMode <String>]
2626
[-InboundTeamsNumberTranslationRules <String>] [-InboundPSTNNumberTranslationRules <String>]
2727
[-OutboundTeamsNumberTranslationRules <String>] [-OutboundPSTNNumberTranslationRules <String>] [-PidfloSupported <Boolean>]
2828
[-MediaRelayRoutingLocationOverride <String>] [-InMemory] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
@@ -56,7 +56,7 @@ Allows choice of codec priority when media is negotiated between Media Proxy and
5656
Type: String
5757
Parameter Sets: (All)
5858
Aliases:
59-
Applicable: Skype for Business Online
59+
Applicable: Microsoft Teams
6060
Required: False
6161
Position: Named
6262
Default value: ("SILKWB,SILKNB,PCMU,PCMA")
@@ -71,7 +71,22 @@ Prompts you for confirmation before running the cmdlet.
7171
Type: SwitchParameter
7272
Parameter Sets: (All)
7373
Aliases: cf
74-
Applicable: Skype for Business Online
74+
Applicable: Microsoft Teams
75+
Required: False
76+
Position: Named
77+
Default value: None
78+
Accept pipeline input: False
79+
Accept wildcard characters: False
80+
```
81+
82+
### -Description
83+
Free-format string to describe the gateway.
84+
85+
```yaml
86+
Type: String
87+
Parameter Sets: (All)
88+
Aliases:
89+
Applicable: Microsoft Teams
7590
Required: False
7691
Position: Named
7792
Default value: None
@@ -86,7 +101,7 @@ Used to enable this SBC for outbound calls. Can be used to temporarily remove th
86101
Type: Boolean
87102
Parameter Sets: (All)
88103
Aliases:
89-
Applicable: Skype for Business Online
104+
Applicable: Microsoft Teams
90105
Required: False
91106
Position: Named
92107
Default value: $false
@@ -101,22 +116,42 @@ Allows some codecs to be excluded when media is being negotiated between Media P
101116
Type: String
102117
Parameter Sets: (All)
103118
Aliases:
104-
Applicable: Skype for Business Online
119+
Applicable: Microsoft Teams
105120
Required: False
106121
Position: Named
107122
Default value: None
108123
Accept pipeline input: False
109124
Accept wildcard characters: False
110125
```
111126
127+
### -FailoverResponseCodes
128+
If Direct Routing receives any 4xx or 6xx SIP error code in response to an outgoing Invite the call is considered completed by default. (Outgoing in this context is a call
129+
from a Teams client to the PSTN with traffic flow: Teams Client -> Direct Routing -> SBC -> Telephony network). Setting the SIP codes in this parameter forces Direct Routing
130+
on receiving the specified codes try another SBC (if another SBC exists in the voice routing policy of the user). Find more information in the "Reference" section of "Phone
131+
System Direct Routing" documentation.
132+
133+
Setting this parameter overwrites the default values, so if you want to include the default values, please add them to string.
134+
135+
```yaml
136+
Type: String
137+
Parameter Sets: (All)
138+
Aliases:
139+
Applicable: Microsoft Teams
140+
Required: False
141+
Position: Named
142+
Default value: 408, 503, 504
143+
Accept pipeline input: False
144+
Accept wildcard characters: False
145+
```
146+
112147
### -FailoverTimeSeconds
113148
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 slow gateway responses, that could potentially result in calls being dropped unnecessarily. The default value is 10.
114149
115150
```yaml
116151
Type: Int32
117152
Parameter Sets: (All)
118153
Aliases:
119-
Applicable: Skype for Business Online
154+
Applicable: Microsoft Teams
120155
Required: False
121156
Position: Named
122157
Default value: 10
@@ -131,7 +166,7 @@ The Force switch specifies whether to suppress warning and confirmation messages
131166
Type: SwitchParameter
132167
Parameter Sets: (All)
133168
Aliases:
134-
Applicable: Skype for Business Online
169+
Applicable: Microsoft Teams
135170
Required: False
136171
Position: Named
137172
Default value: None
@@ -146,7 +181,7 @@ Indicates whether call history information will be forwarded to the SBC. If enab
146181
Type: Boolean
147182
Parameter Sets: (All)
148183
Aliases:
149-
Applicable: Skype for Business Online
184+
Applicable: Microsoft Teams
150185
Required: False
151186
Position: Named
152187
Default value: $false
@@ -161,7 +196,7 @@ Indicates whether the P-Asserted-Identity (PAI) header will be forwarded along w
161196
Type: Boolean
162197
Parameter Sets: (All)
163198
Aliases:
164-
Applicable: Skype for Business Online
199+
Applicable: Microsoft Teams
165200
Required: False
166201
Position: Named
167202
Default value: $false
@@ -176,143 +211,147 @@ Limited to 63 characters, the FQDN registered for the SBC. Copied automatically
176211
Type: String
177212
Parameter Sets: ParentAndRelativeKey
178213
Aliases:
179-
Applicable: Skype for Business Online
214+
Applicable: Microsoft Teams
180215
Required: True
181216
Position: Named
182217
Default value: None
183218
Accept pipeline input: False
184219
Accept wildcard characters: False
185220
```
186221
187-
### -Identity
188-
When creating a new SBC, the identity must be identical to the -FQDN parameter, described above. If the parameter is not defined the Identity will be copied from the -FQDN parameter. The Identity parameter is not mandatory.
222+
### -GatewaySiteId
223+
PSTN Gateway Site Id.
189224
190225
```yaml
191-
Type: XdsGlobalRelativeIdentity
192-
Parameter Sets: Identity
226+
Type: String
227+
Parameter Sets: (All)
193228
Aliases:
194-
Applicable: Skype for Business Online
195-
Required: True
196-
Position: 1
229+
Applicable: Microsoft Teams
230+
Required: False
231+
Position: Named
197232
Default value: None
198233
Accept pipeline input: False
199234
Accept wildcard characters: False
200235
```
201236
202-
### -InMemory
237+
### -GatewaySiteLbrEnabled
238+
Used to enable this SBC to report assigned site location. Site location is used for Location Based Routing. When this parameter is enabled ($True), the SBC will report the site
239+
name as defined by the tenant administrator. On an incoming call to a Teams user the value of the site assigned to the SBC is compared with the value of the site assigned to
240+
the user to make a routing decision. The parameter is mandatory for enabling Location Based Routing feature. The default value is False ($False).
203241
204242
```yaml
205-
Type: SwitchParameter
243+
Type: Boolean
206244
Parameter Sets: (All)
207245
Aliases:
208-
Applicable: Skype for Business Online
246+
Applicable: Microsoft Teams
209247
Required: False
210248
Position: Named
211-
Default value: None
249+
Default value: $false
212250
Accept pipeline input: False
213251
Accept wildcard characters: False
214252
```
215253
216-
### -MaxConcurrentSessions
217-
Used by the alerting system. When any value is set, the alerting system will generate an alert to the tenant administrator when the number of concurrent sessions is 90% or higher than this value. If the parameter is not set, alerts are not generated. However, the monitoring system will report the number of concurrent sessions every 24 hours.
254+
### -GatewayLbrEnabledUserOverride
255+
Allow an LBR enabled user working from a network site outside the corporate network, i.e. a network site not configured using tenant network site - typically when working from
256+
home, to make outbound PSTN calls via an LBR enabled gateway. The default value is False.
218257
219258
```yaml
220-
Type: System.Int32
259+
Type: Boolean
221260
Parameter Sets: (All)
222261
Aliases:
223-
Applicable: Skype for Business Online
262+
Applicable: Microsoft Teams
224263
Required: False
225264
Position: Named
226-
Default value: None
265+
Default value: $false
227266
Accept pipeline input: False
228267
Accept wildcard characters: False
229268
```
230269
231-
### -MediaBypass
232-
Parameter indicates if the SBC supports Media Bypass and the administrator wants to use it for this SBC.
270+
### -Identity
271+
When creating a new SBC, the identity must be identical to the -FQDN parameter, described above. If the parameter is not defined the Identity will be copied from the -FQDN parameter. The Identity parameter is not mandatory.
233272
234273
```yaml
235-
Type: Boolean
236-
Parameter Sets: (All)
274+
Type: XdsGlobalRelativeIdentity
275+
Parameter Sets: Identity
237276
Aliases:
238-
Applicable: Skype for Business Online
239-
Required: False
240-
Position: Named
241-
Default value: $false
277+
Applicable: Microsoft Teams
278+
Required: True
279+
Position: 1
280+
Default value: None
242281
Accept pipeline input: False
243282
Accept wildcard characters: False
244283
```
245284
246-
### -MediaRelayRoutingLocationOverride
247-
This parameter is reserved for use with managed carriers.
248-
249-
Allows selecting path for media manually. Direct Routing assigns a datacenter for media path based on the public IP of the SBC. We always select closest to the SBC datacenter. However, in some cases a public IP from for example a US range can be assigned to an SBC located in Europe. In this case we will be using not optimal media path. We only recommend setting this parameter if the call logs clearly indicate that automatic assignment of the datacenter for media path does not assign the closest to the SBC datacenter.
285+
### -InMemory
250286
251287
```yaml
252-
Type: String
288+
Type: SwitchParameter
253289
Parameter Sets: (All)
254290
Aliases:
255291
Applicable: Microsoft Teams
256292
Required: False
257293
Position: Named
258-
Default value: $false
294+
Default value: None
259295
Accept pipeline input: False
260296
Accept wildcard characters: False
261297
```
262298
263-
### -FailoverResponseCodes
264-
If Direct Routing receives any 4xx or 6xx SIP error code in response to an outgoing Invite the call is considered completed by default. (Outgoing in this context is a call from a Teams client to the PSTN with traffic flow: Teams Client -> Direct Routing -> SBC -> Telephony network). Setting the SIP codes in this parameter forces Direct Routing on receiving the specified codes try another SBC (if another SBC exists in the voice routing policy of the user). Find more information in the "Reference" section of "Phone System Direct Routing" documentation.
299+
### -MaxConcurrentSessions
300+
Used by the alerting system. When any value is set, the alerting system will generate an alert to the tenant administrator when the number of concurrent sessions is 90% or higher than this value. If the parameter is not set, alerts are not generated. However, the monitoring system will report the number of concurrent sessions every 24 hours.
265301
266302
```yaml
267-
Type: Int
303+
Type: System.Int32
268304
Parameter Sets: (All)
269305
Aliases:
270-
Applicable: Skype for Business Online
306+
Applicable: Microsoft Teams
271307
Required: False
272308
Position: Named
273-
Default value: 408, 503, 504
309+
Default value: None
274310
Accept pipeline input: False
275311
Accept wildcard characters: False
276312
```
277313
278-
### -GatewaySiteId
279-
PSTN Gateway Site Id.
314+
### -MediaBypass
315+
Parameter indicates if the SBC supports Media Bypass and the administrator wants to use it for this SBC.
280316
281317
```yaml
282-
Type: String
318+
Type: Boolean
283319
Parameter Sets: (All)
284320
Aliases:
285-
Applicable: Skype for Business Online
321+
Applicable: Microsoft Teams
286322
Required: False
287323
Position: Named
288-
Default value: None
324+
Default value: $false
289325
Accept pipeline input: False
290326
Accept wildcard characters: False
291327
```
292328
293-
### -GatewaySiteLbrEnabled
294-
Used to enable this SBC to report assigned site location. Site location is used for Location Based Routing. When this parameter is enabled ($True), the SBC will report the site name as defined by the tenant administrator. On an incoming call to a Teams user the value of the site assigned to the SBC is compared with the value of the site assigned to the user to make a routing decision. The parameter is mandatory for enabling Location Based Routing feature. The default value is False ($False).
329+
### -MediaRelayRoutingLocationOverride
330+
This parameter is reserved for use with managed carriers.
331+
332+
Allows selecting path for media manually. Direct Routing assigns a datacenter for media path based on the public IP of the SBC. We always select closest to the SBC datacenter. However, in some cases a public IP from for example a US range can be assigned to an SBC located in Europe. In this case we will be using not optimal media path. We only recommend setting this parameter if the call logs clearly indicate that automatic assignment of the datacenter for media path does not assign the closest to the SBC datacenter.
295333
296334
```yaml
297-
Type: Boolean
335+
Type: String
298336
Parameter Sets: (All)
299337
Aliases:
300-
Applicable: Skype for Business Online
338+
Applicable: Microsoft Teams
301339
Required: False
302340
Position: Named
303341
Default value: $false
304342
Accept pipeline input: False
305343
Accept wildcard characters: False
306344
```
307345
346+
308347
### -SendSipOptions
309348
Defines if an SBC will or will not send SIP Options messages. If disabled, the SBC will be excluded from the Monitoring and Alerting system. We highly recommend that you enable SIP Options. The default value is True.
310349
311350
```yaml
312351
Type: Boolean
313352
Parameter Sets: (All)
314353
Aliases:
315-
Applicable: Skype for Business Online
354+
Applicable: Microsoft Teams
316355
Required: False
317356
Position: Named
318357
Default value: $true
@@ -328,7 +367,7 @@ Please note: Spelling of this parameter changed recently from SipSignallingPort
328367
Type: Int32
329368
Parameter Sets: (All)
330369
Aliases:
331-
Applicable: Skype for Business Online
370+
Applicable: Microsoft Teams
332371
Required: True
333372
Position: Named
334373
Default value: None
@@ -413,7 +452,7 @@ Enables PIDF-LO support on the PSTN Gateway. If turned on the .xml body payload
413452
Type: Boolean
414453
Parameter Sets: (All)
415454
Aliases:
416-
Applicable: Skype for Business Online
455+
Applicable: Microsoft Teams
417456
Required: False
418457
Position: Named
419458
Default value: $false
@@ -427,7 +466,7 @@ Accept wildcard characters: False
427466
Type: System.Guid
428467
Parameter Sets: (All)
429468
Aliases:
430-
Applicable: Skype for Business Online
469+
Applicable: Microsoft Teams
431470
Required: False
432471
Position: Named
433472
Default value: None
@@ -443,7 +482,7 @@ The cmdlet is not run.
443482
Type: SwitchParameter
444483
Parameter Sets: (All)
445484
Aliases: wi
446-
Applicable: Skype for Business Online
485+
Applicable: Microsoft Teams
447486
Required: False
448487
Position: Named
449488
Default value: None

0 commit comments

Comments
 (0)