BuildMaster Documentation

Iis - Ensure Virtual Directory

  • Last Modified: 2019-07-30

This is generated from the built-in components of BuildMaster 6.1.10, and may be different than what you have installed (especially if you have extensions); go to [User Icon] > Documentation within your BuildMaster instance to see exactly what operations are available.

Ensure Virtual Directory

Ensures the existence of a virtual directory within an IIS site.

Script usage:

IIS::Ensure-VirtualDirectory(
	Site: <text>,
	[ApplicationPath: <text>],
	Path: <text>,
	[PhysicalPath: <text>],
	[LogonMethod: <integer>],
	[Credentials: <text>],
	[UserName: <text>],
	[Password: <text>],
	[Exists: <true/false>]
);

Arguments:

Name Format Script Usage Usage Notes
Site name
text
Site
The name of this site where the virtual directory would exist This argument is required.
Application path
text
ApplicationPath
The relative URL of the application containing the virtual directory, such as /
Virtual path
text
Path
The relative URL of the path, such as /hdars This argument is required.
Physical path
text
PhysicalPath
Physical path to the content for the virtual directory, such as c:\hdars.
Logon method
integer
LogonMethod
Specifies the type of the logon operation to perform when calling LogonUser to acquire the user token impersonated to access the physical path for the virtual directory.
Otter credentials
text
Credentials
The Otter credential name to be impersonated when accessing the physical path for the virtual directory. If a credential name is specified, the username and password fields will be ignored.
User name
text
UserName
Password
text
Password
Exists
true/false
Exists

Example:

# ensures that the hdars virtual directory pool is present on the web server
IIS::Ensure-VirtualDirectory(
    Site: Hdars,
    Path: /hdars,
    PhysicalPath: C:\hdars
);

Is this documentation incorrect or incomplete? Help us by contributing!

This documentation is licensed under CC-BY-SA-4.0 and stored in GitHub.

Generated from commit ce197caa on master