View Source ct_ssh (common_test v1.27)

SSH/SFTP client module.

SSH/SFTP client module.

This module uses application SSH, which provides detailed information about, for example, functions, types, and options.

Argument Server in the SFTP functions is only to be used for SFTP sessions that have been started on existing SSH connections (that is, when the original connection type is ssh). Whenever the connection type is sftp, use the SSH connection reference only.

The following options are valid for specifying an SSH/SFTP connection (that is, can be used as configuration elements):

 [{ConnType, Addr},
  {port, Port},
  {user, UserName}
  {password, Pwd}
  {user_dir, String}
  {public_key_alg, PubKeyAlg}
  {connect_timeout, Timeout}
  {key_cb, KeyCallbackMod}]

ConnType = ssh | sftp.

For other types, see ssh.

All time-out parameters in ct_ssh functions are values in milliseconds.

Summary

Types

For target_name, see module ct.

Handle for a specific SSH/SFTP connection, see module ct.

Return value from an ssh_sftp function.

Functions

apread(SSH, Handle, Position, Length) -> Result

apread(SSH, Server, Handle, Position, Length) -> Result

apwrite(SSH, Handle, Position, Data) -> Result

apwrite(SSH, Server, Handle, Position, Data) -> Result

aread(SSH, Handle, Len) -> Result

aread(SSH, Server, Handle, Len) -> Result

awrite(SSH, Handle, Data) -> Result

awrite(SSH, Server, Handle, Data) -> Result

close(SSH, Handle) -> Result

close(SSH, Server, Handle) -> Result

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

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

connect(KeyOrName, ConnType, ExtraOpts) -> {ok, Handle} | {error, Reason}

del_dir(SSH, Name) -> Result

del_dir(SSH, Server, Name) -> Result

delete(SSH, Name) -> Result

delete(SSH, Server, Name) -> Result

disconnect(SSH) -> ok | {error, Reason}

exec(SSH, Command) -> {ok, Data} | {error, Reason}

exec(SSH, Command, Timeout) -> {ok, Data} | {error, Reason}

exec(SSH, ChannelId, Command, Timeout) -> {ok, Data} | {error, Reason}

get_file_info(SSH, Handle) -> Result

get_file_info(SSH, Server, Handle) -> Result

list_dir(SSH, Path) -> Result

list_dir(SSH, Server, Path) -> Result

make_dir(SSH, Name) -> Result

make_dir(SSH, Server, Name) -> Result

make_symlink(SSH, Name, Target) -> Result

make_symlink(SSH, Server, Name, Target) -> Result

open(SSH, File, Mode) -> Result

open(SSH, Server, File, Mode) -> Result

opendir(SSH, Path) -> Result

opendir(SSH, Server, Path) -> Result

position(SSH, Handle, Location) -> Result

position(SSH, Server, Handle, Location) -> Result

pread(SSH, Handle, Position, Length) -> Result

pread(SSH, Server, Handle, Position, Length) -> Result

pwrite(SSH, Handle, Position, Data) -> Result

pwrite(SSH, Server, Handle, Position, Data) -> Result

read(SSH, Handle, Len) -> Result

read(SSH, Server, Handle, Len) -> Result

read_file(SSH, File) -> Result

read_file(SSH, Server, File) -> Result

read_file_info(SSH, Name) -> Result

read_file_info(SSH, Server, Name) -> Result

read_link(SSH, Name) -> Result

read_link(SSH, Server, Name) -> Result

read_link_info(SSH, Name) -> Result

read_link_info(SSH, Server, Name) -> Result

receive_response(SSH, ChannelId) -> {ok, Data} | {error, Reason}

receive_response(SSH, ChannelId, End) -> {ok, Data} | {error, Reason}

receive_response(SSH, ChannelId, End, Timeout) -> {ok, Data} | {timeout, Data} | {error, Reason}

rename(SSH, OldName, NewName) -> Result

rename(SSH, Server, OldName, NewName) -> Result

send(SSH, ChannelId, Data) -> ok | {error, Reason}

