MSFT_SIPEsEmSetting

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 pool level settings for the Office Communications Server User Services component.

MSFT_SIPEsEmSetting

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_SIPEsEmSetting
{
  [key] string Backend;
  [key] string InstanceID;
  uint32 MaintenanceHourOfDay;
  uint32 MaxContactsPerUser;
  string RedirectMethods;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPEsEmSetting class has the following properties.

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

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

  • MaintenanceHourOfDay
    Data type: uint32

    Access type: Read/Write

    Required. The time when the database is cleaned.

    Value

    Description

    0 to 23

    The hour of the day when the database is cleaned.

    The default value is 2 (A.M.).

  • MaxContactsPerUser
    Data type: uint32

    Access type: Read/Write

    Required. The maximum number of contacts a user can have. The maximum number of ACEs each user can have is twice this number.

    Value

    Description

    150-1000

    The maximum number of contacts allowed per user.

    The default value is 150.

  • RedirectMethods
    Data type: string

    Access type: Read/Write

    Required. The routing method used on this server.

    The value of this property is not case-sensitive.

    The maximum length of the string is 13 characters.

    Value

    Description

    Proxy

    All SIP messages are proxied.

    Redirect

    All SIP messages are redirected.

    AsAppropriate

    SIP REGISTER messages are redirected; all other messages are proxied.

    The default value is AsAppropriate.

Remarks

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

Only one instance of this class can be present in the pool.

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

Namespace: Defined in \root\cimv2.

See Also

Concepts

Office Communications Server WMI Reference