New-CsAVEdgeConfiguration

Syntax

New-CsAVEdgeConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-InMemory <SwitchParameter>] [-MaxBandwidthPerPortKb <UInt32>] [-MaxBandwidthPerUserKb <UInt32>] [-MaxTokenLifetime <TimeSpan>] [-WhatIf [<SwitchParameter>]]

Detailed Description

An A/V Edge server provides a way for audio and video traffic to be exchanged across an organization’s firewall. Among other things, this enables users to use Microsoft Lync Server 2010 across the Internet, and then exchange audio and video data with users who have logged onto the system from inside the firewall. Edge Server configuration settings can be assigned at the global scope, the site scope, and the service scope. The A/V Edge configuration settings enable administrators to manage the amount of time that user authentication is valid before it must be renewed, and to limit the amount of bandwidth that can be used by a single user or a single port.

The New-CsAVEdgeConfiguration cmdlet enables you to create new collections of A/V Edge configuration settings at either the site or the service scope. As noted, A/V Edge settings can also be configured at the global scope. However, you cannot create a new collection at the global scope.

Note that any given site or service can host, at most, a single collection of A/V Edge configuration settings. If the Redmond site already hosts a collection of A/V Edge settings, you cannot create a new collection with the Identity site:Redmond.

Unless instructed by Microsoft support personnel, it is recommended that you do not change the default A/V Edge configuration settings. Because of that, you will probably not need to create a new collection of settings for a site or service.

Who can run this cmdlet: By default, members of the following groups are authorized to run the New-CsAVEdgeConfiguration 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-CsAVEdgeConfiguration"}

Parameters

Input Types

None. New-CsAVEdgeConfiguration does not accept pipelined input.

Return Types

Creates instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.MediaRelaySettings object.

Example

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

New-CsAVEdgeConfiguration -Identity site:Redmond -MaxTokenLifetime "04:00:00"

The command shown in Example 1 creates a new collection of A/V Edge configuration settings for the Redmond site. In this example, the MaxTokenLifetime property is set to 4 hours (04 hours : 00 minutes : 00 seconds).

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

$x = New-CsAVEdgeConfiguration -Identity site:Redmond -InMemory
$x.MaxTokenLifetime = "04:00:00"
Set-CsAVEdgeConfiguration -Instance $x

Example 2 demonstrates how you can create a new collection of A/V Edge configuration settings in memory, and then later transform those virtual settings into an actual collection of A/V Edge settings. To do this, the first command in the example creates a new collection of settings for the Redmond site; the InMemory parameter is added to ensure that these settings are created in memory only and are not immediately applied to the Redmond site. (Because these settings exist in memory only, they must be stored in a variable, in this case, a variable named $x.)

In the second command, the value of the MaxTokenLifetime property is set to 4 hours (04 hours : 00 minutes : 00 seconds). The third command then uses Set-CsAVEdgeConfiguration to apply the settings stored in $x to the Redmond site.

See Also

Other Resources

Get-CsAVEdgeConfiguration
Remove-CsAVEdgeConfiguration
Set-CsAVEdgeConfiguration