sshclient

Documentation

Index

• type Command
• type CommandOutput
• type SSHClient
  • func NewSSHClient(username string, password string, hostname string) *SSHClient
  • func (s *SSHClient) Command(cmdString string) (*CommandOutput, error)
  • func (s *SSHClient) Execute(cmd *Command) (*Command, error)
  • func (s *SSHClient) Quit()
• type ShellConnection

Types

type Command

type Command struct {
	Command string
	Env     []string
	Stdin   io.Reader
	Stdout  io.Writer
	Stderr  io.Writer
}

Command holds the input and output data for a command

type CommandOutput

type CommandOutput struct {
	Stdin  string
	Stdout string
	Stderr string
}

CommandOutput is the buffer contents of a completed command

type SSHClient

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

SSHClient forms the external type

func NewSSHClient

func NewSSHClient(username string, password string, hostname string) *SSHClient

NewSSHClient simple constructor

func (*SSHClient) Command

func (s *SSHClient) Command(cmdString string) (*CommandOutput, error)

Command takes string and inputs to stdin

func (*SSHClient) Execute

func (s *SSHClient) Execute(cmd *Command) (*Command, error)

Execute runs an SSH command and returns a struct of stdin, stdout and stderr

func (*SSHClient) Quit

func (s *SSHClient) Quit()

Quit closes the connection

type ShellConnection

type ShellConnection interface {
	Execute(*Command) (*Command, error)
	Command(string) (*CommandOutput, error)
}

ShellConnection represents local, remote or fake unix shell interactions