ssh

Documentation

Index

• Constants
• func IsExitMissingError(err error) bool
• func ParseOutput(output []byte) []string
• type Client
  • func NewClient(host string, port int, username string, password string, privateKey string) (*Client, error)
  • func (s *Client) Close()
  • func (s *Client) GetConfig() ClientConfig
  • func (s *Client) RawRun(cmds ...string) ([]string, error)
  • func (s *Client) Run(cmds ...string) ([]string, error)
  • func (s *Client) RunCmd(cmd string) ([]string, error)
  • func (s *Client) RunTerminal() error
  • func (s *Client) RunWithInput(input io.Reader, cmds ...string) ([]string, error)
  • func (s *Client) RunWithTTY(cmds ...string) ([]string, error)
• type ClientConfig
  • func (conf ClientConfig) Connect() (*ssh.Client, error)
  • func (conf ClientConfig) ConnectContext(ctx context.Context) (*ssh.Client, error)
  • func (conf ClientConfig) NewClient() (*Client, error)
  • func (conf ClientConfig) ToSshConfig() (*ssh.ClientConfig, error)

Constants

const (
	ErrBadConfig = errors.Error("bad config")
	ErrNetwork   = errors.Error("network error")
	ErrProtocol  = errors.Error("ssh protocol error")
)

Functions

func IsExitMissingError

func IsExitMissingError(err error) bool

func ParseOutput

func ParseOutput(output []byte) []string

Types

type Client

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

func NewClient

func NewClient(
	host string,
	port int,
	username string,
	password string,
	privateKey string,
) (*Client, error)

func (*Client) Close

func (s *Client) Close()

func (*Client) GetConfig

func (s *Client) GetConfig() ClientConfig

func (*Client) RawRun

func (s *Client) RawRun(cmds ...string) ([]string, error)

func (*Client) Run

func (s *Client) Run(cmds ...string) ([]string, error)

func (*Client) RunCmd

func (s *Client) RunCmd(cmd string) ([]string, error)

func (*Client) RunTerminal

func (s *Client) RunTerminal() error

func (*Client) RunWithInput

func (s *Client) RunWithInput(input io.Reader, cmds ...string) ([]string, error)

func (*Client) RunWithTTY

func (s *Client) RunWithTTY(cmds ...string) ([]string, error)

RunWithTTY request Pty before run command.

type ClientConfig

type ClientConfig struct {
	Username   string
	Password   string
	Host       string
	Port       int
	PrivateKey string
}

func (ClientConfig) Connect

func (conf ClientConfig) Connect() (*ssh.Client, error)

func (ClientConfig) ConnectContext

func (conf ClientConfig) ConnectContext(ctx context.Context) (*ssh.Client, error)

func (ClientConfig) NewClient

func (conf ClientConfig) NewClient() (*Client, error)

func (ClientConfig) ToSshConfig

func (conf ClientConfig) ToSshConfig() (*ssh.ClientConfig, error)