MSFT_SIPClientVersionFilterData

  • Article

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.

Defines a set of filter parameters that identifies a client version that Office Communications Server 2007 R2 or a pool supports. Client version information provides a way to specify the version of clients that are supported in a deployment environment. The MSFT_SIPClientVersionFilterData class is configured at the pool level.

MSFT_SIPClientVersionFilterData

The property values for the MSFT_SIPClientVersionFilterData class map to the settings found on the Add Version Filter or Edit 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 to display the Client Version Filter dialog box. A version filter can be added or edited by clicking either the Add or the Edit button in this dialog box.

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

Dd146589.MSFT_SIPClientVersionFilterData_AddDialog(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_SIPClientVersionFilterData
{
  string Action;
  [key] string Backend;
  uint32 BuildNumber;
  string ClientDownloadFolder;
  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. Maps to the Select the action to apply to this version box in the Administration Tool user interface.

    The value of this property is not case-sensitive.

    Value

    Description

    Allow

    Allows the client to log on to the pool.

    AllowWithDynUrl

    Allows the client to log on with an automatic upgrade to a newer version.

    NoteNote
    This option can only be used with clients that support automatic downloads. Currently, only Office Communicator supports this option.

    BlockWithDynUrl

    Prevents the client from logging on with an automatic upgrade to a newer version.

    NoteNote
    This option may only be used with clients that support auto-downloads. Currently, only Office Communicator supports this option.

    BlockWithPrompt

    Prevents the client from logging on to the pool.

    BlockWithUrl

    Prevents the client from logging on to the pool and presents 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

    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.

    This property identifies the instance of SQL Server that manages the back-end database for Office Communications Server. The Backend value does not appear in the Administration Tool.

    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.

  • BuildNumber
    Data type: uint32

    Access type: Read/Write

    Optional. The build number of the client. Maps to the Build number box in the Administration Tool user interface.

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

  • ClientDownloadFolder
    Data type: string

    Access type: Read/Write

    Required. Specifies a subfolder in the Client Download UNC Share (specified by the CreatePool action) where the update images—Windows Installer (.msi) or Windows Installer Patch (.msp)—are located. Maps to the Folder that contains the upgrade images box in the Administration Tool user interface when either “Block and Upgrade” or “Allow and Upgrade” is selected in the Select the action to apply to this version box.

    This path must exist on a network share, typically using the following path structure: Client Name \Version Number. For example, Office Communicator version 3.0 would have the following structure: Office Communicator\3.0.

    The default value is NULL.

  • CompareOP
    Data type: string

    Access type: Read/Write

    Required. Specifies the type of comparison operation to perform. Maps to the Select the comparision operation to perform box in the Administration Tool user interface.

    The value of this property is not case-sensitive.

    Value

    Description

    EQL

    Equal to

    NEQ

    Not equal to

    GE

    Greater than

    LE

    Less than

    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 Enabled value does not appear in the Administration Tool.

    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 value does not appear in the Administration Tool.

    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. Maps to the Major version number box in the Administration Tool user interface.

    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. Maps to the Minor version number box in the Administration Tool user interface.

    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"). Maps to the Qfe number box in the Administration Tool user interface.

    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. Determined by a filter’s ordinal position in the Client application version control list on the Client Version Check tab of the Client Version Filter dialog box.

    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. Maps to the Url box in the Administration Tool user interface when “Block with Static Url” is selected in the Select the action to apply to this version box.

  • UserAgent
    Data type: string

    Access type: Read/Write

    Required. A string that signifies the type of client to which the filter applies. Maps to the User Agent Header box in the Administration Tool user interface.

    Filters for the following clients are installed by default.

    Value

    Description

    OCPhone

    Microsoft Office Communicator Phone Edition client

    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 R2 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 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. 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 logon 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 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.

See Also

Concepts

Office Communications Server WMI Reference

Other Resources

Configuring Client Version Filtering