MSFT_SIPApplicationPriorityList class

MSFT_SIPApplicationPriorityList

The MSFT_SIPApplicationPriorityList class defines the execution order of the applications installed on a computer running Live Communications Server.

The following syntax is simplified from MOF code and includes all inherited properties.

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

  A GUID value that uniquely identifies the SIP application priority list. 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 Live Communications Server is installed.

• InstanceIDList
  Data type: string []

  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.

Remarks

The priority list is populated as applications are registered and their corresponding MSFT_SIPApplicationSetting 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 Live Communications Server. To remove an application, you must delete its MSFT_SIPApplicationSetting instance.

Available actions for an instance of this class:

• Creation: The administrator cannot create instances of this class.
• Updates: The administrator can update only the InstanceIDList for the instance of this class.
• Deletion: The administrator cannot delete instances of this class.

Requirements

Server: Installed on Windows Server 2003 with Live Communications Server 2005 with SP1.
Namespace: Defined in \root\cimv2.

See Also

MSFT_SIPApplicationSetting, Live Communications Server WMI Reference