Get-OfflineAddressBook

This cmdlet is available in on-premises Exchange 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 view 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 (https://technet.microsoft.com/library/bb123552.aspx).

Syntax

Get-OfflineAddressBook
   -Server <ServerIdParameter>
   [-DomainController <Fqdn>]
   [<CommonParameters>]
Get-OfflineAddressBook
   [[-Identity] <OfflineAddressBookIdParameter>]
   [-DomainController <Fqdn>]
   [<CommonParameters>]

Description

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 (https://technet.microsoft.com/library/mt432940.aspx).

Examples

-------------------------- Example 1 --------------------------

Get-OfflineAddressBook

This example returns a summary list of all existing OABs.

-------------------------- Example 2 --------------------------

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

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

-------------------------- Example 3 --------------------------

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

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.

Required Parameters

-Server

This parameter is available only in on-premises Exchange.

Note: This parameter isn't relevant in Exchange 2013 or later. The Server property for an OAB is blank, because the OAB is generated by an arbitration mailbox.

The Server parameter returns all of the OABs that are generated by the specified Exchange 2010 or earlier server. You can use any value that uniquely identifies the server. For example:

  • Name

  • Distinguished name (DN)

  • FQDN

  • ExchangeLegacyDN

  • GUID

You can't use this parameter with the Identity parameter.

Type:ServerIdParameter
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Online

Optional Parameters

-DomainController

This parameter is available only in on-premises Exchange.

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.

Type:Fqdn
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016
-Identity

The Identity parameter specifies the OAB that you want to view. You can use any value that uniquely identifies the OAB. For example:

  • Name or \Name

  • Distinguished name (DN)

  • GUID

You can't use this parameter with the Server parameter.

Type:OfflineAddressBookIdParameter
Position:1
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Online

Inputs

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data.

Outputs

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data.