Default FTP File Handling Settings <fileHandling>

Overview

The <fileHandling> element is used to specify the way that the FTP service handles file operations. For example, the keepPartialUploads attribute configures whether the FTP service should keep files that were partially transferred, such as when a file transfer ends prematurely.

Compatibility

Version Notes
IIS 7.5 The <fileHandling> element of the <ftpServer> element ships as a feature of IIS 7.5.
IIS 7.0 The <fileHandling> element of the <ftpServer> element was introduced in FTP 7.0, which was a separate download for IIS 7.0.
IIS 6.0 N/A

Note: The FTP 7.0 and FTP 7.5 services shipped out-of-band for IIS 7.0, which required downloading and installing the modules from the following URL:

http://www.iis.net/expand/FTP

With Windows 7 and Windows Server 2008 R2, the FTP 7.5 service ships as a feature for IIS 7.5, so downloading the FTP service is no longer necessary.

Setup

To support FTP publishing for your Web server, you must install the FTP service. To do so, use the following steps.

IIS 7.5 for Windows Server 2008 R2

  1. On the taskbar, click Start, point to Administrative Tools, and then click Server Manager.
  2. In the Server Manager hierarchy pane, expand Roles, and then click Web Server (IIS).
  3. In the Web Server (IIS) pane, scroll to the Role Services section, and then click Add Role Services.
  4. On the Select Role Services page of the Add Role Services Wizard, expand FTP Server.
  5. Select FTP Service.

    Note: To support ASP.Membership authentication or IIS Manager authentication for the FTP service, you will also need to select FTP Extensibility.
  6. Click Next.
  7. On the Confirm Installation Selections page, click Install.
  8. On the Results page, click Close.

IIS 7.5 for Windows 7

  1. On the taskbar, click Start, and then click Control Panel.
  2. In Control Panel, click Programs and Features, and then click Turn Windows Features on or off.
  3. Expand Internet Information Services, and then FTP Server.
  4. Select FTP Service.

    Note: To support ASP.Membership authentication or IIS Manager authentication for the FTP service, you will also need to select FTP Extensibility.
  5. Click OK.

IIS 7.0 for Windows Server 2008 and Windows Vista

  1. Download the installation package from the following URL:
  2. Follow the instructions in the following walkthrough to install the FTP service:

How To

How to configure the default file handling options for an FTP server

  1. Open Internet Information Services (IIS) Manager:
    • If you are using Windows Server 2008 or Windows Server 2008 R2:
      • On the taskbar, click Start, point to Administrative Tools, and then click Internet Information Services (IIS) Manager.
    • If you are using Windows Vista or Windows 7:
      • On the taskbar, click Start, and then click Control Panel.
      • Double-click Administrative Tools, and then double-click Internet Information Services (IIS) Manager.
  2. In the Connections pane, expand the server name, and thecn click the Sites node.
  3. In the Sites pane, click Set FTP Site Defaults... in the Actions pane.
  4. In the FTP Site Defaults dialog box, expand File Handling, and specify the following options:
    • Specify True for Allow Reading Files While Uploading if the FTP service should allow read access to files that are currently being uploaded; otherwise, specify False.
    • Specify True for Allow Replace on Rename if the FTP service should allow files that are being renamed to overwrite existing files; otherwise, specify False.
    • Specify True for Keep Partial Uploads if the FTP service should keep files that have been partially uploaded; otherwise, specify False. (Note: Keeping partially-uploaded files allows FTP clients to reconnect and resume uploading.)
  5. Click OK.

Configuration

Attributes

Attribute Description
allowReadUploadsInProgress Optional Boolean attribute.

true if the FTP service should allow read access to files that are currently being uploaded; otherwise, false.

The default value is false.
allowReplaceOnRename Optional Boolean attribute.

true if the FTP service should allow files that are being renamed to overwrite existing files; otherwise, false.

The default value is false.
keepPartialUploads Optional Boolean attribute.

