ssh

Documentation

Overview

ssh package uses ssh and scp binaries to execute commands remotely and translate the results back to the calling node

Index

• func CleanOut(out string) string
• type Args
• type CmdSSHActions
  • func NewCmdSSHActions(sshArgs Args, hook shutdown.Hook) *CmdSSHActions
  • func (c *CmdSSHActions) CleanupRemote() error
  • func (c *CmdSSHActions) CopyFromHost(hostName, source, destination string) (string, error)
  • func (c *CmdSSHActions) CopyToHost(hostName, source, destination string) (string, error)
  • func (c *CmdSSHActions) GetCoordinators() (hosts []string, err error)
  • func (c *CmdSSHActions) GetExecutors() (hosts []string, err error)
  • func (c *CmdSSHActions) HelpText() string
  • func (c *CmdSSHActions) HostExecute(mask bool, hostName string, args ...string) (string, error)
  • func (c *CmdSSHActions) HostExecuteAndStream(mask bool, hostString string, output cli.OutputHandler, pat string, ...) (err error)
  • func (c *CmdSSHActions) Name() string
  • func (c *CmdSSHActions) SetHostPid(host, pidFile string)

Functions

func CleanOut

func CleanOut(out string) string

Types

type Args

type Args struct {
	SSHKeyLoc      string
	SSHUser        string
	SudoUser       string
	ExecutorStr    string
	CoordinatorStr string
}

type CmdSSHActions

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

CmdSSHActions depends on the scp and ssh programs being present and then assumes ssh public key auth is in place since it has no support for using password based authentication

func NewCmdSSHActions

func NewCmdSSHActions(sshArgs Args, hook shutdown.Hook) *CmdSSHActions

func (*CmdSSHActions) CleanupRemote

func (c *CmdSSHActions) CleanupRemote() error

func (*CmdSSHActions) CopyFromHost

func (c *CmdSSHActions) CopyFromHost(hostName, source, destination string) (string, error)

func (*CmdSSHActions) CopyToHost

func (c *CmdSSHActions) CopyToHost(hostName, source, destination string) (string, error)

func (*CmdSSHActions) GetCoordinators

func (c *CmdSSHActions) GetCoordinators() (hosts []string, err error)

func (*CmdSSHActions) GetExecutors

func (c *CmdSSHActions) GetExecutors() (hosts []string, err error)

func (*CmdSSHActions) HelpText

func (c *CmdSSHActions) HelpText() string

func (*CmdSSHActions) HostExecute

func (c *CmdSSHActions) HostExecute(mask bool, hostName string, args ...string) (string, error)

func (*CmdSSHActions) HostExecuteAndStream

func (c *CmdSSHActions) HostExecuteAndStream(mask bool, hostString string, output cli.OutputHandler, pat string, args ...string) (err error)

func (*CmdSSHActions) Name

func (c *CmdSSHActions) Name() string

func (*CmdSSHActions) SetHostPid

func (c *CmdSSHActions) SetHostPid(host, pidFile string)