Merge pull request #12327 from teddygyabaah/patch-5

mkbond007 · web-flow · commit bb042388400e · 2025-07-03T12:17:58.000-04:00
Update Set-CsOnlinePSTNGateway.md
diff --git a/teams/teams-ps/teams/Set-CsOnlinePSTNGateway.md b/teams/teams-ps/teams/Set-CsOnlinePSTNGateway.md
@@ -18,12 +18,32 @@ Modifies the previously defined Session Border Controller (SBC) Configuration th
 ## SYNTAX
 
 ```
-Set-CsOnlinePSTNGateway [[-Identity] <string>] [-BypassMode <string>] [-Description <string>] [-Enabled <boolean>]
- [-FailoverResponseCodes <string>] [-FailoverTimeSeconds <int>] [-ForwardCallHistory <boolean>] [-ForwardPai <boolean>] [-GatewayLbrEnabledUserOverride <boolean>]
- [-GatewaySiteId <string>] [-GatewaySiteLbrEnabled <boolean>] [-InboundPstnNumberTranslationRules <Object>] [-InboundTeamsNumberTranslationRules <Object>]
- [-MaxConcurrentSessions <int>] [-MediaBypass <boolean>] [-MediaRelayRoutingLocationOverride <string>] [-OutboundPstnNumberTranslationRules <Object>]
- [-OutboundTeamsNumberTranslationRules <Object>] [-PidfLoSupported <boolean>] [-ProxySbc <string>] [-SendSipOptions <boolean>] [-SipSignalingPort <int>]
- [-WhatIf] [-Confirm] [<CommonParameters>]
+Set-CsOnlinePSTNGateway [[-Identity] <string>]
+ [-BypassMode <string>]
+ [-Confirm]
+ [-Description <string>]
+ [-Enabled <boolean>]
+ [-FailoverResponseCodes <string>]
+ [-FailoverTimeSeconds <int>]
+ [-ForwardCallHistory <boolean>]
+ [-ForwardPai <boolean>]
+ [-GatewayLbrEnabledUserOverride <boolean>]
+ [-GatewaySiteId <string>]
+ [-GatewaySiteLbrEnabled <boolean>]
+ [-IPAddressVersion <string>] 
+ [-InboundPstnNumberTranslationRules <Object>]
+ [-InboundTeamsNumberTranslationRules <Object>]
+ [-MaxConcurrentSessions <int>]
+ [-MediaBypass <boolean>]
+ [-MediaRelayRoutingLocationOverride <string>]
+ [-OutboundPstnNumberTranslationRules <Object>]
+ [-OutboundTeamsNumberTranslationRules <Object>]
+ [-PidfLoSupported <boolean>]
+ [-ProxySbc <string>]
+ [-SendSipOptions <boolean>]
+ [-SipSignalingPort <int>]
+ [-WhatIf]
+ [<CommonParameters>]
  ```
 
 ## DESCRIPTION
@@ -47,6 +67,50 @@ This example modifies the configuration of an SBC with identity (and FQDN)  sbc.
 
 ## PARAMETERS
 
+### -Identity
+The parameter is mandatory when modifying an existing SBC.
+
+```yaml
+Type: String
+Parameter Sets: Identity
+Aliases:
+Applicable: Microsoft Teams
+Required: False
+Position: 1
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -BypassMode
+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.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Confirm
+Prompts you for confirmation before running the cmdlet.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: cf
+Applicable: Microsoft Teams
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -Description
 Free-format string to describe the gateway.
 
@@ -187,113 +251,96 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -Identity
-The parameter is mandatory when modifying an existing SBC.
-
-```yaml
-Type: String
-Parameter Sets: Identity
-Aliases:
-Applicable: Microsoft Teams
-Required: False
-Position: 1
-Default value: None
-Accept pipeline input: False
-Accept wildcard characters: False
-```
-
-### -MaxConcurrentSessions
-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.
+### -InboundTeamsNumberTranslationRules
+This parameter assigns an ordered list of Teams translation rules, that apply to Teams numbers on inbound direction.
 
 ```yaml
-Type: System.Int32
+Type: Object
 Parameter Sets: (All)
 Aliases:
-Applicable: Microsoft Teams
 Required: False
 Position: Named
 Default value: None
 Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -MediaBypass