send(SSH, ChannelId, Data, Timeout) -> ok | {error, Reason}

send(SSH, ChannelId, Type, Data, Timeout) -> ok | {error, Reason}

send_and_receive(SSH, ChannelId, Data) -> {ok, Data} | {error, Reason}

send_and_receive(SSH, ChannelId, Data, End) -> {ok, Data} | {error, Reason}

send_and_receive(SSH, ChannelId, Data, End, Timeout) -> {ok, Data} | {error, Reason}

send_and_receive(SSH, ChannelId, Type, Data, End, Timeout) -> {ok, Data} | {error, Reason}

session_close(SSH, ChannelId) -> ok | {error, Reason}

session_open(SSH) -> {ok, ChannelId} | {error, Reason}

session_open(SSH, Timeout) -> {ok, ChannelId} | {error, Reason}

sftp_connect(SSH) -> {ok, Server} | {error, Reason}

shell(SSH, ChannelId) -> ok | {error, Reason}

shell(SSH, ChannelId, Timeout) -> ok | {error, Reason}

subsystem(SSH, ChannelId, Subsystem) -> Status | {error, Reason}

subsystem(SSH, ChannelId, Subsystem, Timeout) -> Status | {error, Reason}

write(SSH, Handle, Data) -> Result

write(SSH, Server, Handle, Data) -> Result

write_file(SSH, File, Iolist) -> Result

write_file(SSH, Server, File, Iolist) -> Result

write_file_info(SSH, Name, Info) -> Result

write_file_info(SSH, Server, Name, Info) -> Result

Types

Link to this type

connection()

View Source (not exported)
-type connection() :: handle() | ct:target_name().

For target_name, see module ct.

Link to this type

handle()

View Source (not exported)
-type handle() :: pid().

Handle for a specific SSH/SFTP connection, see module ct.

Link to this type

ssh_sftp_return()

View Source (not exported)
-type ssh_sftp_return() :: term().

Return value from an ssh_sftp function.

Functions

Link to this function

apread(SSH, Handle, Position, Length)

View Source
-spec apread(SSH, Handle, Position, Length) -> Result
          when
              SSH :: connection(),
              Handle :: term(),
              Position :: integer(),
              Length :: integer(),
              Result :: ssh_sftp_return().

apread(SSH, Handle, Position, Length) -> Result

For information and other types, see ssh_sftp.

Link to this function

apread(SSH, Server, Handle, Position, Length)

View Source

apread(SSH, Server, Handle, Position, Length) -> Result

For information and other types, see ssh_sftp.

Link to this function

apwrite(SSH, Handle, Position, Data)

View Source

apwrite(SSH, Handle, Position, Data) -> Result

For information and other types, see ssh_sftp.

Link to this function

apwrite(SSH, Server, Handle, Position, Data)

View Source

apwrite(SSH, Server, Handle, Position, Data) -> Result

For information and other types, see ssh_sftp.

aread(SSH, Handle, Len) -> Result

For information and other types, see ssh_sftp.

Link to this function

aread(SSH, Server, Handle, Len)

View Source

aread(SSH, Server, Handle, Len) -> Result

For information and other types, see ssh_sftp.

Link to this function

awrite(SSH, Handle, Data)

View Source

awrite(SSH, Handle, Data) -> Result

For information and other types, see ssh_sftp.

Link to this function

awrite(SSH, Server, Handle, Data)

View Source

awrite(SSH, Server, Handle, Data) -> Result

For information and other types, see ssh_sftp.

close(SSH, Handle) -> Result

For information and other types, see ssh_sftp.

Link to this function

close(SSH, Server, Handle)

View Source

close(SSH, Server, Handle) -> Result

For information and other types, see ssh_sftp.

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

Equivalent to ct_ssh:connect(KeyOrName, host, []).

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

Equivalent to ct_ssh:connect(KeyOrName, ConnType, []).

Link to this function

connect(KeyOrName, ConnType, ExtraOpts)

View Source

connect(KeyOrName, ConnType, ExtraOpts) -> {ok, Handle} | {error, Reason}

