This documentation is archived and is not being maintained.

MSFT_SIPClientVersionFilterSetting

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

Determines whether client version filtering is enabled, and specifies the default filter action to apply to clients that do not match the parameters specified by an instance of . Client version information provides a way to specify the version of clients that are supported in a deployment environment. The MSFT_SIPClientVersionFilterSetting class is configured at the pool level.

The property values for the MSFT_SIPClientVersionFilterSetting class map to the settings found on the Client Version Filter dialog box. You can access these values in the Office Communications Server 2007 R2 Administration Tool by right-clicking a pool, pointing to Filtering Tools, and then clicking Client Version Filter.

The mapping between the dialog box and the WMI properties is shown in the illustration below:

Dd185936.MSFT_SIPClientVersionFilterSetting_ClientVersionFilterDialog(en-us,office.13).jpg

The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties. Properties are listed in alphabetic order, not MOF order.

Syntax


class MSFT_SIPClientVersionFilterSetting
{
  [key] string Backend;
  string DefaultAction;
  boolean Enabled;
  [key] string InstanceID;
  string URL;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPClientVersionFilterSetting class has the following properties.

Backend

Data type: [key] string

Access type: Read-only

Required: When accessing data from any role that belongs to a pool. This property must be empty when accessing data from the Edge Server or Proxy Server role. The Backend value does not appear in the Administration Tool.

This property identifies the instance of SQL Server that manages the back-end database for Office Communications Server.

The value for this property depends on the topology of Office Communications Server.

Topology

Value

Standard Edition

(local)\rtc

Enterprise Edition

(consolidated or expanded configuration)

computername\instancename

or

computername

For Enterprise Edition, computername identifies either the FQDN or the NetBIOS name of the host computer for SQL Server and instancename identifies a named instance of SQL Server on the host computer. The value computername by itself specifies the default instance of SQL Server on the host computer.

DefaultAction

Data type: string

Access type: Read/Write

Required. Controls whether the client can log on to the server or pool. Maps to the Action box in the Administration Tool user interface.

The value of this property is not case-sensitive. Filters are defined by instances of MSFT_SIPClientVersionFilterData.

Value

Description

Allow

Allows the client to log on if the client version does not match any filter.

BlockWithPrompt

Prevents the client from logging on if the client version does not match any filter.

BlockWithUrl

Prevents the client from logging on if the client version does not match any filter and presents the user with a message containing a URL for the client download site.

The default value is Allow.

Enabled

Data type: boolean

Access type: Read/Write

Required. Determines whether client version filtering is enabled. Maps to the Enable Version Control box in the Administration Tool user interface.

The default value is True.

InstanceID

Data type: [key] string

Access type: Read-only

Required. A GUID value that uniquely identifies an instance of this class. The InstanceID does not appear in the Administration Tool.

The GUID must be encapsulated between the "{" and "}" braces; for example: "{01234567-0123-4567-89AB-CDEF01234567}".

URL

Data type: string

Access type: Read/Write

Optional. A URL included in the message that usually points to the location from which to download the client when DefaultAction is set to “BlockWithUrl”. Maps to the Url box in the Administration Tool user interface.

Remarks

This class gets and sets information at the following levels: WMI and SQL.

If this class is installed on a server whose role has "Pool" scope, the scope of this class is "Pool" and settings are stored in SQL. In this case, only one instance of this class can be present in the pool. For a list of server roles and their corresponding WMI class scopes, see WMI Class Management Scopes and Roles.

Instances of this class support the following interface methods:

  • Provider::EnumerateInstances();

  • Provider::GetObject();

  • Provider::PutInstance();

    Where PutInstance() supports the following flags:

    • WBEM_FLAG_CREATE_ONLY

    • WBEM_FLAG_UPDATE_ONLY

    • WBEM_FLAG_CREATE_OR_UPDATE

Requirements

Server: Installed on computers serving the following roles: Administrative Tools Server, Access Edge Server, and Front End Server.

Namespace: Defined in \root\cimv2.

Show: