Share via

Managed Office Communications Server::SetSharedPoolProperties

  • Article

This procedure sets properties for a shared Office Communications Server pool.

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>

No

xs:string

The tag name representing 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 has been added into Shared Pools list.

Business Rules

Calling this procedure multiple times should succeed.

Post-conditions

The poolproperty should be set to the value specified in the input parameter.

Sequence Narrative

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

  2. The Managed Office Communications Server namespace calls private procedure SetSharedPoolProperties_ to set specified parameters except "poolStatus" which is not exposed to public.

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="SetSharedPoolProperties" 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 /> 
</response>

Applies To

Managed Office Communications Server Namespace API for:

  • Hosted Messaging and Collaboration version 4.5

See also

Tasks

Managed Office Communications Server::AddSharedPool
Managed Office Communications Server::RemoveSharedPool
Managed Office Communications Server::DeleteSharedPool
Managed Office Communications Server::GetSharedPools