ct_ssh (common_test v1.30)

Copy Markdown View Source

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

connection()

Reference to opened SSH/SFTP connection associated to either a handle or target_name.

connection_type()

Connection type used for connect.

handle()

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

ssh_channel_id()

Data type representing a channel inside a connection.

ssh_data_type_code()

The valid values are 0 ("normal") and 1 ("stderr"), see RFC 4254, Section 5.2.

Functions

apread(SSH, Handle, Position, Length)

For information and other types, see ssh_sftp.

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

For information and other types, see ssh_sftp.

apwrite(SSH, Handle, Position, Data)

For information and other types, see ssh_sftp.

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

For information and other types, see ssh_sftp.

aread(SSH, Handle, Len)

For information and other types, see ssh_sftp.

aread(SSH, Server, Handle, Len)

For information and other types, see ssh_sftp.

awrite(SSH, Handle, Data)

For information and other types, see ssh_sftp.

awrite(SSH, Server, Handle, Data)

For information and other types, see ssh_sftp.

close(SSH, Handle)

For information and other types, see ssh_sftp.

close(SSH, Server, Handle)

For information and other types, see ssh_sftp.

connect/2

Opens an SSH or SFTP connection using the information associated with KeyOrName (see connect/3).

connect(KeyOrName)
connect(KeyOrName, ConnType, ExtraOpts)

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

del_dir(SSH, Name)

For information and other types, see ssh_sftp.

del_dir(SSH, Server, Name)

For information and other types, see ssh_sftp.

delete(SSH, Name)

For information and other types, see ssh_sftp.

delete(SSH, Server, Name)

For information and other types, see ssh_sftp.

disconnect(SSH)

Closes an SSH/SFTP connection.

exec(SSH, Command)
exec/3

Requests server to perform Command, (see exec/4).

exec(SSH, ChannelId, Command, Timeout)

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.

get_file_info(SSH, Handle)

For information and other types, see ssh_sftp.

get_file_info(SSH, Server, Handle)

For information and other types, see ssh_sftp.

list_dir(SSH, Path)

For information and other types, see ssh_sftp.

list_dir(SSH, Server, Path)

For information and other types, see ssh_sftp.

make_dir(SSH, Name)

For information and other types, see ssh_sftp.

make_dir(SSH, Server, Name)

For information and other types, see ssh_sftp.

make_symlink(SSH, Name, Target)

For information and other types, see ssh_sftp.

make_symlink(SSH, Server, Name, Target)

For information and other types, see ssh_sftp.

open(SSH, File, Mode)

For information and other types, see ssh_sftp.

open(SSH, Server, File, Mode)

For information and other types, see ssh_sftp.

opendir(SSH, Path)

For information and other types, see ssh_sftp.

opendir(SSH, Server, Path)

For information and other types, see ssh_sftp.

position(SSH, Handle, Location)

For information and other types, see ssh_sftp.

position(SSH, Server, Handle, Location)

For information and other types, see ssh_sftp.

pread(SSH, Handle, Position, Length)

For information and other types, see ssh_sftp.

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

For information and other types, see ssh_sftp.

pwrite(SSH, Handle, Position, Data)

For information and other types, see ssh_sftp.

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

For information and other types, see ssh_sftp.

read(SSH, Handle, Len)

For information and other types, see ssh_sftp.

read(SSH, Server, Handle, Len)

For information and other types, see ssh_sftp.

read_file(SSH, File)

For information and other types, see ssh_sftp.

read_file(SSH, Server, File)

For information and other types, see ssh_sftp.

read_file_info(SSH, Name)

For information and other types, see ssh_sftp.

read_file_info(SSH, Server, Name)

For information and other types, see ssh_sftp.

read_link(SSH, Name)

For information and other types, see ssh_sftp.

read_link(SSH, Server, Name)

For information and other types, see ssh_sftp.

read_link_info(SSH, Name)

For information and other types, see ssh_sftp.

