Share via

New-OfflineAddressBook (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 New-OfflineAddressBook cmdlet to create a new offline address book (OAB).

Syntax

New-OfflineAddressBook -Name <String> -AddressLists <AddressBookBaseIdParameter[]> -Server <ServerIdParameter> [-DiffRetentionPeriod <Nullable>] [-DomainController <Fqdn>] [-IsDefault <$true | $false>] [-PublicFolderDatabase <DatabaseIdParameter>] [-PublicFolderDistributionEnabled <$true | $false>] [-Schedule <Schedule>] [-TemplateInstance <PSObject>] [-Versions <Collection>] [-VirtualDirectories <VirtualDirectoryIdParameter[]>]

Detailed Description

The New-OfflineAddressBook cmdlet allows administrators to create new OABs. For example, if you uninstall a Client Access server that contains an OAB, you will need to re-create it on another Client Access server.

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

  • Exchange Organization Administrator role

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

AddressLists

Required

Microsoft.Exchange.Configuration.Tasks.AddressBookBaseIdParameter[]

The AddressLists parameter specifies an array of address list identities that are included in the OAB.

Name

Required

System.String

The Name parameter specifies the name that describes the OAB object in Exchange System Manager (up to 64 characters).

Server

Required

Microsoft.Exchange.Configuration.Tasks.ServerIdParameter

The Server parameter specifies the server that the new OAB will be created on.

DiffRetentionPeriod

Optional

System.Nullable

The DiffRetentionPeriod parameter specifies the length of time, in days, that the OAB difference files are retained on the OAB-generating server and the Client Access server. To retain the OAB difference files indefinitely, use the value "Unlimited."

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the domain controller to be used for the creation of the OAB.

IsDefault

Optional

System.Boolean

If the value of the IsDefault parameter is $true, the OAB is set as the default OAB for all new mailbox databases. If the value is $false, the OAB is not set as the default OAB.

PublicFolderDatabase

Optional

Microsoft.Exchange.Configuration.Tasks.DatabaseIdParameter

The PublicFolderDatabase parameter specifies the identity of a public folder database.

PublicFolderDistributionEnabled

Optional

System.Boolean

If the value of the PublicFolderDistributionEnabled parameter is $true, the OAB will be distributed via public folders.

Schedule

Optional

Microsoft.Exchange.Data.Schedule

The Schedule parameter specifies the interval scheduled for generating the new OAB.

The Schedule parameter takes the following format and must include a range: Weekday.Hour:Minute[AM/PM]-Weekday.Hour:Minute[AM/PM].

TemplateInstance

Optional

System.Management.Automation.PSObject

The TemplateInstance parameter specifies the template used to create the new OAB.

Versions

Optional

System.Collections.ObjectModel.Collection

The Versions parameter specifies what version of OAB to generate. The allowed values are:

  • Version1

  • Version2

  • Version3

  • Version4

VirtualDirectories

Optional

Microsoft.Exchange.Configuration.Tasks.VirtualDirectoryIdParameter[]

The VirtualDirectories parameter specifies the array of OABVirtualDirectory objects. If the VirtualDirectories parameter is specified, Version4 of the OAB must be generated.

Input Types

Return Types

Errors

Error Description

 

Exceptions

Exceptions Description

 

Example

This example uses two commands to create a new OAB named OfflineAddressBook that includes all of the available address lists in the organization. With the settings shown, an OAB is generated by myserver.contoso.com on Mondays and Wednesdays from 01:00 (1:00 A.M.) to 02:00 (2:00 A.M.). The command also creates the default OAB for the organization.

$a = Get-AddressList
New-OfflineAddressBook -Name "OfflineAddressBook" -Server myserver.contoso.com -AddressLists $a -Schedule "Mon.01:00-Mon.02:00, Wed.01:00-Wed.02:00"