ChannelPid = pid()

Handle = N = term()

Position = Len = integer()

Error = {error, reason()}

The apread/4 function reads from a specified position, combining the position/3 and aread/3 functions.

ChannelPid = pid()

Handle = N = term()

Position = integer()

Data = binary()

Error = {error, reason()}

The apwrite/4 function writes to a specified position, combining the position/3 and awrite/3 functions.

ChannelPid = pid()

Handle = N = term()

Len = integer()

Error = {error, reason()}

Reads from an open file, without waiting for the result. If the handle is valid, the function returns {async, N}, where N is a term guaranteed to be unique between calls of aread. The actual data is sent as a message to the calling process. This message has the form {async_reply, N, Result}, where Result is the result from the read, either {ok, Data}, eof, or {error, reason()}.

ChannelPid = pid()

Handle = N = term()

Data = binary()

Error = {error, reason()}

Writes to an open file, without waiting for the result. If the handle is valid, the function returns {async, N}, where N is a term guaranteed to be unique between calls of awrite. The result of the write operation is sent as a message to the calling process. This message has the form {async_reply, N, Result}, where Result is the result from the write, either ok, or {error, reason()}.

Error = {error, reason()}

Closes a handle to an open file or directory on the server.

ChannelPid = pid()

Name = string()

Timeout = timeout()

Error = {error, reason()}

Deletes a directory specified by Name. The directory must be empty before it can be successfully deleted.

ChannelPid = pid()

Name = string()

Timeout = timeout()

Error = {error, reason()}

Deletes the file specified by Name.

ChannelPid = pid()

Path = FileName = string()

Timeout = timeout()

Result = {ok, FileNames} | Error

Error = {error, reason()}

FileNames = [FileName]

Lists the given directory on the server, returning the filenames as a list of strings.

ChannelPid = pid()

Name = string()

Timeout = timeout()

Error = {error, reason()}

Creates a directory specified by Name. Name must be a full path to a new directory. The directory can only be created in an existing directory.

ChannelPid = pid()

Name = Target = string()

Timeout = timeout()

Error = {error, reason()}

Creates a symbolic link pointing to Target with the name Name.

ChannelPid = pid()

Name = string()

Mode = [read | write | append | binary | raw]

Timeout = timeout()

Result = {ok, Handle} | Error

Error = {error, reason()}

Handle = term()

Opens a file on the server and returns a handle, which can be used for reading or writing.

ChannelPid = pid()

Path = string()

Mode = [read | write | {crypto, tar_crypto_spec()}]

Timeout = timeout()

Result = {ok, Handle} | Error

Error = {error, reason()}

Handle = term()

Opens a handle to a tar file on the server, associated with ChannelPid. The handle can be used for remote tar creation and extraction. The actual writing and reading is performed by calls to erl_tar:add/3,4 and erl_tar:extract/2. Note: The erl_tar:init/3 function should not be called, that one is called by this open_tar function.

For code examples see Section SFTP Client with TAR Compression in the ssh Users Guide.

The crypto mode option is explained in the data types section above, see Crypto operations for open_tar. Encryption is assumed if the Mode contains write, and decryption if the Mode contains read.

ChannelPid = pid()

Path = string()

Timeout = timeout()

Result = {ok, Handle} | Error

Error = {error, reason()}

Handle = term()

Opens a handle to a directory on the server. The handle can be used for reading directory contents.

ChannelPid = pid()

Handle = term()

Location = Offset | {bof, Offset} | {cur, Offset} | {eof, Offset} | bof | cur | eof

Timeout = timeout()

Result = {ok, NewPosition} | Error

Error = {error, reason()}

Offset = NewPosition = integer()

Sets the file position of the file referenced by Handle. Returns {ok, NewPosition} (as an absolute offset) if successful, otherwise {error, reason()}. Location is one of the following:

• Offset - The same as {bof, Offset}.

• {bof, Offset} - Absolute offset.

• {cur, Offset} - Offset from the current position.

• {eof, Offset} - Offset from the end of file.

• bof | cur | eof - The same as eariler with Offset 0, that is, {bof, 0} | {cur, 0} | {eof, 0}.

ChannelPid = pid()

Handle = term()

Position = Len = integer()

Timeout = timeout()

Result = {ok, Data} | eof | Error

Error = {error, reason()}

Data = string() | binary()

The pread/3,4 function reads from a specified position, combining the position/3 and read/3,4 functions.

ChannelPid = pid()

Handle = term()

Position = integer()

Data = iolist()

Timeout = timeout()

