sshclient

Documentation

Index

• type Client
  • func NewClient(opts ClientOpts, logger *logrus.Logger) (*Client, error)
  • func (c *Client) Run(command []string) error
• type ClientOpts

Types

type Client

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

Client to execute commands over SSH.

func NewClient

func NewClient(opts ClientOpts, logger *logrus.Logger) (*Client, error)

NewClient creates a new client to start a SSH session.

func (*Client) Run

func (c *Client) Run(command []string) error

Run adds the optional remote command and starts the SSH session.

type ClientOpts

type ClientOpts struct {
	BinaryPath string
	Input      io.Reader
	Out        io.Writer
	ErrOut     io.Writer
	SSHOptions []string
	Config     string
	User       string
	Proxy      string
	Host       string
}

ClientOpts defines all available options that can be set on a Client.