New-UMVirtualDirectory
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
The New-UMVirtualDirectory cmdlet lets you create a new virtual directory on the computer that is running Microsoft Exchange Server 2007 that has the Client Access server role installed.
Syntax
New-UMVirtualDirectory [-ApplicationRoot <String>] [-AppPoolId <String>] [-BasicAuthentication <$true | $false>] [-Confirm [<SwitchParameter>]] [-DigestAuthentication <$true | $false>] [-DomainController <Fqdn>] [-ExternalUrl <Uri>] [-InternalUrl <Uri>] [-Path <String>] [-TemplateInstance <PSObject>] [-WebSiteName <String>] [-WhatIf [<SwitchParameter>]] [-WindowsAuthentication <$true | $false>]
Detailed Description
The New-UMVirtualDirectory cmdlet lets you create a new Unified Messaging virtual directory on the Exchange 2007 Client Access server. You can create a single or multiple UM virtual directories.
To run the New-UMVirtualDirectory cmdlet, the account you use must be delegated the Exchange 2007 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 specifies the Web site path that is defined in the Internet Information Service (IIS) metabase. By default, the path is set to /W3SVC/1/ROOT, where 1= the default Web site. |
AppPoolId |
Optional |
System.String |
This parameter specifies the IIS application pool name. This setting can be configured in <SERVERNAME>\Application Pools on the Web site in IIS Manager. By default, the pool name is set to MSExchangeUMAppPool. |
BasicAuthentication |
Optional |
System.Boolean |
This parameter specifies whether to enable Basic authentication on the virtual directory. |
DigestAuthentication |
Optional |
System.Boolean |
This parameter specifies whether to enable Digest authentication on the virtual directory. |
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
This parameter causes the command to pause processing and requires the administrator to acknowledge what the command will do before processing continues. The default value is $true. |
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
This parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to the Active Directory directory service. |
ExternalUrl |
Optional |
System.Uri |
This parameter specifies the host name that will be used to connect to the Exchange server from outside the perimeter network. |
InternalUrl |
Optional |
System.Uri |
This parameter specifies the host name of the Exchange server host for connection from inside the perimeter network. |
Path |
Optional |
System.String |
This parameter specifies the local path on the Client Access server where the UMWebservice files are located. The default location is %ExchangeInstallDir%\UnifiedMessaging\WebService. |
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. |
WebSiteName |
Optional |
System.String |
This parameter specifies the name of the Web site under which to create the new virtual directory. This parameter should not be used when you are creating a new virtual directory under the default Web site. |
WindowsAuthentication |
Optional |
System.Boolean |
This parameter specifies whether to enable Integrated Windows authentication on the virtual directory. |
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, the administrator can view what changes would occur without having to apply any of those changes. The default value is $true. |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
|
Exceptions
| Exceptions | Description |
|---|---|
|
|
Example
This code example creates a new Unified Messaging virtual directory named MyUMWeb.
New-UMVirtualDirectory -MyUMWeb -WebsiteName "www.contoso.com" -ExternalUrl "https://www.contoso.com/UMwebservices.aspx"