MSFT_SIPClientVersionFilterSetting class

Communications Server 2007 Server SDK Documentation


Specifies the default filter action to apply to clients that do not match the parameters specified by an instance of MSFT_SIPClientVersionFilterData.

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.

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


This class does not define any methods.


The MSFT_SIPClientVersionFilterSetting class has the following properties.

Data type: [key] string

Access type: Read-only

Must be empty when accessing data from Edge Server or Proxy Server roles. Required when accessing data from any role that belongs to a pool.

The computer name (either the FQDN or NetBIOS name) and SQL Server instance name of the Office Communications Server 2007, Back-End Database (configuration data is stored in the same SQL instance as user data, but in a different database). Indicates where this class is stored, which varies depending on the server role.

Server RoleAcceptable Values
Enterprise EditionSQL_Instance_Name
Standard Edition(local)\rtc
Access Edge Server and Forwarding ProxyEmpty string
Data type: string

Access type: Read/Write

Required. Controls whether the client can log on to the server or pool.

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

"Allow"Allow the client to log on if the client version does not match any filter.
"BlockWithPrompt"Prevent the client from logging on if the client version does not match any filter.
"BlockWithUrl"Prevent the client from logging on if the client version does not match any filter, and present the user with a message containing a URL to a recommended client download site.

The default value is Allow.

Data type: boolean

Access type: Read/Write

Required. Determines whether client version filtering is enabled.

The default value is true.

Data type: [key] string

Access type: Read-only

Required. A GUID value that uniquely identifies an instance of this class.

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

Data type: string

Access type: Read/Write

Optional. The URL that points to the message that is displayed in the client when the value of the Action property is set to BlockWithUrl.


This class gets and sets information at the following level(s): WMI, 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 flag(s):



Server: Installed on computers serving the following role(s): Administrative Tools Server, Access Edge Server, Front End Server.
Namespace: Defined in \root\cimv2.

See Also

Communications Server WMI Reference

  What did you think of this topic?
  © 2007 Microsoft Corporation. All rights reserved.


Community Additions