Share via

Managed Email 2007::GetOABCASPools

  • Article

This procedure gets the offline address book (OAB) client access system (CAS) Pool properties in the Active Directory.

Arguments

Input Arguments Type Required Description

<preferredDomainController>

string

Yes

The name of the Active Directory domain controller.

<oabCASPool>

string

No

The name of the OAB CAS Pool.
Output Arguments Type Required Description

<oabCASPools>

complexType

Yes

The OAB CAS Pool list in the Active Directory.

<oabCASPools/ oabCASPool>

complexType

No

The definition of OAB CAS Pool.

<oabCASPools/ oabCASPool/ poolName>

string

No

The name of the OAB CAS Pool.

<oabCASPools/ oabCASPool/ isDefault>

boolean

No

This parameter specifies whether this is a default CAS pool.

<oabCASPools/ oabCASPool/ poolTag>

string

No

A free-form text representing the pool.

Remarks

Security

The caller must be at least a member of role: DomainAdmin.

Schema Definition

Input

<executeData> 
        <preferredDomainController>1..1</preferredDomainController> 
        <oabCASPool>0..1</oabCASPool> 
</executeData>

Output

<executeData> 
    <oabCASPools> 
        1..1 
        <oabCASPool> 
            0..unbounded 
            <poolName>1..1</poolName> 
            <isDefault>1..1</isDefault> 
            <poolTag>1..1</poolTag> 
        </oabCASPool> 
    </oabCASPools> 
</executeData>

Sample Code

Example XML Request

<request> 
  <data> 
    <!--The domain controller to use for Active Directory actions.--> 
    <preferredDomainController>AD01.Fabrikam.Com</preferredDomainController> 
    <!--Name of the OABCASPool.--> 
    <oabCASPool>CasOABPool001</oabCASPool> 
  </data> 
  <procedure> 
    <execute namespace="Managed Email 2007" procedure="GetOABCASPools" impersonate="1"> 
      <before source="data" sourcePath="preferredDomainController" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="oabCASPool" destination="executeData" mode="move" /> 
      <after source="executeData" destination="data" mode="merge" /> 
    </execute> 
  </procedure> 
</request>

Example XML Response

<response> 
  <data> 
    <!--OAB CAS Pool list found in Active Directory.--> 
    <oabCASPools> 
      <!--Property list of an OAB CAS pool.--> 
      <oabCASPool> 
        <!--Name of the OAB CAS pool.--> 
        <poolName>CasOABPool001</poolName> 
        <!--Specify whether the pool is the current default pool.--> 
        <isDefault>false</isDefault> 
        <!--A free form text representing the pool.--> 
        <poolTag>Non HA</poolTag> 
      </oabCASPool> 
    </oabCASPools>     
  </data> 
</response>

Applies To

  • Hosted Messaging and Collaboration version 4.5

See also

Tasks

Managed Email 2007::CreateOABCASPool
Managed Email 2007::GetOABCASPoolDefault
Managed Email 2007::ModifyOABCASPool
Managed Email 2007::RemoveOABCASPool
Managed Email 2007::SetOABCASPoolDefault