MSFT_SIPLocationProfileData

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

Enables you to add or revise location profiles for implementation of Enterprise Voice at locations across your organization.

The property values for the MSFT_SIPLocationProfileData class map to the settings found in the Add Location Profile or Edit Location Profiles dialog boxes. You can access these values in the Office Communications Server 2007 R2 Administration Tool by right-clicking Forest, pointing to Properties, and then clicking Voice Properties. In the Office Communications Server Voice Properties dialog box, click the Location Profiles tab, then either select an existing phone route and click Edit or click New to create a new phone route.

MSFT_SIPLocationProfileData

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_SIPLocationProfileData
{
  string Description;
  boolean ExternalAccessPrefix;
  [key] string InstanceID;
  string Name;
  string[] NormalizationRules;
  boolean OptimizeDeviceDialing;
  string ProfileDN;
  string[] TrustedServerReference;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPLocationProfileData class has the following properties.

  • Description
    Data type: string

    Access type: Read/Write

    Optional. A description of the property settings that are specified by a particular instance of this class.

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

    The Description property maps to the Description text box in the Add Location Profile or the Edit Location Profile dialog box.

  • ExternalAccessPrefix
    Data type: string

    Access type: Read/Write

    Optional. Specifies an external access prefix of up to four characters (#, *, and 0-9) that is used when the OptimizeDeviceDialing property is set to True.

    The maximum length of the string is 4 characters.

    The ExternalAccessPrefix property maps to the External access prefix text box in the Add Location Profile or the Edit Location Profile dialog box.

  • InstanceID
    Data type: [key] string

    Access type: Read-only

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

    The InstanceID property does not map to the Add Location Profile or the Edit Location Profile dialog box.

  • Name
    Data type: string

    Access type: Read/Write

    Required. The name of the profile.

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

    The Name property maps to the Name text box in the Add Location Profile or the Edit Location Profile dialog box.

  • NormalizationRules
    Data type: string[]

    Access type: Read/Write

    Optional. An array of MSFT_SIPLocalNormalizationRuleData::NormalizationRuleDN values that identify the normalization rules in this location profile.

    The values for this property are not case-sensitive.

    The NormalizationRules property maps to the Normalization Rules list box in the Add Location Profile or the Edit Location Profile dialog box.

  • OptimizeDeviceDialing
    Data type: boolean

    Access type: Read/Write

    Optional. Specifies whether a device using this location profile can optimize dialing.

    The external access prefix specified by ExternalAccessPrefix can be used by the device when this property is set to True.

    The default value for this property is False.

    The OptimizeDeviceDialing property maps to the Optimize device dialing checkbox in the Add Location Profile or the Edit Location Profile dialog box.

  • ProfileDN
    Data type: string

    Access type: Read-only

    Optional. The distinguished name of the profile.

    The value of this property is not case-sensitive.

    The ProfileDN property does not map to the Add Location Profile or the Edit Location Profile dialog box.

  • TrustedServerReference
    Data type: string[]

    Access type: Read-only

    Optional. References SIPLocationContactMapping objects.

    This property is used internally by Microsoft Management Console (MMC) when an administrator attempts to delete a location profile to check whether any application contacts are mapped to this object.

    The value of this property is not case-sensitive.

    The TrustedServerReference property does not map to the Add Location Profile or the Edit Location Profile dialog box.

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

Namespace: Defined in \root\cimv2.

See Also

Concepts

Office Communications Server WMI Reference