Remove-CsMediaConfiguration
Removes the specified collection of media configuration settings. This cmdlet was introduced in Lync Server 2010.
Syntax
Default (Default)
Remove-CsMediaConfiguration
[-Identity] <XdsIdentity>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
This cmdlet removes a collection of media settings. These settings relate to audio and video calls between client endpoints.
This cmdlet can also be used to remove the global media settings. In that case, however, the settings will not actually be removed; instead, they will simply be reset to their default values.
Examples
Example 1
Remove-CsMediaConfiguration -Identity site:Redmond1
In Example 1, the Remove-CsMediaConfiguration
cmdlet is used to delete the media configuration collection with the Identity site:Redmond1.
When media settings are removed from the site scope, that site will automatically begin to use the global media settings.
Example 2
Get-CsMediaConfiguration | Where-Object {$_.EncryptionLevel -eq "RequireEncryption"} | Remove-CsMediaConfiguration
In Example 2, three cmdlets--the Get-CsMediaConfiguration
cmdlet, the Where-Object
cmdlet and the Remove-CsMediaConfiguration
cmdlet--are used to remove all the media configuration collections where encryption is required of all parties involved in the conversation.
To do this, the Get-CsMediaConfiguration
cmdlet is first used to return all the media configuration collections in the organization.
That information is then piped to the Where-Object
cmdlet, which applies a filter that restricts the pipeline data to those collections where the EncryptionLevel property is equal to (-eq) RequireEncryption.
Finally, that filtered set of data is passed to the Remove-CsMediaConfiguration
cmdlet, which deletes each item in the set.
Example 3
Get-CsMediaConfiguration -Filter service:* | Remove-CsMediaConfiguration
In this example all media configurations defined at the service scope (meaning the configuration applies to a specific service) are removed.
This is accomplished by first calling the Get-CsMediaConfiguration
cmdlet using the Filter service:*.
This filter retrieves all media configuration collections with an Identity starting with service, which means all collections at the service scope.
That set of collections is then piped the Remove-CsMediaConfiguration
cmdlet, which removes them all.
Parameters
-Confirm
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Prompts you for confirmation before executing the command.
Parameter properties
Type: | SwitchParameter |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Aliases: | cf |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-Force
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Suppresses any confirmation prompts that would otherwise be displayed before making changes.
Parameter properties
Type: | SwitchParameter |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-Identity
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
The unique identifier of the media configuration settings you want to remove. This identifier specifies the scope at which this configuration is applied (global, site, or service).
Parameter properties
Type: | XdsIdentity |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | 2 |
Mandatory: | True |
Value from pipeline: | False |
Value from pipeline by property name: | True |
Value from remaining arguments: | False |
-WhatIf
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Describes what would happen if you executed the command without actually executing the command.
Parameter properties
Type: | SwitchParameter |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Aliases: | wi |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
Microsoft.Rtc.Management.WritableConfig.Settings.Media.MediaSettings
Accepts pipelined input of media configuration objects.
Outputs
Microsoft.Rtc.Management.WritableConfig.Settings.Media.MediaSettings
Removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Media.MediaSettings.