[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

Creates new global settings for media bypass.

Syntax

New-CsNetworkMediaBypassConfiguration [-AlwaysBypass <$true | $false>] [-BypassID <String>] [-Enabled <$true | $false>] [-EnableDefaultBypassID <$true | $false>] [-ExternalBypassMode <Nullable>] [-InternalBypassMode <Nullable>]

Parameters

Parameter Required Type Description

AlwaysBypass

Optional

Boolean

Setting this parameter to True will attempt media bypass on all calls.

Set this value to True only if call admission control (CAC) is not implemented or is disabled. This option should also only be true for very simple Communications Server deployments. If you set AlwaysBypass to True but do not also set the value of the Enabled parameter to True, you’ll receive a warning message: Always Bypass setting is ignored if Enabled is set to false.

In order for media bypass to work a bypass ID must be provided. Setting AlwaysBypass and Enabled both to True will auto-generate a bypass ID that will be stored in the BypassID property.

Default: False

BypassID

Optional

String

The global or default bypass ID. This ID will be used when either AlwaysBypass is set to True or when a global default bypass ID is necessary to resolve a bypass situation. This ID must be in the format of a GUID (for example, 96f14dea-5170-429a-b92b-f1cb909c4bb6).

This value is automatically generated when Enabled is set to True and either: 1) AlwaysBypass is set to True, or 2) the EnableDefaultBypassID parameter is set to True. You do not have to automatically generate this ID, but auto-generation is recommended.

Enabled

Optional

Boolean

Set this parameter to True to enable media bypass.

Media bypass cannot be enabled if internal bypass is turned off. Therefore setting this value to True will automatically change the value of the InternalBypassMode property from the default Off to Any.

Default: False

EnableDefaultBypassID

Optional

Boolean

Setting this value to True will automatically generate a default bypass ID. This auto-generated value will be stored in the BypassID property.

A default bypass ID is necessary when the bypass ID associated with checking an IP address against the CAC region and site configuration in an attempt to find a bypass ID results in no match. This field is useful when there is a well-connected core with remote sites that have bandwidth constrained links. The admin will need to define only the subnets associated with the remote sites. Any subnets associated with the core need not be defined and will be associated with the default bypass ID.

This value can be set to True only if Enabled has also been set to True.

Default: False

ExternalBypassMode

Optional

BypassModeEnumType

Reserved for future use. External media bypass is not supported in Communications Server 2010. Although this parameter accepts a value of type BypassModeEnumType (which consists of the values Off, ICE, and Any), the only value that can be set at this time is Off.

Default: Off

InternalBypassMode

Optional

BypassModeEnumType

You most likely won’t ever have to modify this setting. Modifying this value will be ignored if the Enabled parameter is set to False (the default). If Enabled is set to True, this value will automatically be changed to Any. Although this value is of type BypassModeEnumType (which consists of the values Off, ICE, and Any), ICE is not supported in Communications Server 2010.

Available values: Off, ICE, Any

Default: Off

Detailed Description

This cmdlet creates global settings for media bypass of audio and video connections. Depending on the configuration, these settings will determine how media bypass is implemented on a global level or within a call admission control (CAC) region, site, and subnet level.

Unlike most New- cmdlets in Microsoft Communications Server 2010, this cmdlet does not immediately save the new configuration, it creates the settings only in memory. The object created by this cmdlet must be saved to a variable, then assigned to the MediaBypassSettings property of the network configuration. (See the Examples section.)

The settings created with this cmdlet can be retrieved only by accessing the MediaBypassSettings property of the global network configuration. To retrieve these settings, run this command: (Get-CsNetworkConfiguration).MediaBypassSettings.

Return Types

Creates an object reference of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.MediaBypassSettingsType.

Examples

-------------------------- Example 1 --------------------------

Copy Code
$a = New-CsNetworkMediaBypassConfiguration -AlwaysBypass $true -Enabled $true
Set-CsNetworkConfiguration -MediaBypassSettings $a

The commands in this example enable media bypass and configure it to always attempt bypass. This first line in the example is a call to the New-CsNetworkMediaBypassConfiguration cmdlet. We pass two parameters to this cmdlet: AlwaysBypass and Enabled, setting both to True ($true). Setting Enabled to True enables media bypass, while setting AlwaysBypass to True assures that media bypass will be attempted on all calls. (Note that setting these two parameters will automatically generate a value for the BypassID property.) New-CsNetworkMediaBypassConfiguration creates the object only in memory, so we assign that object to the variable $a.

The media bypass configuration is stored with the network configuration settings. Therefore, in line 2 of the example we save the media bypass configuration changes to the network configuration by calling the Set-CsNetworkConfiguration cmdlet, passing the MediaBypassSettings parameter the media bypass configuration object ($a) we created in line 1.

-------------------------- Example 2 --------------------------

Copy Code
$a = (Get-CsNetworkConfiguration).MediaBypassSettings
$a.AlwaysBypass = $false
Set-CsNetworkConfiguration -MediaBypassSettings $a

There is no Set-CsNetworkMediaBypassConfiguration cmdlet in Communications Server 2010, so in order to modify existing settings you must either create a new configuration (as shown in Example 1) to replace the existing configuration, or you must modify the settings by retrieving the existing settings, modifying them, then using the Set-CsNetworkConfiguration cmdlet to save the changes. This example demonstrates turning off the Always Bypass option by using this latter option.

The first line in the example retrieves the existing media bypass settings. It does this by calling Get-CsNetworkConfiguration. The call to this cmdlet is within parentheses to ensure the cmdlet is completed before any other part of the command is run. Get-CsNetworkConfiguration retrieves all settings for an entire network configuration. Because we’re interested in only the media bypass settings, we specify the MediaBypassSettings property to retrieve only those settings. We assign those settings to the variable $a.

In line 2 we modify the settings stored in variable $a by assigning the value False ($false) to the AlwaysBypass property. Finally, in line 3 we call Set-CsNetworkConfiguration, passing the MediaBypassSettings parameter the variable $a, which saves the change we made to the AllowBypass property.