Export (0) Print
Expand All
Expand Minimize

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 settings for a specific Active Directory user in the context of SIP.

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_SIPESUserSetting
{
  boolean AllowOrganizeMeetingWithAnonymousParticipants;
  boolean ArchiveFederatedCommunications;
  boolean ArchiveInternalCommunications;
  string ContactType;
  string DisplayName;
  boolean Enabled;
  boolean EnabledForEnhancedPresence;
  boolean EnabledForFederation;
  boolean EnabledForInternetAccess;
  string HomeServerDN;
  [key] string InstanceID;
  boolean IPPBXSoftPhoneRoutingEnabled;
  string LineServerURI;
  string LineURI;
  string MeetingPolicy;
  string PrimaryURI;
  boolean PublicNetworkEnabled;
  boolean RemoteCallControlTelephonyEnabled;
  string TargetServerDNIfMoving;
  boolean UCEnabled;
  string UCPolicy;
  string UserCategory;
  string UserDN;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPESUserSetting class has the following properties.

AllowOrganizeMeetingWithAnonymousParticipants

Data type: boolean

Access type: Read/Write

Optional. Controls whether the user is permitted to organize meetings that include anonymous participants.

ArchiveFederatedCommunications

Data type: boolean

Access type: Read/Write

Optional. Controls whether a user's communications across federated domains are archived.

The default value is false.

ArchiveInternalCommunications

Data type: boolean

Access type: Read/Write

Optional. Controls whether a user's communications within their internal domain are archived.

The default value is false.

ContactType

Data type: string

Access type: Read-only

Optional. When the UserCategory property is set to contact, ContactType specifies whether the contact is an auto attendant (AA) or a normal (default) contact.

Value

Description

"default"

The contact is a normal contact.

"AA"

The contact is an auto attendant.

DisplayName

Data type: string

Access type: Read-only

Optional. The display name for this user as registered on the home server.

The value can be NULL, but if specified, it must be the actual display name of the user as specified in Active Directory (both for create and update operations). The value of this property is not case-sensitive.

Enabled

Data type: boolean

Access type: Read/Write

Required. If true, this user is enabled for Office Communications Server; if false, the user does not have specific support under SIP.

EnabledForEnhancedPresence

Data type: boolean

Access type: Read/Write

Optional. Controls whether the user is enabled for enhanced presence.

When using WMI to enable new users whose client is Office Communicator 2007, this property must be set to true to enable them to log on to Office Communications Server 2007.

After this property is set to true for a user, it is not possible to set this property back to false for that user. An attempt to set this property from true to false for a user returns an error.

The default value is false.

EnabledForFederation

Data type: boolean

Access type: Read/Write

Optional. Controls whether the user is enabled for federation.

The default value is false.

EnabledForInternetAccess

Data type: boolean

Access type: Read/Write

Optional. Controls whether the user is enabled for Internet access.

The default value is false.

HomeServerDN

Data type: string

Access type: Read/Write

Required. The distinguished name of the Office Communications Server pool or server for this user.

This name must be valid within the domain's Active Directory. The value of this property is not case-sensitive.

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

IPPBXSoftPhoneRoutingEnabled

Data type: boolean

Access type: Read/Write

Optional. Controls whether the user's phone calls that are placed using a soft phone are routed through a PBX.

The default value is false.

LineServerURI

Data type: string

Access type: Read/Write

Optional. The SIP URI of the telephony gateway server assigned to this user for remote-call control (RCC).

A valid SIP URI uses the following form: sip:abc@pbx1.phones.microsoft.com

This property is not indexed, but is marked for global container replication.

If RemoteCallControlTelephoneyEnabled is true, then this value cannot be NULL.

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

LineURI

Data type: string

Access type: Read/Write

Optional. Either the SIP URI or the Tel. URI of the user's phone line.

This value is used by the Microsoft Office Communicator client and by Enterprise Voice for call routing.

A valid SIP URI uses the following form: sip:+14255550100@phones.fabrikam.com;user=phone This SIP URI value must be unique.

A valid Tel. URI uses the following form: tel:+14255550111;ext=50111;attribute=telephone number

This property is indexed and marked for global container replication.

If RemoteCallControlTelephoneyEnabled is true, then this value cannot be NULL.

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

MeetingPolicy

Data type: string

Access type: Read/Write

Optional. Specifies the distinguished name of the meeting policy that applies to the user.

The value of this property is not case-sensitive.

PrimaryURI

Data type: string

Access type: Read/Write

Required. The primary SIP URI of the user.

This URI must be unique and must be represented in the form "sip:user@domain" where the domain substring is a fully qualified domain name.

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

PublicNetworkEnabled

Data type: boolean

Access type: Read/Write

Optional. Controls whether the user is able to exchange instant messages with other users who are hosted by one or more public IM service providers.

The default value is false.

RemoteCallControlTelephonyEnabled

Data type: boolean

Access type: Read/Write

Optional. Controls whether the user is able to use the Microsoft Office Communicator client in combination with the user's computer to initiate, receive, and forward phone calls.

If true, the user is authorized for remote call control. If false, the user is not authorized for remote call control. If the value is true, LineURI and LineServerURI cannot be null.

The default value is false.

TargetServerDNIfMoving

Data type: string

Access type: Read-only

Optional. The distinguished name of the target server to which the Active Directory user object is moving, if a user move is in progress.

The value of this property is not case-sensitive.

UCEnabled

Data type: boolean

Access type: Read/Write

Optional. Controls whether the user is enabled for Enterprise Voice (VoIP).

The default value is true.

UCPolicy

Data type: string

Access type: Read/Write

Optional. Specifies the distinguished name of the Unified Communications (UC) policy that applies to the user.

The value of this property is not case-sensitive.

UserCategory

Data type: string

Access type: Read-only

Optional. Indicates whether the user is represented in Active Directory by a User object, a Contact object, or an inetOrgPerson object.

Value

Description

"user"

The Active Directory object is, or is derived from, a User object.

"contact"

The Active Directory object is, or is derived from, a Contact object.

"inetOrgPerson"

The Active Directory object is, or is derived from, an inetOrgPerson object, which can represent any user who is associated with an organization in some way.

The value of this property is not case-sensitive.

UserDN

Data type: string

Access type: Read-only

Required. The distinguished name of the corresponding Active Directory user object for this user.

The value of this property is not case-sensitive.

Remarks

This class gets and sets information at the following level(s): AD (Active Directory).

Instances of this class support the following interface methods:

  • Provider::DeleteInstance();

  • Provider::EnumerateInstances();

  • Provider::GetObject();

  • Provider::PutInstance();

    Where PutInstance() supports the following flag(s):

    • WBEM_FLAG_CREATE_OR_UPDATE

Requirements

Server: Installed on computers serving the following role(s): Administrative Tools Server, Front End Server, Proxy Server, Web Components Server.

Namespace: Defined in \root\cimv2.

Show:
© 2014 Microsoft