Get-OfflineAddressBook

Get-OfflineAddressBook

Switch on low bandwidth view

Collapse All

Language Filter

Applies to: Exchange Server 2007 SP1 Topic Last Modified: 2007-06-28

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

Syntax


Get-OfflineAddressBook [-Identity <OfflineAddressBookIdParameter>] [-DomainController <Fqdn>]


Get-OfflineAddressBook -Server <ServerIdParameter> [-DomainController <Fqdn>]

Parameters

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 that is generating the OAB.
DomainController	Optional	Microsoft.Exchange.Data.Fqdn	To specify the FQDN of the domain controller that retrieves data from the Active Directory directory service, include the DomainController parameter in the command.
Identity	Optional	Microsoft.Exchange.Configuration.Tasks.OfflineAddressBookIdParameter	Use the Identity parameter to specify the GUID, distinguished name or offline address book name that represents a specific offline address book. You can also include the path using the format Server\OfflineAddressBookName. You can omit the parameter label Identity so that only the offline address book name or GUID is supplied.

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 that is generating the OAB.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the FQDN of the domain controller that retrieves data from the Active Directory directory service, include the DomainController parameter in the command.

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.OfflineAddressBookIdParameter

Use the Identity parameter to specify the GUID, distinguished name or offline address book name that represents a specific offline address book. You can also include the path using the format Server\OfflineAddressBookName.

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

Detailed Description

If a parameter is not 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.

To run the Get-OfflineAddressBook cmdlet the account you use must be delegated the following:

Exchange View-Only Administrator role

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

Input Types

Return Types

Errors

Error	Description

Exceptions

Exceptions	Description

Example

In this example, the Get-OfflineAddressBook cmdlet is used without parameters to obtain all of the configuration details of all of the existing OABs.

Get-OfflineAddressBook | Format-List