Default FTP Connection Settings <connections>

Overview

The <connections> element specifies the connection-related settings for FTP sites. More specifically, the settings in the <connections> element control the behavior for the FTP service with regard to how to manage clients that are connecting to an FTP site.

For example, the unauthenticatedTimeout, controlChannelTimeout, and dataChannelTimeout attributes specify the time-outs for an FTP site. The settings specify, respectively, when the FTP service will disconnect an FTP client that has not successfully logged in or is idle, or when to disconnect an idle data connection. Specifying values for the attributes in the <connections> element can directly affect the overall performance of your server by helping to police the number of active client sessions for your FTP sites.

Compatibility

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.

Windows Server 2012 or Windows Server 2012 R2

1. On the taskbar, click Server Manager.

2. In Server Manager, click the Manage menu, and then click Add Roles and Features.

3. In the Add Roles and Features wizard, click Next. Select the installation type and click Next. Select the destination server and click Next.

4. On the Server Roles page, expand Web Server (IIS), and then select FTP Server.

   Note

   To support ASP.Membership authentication or IIS Manager authentication for the FTP service, you will need to select FTP Extensibility, in addition to FTP Service.
   .

5. Click Next, and then on the Select features page, click Next again.

6. On the Confirm installation selections page, click Install.

7. On the Results page, click Close.

Windows 8 or Windows 8.1

1. On the Start screen, move the pointer all the way to the lower left corner, right-click the Start button, 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 select FTP Server.

   Note

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

4. Click OK.

5. Click Close.

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.

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.

Windows Server 2008 or Windows Vista

1. Download the installation package from the following URL:

   • https://www.iis.net/expand/FTP

2. Follow the instructions in the following walkthrough to install the FTP service:

   • Installing and Troubleshooting FTP 7

How To

How to configure the default control and data channel time-outs for all FTP sites

1. Open Internet Information Services (IIS) Manager:

   • If you are using Windows Server 2012 or Windows Server 2012 R2:

     • On the taskbar, click Server Manager, click Tools, and then click Internet Information Services (IIS) Manager.

   • If you are using Windows 8 or Windows 8.1:

     • Hold down the Windows key, press the letter X, and then click Control Panel.
     • Click Administrative Tools, and then double-click 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, click the server name, and then click the Sites node.

3. In the Sites pane, click Set FTP Site Defaults... in the Actions pane.

4. In the Advanced Settings dialog box, expand Connections, specify your time-outs in the Control Channel Timeout and Data Channel Timeout fields, and then click OK.

Configuration

Attributes

Child Elements

None.

Configuration Sample

The following configuration sample displays an example <connections> element for a server that has the default control channel time-out set to 300 seconds.

<siteDefaults>
   <ftpServer>
      <connections controlChannelTimeout="300" />
   </ftpServer>
</siteDefaults>

Sample Code

The following code samples illustrate how to set the default control channel time-out to 300 seconds..

AppCmd.exe

appcmd.exe set config -section:system.applicationHost/sites /siteDefaults.ftpServer.connections.controlChannelTimeout:"300" /commit:apphost

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 connectionsElement = ftpServerElement.GetChildElement("connections");
         connectionsElement["controlChannelTimeout"] = 300;

         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 connectionsElement As ConfigurationElement = ftpServerElement.GetChildElement("connections")
      connectionsElement("controlChannelTimeout") = 300

      serverManager.CommitChanges()
   End Sub

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 connectionsElement = ftpServerElement.ChildElements.Item("connections");
connectionsElement.Properties.Item("controlChannelTimeout").Value = 300;

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 connectionsElement = ftpServerElement.ChildElements.Item("connections")
connectionsElement.Properties.Item("controlChannelTimeout").Value = 300

adminManager.CommitChanges()