This documentation is archived and is not being maintained.

MSFT_SIPGlobalFederationSetting

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.

Enables federation for all internal users and defines the default route and port of a Director or a computer running Access Edge Server (if a Director is not deployed) to which internal servers route all federated communications. Enabling federation and public IM connectivity makes it possible for internal users to communicate with federated partners and use public IM providers. Global federation settings are configured on a forest-wide basis.

The property values for the MSFT_SIPGlobalUCSetting class map to the settings found on the Federation 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 Forest in the console tree, pointing to Properties, and then clicking Global Properties.

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

Dd146526.MSFT_SIPGlobalFederationSetting_FederationTab(en-us,office.13).jpg

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_SIPGlobalFederationSetting
{
  boolean EnableRouteToEnterpriseEdge;
  [key] string InstanceID;
  string RouteToEnterpriseEdge;
  uint32 RouteToEnterpriseEdgePort;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPGlobalFederationSetting class has the following properties.

EnableRouteToEnterpriseEdge

Data type: boolean

Access type: Read/Write

Required. Enables or disables federation for all internal users. Maps to the Enable Federation and Public IM connectivity check box on the Federation tab in the Administration Tool user interface.

If False, internal users cannot connect to the Director or Access Edge Server. If True, internal users can connect to Access Edge Server.

The default value is False.

InstanceID

Data type: [key] string

Access type: Read-only

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

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

RouteToEnterpriseEdge

Data type: string

Access type: Read/Write

Optional. The fully qualified domain name (FQDN) of the Director, Access Edge Server, or load balancer through which outbound SIP traffic is routed. Maps to the FDQN box on the Federation tab in the Administration Tool user interface.

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

This property can be NULL only if EnableRouteToEnterpriseEdge is False.

The default value is NULL.

RouteToEnterpriseEdgePort

Data type: uint32

Access type: Read/Write

Optional. The port number of the Director or Access Edge Server. Maps to the Port box on the Federation tab in the Administration Tool user interface.

The minimum value for this property is 1 and the maximum value is 65535.

The value can be NULL only if EnableRouteToEnterpriseEdge is False.

The default value is NULL.

Remarks

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

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

Instances of this class support the following interface methods:

  • Provider::EnumerateInstances();

  • Provider::GetObject();

  • Provider::PutInstance();

    Where PutInstance() supports the following flag:

    • WBEM_FLAG_UPDATE_ONLY

Requirements

Server: Installed on computers serving the following roles: Administrative Tools Server, Front End Server, and Proxy Server.

Namespace: Defined in \root\cimv2.

Show: