Parameters

This cmdlet creates global settings for media bypass of audio connections.

Unlike most New- cmdlets in Microsoft Lync 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 and then assigned to the MediaBypassSettings property of the network configuration. (For more details, see the Examples section in this topic.)

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.

Who can run this cmdlet: By default, members of the following groups are authorized to run the New-CsNetworkMediaBypassConfiguration cmdlet locally: RTCUniversalServerAdmins. To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt:

Get-CsAdminRole | Where-Object {$_.Cmdlets –match "New-CsNetworkMediaBypassConfiguration"}

None.

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

-------------------------- 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. The 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 and passing the media bypass configuration object ($a) we created in line 1 to the MediaBypassSettings parameter.

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

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

There is no Set-CsNetworkMediaBypassConfiguration cmdlet in Lync Server, 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, and 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 AlwaysBypass property.

Other Resources