read_link_info(SSH, Server, Name)

For information and other types, see ssh_sftp.

receive_response/3

Receives expected data from server on the specified session channel (see receive_response/4).

receive_response(SSH, ChannelId)
receive_response(SSH, ChannelId, End, Timeout)

Receives expected data from server on the specified session channel.

rename(SSH, OldName, NewName)

For information and other types, see ssh_sftp.

rename(SSH, Server, OldName, NewName)

For information and other types, see ssh_sftp.

send/4

Sends data to server on specified session channel (see send/5).

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

Sends data to server on specified session channel.

send_and_receive/4

Sends data to server on specified session channel and waits to receive the server response (see send_and_receive/6).

send_and_receive/5

Sends data to server on specified session channel and waits to receive the server response (see send_and_receive/6).

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

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

session_close(SSH, ChannelId)

Closes an SSH session channel.

session_open(SSH)
session_open(SSH, Timeout)

Opens a channel for an SSH session.

sftp_connect(SSH)

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.

shell(SSH, ChannelId)
shell(SSH, ChannelId, Timeout)

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

subsystem(SSH, ChannelId, Subsystem)
subsystem(SSH, ChannelId, Subsystem, Timeout)

Sends a request to execute a predefined subsystem.

write(SSH, Handle, Data)

For information and other types, see ssh_sftp.

write(SSH, Server, Handle, Data)

For information and other types, see ssh_sftp.

write_file(SSH, File, Iolist)

For information and other types, see ssh_sftp.

write_file(SSH, Server, File, Iolist)

For information and other types, see ssh_sftp.

write_file_info(SSH, Name, Info)

For information and other types, see ssh_sftp.

write_file_info(SSH, Server, Name, Info)

For information and other types, see ssh_sftp.

Types

connection()

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

Reference to opened SSH/SFTP connection associated to either a handle or target_name.

connection_type()

(not exported) 
-type connection_type() :: host | ssh | sftp.

Connection type used for connect.

handle()

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

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

ssh_channel_id()

(not exported) 
-type ssh_channel_id() :: non_neg_integer().

Data type representing a channel inside a connection.

"For ssh_channel_id, see module ssh.".

ssh_data_type_code()

(not exported) 
-type ssh_data_type_code() :: non_neg_integer().

The valid values are 0 ("normal") and 1 ("stderr"), see RFC 4254, Section 5.2.

Functions

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

Types

SSH = connection()
Handle = Reason = N = term()
Position = Length = integer()
Result = {async, N} | {error, Reason}

For information and other types, see ssh_sftp.

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

Types

SSH = connection()
Server = pid()
Handle = Reason = N = term()
Position = Length = integer()
Result = {async, N} | {error, Reason}

For information and other types, see ssh_sftp.

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

Types

SSH = connection()
Handle = Reason = N = term()
Position = integer()
Data = binary()
Result = {async, N} | {error, Reason}

For information and other types, see ssh_sftp.

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

Types

SSH = connection()
Server = pid()
Handle = Reason = N = term()
Position = integer()
Data = binary()
Result = {async, N} | {error, Reason}

For information and other types, see ssh_sftp.

aread(SSH :: connection(), Handle :: term(), Len :: integer()) -> Result

Types

Handle = Reason = N = term()
Result = {async, N} | {error, Reason}

For information and other types, see ssh_sftp.

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

Types

SSH = connection()
Server = pid()
Handle = Reason = N = term()
Len = integer()
Result = {async, N} | {error, Reason}

For information and other types, see ssh_sftp.

awrite(SSH :: connection(), Handle :: term(), Data :: binary()) -> Result

Types

Handle = Reason = N = term()
Result = {async, N} | {error, Reason}

For information and other types, see ssh_sftp.

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

Types

SSH = connection()
Server = pid()
Handle = Reason = N = term()
Data = binary()
Result = {async, N} | {error, Reason}

For information and other types, see ssh_sftp.