Opens an SSH or SFTP connection using the information associated with KeyOrName.

If Name (an alias name for Key) is used to identify the connection, this name can be used as connection reference for subsequent calls. Only one open connection at a time associated with Name is possible. If Key is used, the returned handle must be used for subsequent calls (multiple connections can be opened using the configuration data specified by Key).

For information on how to create a new Name, see ct:require/2.

For target_name, see module ct.

ConnType always overrides the type specified in the address tuple in the configuration data (and in ExtraOpts). So it is possible to, for example, open an SFTP connection directly using data originally specifying an SSH connection. Value host means that the connection type specified by the host option (either in the configuration data or in ExtraOpts) is used.

ExtraOpts (optional) are extra SSH options to be added to the configuration data for KeyOrName. The extra options override any existing options with the same key in the configuration data. For details on valid SSH options, see application SSH.

del_dir(SSH, Name) -> Result

For information and other types, see ssh_sftp.

Link to this function

del_dir(SSH, Server, Name)

View Source

del_dir(SSH, Server, Name) -> Result

For information and other types, see ssh_sftp.

delete(SSH, Name) -> Result

For information and other types, see ssh_sftp.

Link to this function

delete(SSH, Server, Name)

View Source

delete(SSH, Server, Name) -> Result

For information and other types, see ssh_sftp.

disconnect(SSH) -> ok | {error, Reason}

Closes an SSH/SFTP connection.

exec(SSH, Command) -> {ok, Data} | {error, Reason}

Equivalent to ct_ssh:exec(SSH, Command, DefaultTimeout).

exec(SSH, Command, Timeout) -> {ok, Data} | {error, Reason}

Requests server to perform Command. A session channel is opened automatically for the request. Data is received from the server as a result of the command.

Link to this function

exec(SSH, ChannelId, Command, Timeout)

View Source

exec(SSH, ChannelId, Command, Timeout) -> {ok, Data} | {error, Reason}

Requests server to perform Command. A previously opened session channel is used for the request. Data is received from the server as a result of the command.

Link to this function

get_file_info(SSH, Handle)

View Source

get_file_info(SSH, Handle) -> Result

For information and other types, see ssh_sftp.

Link to this function

get_file_info(SSH, Server, Handle)

View Source

get_file_info(SSH, Server, Handle) -> Result

For information and other types, see ssh_sftp.

list_dir(SSH, Path) -> Result

For information and other types, see ssh_sftp.

Link to this function

list_dir(SSH, Server, Path)

View Source

list_dir(SSH, Server, Path) -> Result

For information and other types, see ssh_sftp.

make_dir(SSH, Name) -> Result

For information and other types, see ssh_sftp.

Link to this function

make_dir(SSH, Server, Name)

View Source

make_dir(SSH, Server, Name) -> Result

For information and other types, see ssh_sftp.

Link to this function

make_symlink(SSH, Name, Target)

View Source

make_symlink(SSH, Name, Target) -> Result

For information and other types, see ssh_sftp.

Link to this function

make_symlink(SSH, Server, Name, Target)

View Source

make_symlink(SSH, Server, Name, Target) -> Result

For information and other types, see ssh_sftp.

open(SSH, File, Mode) -> Result

For information and other types, see ssh_sftp.

Link to this function

open(SSH, Server, File, Mode)

View Source

open(SSH, Server, File, Mode) -> Result

For information and other types, see ssh_sftp.

opendir(SSH, Path) -> Result

For information and other types, see ssh_sftp.

Link to this function

opendir(SSH, Server, Path)

View Source

opendir(SSH, Server, Path) -> Result

For information and other types, see ssh_sftp.

Link to this function

position(SSH, Handle, Location)

View Source

position(SSH, Handle, Location) -> Result

For information and other types, see ssh_sftp.

Link to this function

position(SSH, Server, Handle, Location)

View Source

position(SSH, Server, Handle, Location) -> Result

For information and other types, see ssh_sftp.

Link to this function

pread(SSH, Handle, Position, Length)

