Summary

Creates or modifies a virtual directory of a web site hosted on Internet Information Server.

Assembly

NAnt.Contrib.dll

Namespace

NAnt.Contrib.Tasks.Web

Base Types

Task
WebBase

graph BT Type-->Base0["WebBase"] click Base0 "/api/NAnt.Contrib.Tasks.Web/WebBase" Base0-->Base1["Task"] Type["CreateVirtualDirectory"] class Type type-node

Syntax

[TaskName("mkiisdir")]
public class CreateVirtualDirectory : WebBase

Examples

Create a virtual directory named Temp pointing to c:\temp on the local machine.

<mkiisdir dirpath="c:\temp" vdirname="Temp" />

Create a virtual directory named Temp pointing to c:\temp on machine Staging.

<mkiisdir iisserver="Staging" dirpath="c:\temp" vdirname="Temp" />

Configure the home directory of for http://svc.here.dev/ to point to D:\Develop\Here and require authentication

<mkiisdir iisserver="svc.here.dev" dirpath="D:\Develop\Here" vdirname="/" authanonymous="false"/>

Create a virtual directory named WebServices/Dev pointing to c:\MyProject\dev on the web site running on port 81 of machine MyHost.

<mkiisdir iisserver="MyHost:81" dirpath="c:\MyProject\dev" vdirname="WebServices/Dev" />

Note that if WebServices is neither an existing virtual directory nor an existing physical subdirectory of the web root, your IIS Management Console will get confused. Even though http://MyHost:81/WebServices/Dev/theService.asmx may be a perfectly working webservice, the Management Console will not show it.

Remarks

If the virtual directory does not exist it is created, and if it already exists it is modified. Only the IIS-properties specified will be set. If set by other means (e.g. the Management Console), the unspecified properties retain their current value, otherwise they are inherited from the parent.

For a list of optional parameters see IIsWebVirtualDir.

More information on metabase parameters is available here.

Attributes

Type	Description
TaskName

Properties

