Skip to content

Commit 807209e

Browse files
chrisdachrisda
committed
Update Set-CsOnlinePSTNGateway.md
1 parent f4a2614 commit 807209e

File tree

1 file changed

+107
-87
lines changed

1 file changed

+107
-87
lines changed

‎teams/teams-ps/teams/Set-CsOnlinePSTNGateway.md

Lines changed: 107 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,32 @@ Modifies the previously defined Session Border Controller (SBC) Configuration th
1818
## SYNTAX
1919

2020
```
21-
Set-CsOnlinePSTNGateway [[-Identity] <string>] [-BypassMode <string>] [-Description <string>] [-Enabled <boolean>]
22-
[-FailoverResponseCodes <string>] [-FailoverTimeSeconds <int>] [-ForwardCallHistory <boolean>] [-ForwardPai <boolean>] [-GatewayLbrEnabledUserOverride <boolean>]
23-
[-GatewaySiteId <string>] [-GatewaySiteLbrEnabled <boolean>] [-InboundPstnNumberTranslationRules <Object>] [-InboundTeamsNumberTranslationRules <Object>]
24-
[-MaxConcurrentSessions <int>] [-MediaBypass <boolean>] [-MediaRelayRoutingLocationOverride <string>] [-OutboundPstnNumberTranslationRules <Object>]
25-
[-OutboundTeamsNumberTranslationRules <Object>] [-PidfLoSupported <boolean>] [-ProxySbc <string>] [-SendSipOptions <boolean>] [-SipSignalingPort <int>] [-IPAddressVersion <string>]
26-
[-WhatIf] [-Confirm] [<CommonParameters>]
21+
Set-CsOnlinePSTNGateway [[-Identity] <string>]
22+
[-BypassMode <string>]
23+
[-Confirm]
24+
[-Description <string>]
25+
[-Enabled <boolean>]
26+
[-FailoverResponseCodes <string>]
27+
[-FailoverTimeSeconds <int>]
28+
[-ForwardCallHistory <boolean>]
29+
[-ForwardPai <boolean>]
30+
[-GatewayLbrEnabledUserOverride <boolean>]
31+
[-GatewaySiteId <string>]
32+
[-GatewaySiteLbrEnabled <boolean>]
33+
[-IPAddressVersion <string>]
34+
[-InboundPstnNumberTranslationRules <Object>]
35+
[-InboundTeamsNumberTranslationRules <Object>]
36+
[-MaxConcurrentSessions <int>]
37+
[-MediaBypass <boolean>]
38+
[-MediaRelayRoutingLocationOverride <string>]
39+
[-OutboundPstnNumberTranslationRules <Object>]
40+
[-OutboundTeamsNumberTranslationRules <Object>]
41+
[-PidfLoSupported <boolean>]
42+
[-ProxySbc <string>]
43+
[-SendSipOptions <boolean>]
44+
[-SipSignalingPort <int>]
45+
[-WhatIf]
46+
[<CommonParameters>]
2747
```
2848

2949
## DESCRIPTION
@@ -47,6 +67,50 @@ This example modifies the configuration of an SBC with identity (and FQDN) sbc.
4767

4868
## PARAMETERS
4969

