lwrunner

Documentation

Overview

A runner package that executes commands on remote hosts.

Index

• func AddKnownHost(host string, remote net.Addr, key ssh.PublicKey, knownFile string) (err error)
• func CheckKnownHost(host string, remote net.Addr, key ssh.PublicKey, knownFile string) (found bool, err error)
• func DefaultIdentityFilePath() (string, error)
• func DefaultKnownHosts() (ssh.HostKeyCallback, error)
• func DefaultKnownHostsPath() (string, error)
• type Runner
  • func New(user, host string, callback ssh.HostKeyCallback) *Runner
  • func (run *Runner) Address() string
  • func (run *Runner) Exec(cmd string) (stdout bytes.Buffer, stderr bytes.Buffer, err error)
  • func (run Runner) UseIdentityFile(file string) error
  • func (run Runner) UsePassword(secret string)

Functions

func AddKnownHost

func AddKnownHost(host string, remote net.Addr, key ssh.PublicKey, knownFile string) (err error)

AddKnownHost adds a host to the provided known hosts file, if no known hosts file is provided, it will fallback to default known_hosts file

func CheckKnownHost

func CheckKnownHost(host string, remote net.Addr, key ssh.PublicKey, knownFile string) (found bool, err error)

CheckKnownHost checks if a host is in known hosts file, if no known hosts file is provided, it will fallback to default known_hosts file

func DefaultIdentityFilePath

func DefaultIdentityFilePath() (string, error)

func DefaultKnownHosts

func DefaultKnownHosts() (ssh.HostKeyCallback, error)

DefaultKnownHosts returns a host key callback from default known hosts path

func DefaultKnownHostsPath

func DefaultKnownHostsPath() (string, error)

DefaultKnownHostsPath returns default user ~/.ssh/known_hosts file

Types

type Runner

type Runner struct {
	Hostname string
	Port     int
	*ssh.ClientConfig
}

func New

func New(user, host string, callback ssh.HostKeyCallback) *Runner

func (*Runner) Address

func (run *Runner) Address() string

func (*Runner) Exec

func (run *Runner) Exec(cmd string) (stdout bytes.Buffer, stderr bytes.Buffer, err error)

Exec executes a command on the configured remote host

func (Runner) UseIdentityFile

func (run Runner) UseIdentityFile(file string) error

func (Runner) UsePassword

func (run Runner) UsePassword(secret string)