close(SSH :: connection(), Handle :: term()) -> Result

Types

Handle = Reason = term()
Result = ok | {error, Reason}

For information and other types, see ssh_sftp.

close(SSH :: connection(), Server :: pid(), Handle :: term()) -> Result

Types

Handle = Reason = term()
Result = ok | {error, Reason}

For information and other types, see ssh_sftp.

connect/2

-spec connect(KeyOrName, ConnType) -> {ok, Handle} | {error, Reason}
                 when
                     KeyOrName :: ct:key_or_name(),
                     ConnType :: connection_type(),
                     Handle :: handle(),
                     Reason :: term();
             (KeyOrName, ExtraOpts) -> {ok, Handle} | {error, Reason}
                 when
                     KeyOrName :: ct:key_or_name(),
                     ExtraOpts :: [ExtraOption],
                     ExtraOption ::
                         {ssh, Address} | {sftp, Address} | ssh:client_option() | ssh_sftp:sftp_option(),
                     Address :: ssh:host(),
                     Handle :: handle(),
                     Reason :: term().

Opens an SSH or SFTP connection using the information associated with KeyOrName (see connect/3).

Equivalent to connect(KeyOrName, ConnType, []) if called with ConnType being atom.

Equivalent to connect(KeyOrName, host, ExtraOpts) if called with ExtraOpts being list.

connect(KeyOrName) ≡ connect(KeyOrName, host, [])

connect(KeyOrName, ConnType, ExtraOpts) -> Result

Types

KeyOrName = ct:key_or_name()
ConnType = connection_type()
ExtraOpts = [ExtraOption]
Result = {ok, Handle} | {error, Reason}
Reason = term()
Handle = handle()
ExtraOption = {ssh, Address} | {sftp, Address} | ssh:client_option() | ssh_sftp:sftp_option()
Address = ssh:host()

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.

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 :: connection(), Name :: file:filename()) -> Result

Types

Result = ok | {error, Reason}
Reason = term()

For information and other types, see ssh_sftp.

del_dir(SSH :: connection(), Server :: pid(), Name :: file:filename()) -> Result

Types

Result = ok | {error, Reason}
Reason = term()

For information and other types, see ssh_sftp.

delete(SSH :: connection(), Name :: file:filename()) -> Result

Types

Result = ok | {error, Reason}
Reason = term()

For information and other types, see ssh_sftp.

delete(SSH :: connection(), Server :: pid(), Name :: file:filename()) -> Result

Types

Result = ok | {error, Reason}
Reason = term()

For information and other types, see ssh_sftp.

disconnect(SSH :: connection()) -> Result

Types

Result = ok | {error, Reason}
Reason = term()

Closes an SSH/SFTP connection.

exec(SSH, Command) ≡ exec(SSH, Command, DefaultTimeout)

exec/3

-spec exec(SSH, Command) -> {ok, Data} | {timeout, Data} | {error, Reason}
              when SSH :: connection(), Command :: string(), Data :: string(), Reason :: term().
-spec exec(SSH, Command, Timeout) -> {ok, Data} | {timeout, Data} | {error, Reason}
              when
                  SSH :: connection(),
                  Command :: string(),
                  Timeout :: timeout(),
                  Data :: string(),
                  Reason :: term();
          (SSH, ChannelId, Command) -> {ok, Data} | {timeout, Data} | {error, Reason}
              when
                  SSH :: connection(),
                  ChannelId :: ssh_channel_id(),
                  Command :: string(),
                  Data :: string(),
                  Reason :: term().

Requests server to perform Command, (see exec/4).

Equivalent to exec(SSH, undefined, Command, Timeout) if called with Command being string.

Equivalent to exec(SSH, ChannelId, Command, DefaultTimeout) if called with ChannelId being integer.

exec(SSH, ChannelId, Command, Timeout) -> Result

Types

