Skip to main content
New-OfflineAddressBook
 

Applies to: Exchange Server 2013

Topic Last Modified: 2014-07-03

This cmdlet is available only in on-premises Exchange Server 2013.

Use the New-OfflineAddressBook cmdlet to create an offline address book (OAB).

For information about the parameter sets in the Syntax section below, see Syntax.

Syntax
New-OfflineAddressBook -AddressLists <AddressBookBaseIdParameter[]> -Name <String> [-Confirm [<SwitchParameter>]] [-DiffRetentionPeriod <Unlimited>] [-DomainController <Fqdn>] [-GeneratingMailbox <MailboxIdParameter>] [-GlobalWebDistributionEnabled <$true | $false>] [-IsDefault <$true | $false>] [-Organization <OrganizationIdParameter>] [-VirtualDirectories <VirtualDirectoryIdParameter[]>] [-WhatIf [<SwitchParameter>]]
Examples
EXAMPLE 1

This example uses two commands to create the OAB named OAB_AgencyB that includes all address lists where AgencyB is part of the name. 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 | Where {$_.Name -Like "*AgencyB*" 
New-OfflineAddressBook -Name "OAB_AgencyB" -AddressLists $a -Schedule "Mon.01:00-Mon.02:00, Wed.01:00-Wed.02:00"
EXAMPLE 2

This example creates the OAB New OAB that uses Web-based distribution for Microsoft Office Outlook 2007 or later by using the default virtual directory.

New-OfflineAddressBook -Name "New OAB" -AddressLists "\Default Global Address List" -VirtualDirectories "SERVER01\OAB (Default Web Site)"
Detailed Description

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

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Offline address books" entry in the Email address and address book permissions topic.

By default in Exchange Online, the Address List role isn’t assigned to any role groups. To use any cmdlets that require the Address List role, you need to add the role to a role group. For details, see the “Add a role to a role assignment policy” section of Manage role assignment policies.

Parameters

 

Parameter Required Type Description

AddressLists

Required

Microsoft.Exchange.Configuration.Tasks.AddressBookBaseIdParameter[]

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

Name

Required

System.String

The Name parameter specifies the name that describes the OAB object in Exchange System Manager. This value can contain a maximum of 64 characters.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch.

DiffRetentionPeriod

Optional

Microsoft.Exchange.Data.Unlimited

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 fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.

GeneratingMailbox

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

The GeneratingMailbox parameter specifies the OABGenCapability arbitration mailbox where the offline address books will be generated. This allows on-premises admins to load balance OAB generation.

GlobalWebDistributionEnabled

Optional

System.Boolean

The GlobalWebDistributionEnabled parameter specifies whether distribution occurs to all virtual directories in the organization. If the value of the GlobalWebDistributionEnabled parameter is $true, distribution occurs to all virtual directories in the organization and the VirtualDirectories parameter can't be used.

IsDefault

Optional

System.Boolean

The IsDefault parameter specifies whether the OAB is set as the default OAB for all new mailbox databases. 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 isn't set as the default OAB.

Organization

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

This parameter is reserved for internal Microsoft use.

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.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch.

Input Types

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

Return Types

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.