sshexec

README

sshexec - Go library for executing SSH commands

This is a simple Go library for starting an SSH client agent and executing a set of commands based on host and credentials in a concurrent manner and passing the results of that command execution to a set of listening functions.

Example usage can be found in the example directory.

Documentation

Index

• func Copy(dst io.Writer, src io.Reader) (written int64, err error)
• func GetAuthKeys(keys []string) []ssh.AuthMethod
• func GetAuthPassword(password string) []ssh.AuthMethod
• func PublicKeyFile(file string) ssh.AuthMethod
• type ExecResult
• type HostSession
  • func (exec *HostSession) Exec(id int, command string, config ssh.ClientConfig) *ExecResult
  • func (exec *HostSession) GenerateConfig() ssh.ClientConfig
  • func (exec *HostSession) Transfer(id int, localFilePath string, remoteFilePath string, config ssh.ClientConfig) *ExecResult
• type SSHExecAgent
  • func (s *SSHExecAgent) SftpHostByKey(hosts []string, user string, localFilePath string, remoteFilePath string) ([]ExecResult, error)
  • func (s *SSHExecAgent) SshHostByKey(hosts []string, user string, cmd string) ([]ExecResult, error)

Functions

func Copy

func Copy(dst io.Writer, src io.Reader) (written int64, err error)

func GetAuthKeys

func GetAuthKeys(keys []string) []ssh.AuthMethod

func GetAuthPassword

func GetAuthPassword(password string) []ssh.AuthMethod

func PublicKeyFile

func PublicKeyFile(file string) ssh.AuthMethod

Types

type ExecResult

type ExecResult struct {
	Id             int
	Host           string
	Command        string
	LocalFilePath  string
	RemoteFilePath string
	Result         string
	StartTime      time.Time
	EndTime        time.Time
	Error          error
	ErrorInfo      string
}

type HostSession

type HostSession struct {
	Username string
	Password string
	Hostname string
	Signers  []ssh.Signer
	Port     int
	Auths    []ssh.AuthMethod
}

func (*HostSession) Exec

func (exec *HostSession) Exec(id int, command string, config ssh.ClientConfig) *ExecResult

func (*HostSession) GenerateConfig

func (exec *HostSession) GenerateConfig() ssh.ClientConfig

func (*HostSession) Transfer

func (exec *HostSession) Transfer(id int, localFilePath string, remoteFilePath string, config ssh.ClientConfig) *ExecResult

type SSHExecAgent

type SSHExecAgent struct {
	Worker  int
	TimeOut time.Duration
}

func (*SSHExecAgent) SftpHostByKey

func (s *SSHExecAgent) SftpHostByKey(hosts []string, user string, localFilePath string, remoteFilePath string) ([]ExecResult, error)

这里的host要带端口信息

func (*SSHExecAgent) SshHostByKey

func (s *SSHExecAgent) SshHostByKey(hosts []string, user string, cmd string) ([]ExecResult, error)