SSH = connection()
ChannelId = ssh_channel_id() | undefined
Command = Data = string()
Timeout = timeout()
Result = {ok, Data} | {timeout, Data} | {error, Reason}
Reason = term()

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.

get_file_info(SSH :: connection(), Handle :: term()) -> Result

Types

Handle = Reason = term()
Result = {ok, FileInfo} | {error, Reason}
FileInfo = file:file_info()

For information and other types, see ssh_sftp.

get_file_info(SSH :: connection(), Server :: pid(), Handle :: term()) -> Result

Types

Handle = Reason = term()
Result = {ok, FileInfo} | {error, Reason}
FileInfo = file:file_info()

For information and other types, see ssh_sftp.

list_dir(SSH :: connection(), Path :: file:filename()) -> Result

Types

Path = FileName = file:filename()
Result = {ok, FileNames} | {error, Reason}
Reason = term()
FileNames = [FileName]

For information and other types, see ssh_sftp.

list_dir(SSH, Server, Path) -> Result

Types

SSH = connection()
Server = pid()
Path = FileName = file:filename()
Result = {ok, FileNames} | {error, Reason}
Reason = term()
FileNames = [FileName]

For information and other types, see ssh_sftp.

make_dir(SSH :: connection(), Name :: file:filename()) -> Result

Types

Result = ok | {error, Reason}
Reason = term()

For information and other types, see ssh_sftp.

make_dir(SSH, Server, Name) -> Result

Types

SSH = connection()
Server = pid()
Name = file:filename()
Result = ok | {error, Reason}
Reason = term()

For information and other types, see ssh_sftp.

make_symlink(SSH, Name, Target) -> Result

Types

SSH = connection()
Name = Target = file:filename()
Result = ok | {error, Reason}
Reason = term()

For information and other types, see ssh_sftp.

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

Types

SSH = connection()
Server = pid()
Name = Target = file:filename()
Result = ok | {error, Reason}
Reason = term()

For information and other types, see ssh_sftp.

open(SSH, File, Mode) -> Result

Types

SSH = connection()
File = file:filename()
Mode = [read | write | append | binary | raw]
Result = {ok, Handle} | {error, Reason}
Reason = Handle = term()

For information and other types, see ssh_sftp.

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

Types

SSH = connection()
Server = pid()
File = file:filename()
Mode = [read | write | append | binary | raw]
Result = {ok, Handle} | {error, Reason}
Reason = Handle = term()

For information and other types, see ssh_sftp.

opendir(SSH :: connection(), Path :: file:filename()) -> Result

Types

Result = {ok, Handle} | {error, Reason}
Reason = Handle = term()

For information and other types, see ssh_sftp.

opendir(SSH :: connection(), Server :: pid(), Path :: file:filename()) -> Result

Types

Result = {ok, Handle} | {error, Reason}
Reason = Handle = term()

For information and other types, see ssh_sftp.

position(SSH, Handle, Location) -> Result

Types

SSH = connection()
Handle = Reason = term()
Location = Offset | {bof, Offset} | {cur, Offset} | {eof, Offset} | bof | cur | eof
Result = {ok, NewPosition} | {error, Reason}
Offset = NewPosition = integer()

For information and other types, see ssh_sftp.

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

Types

SSH = connection()
Server = pid()
Handle = Reason = term()
Location = Offset | {bof, Offset} | {cur, Offset} | {eof, Offset} | bof | cur | eof
Result = {ok, NewPosition} | {error, Reason}
Offset = NewPosition = integer()

For information and other types, see ssh_sftp.

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

Types

SSH = connection()
Handle = Reason = term()
Position = Length = integer()
Result = {ok, Data} | eof | {error, Reason}
Data = string() | binary()

For information and other types, see ssh_sftp.

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

Types

SSH = connection()
Server = pid()
Handle = Reason = term()
Position = Length = integer()
Result = {ok, Data} | eof | {error, Reason}
Data = string() | binary()

For information and other types, see ssh_sftp.

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

Types

