Managed Office Communications Server::GetPoolProperties

Article
04/19/2010

This procedure retrieves a pool's properties from the Office Communications Server.

Arguments

Input argument	Required	Type	Description
<poolFQDN>	Yes	xs:string	The fully qualified domain name (FQDN) of a pool.
<preferredDomainController>	Yes	xs:string	The domain controller to use for Active Directory actions.

Output argument	Type	Description
<backEndDBPath>	xs:string	This parameter specifies the fully qualified domain name (FQDN) of the back-end server of the pool.
<defaultLocationProfile>	xs:string	This parameter contains the distinguished name of a location profile class object assigned to the pool. This is the forward link.
<DomainFQDN>	xs:string	The value of this parameter, when present, represents the pool's domain FQDN if the administrator wants to create an Enterprise pool with an FQDN that does not conform to the Active Directory domain structure in which the Enterprise pool is created (for example, a SIP namespace disjoined from DNS namespace).
<instanceID>	xs:string	A GUID value that uniquely identifies an instance of this class.
<majorVersion>	xs:integer	This parameter defines the major version of the pool.
<mcuFactoryList>		A list of the distinguished names of the MCU Factories that this pool supports.
<mcuFactoryList/ mcuFactory>	xs:string	The distinguished name of a MCU Factorie that this pool supports.
<poolDisplayName>	xs:string	An arbitrary name for a pool that is displayed by the management console.
<poolDN>	xs:string	The distinguished name of the pool.
<poolMemberList>		Collection of pool services.
<poolMember>	xs:string	A FQDN representing the service connection point of a pool.
<poolType>	xs:string	This parameter specifies whether a server pool is a Home Server Pool, or a Front End Pool.
<supportIMPresence>	xs:boolean	This parameter defines whether the pool is capable of IM and presence.
<supportMeeting>	xs:boolean	This parameter defines whether the pool is capable of meetings.
<trustedMRASServer>	xs:string	The distinguished name that references a trusted MRAS service object associated with the pool.
<trustedQoSServer>	xs:string	The distinguished name that references a trusted QoS service object associated with the pool.
<webComponentsServerList>		A list of the distinguished names of the Web servers that this pool supports.
<webComponentsServerList/ webComponentsServer>	xs:string	The distinguished name of a Web server that this pool supports.

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 (DomainAdmin).

Business Rules

If no pools are found, an empty <pools> collection is returned.

Sequence Narrative

Actor submits GetPoolProperties request to the Managed Office Communications Server namespace.
The Managed Office Communications Server namespace calls the Office Communcations Server Provider::GetPoolProperties procedure.

Sample Code

Example XML Request

<request> 
  <data> 
    <!--The fully qualified domain name (FQDN) of a pool--> 
    <poolFQDN>pool01.fabrikam.com</poolFQDN> 
    <!--The domain controller to use for Active Directory actions--> 
    <preferredDomainController>AD01.Fabrikam.Com</preferredDomainController> 
  </data> 
  <procedure> 
    <execute namespace="Managed Office Communications Server" procedure="GetPoolProperties" impersonate="1"> 
      <before source="data" sourcePath="poolFQDN" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="preferredDomainController" destination="executeData" mode="move" /> 
      <after source="executeData" destination="data" mode="merge" /> 
    </execute> 
  </procedure> 
</request>

Example XML Response

<response> 
  <data> 
    <!--Specifies the FQDN of the back-end server of the pool--> 
    <backEndDBPath>MPSSQL</backEndDBPath> 
    <!--Contains the distinguished name of a location profile class object assigned to the pool. This is the forward link--> 
    <defaultLocationProfile>CN={FA07C909-B535-4F5C-A398-B518DFEB0E63},CN=Location Profiles,CN=RTC Service,CN=Microsoft,CN=System,DC=fabrikam,DC=com</defaultLocationProfile> 
    <!--The value of this parameter, when present, represents the pool's domain FQDN if the administrator wants to create an Enterprise pool with an FQDN that does not conform to the Active Directory domain structure in which the Enterprise pool is created (for example, a SIP namespace disjoined from DNS namespace)--> 
    <domainFQDN>fabrikam.com</domainFQDN> 
    <!--A GUID value that uniquely identifies an instance of this class--> 
    <instanceID>{01234567-0123-4567-89AB-CDEF0123456}</instanceID> 
    <!--Defines the major version of the pool--> 
    <majorVersion>3</majorVersion> 
    <!--Defines the major version of the pool--> 
    <majorVersion>3</majorVersion> 
    <!--Defines the minor version of the pool--> 
    <minorVersion>0</minorVersion> 
    <!--Container for mcu factory list.--> 
    <mcuFactoryList> 
      <!--A mcu factory.--> 
      <mcuFactory>CN={DA9F31E7-47CD-4DAB-875B-F86630C5B44A},CN=MCU Factories,CN=RTC Service,CN=Microsoft,CN=System,DC=fabrikam,DC=com</mcuFactory> 
    </mcuFactoryList> 
    <!--Specifies an arbitrary name for a pool that is displayed by the management console--> 
    <poolDisplayName>OcsPool01</poolDisplayName> 
    <!--The distinguished name of the pool--> 
    <poolDN>CN=LC Services,CN=Microsoft,CN=OcsPool01,CN=Pools,CN=RTC Service,CN=Microsoft,CN=System,DC=fabrikam,DC=com</poolDN> 
    <!--Collection of pool services--> 
    <poolMemberList> 
      <!--A FQDN representing the service connection point of a pool--> 
      <poolMember>OCSHOME1.fabrikam.com</poolMember> 
    </poolMemberList> 
    <!--Specifies whether a server pool is a Home Server Pool, or a Front End Pool--> 
    <poolType>FEPool</poolType> 
    <!--Defines whether the pool is capable of IM and presence--> 
    <supportIMPresence>true</supportIMPresence> 
    <!--Defines whether the pool is capable of meetings--> 
    <supportMeeting>true</supportMeeting> 
    <!--The name that references a trusted MRAS service object associated--> 
    <trustedMRASServer>MRAServer.fabrikam.com</trustedMRASServer> 
    <!--The name that references a trusted QoS service object associated with the pool--> 
    <trustedQoSServer>QoSServer.fabrikam.com</trustedQoSServer> 
    <!--Container for the web components servers.--> 
    <webComponentsServerList> 
      <!--The name that references a web components server associated.--> 
      <webComponentsServer>CN=LS WebComponents Service,CN=Microsoft,CN=OCS01,CN=Computers,DC=fabrikam,DC=com</webComponentsServer> 
    </webComponentsServerList> 
  </data> 
</response>

Applies To

Managed Office Communications Server Namespace API for:

Hosted Messaging and Collaboration version 4.5

Share via

Managed Office Communications Server::GetPoolProperties

Arguments

Remarks

Sample Code

Applies To

Additional resources