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

Parameters

Client version rules are used to determine which client applications are allowed to log on to Microsoft Communications Server and which client applications are not allowed to log on. When a user attempts to log on to Communications Server, his or her client application sends a SIP header to the server; this header includes detailed information about the application itself, including the software’s major version, minor version, and build number. The version information included in the SIP header is then checked against a collection of client version rules to see if any rules apply to that particular application. For example, suppose a user attempts to log on using Office Communicator version 2.0. Before logon can take place, the system will check to see if there is a client version rule that applies to Office Communicator 2.0. If such a rule exists, Microsoft Communications Server will then take the action specified by the rule. That action must be one of the following:

Allow. The user will be allowed to log on.

AllowAndUpgrade. The user will be allowed to log on, and his or her copy of Office Communicator will automatically be upgraded to the latest version of Microsoft Communicator.

AllowWithUrl. The user will be allowed to log on, and a message will be displayed pointing him or her to a URL where the latest version of Microsoft Communicator can be downloaded and installed.

Block. The user will not be allowed to logon.

BlockAndUpgrade. The user will not be allowed to logon, but his or her copy of Office Communicator will automatically be upgraded to the latest version of Microsoft Communicator. The user can then try to logon on using the new client application.

BlockWithUrl. The user will not be allowed to log on, but a message will be displayed pointing him or her to a URL where the latest version of Microsoft Communicator can be downloaded and installed.

Client version rules are collected in client version policies, policies that can be configured at the global scope, the site scope, the service scope (Registrar service), or the per-user scope. This enables you to provide different users with different rules regarding the client applications they can or cannot use to log on to Microsoft Communications Server. For example, as a general rule you might want to prevent users from logging on using Office Communicator; after all, Office Communicator does not support the same features and capabilities as Microsoft Communicator. However, due to hardware or software conflicts you might also have a select group of users who cannot upgrade to Microsoft Communicator. In that case, you can create a separate rule – and a separate client version policy – that allows those users to log on from within Office Communicator.

The Remove-CsClientVersionPolicyRule cmdlet enables you to delete one or more of the client policy rules configured for use in your organization. These rules can be deleted from any of your client version policies, including the global policy. If you delete a rule from the global policy, you can use the New-CsClientVersionPolicyRule to re-create that rule. Alternatively, you can run Remove-CsClientVersionPolicy against the global policy; that effectively resets the policy, restoring all the rules and settings that were in place when you first installed Microsoft Communications Server.

Remove-CsClientVersionPolicyRule deletes instances of the Microsoft.Rtc.Management.WriteableConfig.Policy.ClientVersion.Rule object.

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

	Copy Code
Remove-CsClientVersionPolicyRule -Identity site:Redmond/74ba9211-8610-42f9-91ba-846cdee98820

The command shown in Example 1 deletes the client version policy rule that has the Identity site:Redmond/74ba9211-8610-42f9-91ba-846cdee98820. Because Identities must be unique, this command can only delete, at most, a single rule.

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

	Copy Code
Get-CsClientVersionPolicyRule -Filter "site:Redmond/*" | Remove-CsClientVersionPolicyRule

The preceding command deletes all the client version policy rules that have been configured for the Redmond site. To do this, the command first calls Get-CsClientVersionPolicyRule along with the -Filter parameter; the filter value "site:Redmond/*" limits the returned data to policy rules that have an Identity that begins with the string value "site:Redmond/". This filtered collection is then piped to Remove-CsClientVersionPolicyRule, which, in turn, deletes each item in that collection.

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

	Copy Code
Get-CsClientVersionPolicyRule | Where-Object {$_.UserAgent -eq "OCPhone"} | Remove-CsClientVersionPolicyRule

The command shown in Example 3 deletes all the client version policy rules for Communicator Phones (OCPhone). To carry out this task, the command first calls Get-CsClientVersionPolicyRule in order to return a collection of all the policy rules currently in use; this collection is then piped to Where-Object, which selects only those rules where the UserAgent property is equal to (-eq) OCPhone. This sub-collection is then piped to Remove-CsClientVersionPolicyRule, which proceeds to delete all the client version policy rules for Communicator Phones.

-------------------------- Example 4 ------------------------

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

Example 4 deletes all the client version policy rules that are currently disabled. To do this, the command first calls Get-CsClientVersionPolicy rule, without any parameters, in order to return a collection of all the policy rules currently in use in the organization. This collection is then piped to the Where-Object cmdlet, which picks out all the rules where the Enabled property is equal to False ($False). This filtered collection is then piped to Remove-CsClientVersionPolicyRule, which deletes each item (that is, each disabled rule) in the collection.