Remove-CsMeetingConfiguration enables you to delete an existing collection of meeting configuration settings. Meeting configuration settings help dictate the type of meetings 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. |
Tenant |
Optional |
GUID |
|
Force |
Optional |
Switch Parameter |
Suppresses the display of any non-fatal error message that might arise when running the command. |
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 are an integral part of Microsoft Communications Server. 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, both New-CsMeetingConfiguration and Set-CsMeetingConfiguration allow administrators to give users the option of creating public meetings. Public meetings are designed for in-house and impromptu get-togethers: public meetings include no designated start or end times, and organizers do not have to specify attendee lists or set up access permissions. By definition, any user within the organization can participate in a public meeting; however, anonymous users (that is, unauthenticated users) are not allowed to attend public meetings.
Alternatively, administrators can disable the ability of their users to create public meetings. In that case, all meetings will be private meetings: meetings with specified start and end times; meetings that require an attendee list; and meetings that require organizers to assign access permissions. Private meetings give users full control over their get-togethers and who can attend them; conversely, private meetings also require more effort to schedule and to manage.
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.
Return Types
Remove-CsMeetingConfiguration deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.MeetingConfiguration object.
Examples
-------------------------- 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, which returns 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 (-eq) True ($True). The filtered collection is then piped to Remove-CsMeetingConfiguration, which proceeds to remove each item in that filtered collection.