MSFT_SIPESUserSetting
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 property values for the MSFT_SIPESUserSetting class map to the settings found in the user Properties dialog box. You can access these values in the Office Communications Server 2007 R2 Administration Tool by expanding Forest, expanding either to Enterprise pools or Standard Edition Servers (depending on whether you are running the Enterprise or Standard edition of Office Communications Server), and expanding the pool or server name, and then clicking Users. From there you can then right click the name of a users and then click Properties. In addition to the Properties dialog box itself (which lists basic account information, such as the user's SIP address and home server) you can click the appropriate buttons and view the following dialog boxes:
Meeting Options. Use this dialog box to specify settings for conferences organized by the user. You cannot configure the settings on this page unless the settings on the Meetings tab in Office Communications Server Global Properties are configured to use per user settings.
Other Options. Use this dialog box to enable federation, archiving, or enhanced presence for the user.
Telephony Options. Use this dialog box to specify settings for the calls sent to or from a media gateway for the user.
MSFT_SIPESUserSetting
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 LocationProfile;
string MeetingPolicy;
string PresencePolicy;
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: booleanAccess type: Read/Write
Optional. Controls whether the user is permitted to organize meetings that include anonymous participants.
The AllowOrganizeMeetingsWithAnonymousParticipants property maps to the Allow anonymous participants checkbox in the Meeting Options dialog box.
ArchiveFederatedCommunications
Data type: booleanAccess type: Read/Write
Optional. Controls whether a user's communications across federated domains are archived.
The default value is False.
The ArchiveFederatedCommunications property maps to the Archive federated IM conversations checkbox in the Other Options dialog box.
ArchiveInternalCommunications
Data type: booleanAccess type: Read/Write
Optional. Controls whether a user's communications within their internal domain are archived.
The default value is False.
The ArchiveInternalCommunications property maps to the Archive internal IM conversations checkbox in the Other Options dialog box.
ContactType
Data type: stringAccess 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.
The ContactType property does not map to the Administration Tool user interface.
DisplayName
Data type: stringAccess 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.
The DisplayName property does not map to any of the user property dialog boxes. However, this value is shown in the Status pane under the heading Display Name.
Enabled
Data type: booleanAccess 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.
The Enabled property maps to the Enable user for Office Communications Server checkbox in the user Properties dialog box.
EnabledForEnhancedPresence
Data type: booleanAccess 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 R2, this property must be set to True to enable them to log on to Office Communications Server 2007 R2.
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.
The EnableForEnhancedPresence property maps to the Enable enhanced presence checkbox in the Other Options dialog box.
EnabledForFederation
Data type: booleanAccess type: Read/Write
Optional. Controls whether the user is enabled for federation.
The default value is False.
The EnableForFederation property maps to the Enable federation checkbox in the Other Options dialog box.
EnabledForInternetAccess
Data type: booleanAccess type: Read/Write
Optional. Controls whether the user is enabled for Internet access.
The default value is False.
The EnableForInternetAccess property maps to the Enable remote user access checkbox in the Other Options dialog box.
HomeServerDN
Data type: stringAccess 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.
The HomeServerDN property maps to the Server or pool dropdown list in the user Properties dialog box.
InstanceID
Data type: [key] stringAccess 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 User property does not map to the Administration Tool user interface.
IPPBXSoftPhoneRoutingEnabled
Data type: booleanAccess 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.
The IPPBXSoftPhoneRoutingEnabled property maps to the Enable PBX integration checkbox in the Telephony Options dialog box.
LineServerURI
Data type: stringAccess 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 RemoteCallControlTelephonyEnabled is True, this value cannot be NULL.
The value of this property is not case-sensitive. The maximum length of the string is 454 characters.
The LineServerURI property maps to the Server URI text box in the Telephony Options dialog box.
LineURI
Data type: stringAccess type: Read/Write
Optional. Either the SIP URI or the Tel. The 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. The URI uses the following form: +14255550111;ext=50111;attribute=telephone number
This property is indexed and marked for global container replication.
If RemoteCallControlTelephonyEnabled is True, this value cannot be NULL.
The value of this property is not case-sensitive. The maximum length of the string is 454 characters.
The LineURI property maps to the Line URI text box in the Telephony Options dialog box.
LocationProfile
Data type: stringAccess type: Read/Write
Optional. The distinguished name (DN) that points to a location profile object of the user.
The LocationProfile property maps to the Location profile dropdown list in the Telephony Options dialog box.
MeetingPolicy
Data type: stringAccess 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.
The MeetingPolicy property maps to the Policy dropdown list in the Meeting Options dialog box.
PresencePolicy
Data type: stringAccess type: Read/Write
Optional. Specifies the distinguished name of the presence policy that applies to the user.
The value of this property is not case-sensitive.
The PresencePolicy property does not map to the Administration Tool user interface.
PrimaryURI
Data type: stringAccess 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.
The PrimaryURI property maps to the Sign-in name text box in the user Properties dialog box.
PublicNetworkEnabled
Data type: booleanAccess 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.
The PublicNetworkEnabled property maps to the Enable public IM connectivity checkbox in the Other Options dialog box.
RemoteCallControlTelephonyEnabled
Data type: booleanAccess 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.
The RemoteCallControlTelephonyenabled property maps to the Enable Remote call control checkbox in the Telephony Options dialog box.
TargetServerDNIfMoving
Data type: stringAccess 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.
The TargetServerDNIfMoving property does not map to the Administration Tool user interface.
UCEnabled
Data type: booleanAccess type: Read/Write
Optional. Controls whether the user is enabled for Enterprise Voice (VoIP).
The default value is True.
The UCEnabled property maps to the Enable Enterprise Voice checkbox in the Telephony Options dialog box.
UCPolicy
Data type: stringAccess 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.
The UCPolicy property maps to the Policy dropdown list in the Telephony Options dialog box.
UserCategory
Data type: stringAccess 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
Active Directory Object / Or Derived From
user
A User object.
contact
A Contact object.
inetOrgPerson
An inetOrgPerson object, which can represent any user who is associated in some way with an organization.
The value of this property is not case-sensitive.
The UserCategory property does not map to the Properties dialog box. However, the value does appear in the Status pane under the heading Type.
UserDN
Data type: stringAccess 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.
The UserDN property does not map to the Administration Tool user interface.
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 flag:
- WBEM_FLAG_CREATE_OR_UPDATE
Requirements
Server: Installed on computers serving the following roles: Administrative Tools Server, Front End Server, Proxy Server, and Web Components Server.
Namespace: Defined in \root\cimv2.