Hosted Office Communications Server::GetPoolProperties

This procedure retrieves the properties of a pool.

Use this procedure to retrieve a pool's properties from the Office Communications Server.

Arguments

Remarks

Security

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

Permission Check

This procedure does not need to perform an explicit permission check. The procedure calls Managed Plans::GetPoolProperties which performs a check for Domain Administrator.

Preconditions

None.

Business Rules

None.

Post-conditions

• The properties of the specified pool are retrieved.

• If no pool matches, no properties are returned.

Sequence Narrative

1. Actor submits GetPoolProperties request to the Hosted Office Communications Server namespace.

2. GetPoolProperties calls Managed Office Communications Server::GetPoolProperties.

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="Hosted 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 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 distinguished 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

Hosted Office Communications Server Namespace API for:

• Hosted Messaging and Collaboration version 4.5