ssh

Documentation

Index

• type Connection
  • func NewConnection(o Opts) (Connection, error)
• type Connector
  • func NewConnector() *Connector
  • func (c *Connector) CloseAll()
  • func (c *Connector) Connect(node config.HostConfig) (Connection, error)
• type Opts

Types

type Connection

type Connection interface {
	Close() error
	Closed() bool

	Exec(string) (string, string, int, error)
	Stream(string, io.Writer, io.Writer) (int, error)

	Upload(io.Reader, int64, os.FileMode, string) error
	UploadFile(string, string) error

	Download(string, io.Writer) error
	DownloadToFile(string, string) error
}

Connection represents an established connection to an SSH server.

func NewConnection

func NewConnection(o Opts) (Connection, error)

NewConnection attempts to create a new SSH connection to the host specified via the given options.

type Connector

type Connector struct {
	// contains filtered or unexported fields
}

Connector holds a map of Connections

func NewConnector

func NewConnector() *Connector

NewConnector constructor

func (*Connector) CloseAll

func (c *Connector) CloseAll()

CloseAll closes all connections

func (*Connector) Connect

func (c *Connector) Connect(node config.HostConfig) (Connection, error)

Connect to the node

type Opts

type Opts struct {
	Username    string
	Password    string
	Hostname    string
	Port        int
	PrivateKey  string
	KeyFile     string
	AgentSocket string
	Timeout     time.Duration
}

Opts represents all the possible options for connecting to a remote server via SSH.