ssh

Documentation

Index

• type SshClient
  • func NewSshClient(config *SshClientConfig) (*SshClient, error)
  • func (client *SshClient) Close() error
  • func (client *SshClient) Exec(opts *SshExecOpts) error
  • func (client *SshClient) SendRequest(protocol string, payload string) (string, error)
  • func (client *SshClient) Tunnel(opts *SshTunnelOpts)
• type SshClientConfig
• type SshExecOpts
• type SshTunnelOpts
  • func (t *SshTunnelOpts) LocalAddress() string
  • func (t *SshTunnelOpts) Network() string
  • func (t *SshTunnelOpts) RemoteAddress() string

Types

type SshClient

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

func NewSshClient

func NewSshClient(config *SshClientConfig) (*SshClient, error)

func (*SshClient) Close

func (client *SshClient) Close() error

func (*SshClient) Exec

func (client *SshClient) Exec(opts *SshExecOpts) error

func (*SshClient) SendRequest

func (client *SshClient) SendRequest(protocol string, payload string) (string, error)

func (*SshClient) Tunnel

func (client *SshClient) Tunnel(opts *SshTunnelOpts)

type SshClientConfig

type SshClientConfig struct {
	Address  string
	Username string
	Token    string
}

type SshExecOpts

type SshExecOpts struct {
	Payload               string
	OnStreamStartCallback func()
	OnStreamErrorCallback func(error)
}

type SshTunnelOpts

type SshTunnelOpts struct {
	LocalPort             string
	RemoteHost            string
	RemotePort            string
	OnTunnelStartCallback func(string)
	OnTunnelStopCallback  func(string)
	OnTunnelErrorCallback func(error)
}

func (*SshTunnelOpts) LocalAddress

func (t *SshTunnelOpts) LocalAddress() string

func (*SshTunnelOpts) Network

func (t *SshTunnelOpts) Network() string

func (*SshTunnelOpts) RemoteAddress

func (t *SshTunnelOpts) RemoteAddress() string