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
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
Functions
-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
.
apread(SSH, Server, Handle, Position, Length) -> Result
For information and other types, see ssh_sftp
.
apwrite(SSH, Handle, Position, Data) -> Result
For information and other types, see ssh_sftp
.
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
.
aread(SSH, Server, Handle, Len) -> Result
For information and other types, see ssh_sftp
.
awrite(SSH, Handle, Data) -> Result
For information and other types, see ssh_sftp
.
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
.
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, [])
.
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
.
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
.
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.
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.
get_file_info(SSH, Handle) -> Result
For information and other types, see ssh_sftp
.
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
.
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
.
make_dir(SSH, Server, Name) -> Result
For information and other types, see ssh_sftp
.
make_symlink(SSH, Name, Target) -> Result
For information and other types, see ssh_sftp
.
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
.
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
.
opendir(SSH, Server, Path) -> Result
For information and other types, see ssh_sftp
.
position(SSH, Handle, Location) -> Result
For information and other types, see ssh_sftp
.
position(SSH, Server, Handle, Location) -> Result
For information and other types, see ssh_sftp
.
pread(SSH, Handle, Position, Length) -> Result
For information and other types, see ssh_sftp
.
pread(SSH, Server, Handle, Position, Length) -> Result
For information and other types, see ssh_sftp
.
pwrite(SSH, Handle, Position, Data) -> Result
For information and other types, see ssh_sftp
.
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
.
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
.
read_file(SSH, Server, File) -> Result
For information and other types, see ssh_sftp
.
read_file_info(SSH, Name) -> Result
For information and other types, see ssh_sftp
.
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
.
read_link(SSH, Server, Name) -> Result
For information and other types, see ssh_sftp
.
read_link_info(SSH, Name) -> Result
For information and other types, see ssh_sftp
.
read_link_info(SSH, Server, Name) -> Result
For information and other types, see ssh_sftp
.
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)
.
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).
rename(SSH, OldName, NewName) -> Result
For information and other types, see ssh_sftp
.
rename(SSH, Server, OldName, NewName) -> Result
For information and other types, see ssh_sftp
.
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)
.
send(SSH, ChannelId, Type, Data, Timeout) -> ok | {error, Reason}
Sends data to server on specified session channel.
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)
.
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
.
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)
.
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.
-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)
.
-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.
subsystem(SSH, ChannelId, Subsystem) -> Status | {error, Reason}
Equivalent to
ct_ssh:subsystem(SSH, ChannelId, Subsystem, DefaultTimeout)
.
subsystem(SSH, ChannelId, Subsystem, Timeout) -> Status | {error, Reason}
Sends a request to execute a predefined subsystem.
write(SSH, Handle, Data) -> Result
For information and other types, see ssh_sftp
.
write(SSH, Server, Handle, Data) -> Result
For information and other types, see ssh_sftp
.
write_file(SSH, File, Iolist) -> Result
For information and other types, see ssh_sftp
.
write_file(SSH, Server, File, Iolist) -> Result
For information and other types, see ssh_sftp
.
write_file_info(SSH, Name, Info) -> Result
For information and other types, see ssh_sftp
.
write_file_info(SSH, Server, Name, Info) -> Result
For information and other types, see ssh_sftp
.