New-OwaVirtualDirectory
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
The New-OWAVirtualDirectory cmdlet creates a new Outlook Web Access virtual directory in an existing Internet Information Services (IIS) Web site on a computer that is running Microsoft Exchange Server 2007.
Syntax
New-OwaVirtualDirectory [-Name <String>] [-ApplicationRoot <String>] [-AppPoolId <String>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-ExternalAuthenticationMethods <MultiValuedProperty>] [-ExternalUrl <Uri>] [-InternalUrl <Uri>] [-OwaVersion <Exchange2003or2000 | Exchange2007>] [-Path <String>] [-TemplateInstance <PSObject>] [-VirtualDirectoryType <NotSpecified | Mailboxes | PublicFolders | Exchweb | Exadmin>] [-WebSiteName <String>] [-WhatIf [<SwitchParameter>]]
Detailed Description
By default, when Exchange 2007 is installed, the following Outlook Web Access virtual directories are created in the default IIS Web site on the local server that is running Microsoft Exchange:
Owa An Exchange 2007 Outlook Web Access virtual directory.
Exchange A legacy Outlook Web Access virtual directory that can be accessed by users who have mailboxes on servers that are running Exchange Server 2003 or Exchange 2000 Server.
Public A legacy Outlook Web Access virtual directory that points to the public folders on servers that are running Exchange 2003 or Exchange 2000.
Exchweb A legacy Outlook Web Access virtual directory that users can use to access the Outlook Web Access virtual directories. By default, requests to the exchweb virtual directory are sent to the user’s Mailbox server.
Note
Generally, you use the New-OWAVirtualDirectory cmdlet if you have special business needs that require additional virtual directories, such as hosting, or for Outlook Web Access troubleshooting tasks such as deleting and re-creating an Outlook Web Access virtual directory.
The New-OwaVirtualDirectory cmdlet must be run on the Exchange 2007 server that is hosting the Client Access server role on which you want to host the new virtual directory. The account you use must be delegated the Exchange Server Administrator role and membership in the local Administrators group for the target server.
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 |
|---|---|---|---|
ApplicationRoot |
Optional |
System.String |
This parameter sets the path of the virtual directory in the metabase. Note This parameter has not been implemented. |
AppPoolId |
Optional |
System.String |
This parameter sets the IIS application pool in which Outlook Web Access will run. It is best to leave this set to the default. |
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
This parameter causes the command to pause processing and requires that you acknowledge what the command will do before processing continues. You do not have to specify a value with the Confirm parameter. |
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
This parameter specifies the fully qualified domain name (FQDN) of the domain controller that retrieves data from the Active Directory directory service. |
ExternalAuthenticationMethods |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
This parameter, a Services Discovery property setting, specifies the authentication methods that are supported on the Exchange server from outside the firewall. Note This parameter has not been implemented, but can be set by using Set-OwaVirtualDirectory. |
ExternalUrl |
Optional |
System.Uri |
This parameter specifies the host name that would be used to connect to the Exchange server from outside the firewall. This setting is also important when Secure Sockets Layer (SSL) is used. Note You can only configure this setting on Exchange 2007 virtual directories. The default Exchange 2007 virtual directory is /owa. |
InternalUrl |
Optional |
System.Uri |
This parameter specifies the host name of the Exchange server host for connection from inside the firewall. This setting is also important when SSL is used. Note You can only configure this setting on Exchange 2007 virtual directories. The default Exchange 2007 virtual directory is /owa. |
Name |
Optional |
System.String |
This parameter specifies the name of an Outlook Web Access virtual directory if the Outlook Web Access virtual directory is on a server that is running Exchange 2003 or Exchange 2000. If the Outlook Web Access virtual directory is on an Exchange 2007 server, the parameter is ignored. |
OWAVersion |
Optional |
Microsoft.Exchange.Data.Directory.SystemConfiguration.OwaVersions |
This parameter specifies whether the version of the Outlook Web Access virtual directory is Exchange 2007, Exchange 2003, or Exchange 2000. |
Path |
Optional |
System.String |
This 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. |
TemplateInstance |
Optional |
System.Management.Automation.PSObject |
This parameter specifies that the cmdlet will use the configuration of an existing object, when that object is supplied to this parameter, to create an identical copy of the object on a local or target server. Note This parameter has not been implemented. |
VirtualDirectoryType |
Optional |
Microsoft.Exchange.Data.Directory.SystemConfiguration.VirtualDirectoryTypes |
This parameter specifies whether the Outlook Web Access virtual directory points to mailboxes, public folders, or exchweb. It is required if the Outlook Web Access virtual directory is on an Exchange 2003 or Exchange 2000 server. If the Outlook Web Access virtual directory is on an Exchange 2007 server, this parameter is ignored. |
WebSiteName |
Optional |
System.String |
This parameter specifies the name of the IIS Web site under which the Outlook Web Access virtual directory is created. |
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
This parameter instructs the command to simulate the actions that it would take on the object. By using the WhatIf parameter, you can view what changes would occur without having to apply any of those changes. You do not have to specify a value with the WhatIf parameter. |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
|
Exceptions
| Exceptions | Description |
|---|---|
|
|
Example
The following code examples create a set of new Outlook Web Access legacy virtual directories named "exchange", "public", and "exchweb" in a non-default IIS Web site named "contoso.com" on the local Exchange server.
New-OWAVirtualDirectory -OwaVersion:Exchange2003or2000 -VirtualDirectoryType Mailboxes -Name "exchange" -WebSiteName "Contoso.com"
New-OWAVirtualDirectory -OwaVersion:Exchange2003or2000 -VirtualDirectoryType PublicFolders -Name "public" -WebSiteName "Contoso.com"
New-OWAVirtualDirectory -OwaVersion:Exchange2003or2000 -VirtualDirectoryType Exchweb -Name "exchweb" -WebSiteName "Contoso.com"