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) *CmdSSHActions
  • func (c *CmdSSHActions) CopyFromHost(hostName string, _ bool, source, destination string) (string, error)
  • func (c *CmdSSHActions) CopyFromHostSudo(hostName string, _ bool, sudoUser, source, destination string) (string, error)
  • func (c *CmdSSHActions) CopyToHost(hostName string, _ bool, source, destination string) (string, error)
  • func (c *CmdSSHActions) CopyToHostSudo(hostName string, _ bool, sudoUser, source, destination string) (string, error)
  • func (c *CmdSSHActions) FindHosts(searchTerm string) (hosts []string, err error)
  • func (c *CmdSSHActions) HelpText() string
  • func (c *CmdSSHActions) HostExecute(mask bool, hostName string, _ bool, args ...string) (string, error)
  • func (c *CmdSSHActions) HostExecuteAndStream(mask bool, hostString string, output cli.OutputHandler, _ bool, args ...string) (err error)
  • func (c *CmdSSHActions) HostExecuteSudo(mask bool, hostName string, sudoUser string, args ...string) (string, error)
  • func (c *CmdSSHActions) Name() string

Functions

func CleanOut

func CleanOut(out string) string

Types

type Args

type Args struct {
	SSHKeyLoc string
	SSHUser   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) *CmdSSHActions

func (*CmdSSHActions) CopyFromHost

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

func (*CmdSSHActions) CopyFromHostSudo

func (c *CmdSSHActions) CopyFromHostSudo(hostName string, _ bool, sudoUser, source, destination string) (string, error)

func (*CmdSSHActions) CopyToHost

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

func (*CmdSSHActions) CopyToHostSudo

func (c *CmdSSHActions) CopyToHostSudo(hostName string, _ bool, sudoUser, source, destination string) (string, error)

func (*CmdSSHActions) FindHosts

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

func (*CmdSSHActions) HelpText

func (c *CmdSSHActions) HelpText() string

func (*CmdSSHActions) HostExecute

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

func (*CmdSSHActions) HostExecuteAndStream

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

func (*CmdSSHActions) HostExecuteSudo

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

func (*CmdSSHActions) Name

func (c *CmdSSHActions) Name() string