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

Retrieves information about the specified collection of client version configuration settings in use in your organization. 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.

Syntax


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


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

Parameters

Parameter	Required	Type	Description
Identity	Optional	XdsIdentity	Indicates the unique identifier for the collection of client version configuration settings you want to return. To refer to the global settings use this syntax: -Identity global. To refer to a collection configured at the site scope, use syntax similar to this: -Identity site:Redmond. Note that you cannot use wildcards when specifying an Identity. If you need to use wildcards then include the -Filter parameter instead. If this parameter is not specified then Get-CsClientVersionConfiguration will return a collection of all the Address Book settings in use in the organization.
Filter	Optional	String	Enables you to use wildcard characters in order to return a collection (or multiple collections) of client version configuration settings. To return a collection of all the settings configured at the site scope, use this syntax: -Filter site:. To return a collection of all the settings that have the string value "EMEA" somewhere in their Identity (the only property you can filter on) use this syntax: -Filter EMEA*.
LocalStore	Optional	Switch Parameter	This parameter is for testing purposes only.

Parameter

Required

Type

Description

Identity

Optional

XdsIdentity

Indicates the unique identifier for the collection of client version configuration settings you want to return. To refer to the global settings use this syntax: -Identity global. To refer to a collection configured at the site scope, use syntax similar to this: -Identity site:Redmond. Note that you cannot use wildcards when specifying an Identity. If you need to use wildcards then include the -Filter parameter instead.

If this parameter is not specified then Get-CsClientVersionConfiguration will return a collection of all the Address Book settings in use in the organization.

Filter

Optional

String

Enables you to use wildcard characters in order to return a collection (or multiple collections) of client version configuration settings. To return a collection of all the settings configured at the site scope, use this syntax: -Filter site:*. To return a collection of all the settings that have the string value "EMEA" somewhere in their Identity (the only property you can filter on) use this syntax: -Filter *EMEA*.

LocalStore

Optional

Switch Parameter

This parameter is for testing purposes only.

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 2010. When you install Communications Server 2010, 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 2010 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.

The Get-CsClientVersionConfiguration cmdlet enables you to retrieve information about the client version configuration settings currently in use in your organization. These settings will tell you whether or not client version filtering is enabled at the global and/or the site scope (site settings always take precedence over global settings); if filtering is enabled, Communications Server 2010 will check the version number of each client that tries to access the system, then take action based on the appropriate client version policy. For example, if a user tries to log on using Office Communicator 2007 R2, the server will check the appropriate policy to see if Office Communicator 2007 R2 is allowed. If the server cannot find an entry for Office Communicator 2007 R2 then the application will be allowed or denied access based on the configuration setting’s DefaultAction property.

Note that this cmdlet does not return information about which client applications are allowed or are not allowed. To retrieve that information, use Get-CsClientVersionPolicy.

Return Types

Get-CsClientVersionConfiguration returns instances of the Microsoft.Rtc.Management.WriteableConfig.Policy.ClientVersion.ClientVersion configuration object.

Examples

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

	Copy Code
Get-CsClientVersionConfiguration

In the first example, Get-CsClientVersionConfiguration is called without specifying any additional parameters. This causes Get-CsClientVersionConfiguration to return a collection consisting of all the client version configuration settings currently in use in your organization.

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

	Copy Code
Get-CsClientVersionConfiguration -Identity site:Redmond

In the preceding example, Get-CsClientVersionConfiguration returns "all" the client version configuration settings 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-CsClientVersionConfiguration -Filter "site:*"

Example 3 returns all the client version configuration settings that have been applied at the site scope. This is done by including the -Filter parameter and the filter value "site:*"; that filter value tells Get-CsClientVersionConfiguration to return only that settings that have an Identity beginning with the string value "site:".

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

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

The preceding example returns all the client version configuration settings that are currently disabled. To carry out this task, the command first uses Get-CsClientVersionConfiguration to return a collection of all the client version settings configured for use in the organization. This collection is then piped to the Where-Object cmdlet, which applies a filter that limits the collection to those settings where the Enabled property is equal to (-eq) False ($False).