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

Modifies the specified collection of client version configuration settings. 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


Set-CsClientVersionConfiguration [-Identity <XdsIdentity>] [-Confirm [<SwitchParameter>]] [-DefaultAction <Allow \| AllowWithUrl \| Block \| BlockWithUrl>] [-DefaultURL <String>] [-Enabled <$true \| $false>] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

Set-CsClientVersionConfiguration [-Identity <XdsIdentity>] [-Confirm [<SwitchParameter>]] [-DefaultAction <Allow | AllowWithUrl | Block | BlockWithUrl>] [-DefaultURL <String>] [-Enabled <$true | $false>] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]


Set-CsClientVersionConfiguration [-Confirm [<SwitchParameter>]] [-DefaultAction <Allow \| AllowWithUrl \| Block \| BlockWithUrl>] [-DefaultURL <String>] [-Enabled <$true \| $false>] [-Force <SwitchParameter>] [-Instance <PSObject>] [-WhatIf [<SwitchParameter>]]

Set-CsClientVersionConfiguration [-Confirm [<SwitchParameter>]] [-DefaultAction <Allow | AllowWithUrl | Block | BlockWithUrl>] [-DefaultURL <String>] [-Enabled <$true | $false>] [-Force <SwitchParameter>] [-Instance <PSObject>] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter	Required	Type	Description
Identity	Optional	XdsIdentity	Represents the unique identifier to be assigned to the new collection of client version configuration settings. Because you can only create new collections at the site scope the Identity will always be the prefix "site:" followed by the site name; for example "site:Redmond". Note that the preceding command will fail if a collection of settings with the Identity site:Redmond already exists.
Instance	Optional	ClientVersionPolicy objects	Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values.
DefaultAction	Optional	String	Indicates the action to be taken if a user tries to log on from a client application whose version number cannot be found in the appropriate client version policy. DefaultAction must be set to one of the following values: Allow. The client application will be allowed to log on. Block. The client application will be prevented from logging on. BlockWithUrl. The client application will be prevented from logging on. However, the "Access denied" message box displayed to the user will include the URL of a Web page where that user can download an approved client application. The URL for this Web page should be specified as the value for the DefaultUrl property. This property is ignored if the Enabled property is set to False. When the Enabled property is set to False then no client version filtering of any kind takes place.
DefaultUrl	Optional	String	Specifies the URL of the Web page where users can download an approved client application. If specified, and if the DefaultAction is set to BlockWithURL, this URL will appear in the "Access denied" message box displayed any time a user tries to log on from an unsupported client application.
Enabled	Optional	Boolean	Indicates whether client version filtering is enabled or disabled. If the Enabled property is True then the server will check the version number of each client application that attempts to log on; the server will then allow or deny access based on the appropriate client version policy. If the Enabled property is False then any client application capable of logging on will be allowed to log on.
UserAgentMapping	Optional	PS List Modifier
Force	Optional	Switch Parameter
Confirm	Optional	Boolean	Prompts you for confirmation before executing the command.
WhatIf	Optional	Switch Parameter	Describes what would happen if you executed the command without actually executing the command.

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 Set-CsClientVersionConfiguration cmdlet enables you to modify an existing collection of client version configuration settings, at either the global or the site scope.

Return Types

Set-CsClientVersionConfiguration does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WriteableConfig.Policy.ClientVersionFilter object.

Examples

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

	Copy Code
Set-CsClientVersionConfiguration -identity site:Redmond -Enabled $False

In Example 1, Set-CsClientVersionConfiguration is used to modify the settings collection with the Identity "site:Redmond". In this case, the -Enabled parameter is used to disable the client version configuration settings, something you do by setting the parameter value to $False.

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

	Copy Code
Get-CsClientVersionConfiguration \| Set-CsClientVersionConfiguration -DefaultURL "https://litwareinc.com/csclients

In the preceding example, the DefaultUrl property is modified for all the client version configuration settings currently in use in the organization. To do this, the command first uses Get-CsClientVersionConfiguration (without any additional parameters) to return all of the client version configuration settings. That information is the piped to Set-CsClientVersionConfiguration, which sets the value of the DefaultUrl for each configuration collection to https://litwareinc.com/csclients.

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

	Copy Code
Get-CsClientVersionConfiguration \| Where-Object {$_.DefaultAction -eq "Block"} \| Set-CsClientVersionConfiguration -DefaultAction "BlockWithUrl" -DefaultURL "https://litwareinc.com/csclients

In Example 3, modifications are made to all the client version configuration settings where the DefaultAction is currently set to Block. To carry out this task, the command first uses Get-CsClientVersionConfiguration to return all of the client version configuration settings currently in use; that information is then piped to the Where-Object cmdlet, which picks out only those items where the DefaultAction property is equal to (-eq) "Block". In turn, that filtered collection is then piped to Set-CsClientVersionConfiguration, which does two things to each item in the collection: 1) sets the DefaultAction to BlockWithUrl; and, 2) sets the DefaultUrl to https://litwareinc.com/csclients.