Error = {error, reason()}

The pwrite/3,4 function writes to a specified position, combining the position/3 and write/3,4 functions.

ChannelPid = pid()

Handle = term()

Len = integer()

Timeout = timeout()

Result = {ok, Data} | eof | Error

Error = {error, reason()}

Data = string() | binary()

Reads Len bytes from the file referenced by Handle. Returns {ok, Data}, eof, or {error, reason()}. If the file is opened with binary, Data is a binary, otherwise it is a string.

If the file is read past eof, only the remaining bytes are read and returned. If no bytes are read, eof is returned.

ChannelPid = pid()

File = string()

Timeout = timeout()

Error = {error, reason()}

Data = binary()

Reads a file from the server, and returns the data in a binary.

ChannelPid = pid()

Name = string()

Timeout = timeout()

Result = {ok, FileInfo} | Error

Error = {error, reason()}

FileInfo = file:file_info()

Returns a file_info record from the file system object specified by Name or Handle. See file:read_file_info/2 for information about the record.

Depending on the underlying OS:es links might be followed and info on the final file, directory etc is returned. See read_link_info/2 on how to get information on links instead.

ChannelPid = pid()

Name = Target = string()

Timeout = timeout()

Result = {ok, Target} | Error

Error = {error, reason()}

Reads the link target from the symbolic link specified by name.

ChannelPid = pid()

Name = string()

Timeout = timeout()

Result = {ok, FileInfo} | Error

Error = {error, reason()}

FileInfo = file:file_info()

Returns a file_info record from the symbolic link specified by Name or Handle. See file:read_link_info/2 for information about the record.

ChannelPid = pid()

OldName = NewName = string()

Timeout = timeout()

Error = {error, reason()}

Renames a file named OldName and gives it the name NewName.

-spec start_channel(ssh:open_socket() | ssh:connection_ref() | ssh:host()) ->
                       {ok, pid()} | {ok, pid(), ssh:connection_ref()} | {error, reason()}.

-spec start_channel(ssh:open_socket(), [ssh:client_option() | sftp_option()]) ->
                       {ok, pid(), ssh:connection_ref()} | {error, reason()};
                   (ssh:connection_ref(), [ssh:client_option() | sftp_option()]) ->
                       {ok, pid()} | {ok, pid(), ssh:connection_ref()} | {error, reason()};
                   (ssh:host(), [ssh:client_option() | sftp_option()]) ->
                       {ok, pid(), ssh:connection_ref()} | {error, reason()}.

Starts new ssh channel for communicating with the SFTP server.

Starts an ssh channel when first argument is a connection reference.

Equivalent to start_channel(Host, 22, UserOptions) when first argument is recognized as network host.

Otherwise, first argument is treated as a network socket which will be used for establishing new SSH connection. New connection reference will be used for starting an SSH channel.

The returned pid for this process is to be used as input to all other API functions in this module.

See also (start_channel/3).

Host = ssh:host()

Port = inet:port_number()

UserOptions0 = [ssh:client_option() | sftp_option()]

Result = {ok, pid(), ssh:connection_ref()} | {error, reason()}

Starts new ssh connection and channel for communicating with the SFTP server.

The returned pid for this process is to be used as input to all other API functions in this module.

Options:

• {timeout, timeout()} - There are two ways to set a timeout for the underlying ssh connection:

  • If the connection timeout option connect_timeout is set, that value is used also for the negotiation timeout and this option (timeout) is ignored.
  • Otherwise, this option (timeout) is used as the negotiation timeout only and there is no connection timeout set

  The value defaults to infinity.

• {sftp_vsn, integer()} - Desired SFTP protocol version. The actual version is the minimum of the desired version and the maximum supported versions by the SFTP server.

All other options are directly passed to ssh:connect/3 or ignored if a connection is already provided.

Stops an SFTP channel. Does not close the SSH connection. Use ssh:close/1 to close it.

ChannelPid = pid()

Handle = term()

Data = iodata()

Timeout = timeout()

Error = {error, reason()}

Writes data to the file referenced by Handle. The file is to be opened with write or append flag. Returns ok if successful or {error, reason()} otherwise.

ChannelPid = pid()

File = string()

Data = iodata()

Timeout = timeout()

Error = {error, reason()}

Writes a file to the server. The file is created if it does not exist but overwritten if it exists.

ChannelPid = pid()

Name = string()

FileInfo = file:file_info()

Timeout = timeout()

Error = {error, reason()}

Writes file information from a file_info record to the file specified by Name. See file:write_file_info/2,3 for information about the record.