View Source

pread(SSH, Handle, Position, Length) -> Result

For information and other types, see ssh_sftp.

Link to this function

pread(SSH, Server, Handle, Position, Length)

View Source

pread(SSH, Server, Handle, Position, Length) -> Result

For information and other types, see ssh_sftp.

Link to this function

pwrite(SSH, Handle, Position, Data)

View Source

pwrite(SSH, Handle, Position, Data) -> Result

For information and other types, see ssh_sftp.

Link to this function

pwrite(SSH, Server, Handle, Position, Data)

View Source

pwrite(SSH, Server, Handle, Position, Data) -> Result

For information and other types, see ssh_sftp.

read(SSH, Handle, Len) -> Result

For information and other types, see ssh_sftp.

Link to this function

read(SSH, Server, Handle, Len)

View Source

read(SSH, Server, Handle, Len) -> Result

For information and other types, see ssh_sftp.

read_file(SSH, File) -> Result

For information and other types, see ssh_sftp.

Link to this function

read_file(SSH, Server, File)

View Source

read_file(SSH, Server, File) -> Result

For information and other types, see ssh_sftp.

Link to this function

read_file_info(SSH, Name)

View Source

read_file_info(SSH, Name) -> Result

For information and other types, see ssh_sftp.

Link to this function

read_file_info(SSH, Server, Name)

View Source

read_file_info(SSH, Server, Name) -> Result

For information and other types, see ssh_sftp.

read_link(SSH, Name) -> Result

For information and other types, see ssh_sftp.

Link to this function

read_link(SSH, Server, Name)

View Source

read_link(SSH, Server, Name) -> Result

For information and other types, see ssh_sftp.

Link to this function

receive_response(SSH, ChannelId)

View Source

receive_response(SSH, ChannelId) -> {ok, Data} | {error, Reason}

Equivalent to ct_ssh:receive_response(SSH, ChannelId, close).

receive_response(SSH, ChannelId, End) -> {ok, Data} | {error, Reason}

Equivalent to ct_ssh:receive_response(SSH, ChannelId, End, DefaultTimeout).

Link to this function

receive_response(SSH, ChannelId, End, Timeout)

View Source

receive_response(SSH, ChannelId, End, Timeout) -> {ok, Data} | {timeout, Data} | {error, Reason}

Receives expected data from server on the specified session channel.

If End == close, data is returned to the caller when the channel is closed by the server. If a time-out occurs before this happens, the function returns {timeout,Data} (where Data is the data received so far).

If End == timeout, a time-out is expected and {ok,Data} is returned both in the case of a time-out and when the channel is closed.

If End is a fun, this fun is called with one argument, the data value in a received ssh_cm message (see ssh_connection. The fun is to return either true to end the receiving operation (and have the so far collected data returned) or false to wait for more data from the server. Even if a fun is supplied, the function returns immediately if the server closes the channel).

Link to this function

rename(SSH, OldName, NewName)

View Source

rename(SSH, OldName, NewName) -> Result

For information and other types, see ssh_sftp.

Link to this function

rename(SSH, Server, OldName, NewName)

View Source

rename(SSH, Server, OldName, NewName) -> Result

For information and other types, see ssh_sftp.

Link to this function

send(SSH, ChannelId, Data)

View Source

send(SSH, ChannelId, Data) -> ok | {error, Reason}

Equivalent to ct_ssh:send(SSH, ChannelId, 0, Data, DefaultTimeout).

send(SSH, ChannelId, Data, Timeout) -> ok | {error, Reason}

Equivalent to ct_ssh:send(SSH, ChannelId, 0, Data, Timeout).

Link to this function

send(SSH, ChannelId, Type, Data, Timeout)

View Source

send(SSH, ChannelId, Type, Data, Timeout) -> ok | {error, Reason}

Sends data to server on specified session channel.

Link to this function

send_and_receive(SSH, ChannelId, Data)

View Source

send_and_receive(SSH, ChannelId, Data) -> {ok, Data} | {error, Reason}

