Enables you to modify configuration information for any of the A/V Edge Servers currently in use in your organization. A/V Edge Servers enable internal users to share audio and video data with external users (that is, users who are not logged on to your internal network).
Syntax
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>]] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Optional |
XdsIdentity |
Unique identifier for the collection of A/V Edge configuration settings to be modify. 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. |
|
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: 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). |
|
MaxBandwidthPerUserKB |
Optional |
Integer |
Indicates the maximum amount of bandwidth (in kilobytes) that can be allocated to any one user. The maximum bandwidth can be set to any integer value between 1 and 4294967296 (4096 gigabytes); the default value is 10000. |
|
MaxBandwidthPerPortKB |
Optional |
Integer |
Indicates the maximum amount of bandwidth (in kilobytes) that can be allocated to a single port. The maximum bandwidth can be set to any integer value between 1 and 4294967296 (4096 gigabytes); the default value is 3000. |
|
Force |
Optional |
Switch Parameter |
Suppresses the display of any non-fatal error message that might arise 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. |
Detailed Description
A/V Edge servers provide a way for audio and video traffic to be exchanged across the corporate firewall. Among other things, this enables users to access Microsoft Communications Server 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. (For the latter, these settings can only be applied to the Edge Server service.) The A/V Edge configuration settings enable administrators to manage the longevity of authentication tokens, 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.
Return Types
Set-CsAVEdgeConfiguration does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.Edge.MediaRelaySettings object.
Examples
-------------------------- Example 1 ------------------------
 Copy Code |
|
|---|---|
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 (4 hours:0 minutes:0 seconds).
-------------------------- Example 2 ------------------------
| Copy Code |
|
|---|---|
Get-CsAVEdgeConfiguration -Filter site:* | Set-CsAVEdgeConfiguration -MaxTokenLifetime "04:00:00" |
|
The preceding command modifies the MaxTokenLifetime property for all the A/V Edge settings configured at the site scope. To do this, the command first uses Get-CsAVEdgeConfiguration and the -Filter parameter; the filter value "site:*" ensures that only those settings that have an Identity that begins with the string value "site:" are returned. The filtered collection is then piped to Set-CsAVEdgeConfiguration, which takes each item in the collection and changes the value of the MaxTokenLifetime property to 4 hours (4 hours:0 minutes:0 seconds).
-------------------------- Example 3 ------------------------
| Copy Code |
|
|---|---|
Get-CsAVEdgeConfiguration | Where-Object {$_.MaxBandwidthPerUserKB -lt 5000} | Set-CsAVEdgeConfiguration -MaxBandwidthPerUserKB 8000 -MaxBandwidthPerPortKB 4000
|
|
In Example 3, bandwidth properties are modified for all the A/V Edge configuration settings where the maximum allowed bandwidth per user is less than 5,000 KBs. To carry out this task, the command first calls Get-CsAVEdgeConfiguration without any parameters; this returns a collection of all the A/V Edge settings currently in use in the organization. This collection is then piped to the Where-Object cmdlet, which picks out only those settings where the MaxBandwidthPerUserKB property is less than (-lt) 5000 KBs. In turn, the filtered collection is piped to Set-CsAVEdgeConfiguration, which takes each item in the collection and assigns new values to MaxBandwidthPerUserKB and MaxBandwidthPerPortKB properties.