Share via

Set-OABVirtualDirectory (RTM)

  • Article

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 Set-OABVirtualDirectory cmdlet to change configuration settings for an offline address book (OAB) virtual directory.

Syntax

Set-OabVirtualDirectory -Identity <VirtualDirectoryIdParameter> [-DomainController <Fqdn>] [-ExternalUrl <Uri>] [-InternalUrl <Uri>] [-PollInterval <Int32>] [-RequireSSL <$true | $false>]

Set-OabVirtualDirectory [-DomainController <Fqdn>] [-ExternalUrl <Uri>] [-Instance <ADOabVirtualDirectory>] [-InternalUrl <Uri>] [-PollInterval <Int32>] [-RequireSSL <$true | $false>]

Detailed Description

This Set-OABVirtualDirectory cmdlet allows you to change the configuration of an OAB web distribution point on a Client Access server.

To run the Set-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

Identity

Required

Microsoft.Exchange.Configuration.Tasks.VirtualDirectoryIdParameter

Use the Identity parameter to specify the GUID, distinguished name or offline address book virtual directory name that represents a specific offline address book virtual directory. You can also include the path by using the format Server\OfflineAddressBookVirtualDirectoryName.

You can omit the parameter label Identity so that only the offline address book virtual directory name or GUID is supplied.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

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

ExternalUrl

Optional

System.Uri

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

Instance

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.ADOabVirtualDirectory

The Instance parameter enables you to pass an entire object to the command to be processed. It is mainly used in scripts where an entire object must be passed to the command.

InternalUrl

Optional

System.Uri

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

PollInterval

Optional

System.Int32

The time interval which the distribution service should poll the generation server for new updates (in minutes).

RequireSSL

Optional

System.Boolean

When set to $true, this parameter requires that a Secure Sockets Layer (SSL) is used when accessing the OAB virtual directory.

Input Types

Return Types

Errors

Error Description

Exceptions

Exceptions Description

Example

This example sets the OAB virtual directory external web address.

Set-OABVirtualDirectory -Identity "Server1\OAB (Default Web Site)" -ExternalURL "https://www.contoso.com/OAB"