Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Guide That Contains This Content
[+] Expand All
[-] Collapse All

    Overview of Copying and Redirecting Files

    You have two options for copying or redirecting files to or from a remote FTP or TFTP server:

    • Include all remote file data in the copy command. You can specify remote files using the URL format and the file redirect option for the related show commands.
    • Use the host command to define the host and the appropriate file transfer protocol. FTP is the default if you do not specify a file transfer protocol or when Domain Name System (DNS) service is used to map IP addresses to the hostname.

    If you include the remote file data, the copy command contains a source and destination filename, either of which (but not both) can be remote files. The following URL format is supported for both source and destination files:

    protocol://[username [:password]@]location[/directory]/filename

    The location can be a hostname or an IP address.

    The two versions of the URL format are as follows:

    ftp://[username[:password ]@]location[/directory]/filenametftp://location[/directory]/filename

    Note: The TFTP protocol does not support username and password. Entering a username and password in the TFTP version results in a command error.

    The protocol specified in the command always overrides the protocol associated with the host entry, if any, in the host table. Some protocols, such as FTP, require a username and password with each request. For the URL version of the copy command, the following sequence is followed:

    • If the command contains a username, the username and password specified in the command are used. The password null is used if the command does not contain a password.
    • If the location in the URL is a hostname with a corresponding host entry (created by the host command), the username and password of the host entry are used. A host entry that is created without an explicit username is created with the default username of anonymous and password of null.

    The location is the IP address or hostname of the remote file server. The directory/filename is the full path of the file relative to the user login root path.

    The characters in the URL format can be encoded. Any of the delimiter characters can be used in the host, username, password, and directory and file fields when added as encoded characters. The encoded characters must be three characters, starting with a percent and followed by the two hexadecimal digits that are the ASCII equivalent. The system converts all printable characters before passing them to the protocol support. Unprintable characters (0-012F and 0x7f-0x7F) are not converted and are passed directly to the protocol. Printable characters (0x20– 0x7E) are decoded and all others (0x80–0xFF) are rejected.

    In the following example, the username contains the @ delimiter character encoded as %40, and the directory passed to the FTP protocol layer is /dirA/dirB/dirC. The delimiter between the hostname and directory is a forward slash (/) character. To add a slash to the start of the directory specification, add the encoded slash after the host and directory delimiter.


    In the following example, the directory passed to the FTP protocol layer is dirA/dirB/dirC.


    Published: 2014-08-12