ssh

Documentation

Index

• type Client
  • func NewClient(params ClientParams) (*Client, error)
  • func (c *Client) Close() error
  • func (c *Client) RunCommand(ctx context.Context, command string, stdin io.Reader) (string, error)
• type ClientParams

Types

type Client

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

Client is a higher-level abstraction around the standard API's SSH configuration, client and connection to the remote machine.

func NewClient

func NewClient(params ClientParams) (*Client, error)

NewClient instantiates a new SSH Client object. N.B.: provide either the key (privateKey) or its path (privateKeyPath).

func (*Client) Close

func (c *Client) Close() error

Close closes this high-level Client's underlying SSH connection.

func (*Client) RunCommand

func (c *Client) RunCommand(ctx context.Context, command string, stdin io.Reader) (string, error)

RunCommand executes the provided command on the remote machine configured in this Client object. A new Session is created for each call to RunCommand. A Client supports multiple interactive sessions.

type ClientParams

type ClientParams struct {
	User           string
	Host           string
	Port           uint16
	PrivateKeyPath string
	PrivateKey     []byte
	PrintOutputs   bool
}

ClientParams groups inputs to build a client object.