Virtual Directory Properties

Virtual directory properties are specified by the properties node. This node is presented by type VDirProperties (virtdir.xsd). It has the following graphics model:

• The real-path node is optional. It specifies the path of the physical directory mapped by the virtual directory. The path is specified relative to the root directory of the domain that owns this physical directory. If the specified physical folder does not exist, it will be created. Data type: RealDirPath (virtdir.xsd). Default value: '/' .

Note: in API RPC v.1.4.2.0 and earlier versions, the type of this node is VDirPath (virtdir.xsd).

• The access-source node is optional. Enables or disables user access to the source code of ASP applications (residing within the specified virtual directory and its non-virtual subfolders) with read or write permissions (if set). Data type: Boolean. Default value: false.
• The access-read node is optional. Enables or disables read access to files located within the specified virtual directory. Data type: boolean. Default value: true.
• The access-write node is optional. Enables or disables write access to files located within the specified virtual directory. Data type: boolean. Default value: false.
• The dir-browsing node is optional. Allows or disallows the user to see files and nested directories of the specified virtual directory in the browser. Data type: boolean. Default value: false.
• The log-visits node is optional. Enables or disables logging the information about visiting the virtual directory. Data type: Boolean. Default value: true.
• The application node is optional. Specifies a collection of properties used to specify a virtual directory as a web application and configure its execution by the web server. Data type: VDirAppType (virtdir.xsd). To see the structure of this node, proceed to the Web Application Properties topic.
• The execute-perm node is optional. Specifies execution permissions for files located within the specified virtual directory. Data type: VDirExecutePermissionsType (virtdir.xsd). Allowed values: none (only static files can be displayed) | script (static files can be displayed, scripts can be executed) | script_execute (all files can be executed). Default value: script.
• The default-doc node is optional. Specifies a collection of default page properties. These properties enable or disable display of a default page when the user visits the virtual directory with no particular file name specified. Data type: VDirDefaultDocType (virtdir.xsd). To see the structure of this node, proceed to the Default Page Properties section.
• The access-anonymous node is optional. Enables or disables public access to the virtual directory. Data type: boolean. If set to true, indicates that the user can access the directory without authentication.
• The require-ssl node is optional. Enables or disables SSL access to the virtual directory. Data type: boolean.
• The asp-buffering-limit node is optional. Limits the size (in KB) of ASP buffer assigned to a specified virtual directory. Data type: int. Available since protocol version 1.5.2.0.
• The asp-max-request-entity-allowed node is optional. Limits the size (in KB) of ASP request entity body. Data type: int. Available since protocol version 1.5.2.0.
• The asp-enabled-server-debug node is optional. Enables or disables ASP server-side script debugging. If it is a root directory, default value is defined by IIS; else inherited by parent directory. Data type: Boolean. Available since protocol version 1.5.2.0.
• The asp-enablde-client-debug node is optional. Enables or disables ASP client-side script debugging. If it is a root directory, default value is defined by IIS; else inherited by parent directory. Data type: Boolean. Available since protocol version 1.5.2.0.

The following sample packet creates a virtual directory and specifies main properties for it:

<packet version="1.5.2.0">

<virtdir>

<create>

   <domain-id>1</domain-id>

   <name>/my_vdir</name>

   <properties>

      <real-path>/real_dir</real-path>

      <access-source>true</access-source>

      <access-read>true</access-read>

      <access-write>true</access-write>

      <dir-browsing>true</dir-browsing>

      <log-visits>true</log-visits>

      <execute-perm>none</execute-perm>

      <access-anonymous>true</access-anonymous>

      <require-ssl>true</require-ssl>

      <asp-buffering-limit>1024</asp-buffering-limit>

      <asp-enabled-server-debug>true</asp-enabled-server-debug>

   </properties>

</create>

</virtdir>

</packet>