Topic Last Modified: 2010-10-01
Remove-CsMeetingConfiguration enables you to delete an existing collection of meeting configuration settings. Meeting configuration settings help dictate the type of meetings (also called “conferences”) that users can create, as well as control how (or even if) anonymous users and dial-in conferencing users can join these meetings.
Syntax
Remove-CsMeetingConfiguration -Identity
<XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force
<SwitchParameter>] [-Tenant <Nullable>] [-WhatIf
[<SwitchParameter>]]
|
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
Identity |
Required |
Xds Identity |
Unique identifier of the meeting configuration settings to be removed. To "remove" the global settings, use this syntax: -Identity global. (As noted previously, you cannot actually remove the global settings; all you can do is reset the properties to their default values.) To remove settings from the site scope, use syntax similar to this: -Identity site:Redmond. Service settings can be removed using this syntax: -Identity service:UserServer:atl-cs-001.litwareinc.com. Note that you cannot use wildcards when specifying an Identity. |
Force |
Optional |
Switch Parameter |
Suppresses the display of any non-fatal error message that might occur when running the command. |
Tenant |
Optional |
GUID |
This parameter is not used with the on-premises version of Lync Server 2010. |
WhatIf |
Optional |
Switch Parameter |
Describes what would happen if you executed the command without actually executing the command. |
Confirm |
Optional |
Switch Parameter |
Prompts you for confirmation before executing the command. |
Detailed Description
Online meetings (also called conferences) are an integral part of Microsoft Lync Server 2010. The CsMeetingConfiguration cmdlets enable administrators to control the type of meetings that users can create as well as determine how meetings deal with anonymous users and dial-in conferencing users. For example, you can configure meetings so that anyone dialing in over the public switched telephone network (PSTN) is automatically admitted to the meeting. Alternatively, you can configure meetings so that dial-in users are not automatically admitted the meeting, but are instead routed to the meeting lobby. These dial-in users remain on hold in the lobby until a presenter admits them to the meeting.
Meeting configuration settings can be assigned to the global, site, or service scopes. If you create new settings at the site or service scope, those settings can later be removed by using the Remove-CsMeetingConfiguration cmdlet. Remove-CsMeetingConfiguration can also be run against the global meeting settings. In that case, however, the settings will not be removed; that’s because the global settings cannot be removed. Instead, all the properties in the global collection 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-CsMeetingConfiguration 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-CsMeetingConfiguration"}
Input Types
Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.MeetingConfiguration object. Remove-CsMeetingConfiguration accepts pipelined instances of the meeting configuration object.
Return Types
None. Instead, Remove-CsMeetingConfiguration deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.MeetingConfiguration object.
Example
-------------------------- Example 1 ------------------------
Copy Code | |
---|---|
Remove-CsMeetingConfiguration -Identity site:Redmond |
In Example 1, the meeting configuration settings that have the Identity site:Redmond are removed. When these settings are removed from the Redmond site users in that site will automatically inherit the global meeting configuration settings.
-------------------------- Example 2 ------------------------
Copy Code | |
---|---|
Get-CsMeetingConfiguration -Filter "site:*" | Remove-CsMeetingConfiguration |
The command shown in Example 2 removes all the meeting settings that have been configured at the site scope. To do this, the command first calls Get-CsMeetingConfiguration along with the Filter parameter; the filter value "site:*" ensures that only settings that have an Identity that begins with the characters "site:" are selected. This filtered collection is then piped to the Remove-CsMeetingConfiguration cmdlet, which deletes each item in the collection.
-------------------------- Example 3 ------------------------
Copy Code | |
---|---|
Get-CsMeetingConfiguration | Where-Object {$_.AdmitAnonymousUsersByDefault -eq $True} | Remove-CsMeetingConfiguration |
The preceding command deletes each collection of meeting configuration settings where the AdmitAnonymousUsersbyDefault property is True. To carry out this task, the command first calls Get-CsMeetingConfiguration in order to return a collection of all the meeting configuration settings currently in use. This collection is then piped to Where-Object, which picks out only those settings where the AdmitAnonymousUsersByDefault property is equal to True. The filtered collection is then piped to Remove-CsMeetingConfiguration, which proceeds to remove each item in that collection.