Exchange 2007 Provider::GetOABVDir

Article
04/19/2010

This procedure retrieves attributes of an offline adress book (OAB) virtual directory on a client access server (CAS).

Arguments

Input Arguments	Type	Required	Description
<preferredDomainController>	string	Yes	The domain controller to use for Active Directory actions.
<path>	string	Yes	The Lightweight Directory Access Protocol (LDAP) path of the user object from which the mailbox attributes will be retrieved.

Output Arguments	Type	Description
<oabVDirs>	complexType	The domain controller to use for Active Directory actions.
<oabVDir>	complexType	The definition of an OAB virtual directory element.
<name>	string	The name of the OAB virtual directory.
<internalUrl>	string	The internal URL that the OAB virtual directory points to. Although this URL is not accessible by hosted service users, the underlying cmdlet requires it.
<externalUrl>	string	The external URL that the OAB virtual directory points to. This URL is returned by Auto Discover service.
<path>	string	The path to the folder that will host the OAB virtual directory.
<pollInterval>	integer	The time interval that the distribution service should poll the generation server for new updates (in minutes).
<ssl>	boolean	If this value set to True, SSL is required to access the OAB virtual directory.
<oabs>	complexType	The OAB on this virtual directory.
<oab>	string	The name of the OAB in the list.

Remarks

Although provisioning system only uses one virtual directory on a CAS server, the Exchange Server 2007 Service Pack 1 supports multiple virtual directories. So the output may have more than one virtual directory. Only the first one will be used in the provisioning system.

Schema Definition

Input

<executeData> 
        <preferredDomainController>1..1</preferredDomainController> 
        <server>1..1</server> 
</executeData>

Output

<executeData> 
<oabVDirs> 
    1..1 
    <oabVDir> 
        0..unbounded 
        <name>1..1</name> 
        <internalUrl>1..1</internalUrl> 
        <externalUrl>1..1</externalUrl> 
        <path>1..1</path> 
        <pollInterval>1..1</pollInterval> 
        <ssl>1..1</ssl> 
        <oabs> 
            1..1 
            <oab>0..unbounded</oab> 
        </oabs> 
    </oabVDir> 
</oabVDirs> 
</executeData>

Sample Code

Example XML Request

<request> 
  <data> 
    <!--The domain controller to use for Active Directory actions.--> 
    <preferredDomainController>AD01.Fabrikam.Com</preferredDomainController> 
    <!--Specifies the destination CAS server on which to retrieve the virtual directories.--> 
    <server>EXCASOAB01</server> 
  </data> 
  <procedure> 
    <execute namespace="Exchange 2007 Provider" procedure="GetOABVDir" impersonate="1"> 
      <before source="data" sourcePath="preferredDomainController" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="server" destination="executeData" mode="move" /> 
      <after source="executeData" destination="data" mode="merge" /> 
    </execute> 
  </procedure> 
</request>

Example XML Response

<response> 
  <data> 
    <!--Collection of virtual directories.--> 
    <oabVDirs> 
      <!--Details of a virtual directory--> 
      <oabVDir> 
        <!--Name of the OAB virtual directory.--> 
        <name>OAB (Default Web Site)</name> 
        <!--The internal URL that the OAB Virtual directory points to.--> 
        <internalUrl>https://excasoab01.fabrikam.com/oab</internalUrl> 
        <!--The external URL that the OAB Virtual directory points to.--> 
        <externalUrl>https://excasoab01.alpineskihouse.com/oab</externalUrl> 
        <!--The path to the folder that will host the OAB virtual directory.--> 
        <path>C:\Program Files\Microsoft\Exchange Server\ClientAccess\OAB</path> 
        <!--The time interval that the distribution service should poll the generation server for new updates (in minutes).--> 
        <pollInterval>480</pollInterval> 
        <!--Specify whether to require SSL to access to OAB virtual directories.--> 
        <ssl>true</ssl> 
        <!--OAB served on this virtual directory.--> 
        <oabs> 
          <!--Name of the OAB in the list.--> 
          <oab>AlpineSkiHouse OAL</oab> 
        </oabs> 
      </oabVDir> 
    </oabVDirs> 
  </data> 
</response>

Applies To

Exchange 2007 Provider Namespace for:

Hosted Messaging and Collaboration version 4.5

Share via