MSFT_SIPDomainData

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 entry in the list of domains served by Office Communications Server, and indicates whether the domain is used to create Globally Routable User Agent URIs (GRUUs). This class is configured on the forest level.

MSFT_SIPDomainData

The property values for the MSFT_SIPDomainData class map to the settings found on the General tab of the Office Communications Server Global Properties dialog box. You can access these values in the Office Communications Server 2007 R2 Administration Tool by right-clicking the Forest, pointing to Properties, and then clicking Global Properties.

The mapping between the dialog box and the WMI properties is shown in the illustration below:

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_SIPDomainData
{
  string Address;
  boolean Authoritative;
  boolean DefaultDomain;
  [key] string InstanceID;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPDomainData class has the following properties.

• Address
  Data type: string

  Access type: Read/Write

  Required. The fully qualified domain name (FQDN) of a domain handled by Office Communications Server. Maps to a domain in the Domains box in the Administration Tool user interface.

  The value must be an FQDN. An IP address is not allowed.

• Authoritative
  Data type: boolean

  Access type: Read/Write

  Required. Indicates whether Office Communications Servers within the enterprise deployment are authoritative for the domain. The Authoritative value does not appear in the Administration Tool.

  If True, this indicates that all users in the domain are homed on Office Communications Servers. When True and Office Communications Server does not find a user with the given domain in the database, the server responds with 404 and does not attempt to forward the request to a federation route.

• DefaultDomain
  Data type: boolean

  Access type: Read/Write

  Required. Specifies whether the domain is used to form Globally Routable User Agent URIs (GRUUs). Maps to the check box next to a domain in the Domains box in the Administration Tool user interface.

  Only one entry in the list of domains served by the running Office Communications Server should be marked as the default domain. The default value is False.

• InstanceID
  Data type: [key] string

  Access type: Read-only

  Optional. A GUID value that uniquely identifies an instance of this class. The InstanceID value does not appear in the Administration Tool.

  The GUID must be encapsulated between the "{" and "}" braces; for example: "{01234567-0123-4567-89AB-CDEF01234567}".

Remarks

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

This class represents a single entry in a list of domains. Domain addresses can include the "*" (wildcard) character; for example, the address "*.example.com" can be used to represent all subdomains within the example domain. When determining domain service for an incoming request, the most-specific domain address is always chosen.

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

Namespace: Defined in \root\cimv2.

See Also

Concepts

Office Communications Server WMI Reference

MSFT_SIPESGlobalRegistrarSetting

Other Resources

Specifying Supported Internal SIP Domains