Remove-CsAVEdgeConfiguration
Enables you to remove an existing collection of configuration settings applied to computers running the Access 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). This cmdlet was introduced in Lync Server 2010.
Syntax
Remove-CsAVEdgeConfiguration
[-Identity] <XdsIdentity>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 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 Skype for Business 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. The A/V Edge 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 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.
Examples
-------------------------- Example 1 ------------------------
Remove-CsAVEdgeConfiguration -Identity site:RedmondThe command shown in Example 1 removes the A/V Edge configuration settings that have the Identity site:Redmond. After the settings are removed, A/V Edge servers in the Redmond site will be governed by the global configuration settings.
-------------------------- Example 2 ------------------------
Get-CsAVEdgeConfiguration -Filter "service:*" | Remove-CsAVEdgeConfigurationIn Example 2, all of the A/V Edge configuration settings that have been applied at the service scope are removed.
To do this, the command first calls the Get-CsAVEdgeConfiguration cmdlet 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 the Remove-CsAVEdgeConfiguration cmdlet, which deletes each item in the collection.
-------------------------- Example 3 ------------------------
Get-CsAVEdgeConfiguration | Where-Object {$_.MaxBandwidthPerUserKB -lt 5000} | Remove-CsAVEdgeConfigurationThe command shown in Example 3 deletes all of the A/V Edge configuration settings where the value of the MaxBandwidthPerUserKB property is less than 5,000 kilobits per second.
To carry out this task, the command first uses the Get-CsAVEdgeConfiguration cmdlet 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 5000.
The filtered collection is then piped to the Remove-CsAVEdgeConfiguration cmdlet, which deletes each item in that collection.
Parameters
-Confirm
Prompts you for confirmation before executing the command.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-Force
Suppresses the display of any non-fatal error message that might occur when running the command.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-Identity
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
You cannot use wildcards when specifying a policy Identity.
| Type: | XdsIdentity |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-WhatIf
Describes what would happen if you executed the command without actually executing the command.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
Inputs
Microsoft.Rtc.Management.WritableConfig.Settings.Edge.MediaRelaySettings object.
The Remove-CsAVEdgeConfiguration cmdlet accepts pipelined input of media relay settings objects.
These objects retrieved by running the Get-CsAVEdgeConfiguration cmdlet.
Outputs
The Remove-CsAVEdgeConfiguration cmdlet does not return a value or object.
Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.MediaRelaySettings object.