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

Returns information about the Microsoft Communications Server 2010 clients (e.g., Communicator) supported in your Communications Server 2010 environment. Client version policies enable you to specify which "downlevel "clients (such as Microsoft Office Communicator 2007 R2) will be able to log onto your Communications Server 2010 system. If you do not wish to allow a particular client to use the system then you can create a policy that will prevent people using that client from logging on.


Get-CsClientVersionPolicy [-Identity <XdsIdentity>] [-LocalStore <SwitchParameter>]
Get-CsClientVersionPolicy [-Filter <String>] [-LocalStore <SwitchParameter>]


Parameter Required Type Description



Xds Identity

Unique identifier for the policy to be returned. To return the global policy, use this syntax: -Identity global. To return a policy configured at the site scope use syntax similar to this: -Identity "site:Redmond". To return a policy configured at the service scope use syntax like this: -Identity "service: Registrar:atl-cs-001.litwareinc.com". The Registrar service is the only service that can host a client version policy.

Policies can also be configured at the per-user (tag) scope. To return one of these policies, simply leave off the scope portion of the Identity. For example, the policy tag:SalesDepartmentPolicy would be referenced like this: -Identity "SalesDepartmentPolicy".

If this parameter is not included then all the client version policies configured for use in your organization will be returned.




Enables you to use wildcards when specifying the policy (or policies) to be retrieved. For example, this syntax returns all the policies that have been configured at the site scope: -Filter “"site:*". And this syntax returns all the policies that have been configured at the per-user scope: -Filter "tag:*".

You cannot use both the –Filter and the –Identity parameters in the same command.



Switch Parameter

This parameter is for testing purposes only.

Detailed Description

Client version policies are nothing more than a collection of client version rule. 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. For example, the rule might tell Communications Server to allow the logon, it tell instruct Communications Server to block, or it might tell Communications Server allow the logon but then silently update the client application to the latest version of Microsoft Communicator. (This latter behavior can occur only if the user is logging on using a specified version of Office Communicator.”

Rules are designed to address client applications on a one-on-one basis: depending on your needs, you might have one rule for dealing with Office Communicator, a second rule for handling Communicator Phone Edition devices, and a third rule for Microsoft Office Live Meeting. Individual rules can then be bundled together in client version policies. These policies – which can be applied at the global scope, the site scope, the service scope (Registrar service only), or the per-user scope – give you considerable flexibility in determining which client applications can be used to access the system. 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 Get-CsClientVersionPolicy cmdlet provides an easy way for you to retrieve all of the client version policies currently in use in your organization, as well as the individual rules that make up each of those policies.

Return Types

Get-CsClientVersionPolicy returns instances of the Microsoft.Rtc.Management.WriteableConfig.Policy.ClientVersion.ClientVersion policy object.


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

Copy Code

In the first example, Get-CsClientVersionPolicy is called without specifying an additional parameters. This will cause Get-CsClientVersionPolicy to return a collection consisting of all the client version policies configured for use in your organization.

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

Copy Code
Get-CsClientVersionPolicy -Identity site:Redmond

In the preceding example, Get-CsClientVersionPolicy returns "all" the client version policies that have the Identity site:Redmond. Because identities must be unique, this command will never return more than one item.

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

Copy Code
Get-CsClientVersionPolicy -Filter site:*

Example 3 returns all the client version policies that have been configured at the site scope. This is done by including the -Filter parameter and the wildcard site:*; that wildcard tells Get-CsClientVersionPolicy to return only that policies that have an Identity beginning with the string value site:.

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

Copy Code
Get-CsClientVersionPolicy | Select-Object -ExpandProperty Rules

The command used in Example 4 displays detailed information about the individual rules configured for each client version policy. To do this, Get-CsClientVersionPolicy is first used to retrieve a collection of all the client version policies configured for use in the organization. That collection is then piped to the Select-Object cmdlet. Select-Object then uses the -ExpandProperty filter to "expand" the property values for the Rules property; in turn, that results in detailed information about each rule (including such property values as build number, major version, and minor version) to be displayed onscreen.