Name	Value	Summary
AccessExecute	bool	Indicates whether the file or the contents of the folder may be executed, regardless of file type. The default is `false`.
AccessNoRemoteExecute	bool	Indicates whether remote requests to execute applications are denied; only requests from the same computer as the IIS server succeed if `NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessExecute` is set to `true`. You cannot set `NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessNoRemoteExecute` to `false` to enable remote requests, and set `NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessExecute` to `false` to disable local requests. The default is `false`.
AccessNoRemoteRead	bool	Indicates whether remote requests to view files are denied; only requests from the same computer as the IIS server succeed if `NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessExecute` is set to `true`. You cannot set `NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessNoRemoteRead` to `false` to enable remote requests, and set `NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessRead` to `false` to disable local requests. The default is `false`.
AccessNoRemoteScript	bool	A value of true indicates that remote requests to view dynamic content are denied; only requests from the same computer as the IIS server succeed if the AccessScript property is set to true. You cannot set AccessNoRemoteScript to false to enable remote requests, and set AccessScript to false to disable local requests.
AccessNoRemoteWrite	bool	indicates that remote requests to create or change files are denied; only requests from the same computer as the IIS server succeed if the AccessWrite property is set to true. You cannot set AccessNoRemoteWrite to false to enable remote requests, and set AccessWrite to false to disable local requests.
AccessRead	bool	Indicates whether the file or the contents of the folder may be read. The default is `true`.
AccessScript	bool	Indicates whether the file or the contents of the folder may be executed if they are script files or static content. The default is `true`.
AccessSource	bool	Indicates whether users are allowed to access source code if either Read or Write permissions are set. The default is `false`.
AccessSsl	bool	Indicates whether file access requires SSL file permission processing, with or without a client certificate. The default is `false`.
AccesssSl128	bool	Indicates whether file access requires SSL file permission processing with a minimum key size of 128 bits, with or without a client certificate. The default is `false`.
AccessSslMapCert	bool	Indicates whether SSL file permission processing maps a client certificate to a Microsoft Windows � operating system user-account. `NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessSslNegotiateCert` must also be set to `true` for the mapping to occur. The default is `false`.
AccessSslNegotiateCert	bool	Indicates whether SSL file access processing requests a certificate from the client. The default is `false`.
AccessSslRequireCert	bool	Indicates whether SSL file access processing requests a certificate from the client. If the client provides no certificate, the connection is closed. `NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessSslNegotiateCert` must also be set to `true` when using `NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessSslRequireCert`. The default is `false`.
AccessWrite	bool	Indicates whether users are allowed to upload files and their associated properties to the enabled directory on your server or to change content in a Write-enabled file. The default is `false`.
AnonymousPasswordSync	bool	Indicates whether IIS should handle the user password for anonymous users attempting to access resources. The default is `false`.
AppAllowClientDebug	bool	Specifies whether ASP client-side debugging is enabled. The default is `false`.
AppAllowDebugging	bool	Specifies whether ASP debugging is enabled on the server. The default is `false`.
AppCreate	CreateVirtualDirectory.AppType	Specifies what type of application to create for this virtual directory. The default is `NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AppType.Pooled`.
AppFriendlyName	string	The user-friendly name of the package or application.
ApplicationPath	string	Inherited from WebBase
AppPoolId	string	Specifies the application pool where the application is routed (IIS 6.0 or higher).
AspAllowSessionState	bool	Enables session state persistence for the ASP application. The default is `true`.
AspBufferingOn	bool	Specifies whether output from an ASP application will be buffered. If `true`, all output from the application is collected in the buffer before the buffer is flushed to the client. With buffering on, the ASP application has to completely process the ASP script before the client receives any output. The default is `true`.
AspEnableApplicationRestart	bool	Determines whether an ASP application can be automatically restarted. When changes are made to Global.asa or metabase properties that affect an application, the application will not restart unless the `NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspEnableApplicationRestart` property is set to `false`. The default is `true`.
AspEnableAspHtmlFallback	bool	Controls the behavior of ASP when a new request is to be rejected due to a full request queue. If `true`, an .htm file with a similar name as the requested .asp file, will be sent instead of the .asp file. The naming convention for the .htm file is the name of the .asp file with _asp appended. The default is `false`.
AspEnableChunkedEncoding	bool	Specifies whether HTTP 1.1 chunked transfer encoding is enabled for the World Wide Web Publishing Service (WWW service). The default is `false`.
AspEnableParentPaths	bool	Specifies whether an ASP page allows paths relative to the current directory. The default is `true`.
AspEnableTypelibCache	bool	Specifies whether type libraries are cached on the server. The default is `true`.
AspErrorsToNTLog	bool	Specifies which ASP errors are written to the Windows event log.
AspExceptionCatchEnable	bool	Specifies whether ASP pages trap exceptions thrown by components. If set to `false`, the Microsoft Script Debugger tool does not catch exceptions sent by the component that you are debugging. The default is `true`.
AspLogErrorRequests	bool	Controls whether the Web server writes ASP errors to the application section of the Windows event log. The default is `true`.
AspScriptErrorMessage	string
AspScriptErrorSentToBrowser	bool	Specifies whether the Web server writes debugging specifics (file name, error, line number, description) to the client browser, in addition to logging them to the Windows Event Log. The default is `true`.
AspThreadGateEnabled	bool	Indicates whether IIS thread gating is enabled (only applies to IIS 4 and 5). The default is `false`.
AspTrackThreadingModel	bool	Specifies whether IIS checks the threading model of any components that your application creates. The default is `false`.
AuthAnonymous	bool	Specifies Anonymous authentication as one of the possible authentication schemes returned to clients as being available. The default is `true`.
AuthBasic	bool	Specifies Basic authentication as one of the possible authentication schemes returned to clients as being available. The default is `false`.
AuthNtlm	bool	Specifies Integrated Windows authentication as one of the possible authentication schemes returned to clients as being available. The default is `false`.
AuthPersistSingleRequest	bool	Specifies that authentication persists only for a single request on a connection. IIS resets the authentication at the end of each request, and forces re-authentication on the next request of the session.
AuthPersistSingleRequestAlwaysIfProxy	bool	Specifies whether authentication is valid for a single request if by proxy. IIS will reset the authentication at the end of the request and force re-authentication on the next request if the current authenticated request is by proxy of any type. Applies to IIS 5.0 and 5.1. The default is `false`.
AuthPersistSingleRequestIfProxy	bool	Specifies authentication will persist only across single requests on a connection if the connection is by proxy. Applies to IIS 5.0 and 5.1. The default is `false`
CacheControlNoCache	bool	Specifies whether the HTTP 1.1 directive to prevent caching of content should be sent to clients. The default is `false`.
CacheIsapi	bool	Indicates whether ISAPI extensions are cached in memory after first use. The default is `true`.
ContentIndexed	bool	Specifies whether the installed content indexer should index content under this directory tree. The default is `true`.
CpuAppEnabled	bool	Specifies whether process accounting and throttling should be performed for ISAPI extensions and ASP applications. The default is `true`.
CpuCgiEnabled	bool	Indicates whether IIS should perform process accounting for CGI applications. The default is `true`.
CreateCgiWithNewConsole	bool	Indicates whether a CGI application runs in its own console. The default is `false`.
CreateProcessAsUser	bool	Specifies whether a CGI process is created in the system context or in the context of the requesting user. The default is `true`.
DefaultDoc	string	One or more file names of default documents that will be returned to the client if no file name is included in the client's request.
DirBrowseShowDate	bool	Specifies whether date information is displayed when browsing directories. The default is `true`.
DirBrowseShowExtension	bool	Specifies whether file extensions are displayed when browsing directories. The default is `true`.
DirBrowseShowLongDate	bool	Specifies whether date information is displayed in extended format when displaying directories. The default is `true`.
DirBrowseShowSize	bool	Specifies whether file size information is displayed when displaying directories. The default is `true`.
DirBrowseShowTime	bool	Specifies whether file creation time is displayed when browsing directories. The default is `true`.
DirPath	DirectoryInfo	The file system path.
DontLog	bool	Specifies whether client requests are written to the IIS log files. The default is `false`.
EnableDefaultDoc	bool	When set to true, the default document (specified by the DefaultDoc property) for a directory is loaded when the directory is browsed.
EnableDirBrowsing	bool	Specifies whether directory browsing is enabled. The default is `false`.
EnableDocFooter	bool	Enables or disables custom footers. The default is `false`.
EnableReverseDns	bool	Enables or disables reverse Domain Name Server (DNS) lookups for the World Wide Web Publishing Service (WWW service). The default is `false`.
Server	string	The IIS server, which can be specified using the format `[host]:[port]`. The default is `localhost:80`. Inherited from WebBase
ServerPath	string	Inherited from WebBase
SsiExecDisable	bool	Specifies whether server-side include (SSI) #exec directives are disabled under this path. The default is `false`.
UncAuthenticationPassthrough	bool
UncPassword	string	Specifies the encrypted password used to gain access to UNC (Universal Naming Convention) virtual roots.
UncUserName	string	Specifies the user name for Universal Naming Convention (UNC) virtual roots.
VdirPath	string	Inherited from WebBase
Version	WebBase.IISVersion	Gets the version of IIS corresponding with the current OS. Inherited from WebBase
VirtualDirectory	string	Name of the IIS virtual directory. Inherited from WebBase
Website	string	The website on the IIS server. Inherited from WebBase

Methods

Name	Value	Summary
CheckIISSettings()	void	Inherited from WebBase
DirectoryEntryExists(string)	bool	Inherited from WebBase
ExecuteTask()	void