Share via

MSFT_SIPGlobalUCPolicyData

  • 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 Enterprise Voice policies. An Enterprise Voice policy defines call privileges assigned to a user and determines whether users may enable simultaneous ringing. An Enterprise Voice policy defines call privileges with a collection of ordered phone usages that determine which routes a user is allowed to use. An Enterprise Voice policy not associated with any phone usages effectively prevents users assigned to that policy from making any outbound calls to the PSTN. An Enterprise Voice policy is configured on a forest-wide basis.

Every deployment has a default Enterprise Voice policy that can be edited but not renamed or deleted. Organizations typically define additional policies to meet the needs of various users or groups of users. A single Enterprise Voice policy can be assigned globally to all users in an organization or policies may be assigned individually to users or groups of users. The default voice policy is applied to any user that lacks a valid voice policy assignment.

MSFT_SIPGlobalUCPolicyData

The property values for the MSFT_SIPGlobalUCData class map to the Add Policy and the Edit Policy dialog boxes. These dialog boxes expose property values for policies listed in the Define policies box found on the Policy tab of the Office Communications Server Voice 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 Voice Properties. Clicking Add opens the Add Policy dialog box, and clicking Edit opens the Edit Policy dialog box. The Configure button in either dialog box enables a user to add, remove, edit, and reorder phone usage records in the policy.

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

Dd129947.MSFT_SIPGlobalUCPolicy_DlgDataAddPolicy(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_SIPGlobalUCPolicyData
{
  boolean AllowSimultaneousRinging;
  boolean DefaultPolicy;
  [key] string InstanceID;
  string Name;
  string[] PhoneRouteUsages;
  string PolicyDN;
  string Type;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPGlobalUCPolicyData class has the following properties.

  • AllowSimultaneousRinging
    Data type: boolean

    Access type: Read/Write

    Required. Specifies whether endpoint devices are enabled for simultaneous ringing. Maps to the Allow simultaneous ringing of phones check box in the Add Policy and Edit Policy dialog boxes.

  • DefaultPolicy
    Data type: boolean

    Access type: Read-only

    Required. Indicates whether this is the default policy that is applied to users that lack a globally or explicitly assigned policy. The DefaultPolicy does not appear in the Administration Tool.

    True indicates that this is the default policy.

  • InstanceID
    Data type: [key] string

    Access type: Read-only

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

  • Name
    Data type: string

    Access type: Read/Write

    Required. The name of the policy for this instance of the class. Maps to the Name box in the Add Policy and Edit Policy dialog boxes, and to the Name column of the the Defined policies list box on the Policy tab of the Office Communications Server Voice Properties dialog box.

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

  • PhoneRouteUsages
    Data type: string[]

    Access type: Read/Write

    Optional. An array of MSFT_SIPPhoneRouteUsageData::PhoneRouteUsageDN values. Specifies the ordered list of phone usage records assigned to the voice policy. Maps to the Phone usages list box in the Add Policy and Edit Policy dialog boxes. The order of values in the array determines the order in which phone usage records are listed in the Add Policy and Edit Policy dialog boxes.

    The value of this property is not case-sensitive.

  • PolicyDN
    Data type: string

    Access type: Read-only

    Optional. The distinguished name of the policy. The PolicyDN does not appear in the Administration Tool.

    The value of this property is not case-sensitive.

  • Type
    Data type: string

    Access type: Read/Write

    Required. Indicates the type of the policy. The Type does not appear in the Administration Tool.

    The value of this property is case-sensitive. The only acceptable value is uc.

    Value

    Policy Type

    uc

    Unified Communications

Remarks

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

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, and Front End Server.

Namespace: Defined in \root\cimv2.

See Also

Concepts

Office Communications Server WMI Reference

Other Resources

Assigning Call Privileges for Office Communications Server 2007 R2

Configuring Call Authorizations