Dicon.SecureShell (Dicon v0.6.0)

Copy Markdown View Source

A Dicon.Executor based on SSH.

Configuration

The configuration for this executor must be specified under the configuration for the :dicon application:

config :dicon, Dicon.SecureShell,
  dir: "..."

The available configuration options for this executor are:

  • :dir - a binary that specifies the directory where the SSH keys are (in the local machine). Defaults to "~/.ssh".

  • :connect_timeout - an integer that specifies the timeout (in milliseconds) when connecting to the host.

  • :write_timeout - an integer that specifies the timeout (in milliseconds) when writing data to the host.

  • :exec_timeout - an integer that specifies the timeout (in milliseconds) when executing commands on the host.

The username and password used to connect to the server will be picked up by the URL that identifies that server (in :dicon's configuration); read more about this in the documentation for the Dicon module.

The additionally supported :silently_accept_hosts and :save_accepted_host options are documented in :ssh.host_accepting_client_options/0.

Summary

Functions

connect(authority)

Callback implementation for Dicon.Executor.connect/1.

copy(state, source, target)

Callback implementation for Dicon.Executor.copy/3.

exec(state, command, device)

Callback implementation for Dicon.Executor.exec/3.

write_file(state, target, content, atom)

Callback implementation for Dicon.Executor.write_file/4.