Applies to: Exchange Server 2013
Topic Last Modified: 2012-09-13
Use the Get-EcpVirtualDirectory cmdlet to retrieve all configuration data for Exchange Control Panel (ECP) virtual directories. The ECP virtual directory manages the Exchange Administration Center.
For information about the parameter sets in the Syntax section below, see Syntax.
 Note: |
|---|
| The ECP is the web-based user interface developed for Microsoft Exchange Server 2010. The Exchange Server 2013 Exchange Administration Center cmdlets for virtual directory still use ECP in the name, and the ECP cmdlets can be used to manage Exchange 2010 and Exchange 2013 ECP virtual directories. |
Syntax
Get-EcpVirtualDirectory -Server <ServerIdParameter>
<COMMON PARAMETERS>
|
Get-EcpVirtualDirectory [-Identity
<VirtualDirectoryIdParameter>] <COMMON
PARAMETERS>
|
COMMON PARAMETERS: [-ADPropertiesOnly
<SwitchParameter>] [-DomainController <Fqdn>]
[-ShowBackEndVirtualDirectories <SwitchParameter>]
[-ShowMailboxVirtualDirectories <SwitchParameter>]
|
Examples
EXAMPLE 1
This example displays the configuration data for the Exchange Control Panel virtual directory on Server01.
 Copy Code |
|
|---|---|
Get-EcpVirtualDirectory -Server Server01 |
|
Detailed Description
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 "Exchange Administration Center connectivity" entry in the Exchange and Shell Infrastructure 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 ECP virtual directories that you want to display. If you don't specify a value for the Server parameter, all ECP virtual directories are returned. |
|
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 ECP virtual directory. The Identity parameter is represented as: ServerName\ECP (WebsiteName). If you don't specify a server name, the command returns the ECP virtual directory on the local server. |
|
ShowBackEndVirtualDirectories |
Optional |
System.Management.Automation.SwitchParameter |
The ShowBackEndVirtualDirectories switch specifies whether to return virtual directories on Client Access servers when used in a query. If you don't use this parameter, only virtual directories on Mailbox servers are returned. |
|
ShowMailboxVirtualDirectories |
Optional |
System.Management.Automation.SwitchParameter |
The ShowMailboxVirtualDirectories switch specifies whether to return the ECP virtual directories that are located on servers running the Mailbox server role. 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.