Applies to: Exchange Server 2013
Topic Last Modified: 2012-09-18
Use the Get-OabVirtualDirectory cmdlet to return configuration information about offline address book (OAB) distribution points.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Get-OabVirtualDirectory -Server <ServerIdParameter>
<COMMON PARAMETERS>
|
Get-OabVirtualDirectory [-Identity
<VirtualDirectoryIdParameter>] <COMMON
PARAMETERS>
|
COMMON PARAMETERS: [-ADPropertiesOnly
<SwitchParameter>] [-DomainController <Fqdn>]
[-ShowBackEndVirtualDirectories <SwitchParameter>]
[-ShowMailboxVirtualDirectories <SwitchParameter>]
|
Examples
EXAMPLE 1
This example returns all OAB virtual directory web distribution points.
 Copy Code |
|
|---|---|
Get-OabVirtualDirectory |
|
EXAMPLE 2
This example returns all OAB virtual directory web distribution points on the server CAS-01-007.
| Copy Code |
|
|---|---|
Get-OabVirtualDirectory -Server CAS-01-007 |
|
EXAMPLE 3
This example returns OAB virtual directories on Client Access servers. By default, this cmdlet only returns virtual directories on Mailbox servers.
| Copy Code |
|
|---|---|
Get-OabVirtualDirectory -ShowBackEndVirtualDirectories |
|
Detailed Description
The Get-OabVirtualDirectory cmdlet queries a distribution point by identity or by web distribution points on a specific server, or queries for all web distribution points. By default, this cmdlet only returns virtual directories on Mailbox servers. To view virtual directories on Client Access servers, use the ShowBackEndVirtualDirectories parameter.
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 book connectivity" entry in the Email Address and Address Book Permissions topic.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Server |
Required |
Microsoft.Exchange.Configuration.Tasks.ServerIdParameter |
The Server parameter specifies the Exchange server on which to perform the selected operation. You can't use this parameter in conjunction with the Identity parameter. |
|
ADPropertiesOnly |
Optional |
System.Management.Automation.SwitchParameter |
The ADPropertiesOnly switch specifies whether to return only the properties about the virtual directory stored in Active Directory. The properties stored in the Internet Information Services (IIS) metabase aren't returned. |
|
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.VirtualDirectoryIdParameter |
The Identity parameter specifies the GUID, distinguished name (DN), or OAB virtual directory name that represents a specific OAB virtual directory. You can also include the path using the format Server\OfflineAddressBookVirtualDirectoryName. You can omit the parameter label so that only the OAB virtual directory name, DN, or GUID is supplied. You can't use this parameter in conjunction with the Server parameter. |
|
ShowBackEndVirtualDirectories |
Optional |
System.Management.Automation.SwitchParameter |
The ShowBackEndVirtualDirectories switch specifies that OAB virtual directories on Client Access servers are returned. If you don't use this switch, only virtual directories on Mailbox servers are returned. |
|
ShowMailboxVirtualDirectories |
Optional |
System.Management.Automation.SwitchParameter |
The ShowMailboxVirtualDirectories switch specifies whether the OAB virtual directories on Mailbox servers are returned. This switch should only be used with the direction of Microsoft support. |
Input Types
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.
Return Types
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.