sshkit v0.0.3 SSHKit.SSH View Source
Provides convenience functions for working with SSH connections and executing commands on remote hosts.
Examples
{:ok, conn} = SSHKit.SSH.connect("eg.io", user: "me")
{:ok, output, status} = SSHKit.SSH.run(conn, "uptime")
:ok = SSHKit.SSH.close(conn)
Enum.each(output, fn
{:stdout, data} -> IO.write(data)
{:stderr, data} -> IO.write([IO.ANSI.red, data, IO.ANSI.reset])
end)
IO.puts("$?: #{status}")Link to this section Summary
Link to this section Functions
Closes an SSH connection.
Uses SSHKit.SSH.Connection.close/1 to close the connection.
Example
:ok = SSHKit.SSH.close(conn)Establishes a connection to an SSH server.
Uses SSHKit.SSH.Connection.open/2 to open a connection.
options_or_function can either be a list of ssh-options or a function. If it’s a
list, it’s considered to be a list of ssh-options as described in Connection.open/2. If
it’s a function, then it’s equivalent to calling connect(host, [],
options_or_function). See the documentation for open/3 for more information
on this function.
Example
{:ok, conn} = SSHKit.SSH.connect("eg.io", port: 2222, user: "me", timeout: 1000)Similar to connect/2 but expects a function as its last argument.
The ssh-connection is opened, given to the function as an argument and automatically closed after the function returns, regardless if there was an error when executing the function.
Returns {:ok, function_result} in case of success,
{:error, reason} otherwise.
Examples
SSH.connect("eg.io", port: 2222, user: "me", fn(conn) ->
SCP.upload(conn, "list.txt")
end)See open/2 for the list of available options.
Executes a command on the remote and aggregates incoming messages.
Using the default handler, returns {:ok, output, status} or {:error,
reason}. By default, command output is captured into a list of tuples of the
form {:stdout, data} or {:stderr, data}.
A custom handler function can be provided to handle channel messages.
For further details on handling incoming messages,
see SSHKit.SSH.Channel.loop/4.
Options
:timeout- maximum wait time between messages, defaults to:infinity:fun- handler function passed toSSHKit.SSH.Channel.loop/4:acc- initial accumulator value used in the loop
Example
{:ok, output, status} = SSHKit.SSH.run(conn, "uptime")
IO.inspect(output)