New-OABVirtualDirectory (RTM)

Microsoft Exchange Server 2007 will reach end of support on April 11, 2017. To stay supported, you will need to upgrade. For more information, see Resources to help you upgrade your Office 2007 servers and clients.

 

Applies to: Exchange Server 2007

Use the New-OABVirtualDirectory cmdlet to configure a server as a Web distribution point for an offline address book (OAB).

Syntax

New-OabVirtualDirectory [-DomainController <Fqdn>] [-ExternalUrl <Uri>] [-InternalUrl <Uri>] [-Path <String>] [-PollInterval <Int32>] [-RequireSSL <$true | $false>] [-TemplateInstance <PSObject>] [-WebSiteName <String>]

Detailed Description

The New-OABVirtualDirectory cmdlet configures a Client Access server as a Web distribution point for an OAB and creates the OAB virtual directory.

Note

You will have to manually create the file system folder on the server that will host the OAB files.

To run the New-OABVirtualDirectory cmdlet, the account you use must be delegated the following:

  • Exchange Server Administrator role and local Administrators group for the target server

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

Parameters

Parameter Required Type Description

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name (FQDN) of the domain controller that retrieves data from the Active Directory directory service, include the DomainController parameter in the command.

ExternalUrl

Optional

System.Uri

The ExternalUrl parameter specifies the external URL that the OAB virtual directory points to.

InternalUrl

Optional

System.Uri

The InternalUrl parameter specifies the internal URL that the OAB virtual directory points to.

Path

Optional

System.String

The Path parameter specifies the path to the folder that will host the OAB virtual directory.

PollInterval

Optional

System.Int32

The PollInterval parameter specifies the time interval that the distribution service should poll the generation server for new updates (in minutes).

RequireSSL

Optional

System.Boolean

If set to $true, the RequireSSL parameter requires Secure Sockets Layer (SSL) to access the OAB virtual directory.

TemplateInstance

Optional

System.Management.Automation.PSObject

When an existing object is supplied to the TemplateInstance parameter, the command will use that object's configuration to create an exact duplicate of the object on a local or target server

WebSiteName

Optional

System.String

The WebSiteName parameter specifies the name of the Internet Information Services (IIS) Web site under which to create the virtual directory.

Input Types

Return Types

Errors

Error Description

Exceptions

Exceptions Description

Example

This example configures the distribution service to poll the generation server every two hours.

New-OABVirtualDirectory -PollInterval 120