Default FTP Messages <messages>

Overview

The <messages> element is used to specify the message that the FTP service will display to FTP clients. The messages that are specified for the bannerMessage, greetingMessage, and maxClientsMessage attributes are displayed when an FTP client connects to an FTP site, and the message that is specified by the exitMessage attribute is displayed when an FTP client disconnects from an FTP site.

The suppressDefaultBanner attribute can be used in combination with the bannerMessage attribute to disguise your FTP server type. If the default banner is suppressed and a banner message has not been specified in the bannerMessage attribute, the FTP server will display a blank banner when an FTP client connects to your server.

The expandVariables attribute specifies whether to display a specific set of user variables in FTP messages. If this attribute is set to true, the FTP service will display user variables in FTP messages; otherwise, all message text will be displayed as entered. The supported user variables are:

User Variable Description
%BytesReceived% The number of bytes sent from the server to the client for the current session.
%BytesSent% The number of bytes sent from the client to the server for the current session.
%SessionID% The unique identifier for the current session.
%SiteName% The name of the FTP site that is hosting the current session.
%UserName% The account name of the currently logged-on user.

The allowLocalDetailedErrors attribute specifies whether to display detailed error messages when the FTP client is connecting to the FTP server on the server itself. These error messages contain detailed information that server administrators can use to troubleshoot issues. If this attribute is set to true, the FTP service will display detailed error messages only to the local host; otherwise, detailed error messages are not displayed.

Compatibility

Version Notes
IIS 7.5 The <messages> element of the <ftpServer> element ships as a feature of IIS 7.5.
IIS 7.0 The <messages> 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 customized messages for all FTP sites

  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, click the server name.
  3. In the server's Home pane, double-click the FTP Messages feature.
  4. Configure the following options:
    • Click to select the Suppress default banner option.
    • Click to select the Support user variables in messages option.
    • Type "This is my FTP server" for the Banner message.
    • Type "Hello %UserName%!" for the Welcome message.
    • Type "Goodbye %UserName%!" for the Exit message.
  5. Click Apply in the Actions pane.

Configuration

Attributes

Attribute Description
allowLocalDetailedErrors Optional Boolean attribute.

true if detailed error messages should be displayed locally; otherwise, false.

Note: Detailed error messages cannot be displayed remotely.

The default value is true.
bannerMessage Optional string attribute.

Specifies the message that is displayed when a client connects to the FTP server.

There is no default value.
exitMessage Optional string attribute.

Specifies the message that is displayed when a client is closing a connection to the FTP server.

There is no default value.
expandVariables Optional Boolean attribute.

true if user variables should be expanded; otherwise, false.

The default value is false.
greetingMessage Optional string attribute.

Specifies the message that is displayed after a client has logged in to the FTP server.

There is no default value.
maxClientsMessage Optional string attribute.

Specifies the message that is displayed when a client tries to log in and the maximum number of clients has already been reached on the FTP server.

There is no default value.
suppressDefaultBanner Optional Boolean attribute.

true if the FTP service should suppress the default "Microsoft FTP Service" banner; otherwise, false.

The default value is false.

Child Elements

None.

Configuration Sample

The following configuration sample displays an example <messages> element for a server that defines a custom default banner message and enables local detailed error messages.

<siteDefaults>
     <ftpServer>
      <messages bannerMessage="Welcome!" allowLocalDetailedErrors="true" />
     </ftpServer>
</siteDefaults>

Sample Code

The following code samples illustrate setting a custom default banner message and enabling local detailed error messages.

AppCmd.exe

appcmd.exe set config -section:system.applicationHost/sites /siteDefaults.ftpServer.messages.bannerMessage:"Welcome!" /siteDefaults.ftpServer.messages.allowLocalDetailedErrors:"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 messagesElement = ftpServerElement.GetChildElement("messages");
            messagesElement["bannerMessage"] = @"Welcome!";
            messagesElement["allowLocalDetailedErrors"] = true;

         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 messagesElement As ConfigurationElement = ftpServerElement.GetChildElement("messages")
         messagesElement("bannerMessage") = "Welcome!"
         messagesElement("allowLocalDetailedErrors") = True

      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 messagesElement = ftpServerElement.ChildElements.Item("messages");
   messagesElement.Properties.Item("bannerMessage").Value = "Welcome!";
   messagesElement.Properties.Item("allowLocalDetailedErrors").Value = true;

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 messagesElement = ftpServerElement.ChildElements.Item("messages")
   messagesElement.Properties.Item("bannerMessage").Value = "Welcome!"
   messagesElement.Properties.Item("allowLocalDetailedErrors").Value = True

adminManager.CommitChanges()
Deprecated Elements