Share via

MSFT_SIPApplicationSetting

  • 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 the settings used to register a SIP application with an Office Communications Server.

MSFT_SIPApplicationSetting

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_SIPApplicationSetting
{
  boolean Critical;
  boolean Enabled;
  [key] string InstanceID;
  string Name;
  boolean Running;
  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

    Access type: Read/Write

    Required. Specifies whether starting Office Communications Server depends on successfully executing the application.

    If this property is set to True, Office Communications Server does not start if the application fails. If this property is set to False, the application failure does not affect the start of Office Communications Server.

    This property is useful for stopping Office Communications services when a critical application fails. For example, a service for financial transactions can shut down Office Communications Server if the transaction logging the application fails.

  • Enabled
    Data type: boolean

    Access type: Read/Write

    Required. Specifies whether the application can be executed on Office Communications Server when the service starts.

    If True, the application can be executed on Office Communications Server when the service starts. If False, the application does not start.

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

  • Name
    Data type: string

    Access type: Read/Write

    Required. The friendly name of the SIP application.

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

  • Running
    Data type: boolean

    Access type: Read-only

    Optional. Indicates whether the application is running.

  • ScriptPath
    Data type: string

    Access type: Read/Write

    Optional. 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 when the service starts if the script does not exist in this path.

    The maximum length of the string is 260 characters.

  • URI
    Data type: string

    Access type: Read/Write

    Required. 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 value of this property is not case-sensitive. The maximum length of the string is 512 characters.

Remarks

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

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

Namespace: Defined in \root\cimv2.

See Also

Concepts

Office Communications Server WMI Reference