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 Get-OfflineAddressBook cmdlet to obtain the settings of one or more offline address books (OABs).

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.

Get-OfflineAddressBook [-Identity <OfflineAddressBookIdParameter>] <COMMON PARAMETERS>
Get-OfflineAddressBook -Server <ServerIdParameter> <COMMON PARAMETERS>
COMMON PARAMETERS: [-DomainController <Fqdn>]

This example returns a summary list of all existing OABs.


This example returns detailed information about the OAB named Default Offline Address Book.

Get-OfflineAddressBook -Identity "\Default Offline Address Book" | Format-List

This example returns specific properties for all existing OABs, including the GeneratingMailbox property that specifies the arbitration mailbox that's responsible for generating the OAB.

Get-OfflineAddressBook | Format-List Name,AddressLists,GeneratingMailbox

If a parameter isn't passed with the Get-OfflineAddressBook cmdlet, the command returns all of the OABs in the organization. If the Identity parameter is passed, the command returns the OAB for the specified identity. If the Server parameter is passed, the command returns the OABs for the specified 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




The Server parameter specifies the GUID, domain name, or fully qualified domain name (FQDN) of the server generating the OAB.




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,




The Identity parameter specifies the GUID, distinguished name (DN), or OAB name that represents a specific OAB. You can also include the path using the format Server\OfflineAddressBookName.

You can omit the parameter label Identity so that only the OAB name or GUID is supplied.

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.