New-OfflineAddressBook

 

Applies to: Exchange Online, Exchange Server 2016

This cmdlet is available in on-premises Exchange Server 2016 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

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

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 more information, see the "Add a role to a role group" section in the topic, Manage role groups.

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

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

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"

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

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

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

You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet.

 

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 specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

  • Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.

  • Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.

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 OAB distribution server. To retain the OAB difference files indefinitely, use the value unlimited.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is available only in on-premises Exchange 2016.

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

GeneratingMailbox

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

This parameter is available only in on-premises Exchange 2016.

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

This parameter is available only in on-premises Exchange 2016.

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.

ShadowMailboxDistributionEnabled

Optional

System.Boolean

This parameter is available only in on-premises Exchange 2016.

The ShadowMailboxDistributionEnabled parameter enables an OAB generation mailbox to host a shadow copy of another OAB. The default value is $false.

VirtualDirectories

Optional

Microsoft.Exchange.Configuration.Tasks.VirtualDirectoryIdParameter[]

This parameter is available only in on-premises Exchange 2016.

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 simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.

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.

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.

 
Show: