Share via

Managed Office Communications Server::AddSharedPool

  • Article

This procedure adds an Office Communications pool to the shared pools list.

Arguments

Input argument Required Type Description

<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 being added to the list of shared pools.

<poolTag>

Yes

xs:string

The tag name representing the pool.
Output argument Type Description

<poolDN>

xs:string

The distinguished name of the pool.

Remarks

Security

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

Permission Check

This procedure will perform a test for Domain Administrator.

Preconditions

The Pool FQDN can be located in Active Directory.

Business Rules

Adding the same Pool FQDN name multiple times should succeed.

Post-conditions

  • The pool is added to the Shared pools list.

  • Pool status is set to "Available".

Sequence Narrative

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

  2. The Managed Office Communications Server namespace calls Managed Office Communications Server::GetPoolProperties to retrieve the Pool's DN by its FQDN.

  3. Try: The Managed Office Communications Server namespace calls the Managed Helpers::CreateServicePointer_ to add the Pool.

  4. Catch: If an error (0x80004005) occurs in the above step and it is because the Service Pointer exists already, the error is suppressed using Managed Active Directory::RethrowError_.

  5. The pool DN is returned.

Sample Code

Example XML Request

<request> 
  <data> 
    <!--The preferred domain controller for Active Directory operations.--> 
    <preferredDomainController>AD01.Fabrikam.com</preferredDomainController> 
    <!--The fully qualified domain name (FQDN) of the pool being added to the list of shared pools.--> 
    <poolFQDN>pool01.fabrikam.com</poolFQDN> 
    <!--The tag name representing the pool.--> 
    <poolTag>LabA</poolTag> 
  </data> 
  <procedure> 
    <execute namespace="Managed Office Communications Server" procedure="AddSharedPool" impersonate="1"> 
      <before source="data" sourcePath="preferredDomainController" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="poolFQDN" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="poolTag" destination="executeData" mode="move" /> 
      <after source="executeData" destination="data" mode="merge" /> 
    </execute> 
  </procedure> 
</request>

Example XML Response

<response> 
  <data> 
    <!--The distinguished name of the pool.--> 
    <poolDN>CN=LC Services,CN=Microsoft,CN=Pool,CN=Pools,CN=RTC Service,CN=Microsoft,CN=System,DC=fabrikam,DC=com</poolDN> 
  </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::RemoveSharedPool
Managed Office Communications Server::DeleteSharedPool
Managed Office Communications Server::SetSharedPoolProperties
Managed Office Communications Server::GetSharedPools