ssh

Documentation

Index

• Constants
• type Client
  • func NewClient(cfg Config) (*Client, error)
  • func (c *Client) Close() error
  • func (c *Client) Execute(ctx context.Context, shell string, opts ...client.ExecOption) (client.ICmd, error)
  • func (c *Client) Get(ctx context.Context, src, dst string, opts ...client.GetOption) error
  • func (c *Client) Name() string
  • func (c *Client) Put(ctx context.Context, src, dst string, opts ...client.PutOption) error
  • func (c *Client) ReadFile(ctx context.Context, name string) ([]byte, error)
  • func (c *Client) Stat(ctx context.Context, name string) (*client.Stat, error)
• type Cmd
  • func (c *Cmd) Close() error
  • func (c *Cmd) CombinedOutput() ([]byte, error)
  • func (c *Cmd) Run() error
  • func (c *Cmd) Session() *ssh.Session
  • func (c *Cmd) Start() error
  • func (c *Cmd) StderrPipe() (io.Reader, error)
  • func (c *Cmd) StdinPipe() (io.WriteCloser, error)
  • func (c *Cmd) StdoutPipe() (io.Reader, error)
  • func (c *Cmd) Wait() error
• type Config
  • func NewAuthConfig(lg *zap.Logger, host, user, password string) *Config
  • func (cfg *Config) Validate() error

Constants

const (
	DefaultUser = "root"
	DefaultPort = 22
)

Types

type Client

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

func NewClient

func NewClient(cfg Config) (*Client, error)

func (*Client) Close

func (c *Client) Close() error

func (*Client) Execute

func (c *Client) Execute(ctx context.Context, shell string, opts ...client.ExecOption) (client.ICmd, error)

func (*Client) Get

func (c *Client) Get(ctx context.Context, src, dst string, opts ...client.GetOption) error

func (*Client) Name

func (c *Client) Name() string

func (*Client) Put

func (c *Client) Put(ctx context.Context, src, dst string, opts ...client.PutOption) error

func (*Client) ReadFile

func (c *Client) ReadFile(ctx context.Context, name string) ([]byte, error)

func (*Client) Stat

func (c *Client) Stat(ctx context.Context, name string) (*client.Stat, error)

type Cmd

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

func (*Cmd) Close

func (c *Cmd) Close() error

func (*Cmd) CombinedOutput

func (c *Cmd) CombinedOutput() ([]byte, error)

func (*Cmd) Run

func (c *Cmd) Run() error

func (*Cmd) Session

func (c *Cmd) Session() *ssh.Session

func (*Cmd) Start

func (c *Cmd) Start() error

func (*Cmd) StderrPipe

func (c *Cmd) StderrPipe() (io.Reader, error)

func (*Cmd) StdinPipe

func (c *Cmd) StdinPipe() (io.WriteCloser, error)

func (*Cmd) StdoutPipe

func (c *Cmd) StdoutPipe() (io.Reader, error)

func (*Cmd) Wait

func (c *Cmd) Wait() error

type Config

type Config struct {
	Network string
	Addr    string

	ClientConfig *ssh.ClientConfig
	Logger       *zap.Logger
}

func NewAuthConfig

func NewAuthConfig(lg *zap.Logger, host, user, password string) *Config

func (*Config) Validate

func (cfg *Config) Validate() error