• Article

Get-CsClientVersionConfiguration

 

Topic Last Modified: 2012-03-23

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 Lync Server 2010 checks the version number of each client application that logs on to the system. If client version filtering is enabled the ability of that client application to access the system will be based on settings configured in the relevant client version policy.

Syntax

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

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

Detailed Description

Lync 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, there is no technical reason that requires users to log on to Lync Server 2010 by using Microsoft Lync 2010; there are no technical limitations that would prevent users from logging on by using Microsoft Office Communicator 2007 R2.

However, there might be some non-technical reasons why you would prefer that your users do not log on by using Office Communicator 2007 R2. For example, Office Communicator 2007 R2 does not support all of the features and capabilities found in Lync 2010; as a result, users who log on with Office Communicator 2007 R2 will have a different experience than users who log on by using Lync 2010. 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.

If this could be a problem for your organization you can employ client version filtering in order to specify which client applications can be used to log on to Lync Server 2010. When you install Lync 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. In addition to the global settings, 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.

The Get-CsClientVersionConfiguration cmdlet enables you to retrieve information about the client version configuration settings currently in use in your organization. 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.

Note, too that client version configuration is not a security feature. The technology relies on self-reporting from client applications, and does not attempt to verify that an application is really the application and the version number of that application that it claims to be.

Who can run this cmdlet: By default, members of the following groups are authorized to run the Get-CsClientVersionConfiguration cmdlet locally: RTCUniversalUserAdmins, RTCUniversalServerAdmins. To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself) run the following command from the Windows PowerShell prompt:

Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Get-CsClientVersionConfiguration"}

Parameters

Parameter Required Type Description

Identity

Optional

Xds Identity

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. 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 returns a collection of all the client version configuration settings in use in the organization.

Filter

Optional

String

Enables you to use wildcard characters in order to return a collection (or 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 for) use this syntax: -Filter *EMEA*.

LocalStore

Optional

Switch Parameter

Retrieves the client version configuration data from the local replica of the Central Management store rather than from the Central Management store itself.

Input Types

None. Get-CsClientVersionConfiguration does not accept pipelined input.

Return Types

Get-CsClientVersionConfiguration returns instances of the Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.ClientVersionConfiguration object.

Example

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

Get-CsClientVersionConfiguration

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

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

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 --------------------------

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 instructs Get-CsClientVersionConfiguration to return only the settings that have an Identity that begins with the string value "site:".

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

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 False.