SSH = connection()
Handle = Reason = term()
Position = integer()
Data = iolist()
Result = ok | {error, Reason}

For information and other types, see ssh_sftp.

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

Types

SSH = connection()
Server = pid()
Handle = Reason = term()
Position = integer()
Data = iolist()
Result = ok | {error, Reason}

For information and other types, see ssh_sftp.

read(SSH :: connection(), Handle :: term(), Len :: integer()) -> Result

Types

Handle = Reason = term()
Result = {ok, Data} | eof | {error, Reason}
Data = string() | binary()

For information and other types, see ssh_sftp.

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

Types

SSH = connection()
Server = pid()
Handle = Reason = term()
Len = integer()
Result = {ok, Data} | eof | {error, Reason}
Data = string() | binary()

For information and other types, see ssh_sftp.

read_file(SSH :: connection(), File :: file:filename()) -> Result

Types

Result = {ok, Data} | {error, Reason}
Reason = term()
Data = binary()

For information and other types, see ssh_sftp.

read_file(SSH, Server, File) -> Result

Types

SSH = connection()
Server = pid()
File = file:filename()
Result = {ok, Data} | {error, Reason}
Reason = term()
Data = binary()

For information and other types, see ssh_sftp.

read_file_info(SSH :: connection(), Name :: file:filename()) -> Result

Types

Result = {ok, FileInfo} | {error, Reason}
Reason = term()
FileInfo = file:file_info()

For information and other types, see ssh_sftp.

read_file_info(SSH, Server, Name) -> Result

Types

SSH = connection()
Server = pid()
Name = file:filename()
Result = {ok, FileInfo} | {error, Reason}
Reason = term()
FileInfo = file:file_info()

For information and other types, see ssh_sftp.

read_link(SSH :: connection(), Name :: file:filename()) -> Result

Types

Name = Target = file:filename()
Result = {ok, Target} | {error, Reason}
Reason = term()

For information and other types, see ssh_sftp.

read_link(SSH, Server, Name) -> Result

Types

SSH = connection()
Server = pid()
Name = Target = file:filename()
Result = {ok, Target} | {error, Reason}
Reason = term()

For information and other types, see ssh_sftp.

receive_response/3

-spec receive_response(SSH, ChannelId, End) -> {ok, Data} | {timeout, Data} | {error, Reason}
                          when
                              SSH :: connection(),
                              ChannelId :: ssh_channel_id(),
                              End :: fun((string()) -> boolean()),
                              Data :: string(),
                              Reason :: term();
                      (SSH, ChannelId, Timeout) -> {ok, Data} | {timeout, Data} | {error, Reason}
                          when
                              SSH :: connection(),
                              ChannelId :: ssh_channel_id(),
                              Timeout :: timeout(),
                              Data :: string(),
                              Reason :: term().

Receives expected data from server on the specified session channel (see receive_response/4).

Equivalent to receive_response(SSH, ChannelId, End, DefaultTimeout) if called with End being function.

Equivalent to receive_response(SSH, ChannelId, close, Timeout) if called with Timeout being integer.

receive_response(SSH, ChannelId) ≡ receive_response(SSH, ChannelId, close, DefaultTimeout)

receive_response(SSH, ChannelId, End, Timeout) -> Result

Types

SSH = connection()
ChannelId = ssh_channel_id()
End = close | timeout | fun((string()) -> boolean())
Timeout = timeout()
Result = {ok, Data} | {timeout, Data} | {error, Reason}
Reason = term()
Data = string()

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).

rename(SSH, OldName, NewName) -> Result

Types

SSH = connection()
OldName = NewName = file:filename()
Result = ok | {error, Reason}
Reason = term()

For information and other types, see ssh_sftp.

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

Types

SSH = connection()
Server = pid()
OldName = NewName = file:filename()
Result = ok | {error, Reason}
Reason = term()

For information and other types, see ssh_sftp.

send/4

