Remove-CsDialInConferencingConfiguration
Removes one or more collections of dial-in conferencing configuration settings. These settings determine how Skype for Business Server responds when users join or leave a dial-in conference. This cmdlet was introduced in Lync Server 2010.
Syntax
Remove-CsDialInConferencingConfiguration
[-Identity] <XdsIdentity>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
When users join (or leave) a dial-in conference, Skype for Business Server can respond in different ways. For example, participants might be asked to record their name before they can enter the conference itself. Likewise, administrators can decide whether they want to have Skype for Business Server announce that dial-in participants have either left or joined a conference.
These conference "join behaviors" are managed using dial-in conferencing configuration settings; these settings can be configured at the global scope or at the site scope.
(Settings configured at the site scope take precedence over settings configured at the global scope.) When you install Skype for Business Server, a global collection of dial-in conferencing configuration settings will be created for you.
If you want to have different settings for a site (or set of sites), you can create those collections by using the New-CSDialInConferencingConfiguration
cmdlet.
The Remove-CSDialInConferencingConfiguration
cmdlet deletes any dial-in conferencing settings that have been configured at the site scope.
When these site-specific settings are deleted, users in the affected sites will have their dial-in conferencing behaviors governed by the global settings.
You can also run the Remove-CSDialInConferencingConfiguration
cmdlet against the global dial-in conferencing settings.
If you do that, the global settings will not be removed; that's because the global settings cannot be removed.
Instead, all the properties within that collection of settings will be reset to their default values.
Examples
-------------------------- Example 1 ------------------------
Remove-CSDialInConferencingConfiguration -Identity "site:Redmond"
In Example 1, the dial-in conferencing configuration settings for the Redmond site are deleted.
-------------------------- Example 2 ------------------------
Get-CSDialInConferencingConfiguration -Filter "site:*" | Remove-CSDialInConferencingConfiguration
In Example 2, all the dial-in conferencing settings that have been configured at the site scope are deleted.
To do this, the command first uses the Get-CSDialInConferencingConfiguration
cmdlet and the Filter parameter to return a collection of all the dial-in conferencing settings that have been configured at the site scope.
(The filter value "site:*" ensures that only settings that have an Identity that begins with the string value "site:" are returned.) This filtered collection is then piped to the Remove-CSDialInConferencingConfiguration
cmdlet, which removes each item in the collection.
-------------------------- Example 3 ------------------------
Get-CSDialInConferencingConfiguration | Where-Object {$_.EnableNameRecording -eq $False} | Remove-CSDialInConferencingConfiguration
In Example 3, all the dial-in conferencing configuration settings that do not use name recording are deleted.
To carry out this task, the command first calls the Get-CSDialInConferencingConfiguration
cmdlet without any parameters in order to return a collection of all the dial-in conferencing configuration 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 EnableNameRecording property is equal to False.
In turn, this filtered collection is piped to the Remove-CSDialInConferencingConfiguration
cmdlet, which deletes each item in the 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
Indicates the Identity of the dial-in conferencing configuration settings to be removed.
To refer to the global settings, use this syntax: -Identity global
.
To refer to site settings, use syntax similar to this: -Identity site:Redmond
.
Note that you cannot use wildcards when specifying an 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.DialInConferencingSettings.DialInConferencingConfiguration object.
The Remove-CSDialInConferencingConfiguration
cmdlet accepts pipelined instances of the dial-in conferencing configuration object.
Outputs
None.
Instead, the Remove-CSDialInConferencingConfiguration
cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DialInConferencingSettings.DialInConferencingConfiguration object.