Transferring Files Using HTTP or HTTPS

Cisco IOS Release 12.4 provides the ability to transfer files between your Cisco IOS software-based device

and a remote HTTP server using the HTTP or HTTP Secure (HTTPS) protocol. HTTP and HTTPS can now

be specified as the targets and source locations in Cisco IOS command-line interface (CLI) commands that

use file system prefixes such as the copy command.

•

Finding Feature Information, page 1

•

Prerequisites for Transferring Files Using HTTP or HTTPs, page 1

•

Restrictions for Transferring Files Using HTTP or HTTPs, page 2

•

Information About File Transfers Using HTTP or HTTPs, page 2

•

How to Transfer Files Using HTTP or HTTPs, page 2

•

Configuration Examples for the File Transfer Using HTTP or HTTPs, page 9

•

Additional References, page 10

•

Feature Information for Transferring Files Using HTTP or HTTPS, page 12

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.

Prerequisites for Transferring Files Using HTTP or HTTPs

To copy files to or from a remote HTTP server, your system must support the HTTP client feature, which is

integrated in most Cisco IOS software images. The HTTP client is enabled by default. To determine if the

HTTP client is supported on your system, issue the show ip http client allcommand. If you are able to execute

the command, the HTTP client is supported.

The Integrated File System Configuration Guide, Cisco IOS Release 15S

Commands exist for the optional configuration of the embedded HTTP client and for the HTTPS client, but

the default configuration is sufficient for using the File Transfer Using HTTP or HTTPS feature. For information

on configuring optional HTTP or HTTPS client characteristics, see the “Related Documents” section.

Restrictions for Transferring Files Using HTTP or HTTPs

Existing limitations to the copy command, such as no network-to-network copies, are in effect for the File

Transfer Using HTTP or HTTPS feature.

The copy command in Cisco IOS Release 12.4T does not work in conjunction with older versions of the

Apache server software. The Apache server software must be upgraded to version 2.0.49 or later in order

to use the copy command.

Note

Information About File Transfers Using HTTP or HTTPs

To transfer files using HTTP or HTTPS, you should understand the following concept:

The File Transfer Using HTTP or HTTPs feature provides the capability to copy files, such as Cisco IOS

image files, core files, configuration files, log files, scripts, and so on, to and from a remote server and your

local routing device using the Cisco IOS copy command and command-line interface. The HTTP copy

operation works in the same way as copying from other remote file systems, such as FTP or TFTP.

The HTTP copy operation can use the embedded HTTPS client for HTTP Secure transfers, providing secure

and authenticated file transfers within the context of a public key infrastructure (PKI).

How to Transfer Files Using HTTP or HTTPs

This section contains the following procedures:

To use the File Transfer Using HTTP feature, you may need to specify a username and password for the

HTTP connections for those servers that require a username and password to connect. Commands are also

available to specify custom connection characteristics, although default settings can be used. The feature

also offers commands to monitor and maintain connections and files.

Note

Configuring HTTP Connection Characteristics for File Transfers

Default values are provided for HTTP File transfers. The following task is used to customize the connection

characteristics for your network to specify a username and password, connection preferences, a remote proxy

server, and the source interface to be used.

The Integrated File System Configuration Guide, Cisco IOS Release 15S

Transferring Files Using HTTP or HTTPS

Restrictions for Transferring Files Using HTTP or HTTPs

SUMMARY STEPS

enable

configure terminal

ip http client connection {forceclose | idletimeoutseconds | timeoutseconds}

ip http client username username

ip http client password password

ip http client proxy-server {proxy-name | ip-address} [proxy-portport-number]

ip http client source-interface interface-id

do copy running-config startup-config

end

DETAILED STEPS

PurposeCommand or Action

Enables privileged EXEC mode.enable

Step 1

Example:

Router> enable

•

Enter your password if prompted.

Enters global configuration mode.configure terminal

Example:

