Configuring IP SLAs FTP Operations

Last Updated: July 18, 2011

This module describes how to configure an IP Service Level Agreements (SLAs) File Transfer Protocol (FTP) operation to measure the response time between a Cisco device and a FTP server to retrieve a file. The IP SLAs FTP operation supports an FTP GET request only. This module also demonstrates how the results of the FTP operation can be displayed and analyzed to determine the capacity of your network. The FTP operation can be used also for troubleshooting FTP server performance.

Finding Feature Information

Your software release may not support all the features documented in this module. For the latest feature information and caveats, see the release notes for your platform and software release. To find information about the features documented in this module, and to see a list of the releases in which each feature is supported, see the Feature Information Table at the end of this document.

Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to www.cisco.com/go/cfn. An account on Cisco.com is not required.

Restrictions for IP SLAs FTP Operations

The IP SLAs FTP operation only supports FTP GET (download) requests.

Information About IP SLAs FTP Operations

FTP Operation

The FTP operation measures the round-trip time (RTT) between a Cisco device and an FTP server to retrieve a file. FTP is an application protocol, part of the Transmission Control Protocol (TCP)/IP protocol stack, used for transferring files between network nodes.

In the figure below Router B is configured as the source IP SLAs device and an FTP operation is configured with the FTP server as the destination device.

Figure 1 FTP Operation


Connection response time is computed by measuring the time taken to download a file to Router B from the remote FTP server using FTP over TCP. This operation does not use the IP SLAs Responder.


Note
To test the response time to connect to an FTP port (Port 21), use the IP SLAs TCP Connect operation.

Both active and passive FTP transfer modes are supported. The passive mode is enabled by default. Only the FTP GET (download) operation type is supported. The URL specified for the FTP GET operation must be in one of the following formats:

  • ftp://username:password@host/filename
  • ftp://host/filename

If the username and password are not specified, the defaults are anonymous and test, respectively.

FTP carries a significant amount of data traffic and can affect the performance of your network. The results of an IP SLAs FTP operation to retrieve a large file can be used to determine the capacity of the network but retrieve large files with caution because the FTP operation will consume more bandwidth. The FTP operation also measures your FTP server performance levels by determining the RTT taken to retrieve a file.

How to Configure IP SLAs FTP Operations

Configuring an FTP Operation on a Source Device


Note
There is no need to configure an IP SLAs responder on the destination device.

Perform one of the following tasks:

Configuring a Basic FTP Operation on the Source Device

SUMMARY STEPS

1.    enable

2.    configure terminal

3.    ip sla operation-number

