Hosted Live Communications::EnableUser
The EnableUser procedure enables a user object for Live Communications Server 2005.
Arguments
Input argument | Required | Type | Description |
---|---|---|---|
<path> |
Yes |
xs:string |
The Lightweight Directory Access Protocol (LDAP) path of the user. |
<preferredDomainController> |
Yes |
xs:string |
The name of the preferred domain controller. |
<planName> |
Yes |
xs:string |
A valid plan name to assign to the user. |
<serverPool>/<name> |
No |
The common name of the user's Live Communications Server 2005 home server pool. Typically not provided because the Live Communications Server 2005 Resource Manager will automatically select a home server pool from resource manager pool. If provided, this server pool will be used. However, the common name must be a valid Live Communications Server 2005 server, it must have been previously added to the resource pool, and must also have available capacity for the user. |
|
<algorithm> |
No |
xs:string |
Specifies the algorithm used when selecting a Server Pool. Valid values are "level" or "tightPack" with tighPack being the default if a value is not specified. The "tightPack" value attempts to use the smallest number of server pools for the system as a whole by adding a user to the server pool with the least amount of available space. The "level" value attempts to evenly distribute users across the server pools by selecting the pool with the most amount of available space. |
Remarks
Process Steps
The following processes occur to enable a user with the EnableUser procedure:
Add a Plan to the User.
Get Plan settings.
Allocate user to ServerPool.
Managed Live Communications::EnableUser.
Log event in Plans database.
Security
The EnableUser procedure has the following security requirements:
- The caller is impersonated.
Sample Code
Example XML Request
The following is an example of an XML request for the EnableUser procedure of the Hosted Live Communication Namespace:
<request>
<procedure>
<execute namespace="Hosted Live Communications" procedure="EnableUser" impersonate="1">
<executeData>
<path>LDAP://CN=jimc@alpineskihouse.com,OU=alpineskihouse,
OU=consolidatedmessenger,OU=Hosting,DC=fabrikam,DC=Com</path>
<preferredDomainController>AD01.fabrikam.COM
</preferredDomainController>
<planName>LCSBasic</plaName>
</executeData>
<after source="executeData" destination="data" mode="merge"/>
</execute>
</procedure>
</request>
Example XML Response
No example XML response.
Applies To
Hosted Live Communications Namespace API for:
Hosted Messaging and Collaboration version 3.5
Hosted Messaging and Collaboration version 3.0