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

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

Parameters

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.

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

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

	Copy Code
Get-CsClientVersionPolicy

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.