-spec send(SSH, ChannelId, Data, Timeout) -> ok | {error, Reason}
              when
                  SSH :: connection(),
                  ChannelId :: ssh_channel_id(),
                  Data :: iodata(),
                  Timeout :: timeout(),
                  Reason :: term();
          (SSH, ChannelId, Type, Data) -> ok | {error, Reason}
              when
                  SSH :: connection(),
                  ChannelId :: ssh_channel_id(),
                  Type :: ssh_data_type_code(),
                  Data :: iodata(),
                  Reason :: term().

Sends data to server on specified session channel (see send/5).

Equivalent to send(SSH, ChannelId, 0, Data, Timeout) if called with Timeout being integer.

Equivalent to send(SSH, ChannelId, Type, Data, DefaultTimeout) if called with Type being integer.

send(SSH, ChannelId, Data) ≡ send(SSH, ChannelId, 0, Data, DefaultTimeout)

send(SSH, ChannelId, Type, Data, Timeout) -> Result

Types

SSH = connection()
ChannelId = ssh_channel_id()
Type = ssh_data_type_code()
Data = iodata()
Timeout = timeout()
Result = ok | {error, Reason}
Reason = term()

Sends data to server on specified session channel.

send_and_receive/4

-spec send_and_receive(SSH, ChannelId, Data, End) ->
                          {ok, ReceivedData} | {timeout, ReceivedData} | {error, Reason}
                          when
                              SSH :: connection(),
                              ChannelId :: ssh_channel_id(),
                              Data :: iodata(),
                              End :: close | timeout | fun((string()) -> boolean()),
                              ReceivedData :: string(),
                              Reason :: term();
                      (SSH, ChannelId, Data, Timeout) ->
                          {ok, ReceivedData} | {timeout, ReceivedData} | {error, Reason}
                          when
                              SSH :: connection(),
                              ChannelId :: ssh_channel_id(),
                              Data :: iodata(),
                              Timeout :: timeout(),
                              ReceivedData :: string(),
                              Reason :: term();
                      (SSH, ChannelId, Type, Data) ->
                          {ok, ReceivedData} | {timeout, ReceivedData} | {error, Reason}
                          when
                              SSH :: connection(),
                              ChannelId :: ssh_channel_id(),
                              Type :: ssh_data_type_code(),
                              Data :: iodata(),
                              ReceivedData :: string(),
                              Reason :: term().

Sends data to server on specified session channel and waits to receive the server response (see send_and_receive/6).

Equivalent to send_and_receive(SSH, ChannelId, 0, Data, End, DefaultTimeout) if called with End being function.

Equivalent to send_and_receive(SSH, ChannelId, 0, Data, close, Timeout) if called with Timeout being integer.

Equivalent to send_and_receive(SSH, ChannelId, Type, Data, close, DefaultTimeout) if called with Type being integer.

send_and_receive/5

-spec send_and_receive(SSH, ChannelId, Data, End, Timeout) ->
                          {ok, ReceivedData} | {timeout, Data} | {error, Reason}
                          when
                              SSH :: connection(),
                              ChannelId :: ssh_channel_id(),
                              Data :: iodata(),
                              End :: close | timeout | fun((string()) -> boolean()),
                              Timeout :: timeout(),
                              ReceivedData :: string(),
                              Reason :: term();
                      (SSH, ChannelId, Type, Data, Timeout) ->
                          {ok, ReceivedData} | {timeout, ReceivedData} | {error, Reason}
                          when
                              SSH :: connection(),
                              ChannelId :: ssh_channel_id(),
                              Type :: ssh_data_type_code(),
                              Data :: iodata(),
                              Timeout :: timeout(),
                              ReceivedData :: string(),
                              Reason :: term();
                      (SSH, ChannelId, Type, Data, End) ->
                          {ok, ReceivedData} | {timeout, ReceivedData} | {error, Reason}
                          when
                              SSH :: connection(),
                              ChannelId :: ssh_channel_id(),
                              Type :: ssh_data_type_code(),
                              Data :: iodata(),
                              End :: close | timeout | fun((string()) -> boolean()),
                              ReceivedData :: string(),
                              Reason :: term().

