ssh

Documentation

Overview

Package ssh implements SSH-based remote host connectivity.

Index

• func Probe(ctx context.Context, connection Connection) error
• type Connection
• type DialConfig
• type Dialer
  • func NewDialer() Dialer
• type Executor
• type FileTransfer

Functions

func Probe

func Probe(ctx context.Context, connection Connection) error

Runs a trivial echo command over shh to verify the connection is healthy and the remote shell is functional.

Types

type Connection

type Connection interface {
	Executor
	FileTransfer
	Close() error
}

type DialConfig

type DialConfig struct {
	Address        string
	Port           int
	User           string
	PrivateKeyFile string
	KnownHostsFile string
	HostKeyPolicy  string
}

type Dialer

type Dialer interface {
	Dial(ctx context.Context, config DialConfig) (Connection, error)
}

func NewDialer

func NewDialer() Dialer

type Executor

type Executor interface {
	Run(ctx context.Context, cmd string) (stdout, stderr string, err error)
}

Executor runs commands on a remote host.

type FileTransfer

type FileTransfer interface {
	Upload(ctx context.Context, localPath, remotePath string) error
}

FileTransfer copies files to a remote host.