Applies to: Exchange Server 2013, Exchange Online
Topic Last Modified: 2012-09-18
Use the New-OwaVirtualDirectory cmdlet to create a Microsoft Office Outlook Web App virtual directory in an existing Internet Information Services (IIS) website on a server running Microsoft Exchange Server 2013.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
New-OwaVirtualDirectory [-ApplicationRoot <String>]
[-AppPoolId <String>] [-Confirm [<SwitchParameter>]]
[-DomainController <Fqdn>] [-ExtendedProtectionFlags
<MultiValuedProperty>] [-ExtendedProtectionSPNList
<MultiValuedProperty>] [-ExtendedProtectionTokenChecking
<None | Allow | Require>] [-ExternalAuthenticationMethods
<MultiValuedProperty>] [-ExternalUrl <Uri>]
[-InternalUrl <Uri>] [-Path <String>] [-Role
<ClientAccess | Mailbox>] [-Server <ServerIdParameter>]
[-WebSiteName <String>] [-WhatIf
[<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example creates the Outlook Web App virtual directory in an IIS website on the local Exchange server, which isn't a default website.
Copy Code | |
---|---|
New-OwaVirtualDirectory -WebSiteName "Contoso.com" |
Detailed Description
By default, when Exchange is installed, the Outlook Web App virtual directory owa is created in the default IIS website on the local server running Exchange. The New-OwaVirtualDirectory cmdlet must be run on the Exchange server hosting the Client Access server role on which you want to host the new virtual directory.
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 Clients and Mobile Devices Permissions topic.
Parameters
Parameter | Required | Type | Description | ||||
---|---|---|---|---|---|---|---|
ApplicationRoot |
Optional |
System.String |
The ApplicationRoot parameter sets the path of the virtual directory in the metabase.
|
||||
AppPoolId |
Optional |
System.String |
The AppPoolId parameter sets the IIS application pool in which Outlook Web App 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:
|
||||
ExternalAuthenticationMethods |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The ExternalAuthenticationMethods parameter, a Services Discovery property setting, specifies the authentication methods supported on the Exchange server from outside the firewall.
|
||||
ExternalUrl |
Optional |
System.Uri |
The ExternalUrl parameter specifies the host name to be used to connect to the Exchange server from outside the firewall. This setting is important when Secure Sockets Layer (SSL) is used.
|
||||
InternalUrl |
Optional |
System.Uri |
The InternalUrl parameter specifies the host name to be used to connect to the Exchange server from inside the firewall. This setting is important when SSL is used.
|
||||
Path |
Optional |
System.String |
The Path parameter sets the file system path of the 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 Exchange server on which you want to create the virtual directory. You can use any value that uniquely identifies the server, for example:
If you don't use the Server parameter, the virtual directory will be created on the server where the Remote PowerShell session is established This will always be a Mailbox server. If you want to create the virtual directory on a Client Access server or another Mailbox server, you must use the Server parameter. |
||||
WebSiteName |
Optional |
System.String |
The WebSiteName parameter specifies the name of the IIS website under which the Outlook Web App 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.