Sends data to server on specified session channel and waits to receive the server response (see send_and_receive/6).

Equivalent to send_and_receive(SSH, ChannelId, 0, Data, End, Timeout) if called with Timeout being integer.

Equivalent to send_and_receive(SSH, ChannelId, Type, Data, close, Timeout) if called with Type being integer.

Equivalent to send_and_receive(SSH, ChannelId, Type, Data, End, DefaultTimeout) if called with End being function.

send_and_receive(SSH, ChannelId, Data) ≡ send_and_receive(SSH, ChannelId, 0, Data, close, DefaultTimeout)

send_and_receive(SSH, ChannelId, Type, Data, End, Timeout) -> Result

Types

SSH = connection()
ChannelId = ssh_channel_id()
Type = ssh_data_type_code()
Data = iodata()
End = close | timeout | fun((string()) -> boolean())
Timeout = timeout()
Result = {ok, ReceivedData} | {timeout, ReceivedData} | {error, Reason}
Reason = term()
ReceivedData = string()

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.

session_close(SSH, ChannelId) -> Result

Types

SSH = connection()
ChannelId = ssh_channel_id()
Result = ok | {error, Reason}
Reason = term()

Closes an SSH session channel.

session_open(SSH) ≡ session_open(SSH, DefaultTimeout)

session_open(SSH, Timeout) -> Result

Types

SSH = connection()
Timeout = timeout()
Result = {ok, ChannelId} | {error, Reason}
Reason = term()
ChannelId = ssh_channel_id()

Opens a channel for an SSH session.

sftp_connect(SSH :: connection()) -> Result

Types

Result = {ok, Server} | {error, Reason}
Server = pid()
Reason = term()

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.

shell(SSH, ChannelId) ≡ shell(SSH, ChannelId, DefaultTimeout)

(since OTP 20.0)

shell(SSH, ChannelId, Timeout) -> Result

(since OTP 20.0)

Types

SSH = connection()
ChannelId = ssh:ssh_channel_id()
Timeout = timeout()
Result = ok | {error, term()}

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

subsystem(SSH, ChannelId, Subsystem) ≡ subsystem(SSH, Channel, Subsystem, DefaultTimeout)

subsystem(SSH, ChannelId, Subsystem, Timeout) -> Result

Types

SSH = connection()
ChannelId = ssh_channel_id()
Subsystem = string()
Timeout = timeout()
Result = Status | {error, Reason}
Reason = term()
Status = success | failure

Sends a request to execute a predefined subsystem.

write(SSH :: connection(), Handle :: term(), Data :: iodata()) -> Result

Types

Handle = Reason = term()
Result = ok | {error, Reason}

For information and other types, see ssh_sftp.

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

Types

SSH = connection()
Server = pid()
Handle = Reason = term()
Data = iodata()
Result = ok | {error, Reason}

For information and other types, see ssh_sftp.

write_file(SSH, File, Iolist) -> Result

Types

SSH = connection()
File = file:filename()
Iolist = iodata()
Result = ok | {error, Reason}
Reason = term()

For information and other types, see ssh_sftp.

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

Types

SSH = connection()
Server = pid()
File = file:filename()
Iolist = iodata()
Result = ok | {error, Reason}
Reason = term()

For information and other types, see ssh_sftp.

write_file_info(SSH, Name, Info) -> Result

Types

SSH = connection()
Name = file:filename()
Info = file:file_info()
Result = ok | {error, Reason}
Reason = term()

For information and other types, see ssh_sftp.

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

Types

SSH = connection()
Server = pid()
Name = file:filename()
Info = file:file_info()
Result = ok | {error, Reason}
Reason = term()

For information and other types, see ssh_sftp.