Get-OwaVirtualDirectory
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
Use the Get-OwaVirtualDirectory cmdlet to retrieve all Outlook Web Access virtual directories on computer that is running Microsoft Exchange Server 2007 that has the Client Access server role installed.
Syntax
Get-OwaVirtualDirectory [-Identity <VirtualDirectoryIdParameter>] [-DomainController <Fqdn>]
Get-OwaVirtualDirectory -Server <ServerIdParameter> [-DomainController <Fqdn>]
Detailed Description
The Get-OwaVirtualDirectory cmdlet is used to retrieve and display the configuration settings that are currently set on Outlook Web Access virtual directories on Exchange 2007. The Get-OwaVirtualDirectory cmdlet can also retrieve and display the configuration settings on a specific Outlook Web Access virtual directory.
The Get-OwaVirtualDirectory cmdlet can be run on a local server, or run remotely if the server name is specified in the Identity or Server parameters. This cmdlet can also be run without parameters to retrieve the configuration settings from all Outlook Web Access virtual directories on all Internet Information Services (IIS) Web sites that are located on the Client Access servers in the organization.
The Get-OwaVirtualDirectory cmdlet can be run on any server that has the Exchange Server administration tools installed. The account you use must be delegated the Exchange View-Only Administrator role.
For more information about permissions, delegating roles, and the rights that are required to administer Exchange 2007, see Permission Considerations.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Server |
Required |
Microsoft.Exchange.Configuration.Tasks.ServerIdParameter |
This parameter specifies the name or GUID of the server that hosts the Outlook Web Access virtual directories that you want to display. It is required if you are not running Get-OwaVirtualDirectory on a server that has the Client Access server role installed. |
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
This parameter specifies the fully qualified domain name of the domain controller that retrieves data from the Active Directory directory service. |
Identity |
Optional |
Microsoft.Exchange.Configuration.Tasks.VirtualDirectoryIdParameter |
This parameter specifies the name or GUID of an Outlook Web Access virtual directory. It is represented as: |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
|
Exceptions
| Exceptions | Description |
|---|---|
|
|
Example
The first code example shows how to use the Server parameter to retrieve all Outlook Web Access virtual directories on a server named "Contoso."
The second code example shows how to use the Identity parameter to retrieve the configuration settings on an Outlook Web Access virtual directory named "owa (default web site)" on the server named "Contoso."
Get-OwaVirtualDirectory -Server Contoso
Get-OwaVirtualDirectory -Identity "Contoso\owa (default web site)"