MSFT_SIPApplicationConfigSetting (New)

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 an instance of an application that is hosted in the pool by a Unified Communications Application Server.

MSFT_SIPApplicationConfigSetting

Office Communications Server 2007 R2 is installed with the following applications that can be specified by an instance of this class:

  • Conferencing Attendant

  • Conferencing Announcement Service

  • Response Group Service

  • Outside Voice Control

The MSFT_SIPApplicationConfigSetting class properties do not map to the Office Communications Server administrative tools.

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_SIPApplicationConfigSetting
{
  string ApplicationType;
  [key] string Backend;
  string CustomSettings;
  string CustomSettingsXSD;
  string DataLocation;
  string DisplayName;
  string Identifier;
  [key] string InstanceID;
  string RootAssemblyLocation;
  string ServiceName;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPApplicationConfigSetting class has the following properties.

  • ApplicationType
    Data type: string

    Access type: Read-only

    Required. The application type for this instance of the class.

    The maximum length of the string is 256 characters.

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

  • CustomSettings
    Data type: string

    Access type: Read/Write

    Optional. An XML string that defines all the application's custom settings.

  • CustomSettingsXSD
    Data type: string

    Access type: Read-only

    Optional. An XML string that contains the schema definition (XSD) that is used to validate the custom settings XML.

    If empty, the settings are not validated.

  • DataLocation
    Data type: string

    Access type: Read/Write

    Optional. The location of the data directory where applications can store files.

    The maximum length of the string is 160 characters.

  • DisplayName
    Data type:

    Access type: Read/Write

    Required. The name of the application as it is displayed to users.

    This name should generally correspond to the application service's name.

    The maximum length of the string is 256 characters.

  • Identifier
    Data type:

    Access type: Read-only

    Required. A string that uniquely identifies the application.

    The server uses this globally unique identifier to associate the application with the internally-used name of the application's service and to refer to the routing information for the application.

    The maximum length of the string is 100 characters.

  • InstanceID
    Data type:

    Access type: Read-only

    Required. Read-only. 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}".

  • RootAssemblyLocation
    Data type:

    Access type: Read-only

    Optional. The root location of the assembly.

    The maximum length of the string is 160 characters.

  • ServiceName
    Data type:

    Access type: Read-only

    Required. The name used by the system to identify this service.

    The maximum length of the string is 256 characters.

Remarks

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

Instances of this class support the following interface methods:

  • Provider::DeleteInstance();

  • 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 and Application Host.

Namespace: Defined in \root\cimv2.

See Also

Concepts

Office Communications Server WMI Reference

Other Resources

Application Server Application Configuration