Equivalent to ct_ssh:send_and_receive(SSH, ChannelId, Data, close).

send_and_receive(SSH, ChannelId, Data, End) -> {ok, Data} | {error, Reason}

Equivalent to ct_ssh;send_and_receive(SSH, ChannelId, 0, Data, End, DefaultTimeout).

send_and_receive(SSH, ChannelId, Data, End, Timeout) -> {ok, Data} | {error, Reason}

Equivalent to ct_ssh:send_and_receive(SSH, ChannelId, 0, Data, End, Timeout).

Link to this function

send_and_receive(SSH, ChannelId, Type, Data, End, Timeout)

View Source

send_and_receive(SSH, ChannelId, Type, Data, End, Timeout) -> {ok, Data} | {error, Reason}

Sends data to server on specified session channel and waits to receive the server response.

For details on argument End, see ct_ssh:receive_response/4.

Link to this function

session_close(SSH, ChannelId)

View Source

session_close(SSH, ChannelId) -> ok | {error, Reason}

Closes an SSH session channel.

session_open(SSH) -> {ok, ChannelId} | {error, Reason}

Equivalent to ct_ssh:session_open(SSH, DefaultTimeout).

Link to this function

session_open(SSH, Timeout)

View Source

session_open(SSH, Timeout) -> {ok, ChannelId} | {error, Reason}

Opens a channel for an SSH session.

sftp_connect(SSH) -> {ok, Server} | {error, Reason}

Starts an SFTP session on an already existing SSH connection. Server identifies the new session and must be specified whenever SFTP requests are to be sent.

Link to this function

shell(SSH, ChannelId)

View Source (since OTP 20.0)
-spec shell(SSH, ChannelId) -> Result
         when
             SSH :: handle() | ct:target_name(),
             ChannelId :: ssh:ssh_channel_id(),
             Result :: ok | {error, term()}.

shell(SSH, ChannelId) -> ok | {error, Reason}

Equivalent to ct_ssh:shell(SSH, ChannelId, DefaultTimeout).

Link to this function

shell(SSH, ChannelId, Timeout)

View Source (since OTP 20.0)
-spec shell(SSH, ChannelId, Timeout) -> Result
         when
             SSH :: handle() | ct:target_name(),
             ChannelId :: ssh:ssh_channel_id(),
             Timeout :: timeout(),
             Result :: ok | {error, term()}.

shell(SSH, ChannelId, Timeout) -> ok | {error, Reason}

Requests that the user default shell (typically defined in /etc/passwd in Unix systems) is executed at the server end.

Link to this function

subsystem(SSH, ChannelId, Subsystem)

View Source

subsystem(SSH, ChannelId, Subsystem) -> Status | {error, Reason}

Equivalent to ct_ssh:subsystem(SSH, ChannelId, Subsystem, DefaultTimeout).

Link to this function

subsystem(SSH, ChannelId, Subsystem, Timeout)

View Source

subsystem(SSH, ChannelId, Subsystem, Timeout) -> Status | {error, Reason}

Sends a request to execute a predefined subsystem.

Link to this function

write(SSH, Handle, Data)

View Source

write(SSH, Handle, Data) -> Result

For information and other types, see ssh_sftp.

Link to this function

write(SSH, Server, Handle, Data)

View Source

write(SSH, Server, Handle, Data) -> Result

For information and other types, see ssh_sftp.

Link to this function

write_file(SSH, File, Iolist)

View Source

write_file(SSH, File, Iolist) -> Result

For information and other types, see ssh_sftp.

Link to this function

write_file(SSH, Server, File, Iolist)

View Source

write_file(SSH, Server, File, Iolist) -> Result

For information and other types, see ssh_sftp.

Link to this function

write_file_info(SSH, Name, Info)

View Source

write_file_info(SSH, Name, Info) -> Result

For information and other types, see ssh_sftp.

Link to this function

write_file_info(SSH, Server, Name, Info)

View Source

write_file_info(SSH, Server, Name, Info) -> Result

For information and other types, see ssh_sftp.