Enables you to remove an existing 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
Remove-CsAVEdgeConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
XdsIdentity |
Unique identifier for the collection of A/V Edge configuration settings to be removed. To "remove" the global collection, use the following syntax: -Identity global. (As noted previously, the global settings cannot be removed; the properties can only be reset to their default values.) To remove 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. Note that you cannot use wildcards when specifying a policy Identity. |
|
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 Remove-CsAVEdgeConfiguration cmdlet enables you to delete A/V Edge configuration settings that have been applied to either the site or the service scope. The cmdlet can also be run against the global settings; however, those global settings will not be deleted. Instead, the properties contained within the global collection will all be reset to their default values.
Return Types
Remove-CsAVEdgeConfiguration does not return a value or object. Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.Edge.MediaRelaySettings object.
Examples
-------------------------- Example 1 ------------------------
 Copy Code |
|
|---|---|
Remove-CsAVEdgeConfiguration -Identity site:Redmond |
|
The preceding command removes the A/V Edge configuration settings that have the Identity site:Redmond. After the settings are removed Edge Servers in the Redmond site will be governed by the global configuration settings.
-------------------------- Example 2 ------------------------
| Copy Code |
|
|---|---|
Get-CsAVEdgeConfiguration -Filter "service:*" | Remove-CsAVEdgeConfiguration |
|
In Example 2, all the A/V Edge configuration settings that have been applied at the service scope are removed. To do this, the command first calls Get-CsAVEdgeConfiguration along with the -Filter parameter; the filter value "service:*" ensures that only settings configured at the service scope are returned. This filtered collection is then piped to Remove-CsAVEdgeConfiguration, which deletes each item in the collection.
-------------------------- Example 3 ------------------------
| Copy Code |
|
|---|---|
Get-CsAVEdgeConfiguration | Where-Object {$_.MaxBandwidthPerUserKB -lt 5000} | Remove-CsAVEdgeConfiguration
|
|
The command shown in Example 3 deletes all the A/V Edge configuration settings where the value of the MaxBandwidthPerUserKB property is less than 5,000 KB. To carry out this task, the command first uses Get-CsAVEdgeConfiguration without any additional parameters in order to return a collection of all the A/V Edge settings currently in use in the organization. This collection is piped to the Where-Object cmdlet, which selects only those settings where the MaxBandwidthPerUserKB property is less than (-lt) 5000. The filtered collection is then piped to Remove-CsAVEdgeConfiguration, which deletes each item in that collection.