Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

Set-CsAVEdgeConfiguration

 

Topic Last Modified: 2012-03-26

Enables you to modify configuration settings for computers running the A/V Edge service (these computers are also known as A/V Edge servers). An A/V Edge server enables internal users to share audio and video data with external users (that is, users who are not logged on to your internal network), as well as exchange files and participate in desktop sharing sessions.

Set-CsAVEdgeConfiguration [-Identity <XdsIdentity>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-MaxBandwidthPerPortKb <UInt32>] [-MaxBandwidthPerUserKb <UInt32>] [-MaxTokenLifetime <TimeSpan>] [-WhatIf [<SwitchParameter>]]
Set-CsAVEdgeConfiguration [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-Instance <PSObject>] [-MaxBandwidthPerPortKb <UInt32>] [-MaxBandwidthPerUserKb <UInt32>] [-MaxTokenLifetime <TimeSpan>] [-WhatIf [<SwitchParameter>]]

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. These configuration settings enable administrators to do such things as 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 Set-CsAVEdgeConfiguration cmdlet provides a way for you to modify the A/V Edge configuration settings currently in use in your organization. However, unless instructed by Microsoft support personnel, it is recommended that administrators do not modify the default A/V Edge settings.

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

 

Parameter Required Type Description

Identity

Optional

Xds Identity

Unique identifier for the collection of A/V Edge configuration settings to be modified. To modify the global collection, use the following syntax: -Identity global. To modify a site collection use syntax similar to this: -Identity site:Redmond. Settings configured at the service scope should be referred to using syntax similar to this: -Identity service:EdgeServer:atl-cs-001.litwareinc.com.

Instance

Optional

MediaRelaySettings object

Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values.

MaxBandwidthPerPortKB

Optional

Integer

Indicates the maximum amount of bandwidth (in kilobits per second) that can be allocated to a single port. The maximum bandwidth can be set to any integer value between 1 and 4294967296 (4096 gigabits) per second; the default value is 3000.

MaxBandwidthPerUserKB

Optional

Integer

Indicates the maximum amount of bandwidth (in kilobits per second) that can be allocated to any one user. The maximum bandwidth can be set to any integer value between 1 and 4294967296 (4096 gigabits) per second; the default value is 10000.

MaxTokenLifetime

Optional

TimeSpan

The maximum amount of time that an authentication token can be used before it expires and must be renewed. Token lifetimes are expressed using the following format: Days.Hours:Minutes:Seconds. For example, 13 days must be expressed like this, with a period (.) following the number of days, and colons (:) used to separate the hours, minutes, and seconds:

13.00:00:00

The default value of 8 hours must be expressed like this:

08:00:00

The minimum allowed token lifetime is 1 minute (00:01:00); the maximum allowed lifetime is 180 days (180.00:00:00).

Force

Optional

Switch Parameter

Suppresses the display of any non-fatal error message that might occur when running the command.

WhatIf

Optional

Switch Parameter

Describes what would happen if you executed the command without actually executing the command.

Confirm

Optional

Switch Parameter

Prompts you for confirmation before executing the command.

Microsoft.Rtc.Management.WritableConfig.Settings.Edge.MediaRelaySettings object. Set-CsAVEdgeConfiguration accepts pipelined input of media relay settings objects.

Set-CsAVEdgeConfiguration does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.MediaRelaySettings object.

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

Set-CsAVEdgeConfiguration -Identity global -MaxTokenLifetime "04:00:00"

In Example 1, the command modifies the MaxTokenLifetime property for the global A/V Edge configuration settings. In this example, the maximum token lifetime is set to 4 hours (04 hours : 00 minutes : 00 seconds).

 
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.