ssh

Documentation

Index

• type SSHClient
  • func NewSSHClient(remoteAddr string, username string, sshKeyFile string) (*SSHClient, error)
  • func (s *SSHClient) AuthorizedKey() string
  • func (s *SSHClient) Exec(ctx context.Context, cmd string) (string, error)
  • func (s *SSHClient) ExecVerbose(_ context.Context, cmd string) (stdout string, stderr string, exitCode int, err error)
  • func (s *SSHClient) RemoveAddr() string
  • func (s *SSHClient) Run(ctx context.Context, cmds ...string) error
  • func (s *SSHClient) WriteFile(content io.Reader, dstFilePath string) error

Types

type SSHClient

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

func NewSSHClient

func NewSSHClient(remoteAddr string, username string, sshKeyFile string) (*SSHClient, error)

func (*SSHClient) AuthorizedKey

func (s *SSHClient) AuthorizedKey() string

AuthorizedKey returns the public key in authorized_keys format

func (*SSHClient) Exec

func (s *SSHClient) Exec(ctx context.Context, cmd string) (string, error)

Exec executes a command and returns stdout or not nil error

func (*SSHClient) ExecVerbose

func (s *SSHClient) ExecVerbose(_ context.Context, cmd string) (stdout string, stderr string, exitCode int, err error)

ExecVerbose executes a command and returns stdout, stderr, exitCode or not nil error

func (*SSHClient) RemoveAddr

func (s *SSHClient) RemoveAddr() string

func (*SSHClient) Run

func (s *SSHClient) Run(ctx context.Context, cmds ...string) error

Run runs commands in sequence, if any command fails, it will return error

func (*SSHClient) WriteFile

func (s *SSHClient) WriteFile(content io.Reader, dstFilePath string) error