Router# configure terminal

Step 2

Configures characteristics for HTTP client connections to a remote HTTP

server for all file transfers:

ip http client connection {forceclose |

idletimeoutseconds | timeoutseconds}

Step 3

Example:

Router(config)# ip http client

connection timeout 15

•

forceclose --Disables the default persistent connection.

•

idle timeout seconds --Sets the period of time allowed for an idle

connection, in a range from 1 to 60 seconds. Default timeout is 30

seconds.

•

timeout seconds --Sets the maximum time the HTTP client waits

for a connection, in a range from 1 to 60 seconds. Default is 10

seconds.

Specifies the username to be used for HTTP client connections that

require user authentication.

ip http client username username

Example:

Router(config)# ip http client username

user1

Step 4

You can also specify the username on the CLI when you issue

the copy command, in which case the username entered

overrides the username entered with this command. See the

“Downloading a File from a Remote Server Using HTTP or

HTTPs: Example” section for an example.

Note

The Integrated File System Configuration Guide, Cisco IOS Release 15S

Transferring Files Using HTTP or HTTPS

Configuring HTTP Connection Characteristics for File Transfers

PurposeCommand or Action

Specifies the password to be used for HTTP client connections that

require user authentication.

ip http client password password

Example:

Router(config)# ip http client password

letmein

Step 5

You can also specify the password on the CLI when you issue

the copy command, in which case the password entered

overrides the password entered with this command. See the

“Downloading a File from a Remote Server Using HTTP or

HTTPs: Example” section for an example.

Note

Configures the HTTP client to connect to a remote proxy server for

HTTP file system client connections.

ip http client proxy-server {proxy-name |

ip-address} [proxy-portport-number]

Step 6

Example:

Router(config)# ip http client

proxy-server edge2 proxy-port 29

•

The optionalproxy-portport-number keyword and argument specify

the proxy port number on the remote proxy server.

Specifies the interface for the source address in all HTTP client

connections.

ip http client source-interface interface-id

Example:

Router(config)# ip http client

source-interface Ethernet 0/1

Step 7

(Optional) Saves the running configuration as the startup configuration

file.

do copy running-config startup-config

Example:

Router(config)# do copy running-config

startup-config

Step 8

•

The do command allows you to execute privileged EXEC mode

commands from global configuration mode.

Ends your configuration session and returns the CLI to user EXEC mode.end

Example:

Router(config)# end

Step 9

Example:

Router#

Downloading a File from a Remote Server Using HTTP or HTTPs

Perform this task to download a file from a remote HTTP server using HTTP or HTTPs. The copy command

helps you to copy any file from a source to a destination.

The Integrated File System Configuration Guide, Cisco IOS Release 15S

Transferring Files Using HTTP or HTTPS

Downloading a File from a Remote Server Using HTTP or HTTPs

SUMMARY STEPS

enable

Do one of the following:

•

copy [/erase] [/noverify] http://remote-source-urllocal-destination-url

•

copy https:// remote-source-url local-destination-url

DETAILED STEPS

PurposeCommand or Action

Enables privileged EXEC mode.enable

Step 1

Example:

Router> enable

•

Enter your password if prompted.

Example:

Copies a file from a remote web server to

a local file system using HTTP or HTTPS.

Do one of the following:

Step 2

•

copy [/erase] [/noverify] http://remote-source-urllocal-destination-url

•

/erase --Erases the local destination

file system before copying. This

•

copy https:// remote-source-url local-destination-url

option is provided on Class B file

Example:

Router# copy

system platforms with limited

memory to allow an easy way to clear

local flash memory space.

http://user1:[email protected]:8080/image_files/c7200-i-mx

flash:c7200-i-mx

•

/noverify --If the file being copied is

an image file, this keyword disables

Example:

Router# copy

the automatic image verification that

occurs after an image is copied.

•

The remote-source-url argument is

the location URL (or alias) from

