User's Guide
Reference Manual
Release Notes
PDF
Top

Common Test
Reference Manual
Version 1.4.7

Expand All
Contract All

Table of Contents

# ct_ftp

### MODULE

ct_ftp

### MODULE SUMMARY

FTP client module (based on the FTP support of the INETS application).

### DESCRIPTION

FTP client module (based on the FTP support of the INETS application).

### DATA TYPES

connection() = handle() | target_name() (see module ct)
handle() = handle() (see module ct_gen_conn)

  Handle for a specific ftp connection.

### EXPORTS

cd(Connection, Dir) -> ok | {error, Reason}

Types:

Connection = connection()
Dir = string()

Change directory on remote host.

close(Connection) -> ok | {error, Reason}

Types:

Connection = connection()

Close the FTP connection.

delete(Connection, File) -> ok | {error, Reason}

Types:

Connection = connection()
File = string()

Delete a file on remote host

get(KeyOrName, RemoteFile, LocalFile) -> ok | {error, Reason}

Types:

KeyOrName = Key | Name
Key = atom()
Name = target_name() (see module ct)
RemoteFile = string()
LocalFile = string()

Open a ftp connection and fetch a file from the remote host.

RemoteFile and LocalFile must be absolute paths.

The config file must be as for put/3.

See also: put/3.

ls(Connection, Dir) -> {ok, Listing} | {error, Reason}

Types:

Connection = connection()
Dir = string()
Listing = string()

List the directory Dir.

open(KeyOrName) -> {ok, Handle} | {error, Reason}

Types:

KeyOrName = Key | Name
Key = atom()
Name = target_name() (see module ct)
Handle = handle()

Open an FTP connection to the specified node.

You can open one connection for a particular Name and use the same name as reference for all subsequent operations. If you want the connection to be associated with Handle instead (in case you need to open multiple connections to a host for example), simply use Key, the configuration variable name, to specify the target. Note that a connection that has no associated target name can only be closed with the handle value.

put(KeyOrName, LocalFile, RemoteFile) -> ok | {error, Reason}

Types:

KeyOrName = Key | Name
Key = atom()
Name = target_name() (see module ct)
LocalFile = string()
RemoteFile = string()

Open a ftp connection and send a file to the remote host.

LocalFile and RemoteFile must be absolute paths.

If the target host is a "special" node, the ftp address must be specified in the config file like this:

       {node,[{ftp,IpAddr}]}.

If the target host is something else, e.g. a unix host, the config file must also include the username and password (both strings):

       {unix,[{ftp,IpAddr},
              {username,Username},
              {password,Password}]}.

recv(Connection, RemoteFile) -> ok | {error, Reason}

Fetch a file over FTP.

The file will get the same name on the local host.

See also: recv/3.

recv(Connection, RemoteFile, LocalFile) -> ok | {error, Reason}

Types:

Connection = connection()
RemoteFile = string()
LocalFile = string()

Fetch a file over FTP.

The file will be named LocalFile on the local host.

send(Connection, LocalFile) -> ok | {error, Reason}

Send a file over FTP.

The file will get the same name on the remote host.

See also: send/3.

send(Connection, LocalFile, RemoteFile) -> ok | {error, Reason}

Types:

Connection = connection()
LocalFile = string()
RemoteFile = string()

Send a file over FTP.

The file will be named RemoteFile on the remote host.

type(Connection, Type) -> ok | {error, Reason}

Types:

Connection = connection()
Type = ascii | binary

Change file transfer type