true if the FTP service should keep files that have been partially uploaded; otherwise, false.

The default value is false.

Child Elements

None.

Configuration Sample

The following configuration sample displays an example <fileHandling> element for a server that is configured to keep partially-uploaded files by default.

<siteDefaults>
   <ftpServer>
      <fileHandling keepPartialUploads="false" />
   </ftpServer>
</siteDefaults>

Sample Code

The following code samples demonstrate how to configure the FTP service to keep partially-uploaded files by default.

AppCmd.exe

appcmd.exe set config -section:system.applicationHost/sites /siteDefaults.ftpServer.fileHandling.keepPartialUploads:"False" /commit:apphost.ftpServer.logFile.enabled:"True" /commit:apphost

Note: You must be sure to set the commit parameter to apphost when you use AppCmd.exe to configure these settings. This commits the configuration settings to the appropriate location section in the ApplicationHost.config file.

C#

using System;
using System.Text;
using Microsoft.Web.Administration;

internal static class Sample
{
   private static void Main()
   {
      using (ServerManager serverManager = new ServerManager())
      {
         Configuration config = serverManager.GetApplicationHostConfiguration();
         ConfigurationSection sitesSection = config.GetSection("system.applicationHost/sites");
         ConfigurationElement siteDefaultsElement = sitesSection.GetChildElement("siteDefaults");
         ConfigurationElement ftpServerElement = siteDefaultsElement.GetChildElement("ftpServer");

         ConfigurationElement fileHandlingElement = ftpServerElement.GetChildElement("fileHandling");
         fileHandlingElement["keepPartialUploads"] = false;

         serverManager.CommitChanges();
      }
   }
}

VB.NET

Imports System
Imports System.Text
Imports Microsoft.Web.Administration

Module Sample
   Sub Main()
      Dim serverManager As ServerManager = New ServerManager
      Dim config As Configuration = serverManager.GetApplicationHostConfiguration
      Dim sitesSection As ConfigurationSection = config.GetSection("system.applicationHost/sites")
      Dim siteDefaultsElement As ConfigurationElement = sitesSection.GetChildElement("siteDefaults")
      Dim ftpServerElement As ConfigurationElement = siteDefaultsElement.GetChildElement("ftpServer")

      Dim fileHandlingElement As ConfigurationElement = ftpServerElement.GetChildElement("fileHandling")
      fileHandlingElement("keepPartialUploads") = False

      serverManager.CommitChanges()
   End Sub

End Module
End Module

JavaScript

var adminManager = new ActiveXObject('Microsoft.ApplicationHost.WritableAdminManager');
adminManager.CommitPath = "MACHINE/WEBROOT/APPHOST";

var sitesSection = adminManager.GetAdminSection("system.applicationHost/sites", "MACHINE/WEBROOT/APPHOST");
var siteDefaultsElement = sitesSection.ChildElements.Item("siteDefaults");
var ftpServerElement = siteDefaultsElement.ChildElements.Item("ftpServer");

var fileHandlingElement = ftpServerElement.ChildElements.Item("fileHandling");
fileHandlingElement.Properties.Item("keepPartialUploads").Value = false;

adminManager.CommitChanges();

VBScript

Set adminManager = createObject("Microsoft.ApplicationHost.WritableAdminManager")
adminManager.CommitPath = "MACHINE/WEBROOT/APPHOST"
Set sitesSection = adminManager.GetAdminSection("system.applicationHost/sites", "MACHINE/WEBROOT/APPHOST")
Set siteDefaultsElement = sitesSection.ChildElements.Item("siteDefaults")
Set ftpServerElement = siteDefaultsElement.ChildElements.Item("ftpServer")

Set fileHandlingElement = ftpServerElement.ChildElements.Item("fileHandling")
fileHandlingElement.Properties.Item("keepPartialUploads").Value = False

adminManager.CommitChanges()
Deprecated Elements