Default FTP Log Files Settings <logFile>
The <logFile>
element is used to configure the default activity logging options for an FTP server.
For example, you can enable or disable logging, specify the categories of information to store in the log file, and change the directory where the log file is stored. You can also use the <logFile>
element to control how often IIS creates a new log file based either on log file size or time interval and the maximum size (in bytes) that a log file can become.
Note
Unlike Web sites that can use the IIS, NCSA, or W3C format for log files, the FTP 7 service only stores log files in W3C format.
You can define the categories of information that IIS logs by editing the logExtFileFlags attribute. The default values are Date
, Time
, ClientIP
, UserName
, ServerIP
, Method
, UriStem
, FtpStatus
, Win32Status
, FtpSubStatus
, ServerPort
, Session
, and FullPath
.
Version | Notes |
---|---|
IIS 10.0 | The <logFile> element was not modified in IIS 10.0. |
IIS 8.5 | The <logFile> element was not modified in IIS 8.5. |
IIS 8.0 | The <logFile> element was not modified in IIS 8.0. |
IIS 7.5 | The <logFile> element of the <ftpServer> element ships as a feature of IIS 7.5. |
IIS 7.0 | The <logFile> 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:
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.
To support FTP publishing for your Web server, you must install the FTP service. To do so, use the following steps.
On the taskbar, click Server Manager.
In Server Manager, click the Manage menu, and then click Add Roles and Features.
In the Add Roles and Features wizard, click Next. Select the installation type and click Next. Select the destination server and click Next.
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.
.
Click Next, and then on the Select features page, click Next again.
On the Confirm installation selections page, click Install.
On the Results page, click Close.
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.
In Control Panel, click Programs and Features, and then click Turn Windows features on or off.
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.
Click OK.
Click Close.
On the taskbar, click Start, point to Administrative Tools, and then click Server Manager.
In the Server Manager hierarchy pane, expand Roles, and then click Web Server (IIS).
In the Web Server (IIS) pane, scroll to the Role Services section, and then click Add Role Services.
On the Select Role Services page of the Add Role Services Wizard, expand FTP Server.
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.
Click Next.
On the Confirm Installation Selections page, click Install.
On the Results page, click Close.
On the taskbar, click Start, and then click Control Panel.
In Control Panel, click Programs and Features, and then click Turn Windows Features on or off.
Expand Internet Information Services, and then FTP Server.
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.
Click OK.
Download the installation package from the following URL:
Follow the instructions in the following walkthrough to install the FTP service:
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.
In the Connections pane, click the server name where you want to configure logging.
In the Home pane, double-click FTP Logging.
- In the Log File Rollover section, click Select W3C Fields...
Select the fields for your log files, then click OK.
Under Directory, specify the path where the log file should be stored. The default is %SystemDrive%\inetpub\logs\LogFiles.
In the Log File Rollover section, specify the following options:
Schedule: to create new log file that are based on one of the following values:
- Hourly: a new log file is created each hour.
- Daily: a new log file is created each day.
- Weekly: a new log file is created each week.
- Monthly: a new log file is created each month.
Maximum file size (in bytes): to create a new log file when the file reaches a certain size (in bytes). The minimum file size is 1048576 bytes. If this attribute is set to a value less than 1048576 bytes, the default value is implicitly assumed as 1048576 bytes.
Do not create a new log file: there is a single log file that will continue to grow as information is logged.
Select Use local time for file naming and rollover to specify that log file naming and time for log file rollover uses the local server time. When this is not selected, Coordinated Universal Time (UTC) is used.
Click Apply in the Actions pane.
Attribute | Description | ||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
directory |
Optional string attribute. Specifies the logging directory, where the log file and logging-related support files are stored. The default value is %SystemDrive%\inetpub\logs\LogFiles . |
||||||||||||||||||||||||||||||||||||||||||||
enabled |
Optional Boolean attribute. true if logging is enabled; otherwise false. The default value is true . |
||||||||||||||||||||||||||||||||||||||||||||
localTimeRollover |
Optional Boolean attribute. true if the a new log file is created based on local time; otherwise, false for Coordinated Universal Time (UTC), which was previously called Greenwich Mean Time (GMT). Note: Regardless of the setting, the time stamp for each W3C Extended Logging log record is UTC-based. The default value is false . |
||||||||||||||||||||||||||||||||||||||||||||
logExtFileFlags |
Optional flags attribute. Specifies the categories of information that are written to either the log file (when you use W3C Extended log file format) or to the ODBC data source during logging events for a site. The logExtFileFlags attribute can be one or more of the following values. If you specify more than one value, separate them with a comma (,). The default values are Date , Time , ClientIP , UserName , ServerIP , Method , UriStem , FtpStatus , Win32Status , FtpSubStatus , ServerPort , Session , and FullPath .
|
||||||||||||||||||||||||||||||||||||||||||||
period |
Optional enum attribute. Specifies how often the FTP service creates a new log file. The period attribute can be one of the following possible values.The default value is Daily .
|
||||||||||||||||||||||||||||||||||||||||||||
selectiveLogging |
Optional flags attribute. Specifies the verbosity for FTP logging. The default value is LogSuccessful,LogError,LogInfrastructure .
|
||||||||||||||||||||||||||||||||||||||||||||
truncateSize |
Optional int64 attribute. Specifies the maximum size of the log file (in bytes) after which to create a new log file. This value is only applicable when MaxSize is chosen for the period attribute. The minimum file size is 1,048,576 bytes. If this attribute is set to a value less than 1,048,576 bytes, the default value is implicitly assumed as 1,048,576 bytes.The default value is 20971520 . |
None.
The following configuration sample displays an example <logFile>
element for a server that enables logging by default with daily log file rollovers.
<siteDefaults>
<ftpServer serverAutoStart="true">
<logFile period="Daily" enabled="true" />
</ftpServer>
</siteDefaults>
The following code samples illustrate how to enable logging by default with daily log file rollovers.
REM Enable logging by default with daily log file rollover.
appcmd.exe set config -section:system.applicationHost/sites /siteDefaults.ftpServer.logFile.period:"Daily" /siteDefaults.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.
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 logFileElement = ftpServerElement.GetChildElement("logFile");
logFileElement["period"] = @"Daily";
logFileElement["enabled"] = true;
serverManager.CommitChanges();
}
}
}
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 logFileElement As ConfigurationElement = ftpServerElement.GetChildElement("logFile")
logFileElement("period") = "Daily"
logFileElement("enabled") = True
serverManager.CommitChanges()
End Sub
End Module
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 logFileElement = ftpServerElement.ChildElements.Item("logFile");
logFileElement.Properties.Item("period").Value = "Daily";
logFileElement.Properties.Item("enabled").Value = true;
adminManager.CommitChanges();
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 logFileElement = ftpServerElement.ChildElements.Item("logFile")
logFileElement.Properties.Item("period").Value = "Daily"
logFileElement.Properties.Item("enabled").Value = True
adminManager.CommitChanges()