70+
### -Identity
71+
The parameter is mandatory when modifying an existing SBC.
72+
73+
```yaml
74+
Type: String
75+
Parameter Sets: Identity
76+
Aliases:
77+
Applicable: Microsoft Teams
78+
Required: False
79+
Position: 1
80+
Default value: None
81+
Accept pipeline input: False
82+
Accept wildcard characters: False
83+
```
84+
85+
### -BypassMode
86+
Possible values are "None", "Always" and "OnlyForLocalUsers". By setting "Always" mode you indicate that your network is fully routable. If a user usually in site "Seattle", travels to site "Tallinn" and tries to use SBC located in Seattle we will try to deliver the traffic to Seattle assuming that there is connection between Tallinn and Seattle offices. With "OnlyForLocaUsers" you indicate that there is no direct connection between sites. In example above, the traffic will not be send directly from Tallinn to Seattle.
87+
88+
```yaml
89+
Type: String
90+
Parameter Sets: (All)
91+
Aliases:
92+
Required: False
93+
Position: Named
94+
Default value: None
95+
Accept pipeline input: False
96+
Accept wildcard characters: False
97+
```
98+
99+
### -Confirm
100+
Prompts you for confirmation before running the cmdlet.
101+
102+
```yaml
103+
Type: SwitchParameter
104+
Parameter Sets: (All)
105+
Aliases: cf
106+
Applicable: Microsoft Teams
107+
Required: False
108+
Position: Named
109+
Default value: None
110+
Accept pipeline input: False
111+
Accept wildcard characters: False
112+
```
113+
50114
### -Description
51115
Free-format string to describe the gateway.
52116
@@ -187,87 +251,53 @@ Accept pipeline input: False
187251
Accept wildcard characters: False
188252
```
189253
190-
### -Identity
191-
The parameter is mandatory when modifying an existing SBC.
192-
193-
```yaml
194-
Type: String
195-
Parameter Sets: Identity
196-
Aliases:
197-
Applicable: Microsoft Teams
198-
Required: False
199-
Position: 1
200-
Default value: None
201-
Accept pipeline input: False
202-
Accept wildcard characters: False
203-
```
204-
205-
### -MaxConcurrentSessions
206-
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 session is 90% or higher than this value. If this parameter is not set, the alerts are not generated. However, the monitoring system will report the number of concurrent sessions every 24 hours.
254+
### -InboundTeamsNumberTranslationRules
255+
This parameter assigns an ordered list of Teams translation rules, that apply to Teams numbers on inbound direction.
207256
208257
```yaml
209-
Type: System.Int32
258+
Type: Object
210259
Parameter Sets: (All)
211260
Aliases:
212-
Applicable: Microsoft Teams
213261
Required: False
214262
Position: Named
215263
Default value: None
216264
Accept pipeline input: False
217265
Accept wildcard characters: False
218266
```
219267
220-
### -MediaBypass
221-
Parameter indicated of the SBC supports Media Bypass and the administrator wants to use it for this SBC.
268+
### -InboundPSTNNumberTranslationRules
269+
Creates an ordered list of Teams translation rules, that apply to PSTN number on inbound direction.
222270
223271
```yaml
224-
Type: Boolean
272+
Type: Object
225273
Parameter Sets: (All)
226274
Aliases:
227-
Applicable: Microsoft Teams
228275
Required: False
229276
Position: Named
230-
Default value: $false
277+
Default value: None
231278
Accept pipeline input: False
232279
Accept wildcard characters: False
233280
```
234281
235-
### -MediaRelayRoutingLocationOverride
236-
237-
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.
282+
### -IPAddressVersion
283+
Possible values are "IPv4" and '"Pv6". When "IPv6" is set, the SBC must use IPv6 for both signaling and media. **Note: IPv6 is supported only for non-media bypass scenarios.**
238284
239285
```yaml
240286
Type: String
241287
Parameter Sets: (All)
242288
Aliases:
243-
Applicable: Microsoft Teams
244289
Required: False
245290
Position: Named
246-
Default value: $false
247-
Accept pipeline input: False
248-
Accept wildcard characters: False
249-
```
250-
251-
### -SendSipOptions
252-
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.
253-
254-
```yaml
255-
Type: Boolean
256-
Parameter Sets: (All)
257-
Aliases:
258-
Applicable: Microsoft Teams
259-
Required: False
260-
Position: Named
261-
Default value: $true
291+
Default value: None
262292
Accept pipeline input: False
263293
Accept wildcard characters: False
264294
```
265295
266-
### -SipSignalingPort
267-
Listening port used for communicating with Direct Routing services by using the Transport Layer Security (TLS) protocol. The value must be between 1 and 65535.
296+
### -MaxConcurrentSessions
297+
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 session is 90% or higher than this value. If this parameter is not set, the alerts are not generated. However, the monitoring system will report the number of concurrent sessions every 24 hours.
268298
269299
```yaml
270-
Type: Int32
300+
Type: System.Int32
271301
Parameter Sets: (All)
272302
Aliases:
273303
Applicable: Microsoft Teams
@@ -278,44 +308,33 @@ Accept pipeline input: False
278308
Accept wildcard characters: False
279309
```
280310
281-
### -BypassMode
282-
Possible values are "None", "Always" and "OnlyForLocalUsers". By setting "Always" mode you indicate that your network is fully routable. If a user usually in site "Seattle", travels to site "Tallinn" and tries to use SBC located in Seattle we will try to deliver the traffic to Seattle assuming that there is connection between Tallinn and Seattle offices. With "OnlyForLocaUsers" you indicate that there is no direct connection between sites. In example above, the traffic will not be send directly from Tallinn to Seattle.
311+
### -MediaBypass
312+
Parameter indicated of the SBC supports Media Bypass and the administrator wants to use it for this SBC.
283313
284314
```yaml
285-
Type: String
315+
Type: Boolean
286316
Parameter Sets: (All)
287317
Aliases:
318+
Applicable: Microsoft Teams
288319
Required: False
289320
Position: Named
290-
Default value: None
321+
Default value: $false
291322
Accept pipeline input: False
292323
Accept wildcard characters: False
293324
```
294325
295-
### -InboundTeamsNumberTranslationRules
296-
This parameter assigns an ordered list of Teams translation rules, that apply to Teams numbers on inbound direction.
297-
298-
```yaml
299-
Type: Object
300-
Parameter Sets: (All)
301-
Aliases:
302-
Required: False
303-
Position: Named
304-
Default value: None
305-
Accept pipeline input: False
306-
Accept wildcard characters: False
307-
```
326+
### -MediaRelayRoutingLocationOverride
308327
309-
### -InboundPSTNNumberTranslationRules
310-
Creates an ordered list of Teams translation rules, that apply to PSTN number on inbound direction.
328+
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.
311329
312330
```yaml
313-
Type: Object
331+
Type: String
314332
Parameter Sets: (All)
315333
Aliases:
334+
Applicable: Microsoft Teams
316335
Required: False
317336
Position: Named
318-
Default value: None
337+
Default value: $false
319338
Accept pipeline input: False
320339
Accept wildcard characters: False
321340
```
@@ -378,28 +397,28 @@ Accept pipeline input: False
378397
Accept wildcard characters: False
379398
```
380399
381-
### -IPAddressVersion
382-
Possible values are "IPv4" and '"Pv6". When "IPv6" is set, the SBC must use IPv6 for both signaling and media. **Note: IPv6 is supported only for non-media bypass scenarios.**
383-
400+
### -SendSipOptions
401+
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.
402+
384403
```yaml
385-
Type: String
404+
Type: Boolean
386405
Parameter Sets: (All)
387406
Aliases:
407+
Applicable: Microsoft Teams
388408
Required: False
389409
Position: Named
390-
Default value: None
410+
Default value: $true
391411
Accept pipeline input: False
392412
Accept wildcard characters: False
393413
```
394414
395-
### -WhatIf
396-
Shows what would happen if the cmdlet runs.
397-
The cmdlet is not run.
415+
### -SipSignalingPort
416+
Listening port used for communicating with Direct Routing services by using the Transport Layer Security (TLS) protocol. The value must be between 1 and 65535.
398417
399418
```yaml
400-
Type: SwitchParameter
419+
Type: Int32
401420
Parameter Sets: (All)
402-
Aliases: wi
421+
Aliases:
403422
Applicable: Microsoft Teams
404423
Required: False
405424
Position: Named
@@ -408,13 +427,14 @@ Accept pipeline input: False
408427
Accept wildcard characters: False
409428
```
410429
411-
### -Confirm
412-
Prompts you for confirmation before running the cmdlet.
430+
### -WhatIf
431+
Shows what would happen if the cmdlet runs.
432+
The cmdlet is not run.
413433
414434
```yaml
415435
Type: SwitchParameter
416436
Parameter Sets: (All)
417-
Aliases: cf
437+
Aliases: wi
418438
Applicable: Microsoft Teams
419439
Required: False
420440
Position: Named

0 commit comments

Comments
 (0)