IIS Provider::Create (FTPSite)

The Create (FTPSite) method allows you to create an FTP site on a specified server.

Note

To avoid having the site start after you create it, you should configure ServerAutoStart to "0" when creating the site and then set it back to "1" when the site becomes operational.

Arguments

Input argument	Required	Description
<key>	A required node that specifies the metabase key.	Yes
<key path="">	Yes	This path is the IIS path of the metabase key. It is required only in the root key node of the request. Child key nodes do not use path, and require name instead. This attribute is filled in on return for all keys. When creating a Web or FTP site, the provider will automatically choose a site number if the site number requested is "*" as shown in the example. On return, the path name will be filled in with the generated site number. It is important to ensure path points to a valid, appropriate and trusted location. See the security note in IIS Provisioning Security Considerations for more details.
<key name="">	Yes	The name of the metabase key. The name is ignored in the root key node of the request, and mandatory in child key nodes. This attribute is filled in upon return for all keys.
<key type="">	Yes	(returned) The type attribute specifies the object type to be created.
<keys>	No	The <keys> node specifies any child keys which should be created. The <key name="root"> node is necessary for the FTP site to function. Other keys may be created if desired.
siteProperties	No	These properties are stored directly under the site key in the metabase. The minimum required properties and subkeys are shown in this example, but additional properties and subkeys may be supplied if desired. <key> - A required node that specifies the metabase key. <key path=""> - This path is the IIS path of the metabase key. It is required only in the root key node of the request. Child key nodes do not use path, and require name instead. This attribute is filled in on return for all keys. When creating a Web or FTP site, the provider will automatically choose a site number if the site number requested is "*" as shown in the example. On return, the path name will be filled in with the generated site number. <key name=""> - The name of the metabase key. The name is ignored in the root key node of the request, and mandatory in child key nodes. This attribute is filled in upon return for all keys. <key type=""> - (returned) The type attribute specifies the object type to be created. <keys> - (optional) The <keys> node specifies any child keys which should be created. The <key name="root"> node is necessary for the FTP site to function. Other keys may be created if desired. siteProperties - These properties are stored directly under the site key in the metabase. The minimum required properties and subkeys are shown in this example, but additional properties and subkeys may be supplied if desired.
<key name="Root">	Yes	A required virtual directory within the FTP site.
Root/properties	Yes	These properties are stored in the Root key, which lives under the site key in the metabase. The minimum required properties are shown in this example, but additional properties may be supplied if desired. Path - The root storage path for the website. UNCUserName - (optional) If the path is a UNC name, this user name will be used with the UNCPassword to access the UNC resource. UNCPassword - (optional) Uses blank password if not supplied.

Output Argument

The Create (FTPSite) method returns all path and name attributes of the request filled in.

Remarks

Sample Code

Example XML Request

The following is an example of an XML request for the Create (FTPSite) method:

<request>
	<procedure>
	<procedure>
		<execute namespace="IIS Provider" procedure="Create" 
		 impersonate="1">
			<executeData>
			<key path="IIS://WEB01/MSFTPSVC/*" type="IIsFtpServer">
				<properties>
				<property name="ServerComment"> fabrikamFTP</property>
				<property name="ServerState">2</property>
				<property name="ServerBindings">
					<values>
						<value>:2121:</value>
					</values>
				</property>
				</properties>
				<keys>
					<key name="Root" type="IIsFTPVirtualDir">
						<properties>
						<property name="Path">c:\inetpub\wwwroot\test
						</property>
						</properties>
					</key>
				</keys>
			</key>
			</executeData>
			<after source="executeData" destination="data"/>
		</execute>
	</procedure>
	</procedure>
</request>

Example XML Response

The following is an example of an XML response for the Create (FTPSite) method:

<response>
	<data>
		<executeData>
		<key path="IIS://WEB01/MSFTPSVC/3986945" type="IIsFtpServer" 
		 name="3986945">
			<properties>
			<property name="ServerComment">fabrikamFTP</property>
			<property name="ServerState">2</property>
			<property name="ServerBindings">
				<values>
					<value>:2121:</value>
				</values>
			</property>
			</properties>
			<keys>
				<key name="Root" type="IIsFTPVirtualDir"
				 path="IIS://WEB01/MSFTPSVC/3986945/Root">
					<properties>
					<property name="Path">c:\inetpub\wwwroot\test
					</property>
					</properties>
				</key>
			</keys>
		</key>
		</executeData>
	</data>
</response>

Applies To