MSFT_SIPApplicationSetting class

Article
11/13/2008

Microsoft Office Live Communications Server 2005 with SP1

MSFT_SIPApplicationSetting

The MSFT_SIPApplicationSetting class defines the settings used to register a SIP application with a Live Communications Server.

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

class MSFT_SIPApplicationSetting
{
  boolean Critical;
  boolean Enabled;
  [key] string InstanceID;
  string Name;
  string ScriptPath;
  string URI;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPApplicationSetting class has the following properties.

Critical
Data type: boolean

If true, the Live Communications Server does not start if the application fails. If false, application failure does not affect the launch of the Live Communications Server. This property is useful for stopping all Live Communications service when a critical application fails; for example, a service for financial transactions can shut down the Live Communications Server if the transaction logging application fails.

This property is required on creation.
Enabled
Data type: boolean

If true, the application can be executed on the Live Communications Server upon service startup. If false, it will not be started.

This property is required on creation.
InstanceID
Data type: [key] string

A GUID value that uniquely identifies the SIP application. The GUID must be encapsulated between the "{" and "}" braces; for example: "{01234567-0123-4567-89AB-CDEF01234567}".

This property is required on creation and cannot be updated.
Name
Data type: string

The friendly name of the SIP application.

The maximum size of this property is 128 characters. This property is required on creation and can be updated.
ScriptPath
Data type: string

The local path to the MSPL script-only applications on the server (the script is not embedded in the application manifest). An error is generated in the server event log upon service startup if the script does not exist at this path.

The maximum size of this property is 1,024 characters. This property is optional on creation and can be updated.
URI
Data type: string

The unique URI string that identifies the SIP application. This string must be identical to the URI specified in the application manifest of the application.

The maximum size of this property is 512 characters. This property is required on creation and can be updated.

Remarks

Available actions for an instance of this class:

Creation: The administrator can create instances of this class.
Updates: The administrator can update instances of this class.
Deletion: The administrator can delete instances of this class.

Requirements

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

Share via