Creates a new collection of A/V Edge Server configuration settings. 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
New-CsAVEdgeConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-InMemory <SwitchParameter>] [-MaxBandwidthPerPortKb <UInt32>] [-MaxBandwidthPerUserKb <UInt32>] [-MaxTokenLifetime <TimeSpan>] [-WhatIf [<SwitchParameter>]] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
XdsIdentity |
Unique identifier for the collection of A/V Edge configuration settings to be created. To create a collection of settings to be applied at the site scope, use syntax similar to this: -Identity site:Redmond. (Note that this command will fail if a collection of A/V Edge settings have already been applied to the Redmond site.) Settings configured at the service scope should be referenced to using syntax similar to this: -Identity service:EdgeServer:atl-cs-001.litwareinc.com. |
|
MaxTokenLifetime |
Optional |
Integer |
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. |
|
InMemory |
Optional |
Switch Parameter |
Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet’s matching Set- cmdlet. |
|
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 New-CsAVEdgeConfiguration 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; instead, you must use Set-CsAVEdgeConfiguration to modify the existing settings.
Note that any given site or service can host, at most, a single collection of A/V edge configuration settings. If you try to create a collection with the Identity site:Redmond and the Redmond site already hosts a collection of A/V Edge settings your will fail.
Return Types
Creates instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.Edge.MediaRelaySettings object.
Examples
-------------------------- Example 1 ------------------------
 Copy Code |
|
|---|---|
New-CsAVEdgeConfiguration -Identity site:Redmond -MaxTokenLifetime "7.00: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 7 days (7 days.0 hours:0 minutes:0 seconds).
-------------------------- Example 2 ------------------------
| Copy Code |
|
|---|---|
$x = New-CsAVEdgeConfiguration -Identity site:Redmond -InMemory $x.MaxTokenLifetime = "7.00:00:00" Set-CsAVEdgeConfiguration -Instance $x |
|
Example 2 demonstrates how you can create a new collection of A/V Edge configuration settings in memory, then later transform those virtual settings into an actual collection of settings. To do this, the first command in the example creates 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 example, that’s a variable named $x.)
In the second command, the value of the MaxTokenLifetime property is set to 7 days (7 days.0 hours:0 minutes:0 seconds). After that modification has been made, the third command uses Set-CsAVEdgeConfiguration to apply the settings stored in $x to the Redmond site.