[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

Removes the specified collection of client version configuration settings. Client version configuration settings determine whether or not Microsoft Communications Server 2010 checks the version number of each client application that logs on to the system; if this "client version filtering" is enabled then the ability of that client application to access the system will be based on settings configured in the appropriate client version policy.


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


Parameter Required Type Description




Unique identifier for the collection of client version configuration settings to be removed. To remove the global collection, use the following syntax: -Identity global. (Keep in mind that the global settings will not actually be removed; instead, the global properties will all be reset to their default values.) To remove a site collection use syntax similar to this: -Identity site:Redmond. Note that you cannot use wildcards when specifying a policy Identity.



Switch Parameter



Switch Parameter

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



Switch Parameter

Prompts you for confirmation before executing the command.

Detailed Description

Communications Server 2010 gives administrators considerable leeway when it comes to specifying the client software (and, equally important, the version number of that software) that users can use to log on to the system. For example, users do not have to use Microsoft Communicator "14" in order to log on; there is no technical reason to prevent people from logging on using Microsoft Office Communicator 2007 R2.

On the other hand, there might be some non-technical reasons why you would prefer that your users do not try to log on using Office Communicator 2007 R2. After all, Office Communicator 2007 R2 does not support all the features and capabilities found in Communicator "14"; as a result, users who log on with Office Communicator 2007 R2 will have a different experience than users who log on using Communicator "14". This can create difficulties for your users; it can also create difficulties for help desk personnel, who must provide support for a number of different client applications.

That might or might not be a problem in your organization. If it is a problem, then you can employ client version filtering in order to specify which client applications (and which versions of those client applications) can be used to log on to Communications Server. When you install Communications Server, a global set of client version configuration settings is installed and enabled. These settings are used to determine whether or not client version filtering is enabled. If the Enabled property is set to True, two things happen. First, Communications Server will check the version number of each client application that accesses the system. If there is a client version policy that calls out that version of that application (for example, Office Communicator 2007 R2), then that policy will be enforced; depending on how you have configured the policy, that means the application will be granted access; will be denied access; or will be denied access but referred to a URL where a valid client application can be downloaded. If the Enabled property is set to False, then client version filtering will not be employed. That means that any client application that has the ability to log on to the system will be allowed to log on.

In addition the global scope, client version configuration settings can also be applied at the site scope; in those instances, the site settings will have precedence over the global settings. These same site settings can later be deleted using the Remove-CsClientVersionConfiguration cmdlet. If you delete the settings applied to a site then that site will automatically fall under the jurisdiction of the global client version configuration settings.

Note that you can also run Remove-CsClientVersionConfiguration against the global settings. In that case, the global settings will not be removed; instead, the global properties will simply be reset to their default values.

Input Types

Return Types

Deletes instances of the Microsoft.Rtc.Management.WriteableConfig.Policy.ClientVersionFilter object.


-------------------------- Example 1 ------------------------

Copy Code
Remove-CsClientVersionConfiguration -Identity site:Redmond

The command shown in Example 1 deletes the client version configuration settings that have the Identity site:Redmond. After you remove the settings that have been applied to a site that site (and the users in that site) will automatically inherit the global client version configuration settings.

-------------------------- Example 2 ------------------------

Copy Code
Get-CsClientVersionConfiguration -Filter site:* | Remove-CsClientVersionConfiguration

In Example 2 all the client version configuration settings that have been applied at the site scope are deleted. To accomplish this task the command first calls Get-CsClientVersionConfiguration and the -Filter parameter; the filter value "site:*" ensures that only client version configuration settings that have an Identity beginning with the string value "site:" will be returned. (By definition, only settings applied to the site scope can have an Identity that begins with "site:".) After this filtered collection is returned it is piped to Remove-CsClientVersionConfiguration, which deletes each item (each client version configuration setting) in the collection.

-------------------------- Example 3 ------------------------

Copy Code
Get-CsClientVersionConfiguration | Where-Object {$_.Enabled -eq $False} | Remove-CsClientVersionConfiguration

In the preceding command, all the client version configuration settings that are currently disabled are deleted. To do this, the command first uses Get-CsClientVersionConfiguration to return a collection of all the client version configuration settings currently in use in the organization. Once returned, the collection is piped to the Where-Object cmdlet, which proceeds to pick out only those setting where the Enabled property is equal to (-eq) False ($False); if the Enabled property is False that means that the configuration settings are currently disabled. After Where-Object finishes filtering the collection, those items are then passed to Remove-CsClientVersionConfiguration, which proceeds to delete each item in the filtered collection.