Example:

copy

which to get the file to be copied, in

standard Cisco IOS file system HTTP

syntax as follows:

https://user1:[email protected]:8080/image_files/c7200-i-mx

flash:c7200-i-mx

http:// [[username:password]@]

{hostname | host-ip}[/filepath]/filename

The Integrated File System Configuration Guide, Cisco IOS Release 15S

Transferring Files Using HTTP or HTTPS

Downloading a File from a Remote Server Using HTTP or HTTPs

PurposeCommand or Action

The optional username and

password arguments can be used

to log in to an HTTP server that

requires user authentication, in

place of configuring the

iphttpclientusername and

iphttpclientpassword global

configuration commands to

specify these authentication

strings.

Note

•

The local-destination-url is the

location URL (or alias) to put the

copied file, in standard Cisco IOS file

system syntax as follows:

filesystem : [/filepath][/filename]

For more information on URL

syntax when you use the copy

command, see the “Additional

References” section.

Note

Troubleshooting Tips

If file transfers from a remote web server fail, verify the following:

•

Your router has an active connection to the Internet.

•

The correct path and filename have been specified.

•

The remote server requires a username and password.

•

The remote server has a nonstandard communications port configured. (The default port for HTTP is

80; the default port for HTTPS is 443.)

The CLI returns error messages to help you determine the cause of a failed copy request. Additional information

on the copy process can be displayed with the debugiphttpclientall command.

Uploading a File to a Remote Server Using HTTP or HTTPS

Perform this task to upload a file to a remote HTTP server using HTTP or HTTPS.

The Integrated File System Configuration Guide, Cisco IOS Release 15S

Transferring Files Using HTTP or HTTPS

Uploading a File to a Remote Server Using HTTP or HTTPS

SUMMARY STEPS

enable

Do one of the following:

•

copy [/erase] [/noverify] local-source-urlhttp://remote-destination-url

•

copy local-source-url https:// remote-destination-url

DETAILED STEPS

PurposeCommand or Action

Enables privileged EXEC mode.enable

Step 1

Example:

Router> enable

•

Enter your password if prompted.

Copies a file from a local file system to a remote web server using HTTP

or HTTPS.

Do one of the following:

Step 2

•

copy [/erase] [/noverify]

local-source-urlhttp://remote-destination-url

•

/erase --Erases the local destination file system before copying. This

option is provided on Class B file system platforms with limited

memory to allow an easy way to clear local flash memory space.

•

copy local-source-url https://

remote-destination-url

•

/noverify --If the file being copied is an image file, this keyword

disables the automatic image verification that occurs after an image

is copied.

Example:

Router# http://user1:[email protected].

202.129:8080/image_files/c7200-i-mx_backup

•

The local-source-url argument is the location URL (or alias) from

which to get the file to be copied, in standard Cisco IOS file system

syntax as follows:

Example:

Router# copy flash:c7200-i-mx

http:// [[username:password]@] {hostname | host-ip}[/filepath]/filename

The optional username and password arguments can be used to

place of configuring the iphttpclientusername and

iphttpclientpassword global configuration commands to specify

these authentication strings.

Note

http://user1:[email protected].

202.129:8080/image_files/c7200-i-mx_backup

Example:

•

The remote-destination-url is the URL (or alias) to put the copied

file, in standard Cisco IOS file system syntax, as follows:

filesystem : [/filepath ][/filename ]

For more information on URL syntax when you use the copy

command, see the “Additional References” section.

Note

The Integrated File System Configuration Guide, Cisco IOS Release 15S

Transferring Files Using HTTP or HTTPS

Uploading a File to a Remote Server Using HTTP or HTTPS

Troubleshooting Tips

If file transfers from a remote web server fail, verify the following:

•

Your router has an active connection to the Internet.

•

The correct path and filename have been specified.

•

The remote server requires a username and password.

•

