Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2
Topic Last Modified: 2012-11-16
Use the Get-OwaVirtualDirectory cmdlet to retrieve all Microsoft Office Outlook Web App virtual directories on a computer running Microsoft Exchange Server 2010 that has the Client Access server role installed.
Syntax
Get-OwaVirtualDirectory [-Identity
<VirtualDirectoryIdParameter>] [-ADPropertiesOnly
<SwitchParameter>] [-DomainController <Fqdn>]
|
Get-OwaVirtualDirectory -Server <ServerIdParameter>
[-ADPropertiesOnly <SwitchParameter>] [-DomainController
<Fqdn>]
|
Detailed Description
The Get-OwaVirtualDirectory cmdlet retrieves and displays the configuration settings currently set on Outlook Web App virtual directories on Exchange. The Get-OwaVirtualDirectory cmdlet can also retrieve and display the configuration settings on a specific Outlook Web App 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 App virtual directories on all Internet Information Services (IIS) Web sites 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.
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 "Outlook Web App virtual directories" entry in the Client Access Permissions topic.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Server |
Required |
Microsoft.Exchange.Configuration.Tasks.ServerIdParameter |
The Server parameter specifies the name or GUID of the server that hosts the Outlook Web App virtual directories that you want to display. It's required if you aren't running the command on a server that has the Client Access server role installed. |
|
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 name or GUID of an Outlook Web App virtual directory. It's represented as: ServerName\VirtualDirectoryName (WebsiteName). |
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.
Examples
EXAMPLE 1
This example uses the Server parameter to retrieve all Outlook Web App virtual directories on the server Contoso.
 Copy Code |
|
|---|---|
Get-OwaVirtualDirectory -Server Contoso |
|
EXAMPLE 2
This example uses the Identity parameter to retrieve the configuration settings on the Outlook Web App virtual directory owa (default Web site) on the server Contoso.
| Copy Code |
|
|---|---|
Get-OwaVirtualDirectory -Identity "Contoso\owa (default Web site)" |
|