ssh

Documentation

Index

• func BackupFile(s Interface, file string) (string, error)
• func DiskAvail(s Interface, path string) (int, error)
• func GetNetworkInterface(s Interface, ip string) string
• func MakePrivateKeySigner(privateKey []byte, passPhrase []byte) (ssh.Signer, error)
• func MakePrivateKeySignerFromFile(key string) (ssh.Signer, error)
• func MemoryCapacity(s Interface) (uint64, error)
• func NumCPU(s Interface) (int, error)
• func ParsePublicKeyFromFile(keyFile string) (*rsa.PublicKey, error)
• func RestoreFile(s Interface, file string) error
• func Timestamp(s Interface) (int, error)
• type Config
• type Interface
• type SSH
  • func New(c *Config) (*SSH, error)
  • func (s *SSH) CombinedOutput(cmd string) ([]byte, error)
  • func (s *SSH) CopyDir(src, dst string) error
  • func (s *SSH) CopyFile(src, dst string) error
  • func (s *SSH) Exec(cmd string) (stdout string, stderr string, exit int, err error)
  • func (s *SSH) Execf(format string, a ...interface{}) (stdout string, stderr string, exit int, err error)
  • func (s *SSH) Exist(filename string) (bool, error)
  • func (s *SSH) LookPath(file string) (string, error)
  • func (s *SSH) Ping() error
  • func (s *SSH) ReadFile(filename string) ([]byte, error)
  • func (s *SSH) WriteFile(src io.Reader, dst string) error

Functions

func BackupFile

func BackupFile(s Interface, file string) (string, error)

func DiskAvail

func DiskAvail(s Interface, path string) (int, error)

DiskAvail returns available disk space in GiB.

func GetNetworkInterface

func GetNetworkInterface(s Interface, ip string) string

GetNetworkInterface return network interface name by ip

func MakePrivateKeySigner

func MakePrivateKeySigner(privateKey []byte, passPhrase []byte) (ssh.Signer, error)

func MakePrivateKeySignerFromFile

func MakePrivateKeySignerFromFile(key string) (ssh.Signer, error)

func MemoryCapacity

func MemoryCapacity(s Interface) (uint64, error)

MemoryCapacity returns the machine's total memory from /proc/meminfo. Returns the total memory capacity as an uint64 (number of bytes).

func NumCPU

func NumCPU(s Interface) (int, error)

NumCPU returns the number of logical CPUs.

func ParsePublicKeyFromFile

func ParsePublicKeyFromFile(keyFile string) (*rsa.PublicKey, error)

func RestoreFile

func RestoreFile(s Interface, file string) error

func Timestamp

func Timestamp(s Interface) (int, error)

Timestamp returns target node timestamp.

Types

type Config

type Config struct {
	User       string `validate:"required"`
	Host       string `validate:"required"`
	Port       int    `validate:"required"`
	Sudo       bool
	Password   string
	PrivateKey []byte
	PassPhrase []byte
	// 150 seconds is longer than the underlying default TCP backoff delay (127
	// seconds). This timeout is only intended to catch otherwise uncaught hangs.
	DialTimeOut time.Duration
	Retry       int
}

type Interface

type Interface interface {
	Ping() error

	CombinedOutput(cmd string) ([]byte, error)
	Execf(format string, a ...interface{}) (stdout string, stderr string, exit int, err error)
	Exec(cmd string) (stdout string, stderr string, exit int, err error)

	CopyFile(src, dst string) error
	WriteFile(src io.Reader, dst string) error
	ReadFile(filename string) ([]byte, error)
	Exist(filename string) (bool, error)

	LookPath(file string) (string, error)
}

type SSH

type SSH struct {
	*Config
	// contains filtered or unexported fields
}

func New

func New(c *Config) (*SSH, error)

func (*SSH) CombinedOutput

func (s *SSH) CombinedOutput(cmd string) ([]byte, error)

func (*SSH) CopyDir

func (s *SSH) CopyDir(src, dst string) error

func (*SSH) CopyFile

func (s *SSH) CopyFile(src, dst string) error

func (*SSH) Exec

func (s *SSH) Exec(cmd string) (stdout string, stderr string, exit int, err error)

func (*SSH) Execf

func (s *SSH) Execf(format string, a ...interface{}) (stdout string, stderr string, exit int, err error)

func (*SSH) Exist

func (s *SSH) Exist(filename string) (bool, error)

func (*SSH) LookPath

func (s *SSH) LookPath(file string) (string, error)

func (*SSH) Ping

func (s *SSH) Ping() error

func (*SSH) ReadFile

func (s *SSH) ReadFile(filename string) ([]byte, error)

func (*SSH) WriteFile

func (s *SSH) WriteFile(src io.Reader, dst string) error