The remote server has a nonstandard communications port configured. (The default port for HTTP is

80; the default port for HTTPS is 443.)

The CLI returns error messages to help you determine the cause of a failed copy request. Additional information

on the copy process can be displayed with the debugiphttpclientall command.

Maintaining and Monitoring File Transfers Using HTTP

Perform this task to maintain and monitor HTTP connections. Steps 2 through 4 can be performed in any

order.

SUMMARY STEPS

enable

show ip http client connection

show ip http client history

show ip http client session-module

DETAILED STEPS

PurposeCommand or Action

Enables privileged EXEC mode.enable

Step 1

Example:

Router> enable

•

Enter your password if prompted.

Displays details about active HTTP client connections.show ip http client connection

Example:

Router# show ip http client connection

Step 2

Displays the last 20 URLs accessed by the HTTP client.show ip http client history

Example:

Router# show ip http client history

Step 3

The Integrated File System Configuration Guide, Cisco IOS Release 15S

Transferring Files Using HTTP or HTTPS

Maintaining and Monitoring File Transfers Using HTTP

PurposeCommand or Action

Displays details about about sessions (applications) that

have registered with the HTTP client.

show ip http client session-module

Example:

Router# show ip http client session-module

Step 4

Configuration Examples for the File Transfer Using HTTP or

HTTPs

Configuring HTTP Connection Characteristics for File Transfers Example

The following example shows how to configure the HTTP password and username for connection to a remote

server that authenticates all users. The example also shows how to configure the connection for a 20-second

idle connection period. The maximum time the HTTP client waits for a connection remains at the default 10

seconds.

Router(config)# ip http client connection idle timeout 20

Router(config)# ip http client password Secret

Router(config)# ip http client username User1

Router(config)# do show running-config | include ip http client

Downloading a File from a Remote Server Using HTTP or HTTPs Example

The following example shows how to configure the file c7200-i-mx is copied from a remote server to flash

memory using HTTP. This example also shows how to enter a username and password from the command

line for an HTTP server that authenticates users.

Router# copy http://user1:[email protected]:8080/image_files/c7200-i-mx

flash:c7200-i-mx

Uploading a File from Flash to the Remote HTTP Server Example

The following example shows how to copy a file from flash memory to the remote HTTP server. The example

shows the prompts and displays that can be expected from transferring a file using thecopy privileged EXEC

command.

Router# copy flash:c7200-js-mz.ELL2 http://172.19.209.190/user1/c7200-js-mz.ELL2

Address or name of remote host [172.19.209.190]?

Destination filename [user1/c7200-js-mz.ELL2]?

Storing http://172.19.209.190/user1/c7200-js-mz.ELL2 !!!!!!!!!!!!!!!!!!!!!!!

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

The Integrated File System Configuration Guide, Cisco IOS Release 15S

Transferring Files Using HTTP or HTTPS

Configuration Examples for the File Transfer Using HTTP or HTTPs

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

17571956 bytes copied in 57.144 secs (307503 bytes/sec)

Downloading a File from the Remote HTTP Server to Flash Memory Example

The following example shows how to copy a file from the remote HTTP server to the flash memory. The

example shows the prompts and displays that can be expected from transferring a file using the copy privileged

EXEC command.

Router# copy http://172.19.209.190/user1/c7200-i-mz.test flash:c7200-i-mz.test

Destination filename [c7200-i-mz.test]?

Loading http://172.19.209.190/user1/c7200-i-mz.test

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

11272788 bytes copied in 527.104 secs (21386 bytes/sec)

Uploading a File to a Remote Server Using HTTP or HTTPs

The following example shows how to copy a file to the remote server using HTTP or HTTPs.

router#copy flash

: http:

Source filename []? running-config

Address or name of remote host []? 10.1.102.1 Destination filename [pilot-confg]?file1 ...

Additional References

The following sections provide information related to transferring files using HTTP or HTTPS.