4.    ftp get url [source-ip {ip-address | hostname}] [mode {passive | active}

5.    frequency seconds

6.    end


DETAILED STEPS
  Command or Action Purpose
Step 1
enable


Example:

Router> enable

 

Enables privileged EXEC mode.

  • Enter your password if prompted.
 
Step 2
configure terminal


Example:

Router# configure terminal

 

Enters global configuration mode.

 
Step 3
ip sla operation-number


Example:

Router(config)# ip sla 10

 

Begins configuration for an IP SLAs operation and enters IP SLA configuration mode.

 
Step 4
ftp get url [source-ip {ip-address | hostname}] [mode {passive | active}


Example:

Router(config-ip-sla)# ftp get ftp://username:password@hostip/test.cap

 

Defines an FTP operation and enters IP SLA FTP configuration mode.

 
Step 5
frequency seconds


Example:

Router(config-ip-sla-ftp)# frequency 30

 

(Optional) Sets the rate at which a specified IP SLAs operation repeats.

 
Step 6
end


Example:

Router(config-ip-sla-ftp)# exit

 

Exits to privileged EXEC mode.

 

Configuring an FTP Operation with Optional Parameters on the Source Device

SUMMARY STEPS

1.    enable

2.    configure terminal

3.    ip sla operation-number

4.    ftp get url [source-ip {ip-address | hostname}] [mode {passive | active}

5.    history buckets-kept size

6.    history distributions-of-statistics-kept size

7.    history enhanced [interval seconds] [buckets number-of-buckets]

8.    history filter {none | all | overThreshold | failures}

9.    frequency seconds

10.    history hours-of-statistics-kept hours

11.    history lives-kept lives

12.    owner owner-id

13.    history statistics-distribution-interval milliseconds

14.    tag text

15.    threshold milliseconds

16.    timeout milliseconds

17.    end


DETAILED STEPS
  Command or Action Purpose
Step 1
enable


Example:

Router> enable

 

Enables privileged EXEC mode.

  • Enter your password if prompted.
 
Step 2
configure terminal


Example:

Router# configure terminal

 

Enters global configuration mode.

 
Step 3
ip sla operation-number


Example:

Router(config)# ip sla 10

 

Begins configuration for an IP SLAs operation and enters IP SLA configuration mode.

 
Step 4
ftp get url [source-ip {ip-address | hostname}] [mode {passive | active}


Example:

Router(config-ip-sla)# ftp get ftp://username:password@hostip/filename

 

Defines an FTP operation and enters IP SLA FTP configuration mode.

 
Step 5
history buckets-kept size


Example:

Router(config-ip-sla-ftp)# history buckets-kept 25

 

(Optional) Sets the number of history buckets that are kept during the lifetime of an IP SLAs operation.

 
Step 6
history distributions-of-statistics-kept size


Example:

Router(config-ip-sla-ftp)# history distributions-of-statistics-kept 5

 

(Optional) Sets the number of statistics distributions kept per hop during an IP SLAs operation.

 
Step 7
history enhanced [interval seconds] [buckets number-of-buckets]


Example:

Router(config-ip-sla-ftp)# history enhanced interval 900 buckets 100

 

(Optional) Enables enhanced history gathering for an IP SLAs operation.

 
Step 8
history filter {none | all | overThreshold | failures}


Example:

Router(config-ip-sla-ftp)# history filter failures

 

(Optional) Defines the type of information kept in the history table for an IP SLAs operation.

 
Step 9
frequency seconds


Example:

Router(config-ip-sla-ftp)# frequency 30

 

(Optional) Sets the rate at which a specified IP SLAs operation repeats.

 
Step 10
history hours-of-statistics-kept hours


Example:

Router(config-ip-sla-ftp)# history hours-of-statistics-kept 4

 

(Optional) Sets the number of hours for which statistics are maintained for an IP SLAs operation.

 
Step 11
history lives-kept lives


Example:

Router(config-ip-sla-ftp)# history lives-kept 5

 

(Optional) Sets the number of lives maintained in the history table for an IP SLAs operation.

 
Step 12
owner owner-id


Example:

Router(config-ip-sla-ftp)# owner admin

 

(Optional) Configures the Simple Network Management Protocol (SNMP) owner of an IP SLAs operation.

 
Step 13
history statistics-distribution-interval milliseconds


Example:

Router(config-ip-sla-ftp)# history statistics-distribution-interval 10

 

(Optional) Sets the time interval for each statistics distribution kept for an IP SLAs operation.

 
Step 14
tag text


Example:

Router(config-ip-sla-ftp)# tag TelnetPollServer1

 

(Optional) Creates a user-specified identifier for an IP SLAs operation.

 
Step 15
threshold milliseconds


Example:

Router(config-ip-sla-ftp)# threshold 10000

 

(Optional) Sets the upper threshold value for calculating network monitoring statistics created by an IP SLAs operation.

 
Step 16
timeout milliseconds


Example:

Router(config-ip-sla-ftp)# timeout 10000

 

(Optional) Sets the amount of time an IP SLAs operation waits for a response from its request packet.

 
Step 17
end


Example:

Router(config-ip-sla-ftp)# end

 

Exits to privileged EXEC mode.

 

Scheduling IP SLAs Operations


Note
  • All IP SLAs operations to be scheduled must be already configured.
  • The frequency of all operations scheduled in a multioperation group must be the same.
  • List of one or more operation ID numbers to be added to a multioperation group is limited to a maximum of 125 characters, including commas (,).
SUMMARY STEPS

1.    enable

2.    configure terminal

3.    Do one of the following:

  • ip sla schedule operation-number [life {forever | seconds}] [start-time {hh : mm[: ss] [month day | day month] | pending | now | after hh : mm : ss}] [ageout seconds] [recurring]
  • ip sla group schedule group-operation-number operation-id-numbers schedule-period schedule-period-range [ageout seconds] [frequency group-operation-frequency] [life{forever | seconds}] [start-time{hh:mm[:ss] [month day | day month] | pending | now | after hh:mm:ss}]

4.    exit

5.    show ip sla group schedule

6.    show ip sla configuration


DETAILED STEPS
  Command or Action Purpose
Step 1
enable


Example:

Router> enable

 

Enables privileged EXEC mode.

  • Enter your password if prompted.
 
Step 2
configure terminal


Example:

Router# configure terminal

 

Enters global configuration mode.

 
Step 3
Do one of the following:
  • ip sla schedule operation-number [life {forever | seconds}] [start-time {hh : mm[: ss] [month day | day month] | pending | now | after hh : mm : ss}] [ageout seconds] [recurring]
  • ip sla group schedule group-operation-number operation-id-numbers schedule-period schedule-period-range [ageout seconds] [frequency group-operation-frequency] [life{forever | seconds}] [start-time{hh:mm[:ss] [month day | day month] | pending | now | after hh:mm:ss}]


Example:

Router(config)# ip sla schedule 10 start-time now life forever



Example:

Router(config)# ip sla group schedule 1 3,4,6-9

 

For individual IP SLAs operations only:

Configures the scheduling parameters for an individual IP SLAs operation.

or

For multioperation scheduler only:

Specifies an IP SLAs operation group number and the range of operation numbers to be scheduled in global configuration mode.

 
Step 4
exit


Example:

Router(config)# exit

 

Exits to privileged EXEC mode.

 
Step 5
show ip sla group schedule


Example:

Router# show ip sla group schedule

 

(Optional) Displays the IP SLAs group schedule details.

 
Step 6
show ip sla configuration


Example:

Router# show ip sla configuration

 

(Optional) Displays the IP SLAs configuration details.

 

Troubleshooting Tips

  • If the IP SLAs operation is not running and generating statistics, add the verify-data command to the configuration of the operation (while configuring in IP SLA configuration mode) to enable data verification. When enabled, each operation response is checked for corruption. Use the verify-data command with caution during normal operations because it generates unnecessary overhead.
  • Use the debugipsla trace and debug ip sla error commands to help troubleshoot issues with an IP SLAs operation.

What to Do Next

To add proactive threshold conditions and reactive triggering for generating traps, or for starting another operation, to an IP SLAs operation, see the "Configuring Proactive Threshold Monitoring" section.

To view and interpret the results of an IP SLAs operation use the show ip sla statistics command. Checking the output for fields that correspond to criteria in your service level agreement will help you determine whether the service metrics are acceptable.

Configuration Examples for IP SLAs FTP Operations

Example Configuring an FTP Operation

The following example shows how to configure an FTP operation from Router B to the FTP server as shown in the "FTP Operation" figure in the "Information About IP SLAs FTP Operation" section. The operation is scheduled to start every day at 1:30 a.m. In this example, the file named test.cap is to be retrieved from the host, cisco.com, with a password of abc using FTP in active mode.

Router B Configuration

ip sla 10
 ftp get ftp://user1:abc@test.cisco.com/test.cap mode active
 frequency 20
 tos 128
 timeout 40000
 tag FLL-FTP
ip sla schedule 10 start-time 01:30:00 recurring

Additional References

Related Documents

Related Topic

Document Title

Cisco IOS commands

Cisco IOS Master Commands List, All Releases

Cisco IOS IP SLAs commands

Cisco IOS IP SLAs Command Reference

Cisco IOS IP SLAs: general information

Cisco IOS IP SLAs Overview chapter of the Cisco IOS IP SLAs Configuration Guide.

Standards

Standards

Title

No new or modified standards are supported by this feature, and support for existing standards has not been modified by this feature.

--

MIBs

MIBs

MIBs Link

CISCO-RTTMON-MIB

To locate and download MIBs for selected platforms, Cisco IOS releases, and feature sets, use Cisco MIB Locator found at the following URL:

http://www.cisco.com/go/mibs

RFCs

RFCs

Title

No new or modified RFCs are supported by this feature, and support for existing RFCs has not been modified by this feature.

--

Technical Assistance

Description

Link

The Cisco Support and Documentation website provides online resources to download documentation, software, and tools. Use these resources to install and configure the software and to troubleshoot and resolve technical issues with Cisco products and technologies. Access to most tools on the Cisco Support and Documentation website requires a Cisco.com user ID and password.

http://www.cisco.com/cisco/web/support/index.html

Feature Information for IP SLAs FTP Operations

The following table provides release information about the feature or features described in this module. This table lists only the software release that introduced support for a given feature in a given software release train. Unless noted otherwise, subsequent releases of that software release train also support that feature.

Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to www.cisco.com/go/cfn. An account on Cisco.com is not required.

Table 1 Feature Information for IP SLAs FTP Operations

Feature Name

Releases

Feature Information

IP SLAs FTP Operation

12.2(31)SB2

12.2(33)SRB1

12.2(33)SXH

12.3(14)T

15.0(1)S

Cisco IOS XE 3.1.0SG

The Cisco IOS IP SLAs File Transfer Protocol (FTP) operation allows you to measure the network response time between a Cisco device and an FTP server to retrieve a file.

Cisco and the Cisco Logo are trademarks of Cisco Systems, Inc. and/or its affiliates in the U.S. and other countries. A listing of Cisco's trademarks can be found at www.cisco.com/go/trademarks. Third party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1005R)

Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental.