Removes one or more collections of dial-in conferencing configuration settings. These settings determine how Microsoft Communications Server 2010 responds when users join or leave a dial-in conference.
Syntax
Remove-CSDialInConferencingConfiguration -[Identity] <XdsIdentity> -[Tenant <Nullable'1>] [-LocalStore] [-WhatIf] [-Confirm] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
XdsIdentity |
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. |
|
LocalStore |
Optional |
SwitchParameter |
|
|
Force |
Optional |
SwitchParameter |
Suppresses the display of any non-fatal error message that might arise 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. |
Detailed Description
When users join (or leave) a dial-in conference, Communications 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 Communications 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 Communications 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 using the New-CSDialInConferencingConfiguration cmdlet.
The Remove-CSDialInConferencingConfiguration cmdlet to delete 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.
Return Types
Remove-CSDialInConferencingConfiguration deletes instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.DialInConferencingSettings.DialInConferencingConfiguration object.
Examples
-------------------------- Example 1 ------------------------
 Copy Code |
|
|---|---|
Remove-CSDialInConferencingConfiguration -Identity "site:Redmond" |
|
In Example 1, the dial-in conferencing configuration settings that have the Identity site:Redmond are deleted.
-------------------------- Example 2 ------------------------
| Copy Code |
|
|---|---|
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 ------------------------
| Copy Code |
|
|---|---|
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 (-eq) False ($False). In turn, this filtered collection is piped to Remove-CSDialInConferencingConfiguration, which deletes each item in the collection.