-Parameter indicated of the SBC supports Media Bypass and the administrator wants to use it for this SBC.
+### -InboundPSTNNumberTranslationRules
+Creates an ordered list of Teams translation rules, that apply to PSTN number on inbound direction.
 
 ```yaml
-Type: Boolean
+Type: Object
 Parameter Sets: (All)
 Aliases:
-Applicable: Microsoft Teams
 Required: False
 Position: Named
-Default value: $false
+Default value: None
 Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -MediaRelayRoutingLocationOverride
-
-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.
+### -IPAddressVersion
+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.**
 
 ```yaml
 Type: String
 Parameter Sets: (All)
 Aliases:
-Applicable: Microsoft Teams
 Required: False
 Position: Named
-Default value: $false
+Default value: None
 Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -SendSipOptions
-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.
+### -MaxConcurrentSessions
+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.
 
 ```yaml
-Type: Boolean
+Type: System.Int32
 Parameter Sets: (All)
 Aliases:
 Applicable: Microsoft Teams
 Required: False
 Position: Named
-Default value: $true
+Default value: None
 Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -SipSignalingPort
-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.
+### -MediaBypass
+Parameter indicated of the SBC supports Media Bypass and the administrator wants to use it for this SBC.
 
 ```yaml
-Type: Int32
+Type: Boolean
 Parameter Sets: (All)
 Aliases:
 Applicable: Microsoft Teams
 Required: False
 Position: Named
-Default value: None
+Default value: $false
 Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -BypassMode
-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.
+### -MediaRelayRoutingLocationOverride
+
+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.
 
 ```yaml
 Type: String
 Parameter Sets: (All)
 Aliases:
+Applicable: Microsoft Teams
 Required: False
 Position: Named
-Default value: None
+Default value: $false
 Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -InboundTeamsNumberTranslationRules
-This parameter assigns an ordered list of Teams translation rules, that apply to Teams numbers on inbound direction.
+### -OutboundTeamsNumberTranslationRules
+Creates an ordered list of Teams translation rules, that apply to Teams Number on outbound direction.
 
 ```yaml
 Type: Object
@@ -306,8 +353,8 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -InboundPSTNNumberTranslationRules
-Creates an ordered list of Teams translation rules, that apply to PSTN number on inbound direction.
+### -OutboundPSTNNumberTranslationRules
+Assigns an ordered list of Teams translation rules, that apply to PSTN number on outbound direction.
 
 ```yaml
 Type: Object
@@ -320,36 +367,38 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -OutboundTeamsNumberTranslationRules
-Creates an ordered list of Teams translation rules, that apply to Teams Number on outbound direction.
+### -PidfloSupported
+Enables PIDF-LO support on the PSTN Gateway. If turned on the .xml body payload is sent to the SBC with the ___location details of the user.
 
 ```yaml
-Type: Object
+Type: Boolean
 Parameter Sets: (All)
 Aliases:
+Applicable: Microsoft Teams
 Required: False
 Position: Named
-Default value: None
+Default value: $false
 Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -OutboundPSTNNumberTranslationRules
-Assigns an ordered list of Teams translation rules, that apply to PSTN number on outbound direction.
+### -ProxySbc
+The FQDN of the proxy SBC. Used in Local Media Optimization configurations.
 
 ```yaml
-Type: Object
+Type: String
 Parameter Sets: (All)
 Aliases:
+Applicable: Microsoft Teams
 Required: False
 Position: Named
 Default value: None
 Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -PidfloSupported
-Enables PIDF-LO support on the PSTN Gateway. If turned on the .xml body payload is sent to the SBC with the ___location details of the user.
+### -SendSipOptions
+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.
 
 ```yaml
 Type: Boolean
@@ -358,16 +407,16 @@ Aliases:
 Applicable: Microsoft Teams
 Required: False
 Position: Named
-Default value: $false
+Default value: $true
 Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -ProxySbc
-The FQDN of the proxy SBC. Used in Local Media Optimization configurations.
+### -SipSignalingPort
+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.
 
 ```yaml
-Type: String
+Type: Int32
 Parameter Sets: (All)
 Aliases:
 Applicable: Microsoft Teams
@@ -394,21 +443,6 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -Confirm
-Prompts you for confirmation before running the cmdlet.
-
-```yaml
-Type: SwitchParameter
-Parameter Sets: (All)
-Aliases: cf
-Applicable: Microsoft Teams
-Required: False
-Position: Named
-Default value: None
-Accept pipeline input: False
-Accept wildcard characters: False
-```
-
 ### CommonParameters
 This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
 
