ssh

Documentation

Index

• func Args(cc ConnConfig) []string
• func Console(cc ConnConfig, remoteCmd string) error
• func Exec(ctx context.Context, cc ConnConfig, command []string) (int, error)
• func ExecQuiet(ctx context.Context, cc ConnConfig, command []string) (int, error)
• func Output(ctx context.Context, cc ConnConfig, command []string) ([]byte, error)
• func OutputQuiet(ctx context.Context, cc ConnConfig, command []string) ([]byte, error)
• func TestAuth(ctx context.Context, cc ConnConfig) error
• func WaitReady(ctx context.Context, host string, timeout time.Duration, log io.Writer) error
• type ConnConfig

Functions

func Args

func Args(cc ConnConfig) []string

Args builds the SSH command-line arguments for the given connection config. It is exported for use by callers that need to construct custom exec.Cmd with non-standard Stdin/Stdout/Stderr (e.g. sandbox backends).

func Console

func Console(cc ConnConfig, remoteCmd string) error

Console replaces the current process with an interactive SSH session. If remoteCmd is non-empty, it is executed in a forced PTY on the remote host.

func Exec

func Exec(ctx context.Context, cc ConnConfig, command []string) (int, error)

Exec runs a command on the remote host via SSH and returns its exit code.

func ExecQuiet

func ExecQuiet(ctx context.Context, cc ConnConfig, command []string) (int, error)

ExecQuiet runs a non-interactive command on the remote host via SSH and returns its exit code. Unlike Exec, it does not attach stdin/stdout/stderr.

func Output

func Output(ctx context.Context, cc ConnConfig, command []string) ([]byte, error)

Output runs a command on the remote host via SSH and returns its stdout.

func OutputQuiet

func OutputQuiet(ctx context.Context, cc ConnConfig, command []string) ([]byte, error)

OutputQuiet runs a command on the remote host via SSH and returns its stdout, discarding stderr. Use this when parsing command output programmatically.

func TestAuth

func TestAuth(ctx context.Context, cc ConnConfig) error

TestAuth runs a quick SSH connection test (ssh ... true) to verify key-based authentication works. Returns nil on success.

func WaitReady

func WaitReady(ctx context.Context, host string, timeout time.Duration, log io.Writer) error

WaitReady polls the host's SSH port until it accepts connections or the timeout expires. If log is non-nil, progress is written every 5 seconds.

Types

type ConnConfig

type ConnConfig struct {
	Host    string
	User    string
	KeyPath string
	Env     map[string]string // optional, for SetEnv forwarding
}

ConnConfig holds the parameters for an SSH connection.