remote

Documentation

Index

• type Connection
  • func NewConnection(host, port, user, keyPath string) (*Connection, error)
  • func NewConnectionWithRetry(host, port, user, keyPath string, sleep, timeout time.Duration) (*Connection, error)
  • func (c *Connection) CopyFrom(hostname, path string) error
  • func (c *Connection) CopyTo(filename string) error
  • func (c *Connection) CopyToRemote(hostname, path string) error
  • func (c *Connection) Execute(cmd string, printStdout bool) error
  • func (c *Connection) ExecuteRemote(node, command string, printStdout bool) error
  • func (c *Connection) ExecuteRemoteWithRetry(node, command string, printStdout bool, sleep, timeout time.Duration) error
  • func (c *Connection) Read(path string) ([]byte, error)
  • func (c *Connection) Write(data, path string) error
• type NewConnectionResult
  • func NewConnectionAsync(host, port, user, keyPath string) NewConnectionResult

Types

type Connection

type Connection struct {
	Host           string
	Port           string
	User           string
	PrivateKeyPath string
	ClientConfig   *ssh.ClientConfig
	Client         *ssh.Client
}

Connection is

func NewConnection

func NewConnection(host, port, user, keyPath string) (*Connection, error)

NewConnection will build and return a new Connection object

func NewConnectionWithRetry

func NewConnectionWithRetry(host, port, user, keyPath string, sleep, timeout time.Duration) (*Connection, error)

NewConnectionWithRetry establishes an ssh connection, allowing for retries

func (*Connection) CopyFrom

func (c *Connection) CopyFrom(hostname, path string) error

CopyFrom uses this ssh connection to get remote files via scp

func (*Connection) CopyTo

func (c *Connection) CopyTo(filename string) error

CopyTo uses this ssh connection to send files to the remote ssh listener's underlying file system

func (*Connection) CopyToRemote

func (c *Connection) CopyToRemote(hostname, path string) error

CopyToRemote uses this ssh connection to send files via scp to a remote host

func (*Connection) Execute

func (c *Connection) Execute(cmd string, printStdout bool) error

Execute will execute a given cmd on a remote host

func (*Connection) ExecuteRemote

func (c *Connection) ExecuteRemote(node, command string, printStdout bool) error

ExecuteRemote uses this ssh connection to run a remote command from the primary master node

func (*Connection) ExecuteRemoteWithRetry

func (c *Connection) ExecuteRemoteWithRetry(node, command string, printStdout bool, sleep, timeout time.Duration) error

ExecuteRemoteWithRetry runs a remote command with retry tolerance

func (*Connection) Read

func (c *Connection) Read(path string) ([]byte, error)

func (*Connection) Write

func (c *Connection) Write(data, path string) error

type NewConnectionResult

type NewConnectionResult struct {
	Connection *Connection
	Err        error
}

NewConnectionResult is the result type for GetConfigAsync

func NewConnectionAsync

func NewConnectionAsync(host, port, user, keyPath string) NewConnectionResult

NewConnectionAsync wraps NewConnection with a struct response for goroutine + channel usage