Export (0) Print
Expand All

Get-OfflineAddressBook

 

Applies to: Exchange Server 2013

Topic Last Modified: 2014-03-05

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

Use the Get-OfflineAddressBook cmdlet to obtain the settings of one or more offline address books (OABs).

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

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

This example uses the Get-OfflineAddressBook command without parameters to obtain all the configuration details of all the existing OABs.

Get-OfflineAddressBook | Format-List

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 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.

 

Parameter Required Type Description

Server

Required

Microsoft.Exchange.Configuration.Tasks.ServerIdParameter

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

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that retrieves data from Active Directory.

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.OfflineAddressBookIdParameter

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.

Organization

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

The Organization parameter is reserved for internal Microsoft use.

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.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft