Applies to: Exchange Server 2013
Topic Last Modified: 2012-09-18
Use the New-EcpVirtualDirectory cmdlet to create an Exchange Control Panel (ECP) virtual directory. This is a command that Microsoft Exchange Server Setup runs when you install Exchange in your organization. The ECP virtual directory manages the Exchange Administration Center.
Warning: |
---|
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. |
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
New-EcpVirtualDirectory [-AppPoolId <String>]
[-Confirm [<SwitchParameter>]] [-DomainController
<Fqdn>] [-ExtendedProtectionFlags
<MultiValuedProperty>] [-ExtendedProtectionSPNList
<MultiValuedProperty>] [-ExtendedProtectionTokenChecking
<None | Allow | Require>] [-ExternalUrl <Uri>]
[-InternalUrl <Uri>] [-Path <String>] [-Role
<ClientAccess | Mailbox>] [-Server <ServerIdParameter>]
[-WebSiteName <String>] [-WhatIf
[<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example creates the Exchange Control Panel virtual directory ecp located on the default IIS website on the Exchange server Server01.
Copy Code | |
---|---|
New-EcpVirtualDirectory -Identity "Server01\ecp (default Web site)" |
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 | ||||
---|---|---|---|---|---|---|---|
AppPoolId |
Optional |
System.String |
The AppPoolId parameter sets the Internet Information Services (IIS) application pool in which the Exchange Control Panel virtual directory runs. We recommend that you leave this parameter at its default setting. |
||||
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch. |
||||
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory. |
||||
ExtendedProtectionFlags |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The ExtendedProtectionFlags parameter is used to customize the options you use if you're using Extended Protection for Authentication. The possible values are:
|
||||
ExtendedProtectionSPNList |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the specified virtual directory. The possible values are:
|
||||
ExtendedProtectionTokenChecking |
Optional |
Microsoft.Exchange.Data.Directory.SystemConfiguration.ExtendedProtectionTokenCheckingMode |
The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the specified Exchange virtual directory. Extended Protection for Authentication isn't enabled by default. The available settings are:
|
||||
ExternalUrl |
Optional |
System.Uri |
The ExternalUrl parameter specifies the host name used to connect to the server running Exchange from outside the firewall. This setting is important when Secure Sockets Layer (SSL) is used. This parameter must be set to allow the Autodiscover service to return the URL for the Exchange Control Panel virtual directory. |
||||
InternalUrl |
Optional |
System.Uri |
The InternalUrl parameter specifies the host name used to connect to the server running Exchange from inside the firewall. This setting is important when SSL is used. This parameter must be set to allow the Autodiscover service to return the URL for the Exchange Control Panel virtual directory. |
||||
Path |
Optional |
System.String |
The Path parameter sets the file system path of the Exchange Control Panel virtual directory. This parameter should be used with care and only when you must use a different file system path than the default. |
||||
Role |
Optional |
Microsoft.Exchange.Management.SystemConfigurationTasks.VirtualDirectoryRole |
The Role parameter specifies the configuration that should be used when the virtual directory is created. The following are the values that can be used with this parameter:
|
||||
Server |
Optional |
Microsoft.Exchange.Configuration.Tasks.ServerIdParameter |
The Server parameter specifies the name or GUID of the server that hosts the Exchange Control Panel virtual directories that you want to create. You can't create an Exchange Control Panel virtual directory remotely. You can only create an Exchange Control Panel virtual directory on the local computer. |
||||
WebSiteName |
Optional |
System.String |
The WebSiteName parameter specifies the name of the IIS website under which the Exchange Control Panel virtual directory is created. |
||||
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch. |
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.