Removes an existing collection of User Server configuration settings. The User Server service is used to help maintain presence information and manage online conferencing.
Syntax
Remove-CsUserServicesConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
Xds Identity |
Unique identifier for the User Server configuration settings to be removed. To delete settings configured at the site scope, use syntax similar to this: -Identity site:Redmond. To delete settings at the service level, use syntax like this: -Identity service:UserServer:atl-cs-001.litwareinc.com. Remove-CsUserServicesConfiguration can also be run against the global collection. In that case, however, the global collection will not be deleted. Instead, all the properties in that collection will be reset to their default values. |
|
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
Microsoft Communications Server 2010 relies on the User Server service to help maintain presence information for users and to manage online meetings and conferences. In turn, the CsUserServicesConfiguration cmdlets are used to administer User Server settings at the global, site, and service scope. (Note that the only service that can host User Server configuration settings is the User Server service itself.) These settings help determine such things as the number of contacts a user can have; the number of meetings a user can have scheduled at any one time; and the length of time that a given meeting can remain active.
The Remove-CsUserServicesConfiguration enables you to delete User Server configuration settings that have been applied at the site or service scope. This cmdlet can also be run against the global collection. In that case, however, the global settings will not be deleted; that’s because the global settings cannot be deleted. Instead, all of the properties within the global collection will be reset to their default values. For example, if you have changed the MaxContacts value in the global settings to 500 and then run Remove-CsUserServciesConfiguration, MaxContacts will be reset to the default value of 250.
Return Types
Remove-CsUserServicesConfiguration deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.UserServicesSettings object.
Examples
-------------------------- Example 1 ------------------------
 Copy Code |
|
|---|---|
Remove-CsUserServicesConfiguration -Identity site:Redmond |
|
The command shown in Example 1 removes the User Server configuration settings from the Redmond site (-Identity site:Redmond). When the site settings are removed, users in the site will automatically inherit the settings found in the global User Server configuration.
-------------------------- Example 2 ------------------------
| Copy Code |
|
|---|---|
Get-CsUserServicesConfiguration -Filter "service:*:" | Remove-CsUserServicesConfiguration |
|
In Example 2, all the User Server configuration settings that have been applied at the service scope are deleted. To do this, the command calls Get-CsUserServicesConfiguration along with the -Filter parameter; the filter value "service:*" limits returned data to settings configured at the service scope. (That is, settings that have an Identity that begins with the characters "service:".) This filtered collection is then piped to Remove-CsUserServicesConfiguration, which deletes each item in the filtered collection.
-------------------------- Example 3 ------------------------
| Copy Code |
|
|---|---|
Get-CsUserServicesConfiguration | Where-Object {$_.MaxContacts -gt 250} | Remove-CsUserServicesConfiguration
|
|
The preceding command removes all the User Server configuration settings that allow users to have more than 250 contacts. To carry out this task, the command first calls Get-CsUserServicesConfiguration (without any parameters) in order to return a collection of all the user services configuration settings currently in use. This collection is the piped to the Where-Object cmdlet, which selects only those settings where the value of the MaxContacts property is greater than (-gt) 250. Those settings are then piped to, and removed by, the Remove-CsUserServicesConfiguration cmdlet.