MSFT_SIPClientVersionFilterData class

MSFT_SIPClientVersionFilterData

Defines a set of filter parameters that identifies a client that an Office Communications Server or pool supports.

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_SIPClientVersionFilterData
{
  string Action;
  [key] string Backend;
  uint32 BuildNumber;
  string CompareOP;
  boolean Enabled;
  [key] string InstanceID;
  uint32 MajorVersion;
  uint32 MinorVersion;
  uint32 QFENumber;
  uint32 RuleOrder;
  string URL;
  string UserAgent;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPClientVersionFilterData class has the following properties.

• Action
  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.

  Value	Description
  "Allow"	Allow the client to log on to the pool.
  "BlockWithPrompt"	Prevent the client from logging on to the pool.
  "BlockWithUrl"	Prevent the client from logging on to the pool and present the user with a message containing a URL to a recommended client download site.

  The default value is Allow.

• Backend
  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 Role	Acceptable Values
  Enterprise Edition	SQL_Instance_Name
  Standard Edition	(local)\rtc
  Access Edge Server and Forwarding Proxy	Empty string

• BuildNumber
  Data type: uint32

  Access type: Read/Write

  Optional. The build number of the client.

  The minimum value for this property is 0 and the maximum value is 65535.

• CompareOP
  Data type: string

  Access type: Read/Write

  Required. Specifies the type of comparison operation to perform.

  The value of this property is not case-sensitive.

  Value	Description
  "EQL"	Equal to.
  "NEQ"	Not equal to.
  "GEQ"	Greater than or equal to.
  "LEQ"	Less than or equal to.

  The default value is EQL.

• Enabled
  Data type: boolean

  Access type: Read/Write

  Required. Indicates whether this filter is enabled.

  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 GUID must be encapsulated between the "{" and "}" braces; for example: "{01234567-0123-4567-89AB-CDEF01234567}".

• MajorVersion
  Data type: uint32

  Access type: Read/Write

  Optional. The major version release number of the client.

  The minimum value for this property is 0 and the maximum value is 65535.

• MinorVersion
  Data type: uint32

  Access type: Read/Write

  Optional. The minor version release number of the client.

  The minimum value for this property is 0 and the maximum value is 65535.

• QFENumber
  Data type: uint32

  Access type: Read/Write

  Optional. The version number of the most recently installed quick-fix engineering (QFE) package for the client(commonly referred to as a "hotfix").

  The minimum value for this property is 0 and the maximum value is 65535.

• RuleOrder
  Data type: uint32

  Access type: Read/Write

  Required. An integer specifying the order in which this filter is applied.

  The minimum value for this property is 0 and the maximum value is 65535.

• URL
  Data type: string

  Access type: Read/Write

  Optional. The client download URL that is included in the error message that blocked users receive when the value of the Action property is set to BlockWithUrl.

• UserAgent
  Data type: string

  Access type: Read/Write

  Required. A string that signifies the type of client to which the filter applies.

  Filters for the following clients are installed by default:

  Value	Description
  "LCC"	Microsoft Office Communicator 2005 instant messaging client.
  "RTC"	Real-Time Communications instant messaging client.
  "RTCC"	Real-Time Communications and Collaboration client.
  "UCCP"	Unified Communications Client Platform client.
  "OC"	Microsoft Office Communicator 2007 instant messaging client.
  "WM"	Windows Messenger instant messaging client.
  "CWA"	Microsoft Office Communicator Web Access instant messaging client.
  "COMO"	Microsoft Office Communicator Mobile instant messaging client.
  "LMC"	Microsoft Office Live Meeting client.

  The value of this property is not case-sensitive. The maximum length of the string is 128 characters.

Remarks

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. For a list of server roles and their corresponding WMI class scopes, see WMI Class Management Scopes and Roles.

Each instance of this class (a "filter") represents a single entry in the client version control list. When a client attempts to log on, the Client Version Filter application iterates through each filter and compares a string constructed from information specified by the filter to the string provided in the SIP client's User-Agent header. The order in which the Client Version Filter iterates through filters is specified by the filter's RuleOrder property, and the comparison operation that the Client Version Filter performs is specified by the filter's CompareOP property. If the specified comparison operation returns true, the Client Version Filter applies the Action specified by the matching filter to the client's log on request. The Client Version Filter constructs the comparison string for a filter in the following form, using the values of the following properties: UserAgent/MajorVersion.MinorVersion.BuildNumber.QFENumber. For example, "OC/2.0.6362.0" represents Office Communicator 2007 version 2.0, build 6362. Setting any one of the uint32 property values in the comparison string to -1 causes the Client Version Filter to ignore the value of that property when performing the comparison operation (equivalent in effect to the "*" value in the application's graphical user interface). For example, if a filter specifies a BuildNumber value of -1, the Client Version Filter ignores the SIP client's BuildNumber when performing the client version comparison.

Instances of this class support the following interface methods:

• Provider::DeleteInstance();

• Provider::EnumerateInstances();

• Provider::GetObject();

• Provider::PutInstance();

  Where PutInstance() supports the following flag(s):

  • WBEM_FLAG_CREATE_ONLY
  • WBEM_FLAG_UPDATE_ONLY
  • WBEM_FLAG_CREATE_OR_UPDATE

Requirements

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