Export (0) Print
Expand All
Expand Minimize

Remove-CsDialInConferencingConfiguration

 

Topic Last Modified: 2012-03-26

Removes one or more collections of dial-in conferencing configuration settings. These settings determine how Microsoft Lync Server 2010 responds when users join or leave a dial-in conference.

Remove-CsDialInConferencingConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

When users join (or leave) a dial-in conference, Lync Server 2010 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 Lync 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 Lync 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 Remove-CSDialInConferencingConfiguration 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.

Who can run this cmdlet: By default, members of the following groups are authorized to run the Remove-CsDialInConferencingConfiguration cmdlet locally: RTCUniversalServerAdmins. To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt:

Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Remove-CsDialInConferencingConfiguration"}

 

Parameter Required Type Description

Identity

Required

Xds 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.

Force

Optional

SwitchParameter

Suppresses the display of any non-fatal error message that might occur when running the command.

WhatIf

Optional

SwitchParameter

Describes what would happen if you executed the command without actually executing the command.

Confirm

Optional

SwitchParameter

Prompts you for confirmation before executing the command.

Microsoft.Rtc.Management.WritableConfig.Settings.DialInConferencingSettings.DialInConferencingConfiguration object. Remove-CSDialInConferencingConfiguration accepts pipelined instances of the dial-in conferencing configuration object.

None. Instead, Remove-CSDialInConferencingConfiguration deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DialInConferencingSettings.DialInConferencingConfiguration object.

-------------------------- 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 the preceding example, all the dial-in conferencing settings that have been configured at the site scope are deleted. To do this, the command first uses Get-CSDialInConferencingConfiguration 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 Remove-CSDialInConferencingConfiguration, 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 Get-CSDialInConferencingConfiguration 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 Remove-CSDialInConferencingConfiguration, which deletes each item in the collection.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft