Share via

Managed Office Communications Server::SetPoolAssignment

  • Article

This procedure assigns an Office Communications Server pool to the specified organization. The pool will be used as the preferred pool assignment when SIP enabling users.

Arguments

Input argument Required Type Description

<organization>

Yes

xs:string

The Lightweight Directory Access Protocol (LDAP) path of the organization.

<preferredDomainController>

Yes

xs:string

The domain controller to use for Active Directory actions.

<poolFQDN>

Yes

xs:string

The fully qualified domain name (FQDN) of the pool.

Remarks

Security

The caller must be at least a member of role: Customer Administrator

Permission Check

This procedure will perform a test for Customer Administrator (UserCreators).

Preconditions

  • The organization exists in Active Directory.

  • The pool exists.

Post-conditions

The organization will have an OWKO set to the pool.

Sequence Narrative

  1. Actor submits SetPoolAssignment request to the Managed Office Communications Server namespace.

  2. SetPoolAssignment calls Office Communications Provider::GetPoolProperties to retrieve the path of the pool.

  3. ManagedOCS::GetPoolOWKOGUID is called to retrieve the GUID used to identify the OWK entry.

  4. The OWKO of the pool is stamped on the organization's otherWellKnownObjects property using the pool DN with a call to Managed Active Directory::SetOtherWellKnownObject_.

Sample Code

Example XML Request

<request> 
  <data> 
    <!--LDAP path of the organization.--> 
    <organization>LDAP://OU=AlpineSkiHouse,OU=ConsolidatedMessenger,OU=Hosting,DC=Fabrikam,DC=Com</organization> 
    <!--The domain controller to use for Active Directory actions.--> 
    <preferredDomainController>AD01.Fabrikam.Com</preferredDomainController> 
    <!--FQDN of the pool.--> 
    <poolFQDN>pool01.fabrikam.com</poolFQDN> 
  </data> 
  <procedure> 
    <execute namespace="Managed Office Communications Server" procedure="SetPoolAssignment" impersonate="1"> 
      <before source="data" sourcePath="organization" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="preferredDomainController" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="poolFQDN" destination="executeData" mode="move" /> 
      <after source="executeData" destination="data" mode="merge" /> 
    </execute> 
  </procedure> 
</request>

Example XML Response

<response>  
  <data /> 
</response>

Applies To

Managed Office Communications Server Namespace API for:

  • Hosted Messaging and Collaboration version 4.5

See also

Tasks

Managed Office Communications Server::DeletePoolAssignment
Managed Office Communications Server::GetPoolAssignment