Export (0) Print
Expand All
Expand Minimize

MSFT_SIPApplicationPriorityList

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 the execution order of the applications installed on a computer running Office Communications Server.

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_SIPApplicationPriorityList
{
  [key] string InstanceID;
  string[] InstanceIDList;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPApplicationPriorityList class has the following properties.

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}".

This property cannot be updated by the administrator. It is specified when Office Communications Server is installed.

InstanceIDList

Data type: string[]

Access type: Read/Write

Optional. A list of GUIDs corresponding to SIP applications installed on a server. The GUIDs are in the order of execution. That is, when a SIP request is received, the application corresponding to the GUID at the top of the list is executed first, followed in order by the remaining applications represented on the list. For SIP responses, the order of execution is reversed, with the last application in the list executing first.

The administrator can change only the order of the GUIDs in this list; new GUIDs cannot be added and existing GUIDs cannot be deleted. This property is updated as specified.

The value of this property is not case-sensitive.

Remarks

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

Only one instance of this class can be present.

The priority list is populated as applications are registered and their corresponding instances are created. As each application is registered, its GUID is added to the end of the list. Because applications on a server execute in the order in which they appear on the list, they should be installed in the order in which you want them to run.

The execution order should be chosen based on the nature of the applications. For example, an application that logs calls probably should execute before an application that looks up user endpoints because, even if no endpoints exist for a user, an administrator might still want to log the call as part of monitoring SIP traffic.

When a response is received, the applications execute in reverse order, beginning with the last application on the list.

You can change the order of execution by reordering the GUIDs in the InstanceIdList array, but you cannot add or remove an application from the list. To add an application, you must register it with Office Communications Server. To remove an application, you must delete its MSFT_SIPApplicationSetting instance.

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: Access Edge Server, Front End Server, and Proxy Server.

Namespace: Defined in \root\cimv2.

Show:
© 2014 Microsoft