sshrunner

Documentation

Index

• Variables
• type SFTPClient
  • func NewSFTPClient(sc *SSHClient, fileTransBuf int) *SFTPClient
  • func (sf *SFTPClient) Close()
  • func (sf *SFTPClient) Get(localPath, remotePath string, bar *pb.ProgressBar) error
  • func (sf *SFTPClient) Put(localPath, remotePath string, bar *pb.ProgressBar) error
  • func (sf *SFTPClient) RemotePathSize(remotePath string) (int64, error)
• type SSHClient
  • func NewSSHClient(user, password, sshKeyPath, host string, port int) *SSHClient
  • func (sc *SSHClient) Close()
  • func (sc *SSHClient) ExecInteractiveCmd(cmd string) error
  • func (sc *SSHClient) ExecNointeractiveCmd(cmd string, timeout time.Duration) (status runner.OutputStaus, stdout, stderr *bytes.Buffer, err error)
• type SSHRunner
  • func New(user, password, sshKeyPath, host string, port, fileTransBuf int) *SSHRunner
  • func (sr *SSHRunner) ConcurrentExec(input runner.ExecInput, outputChan chan *runner.ConcurrentExecOutput, ...)
  • func (sr *SSHRunner) ConcurrentGet(input runner.RcpInput, outputChan chan *runner.ConcurrentRcpOutput, ...)
  • func (sr *SSHRunner) ConcurrentPut(input runner.RcpInput, outputChan chan *runner.ConcurrentRcpOutput, ...)
  • func (sr *SSHRunner) Login(shell string) error
  • func (sr *SSHRunner) RemotePathSize(input runner.RcpInput) (int64, error)
  • func (sr *SSHRunner) SyncExec(input runner.ExecInput) *runner.ExecOutput
  • func (sr *SSHRunner) SyncGet(input runner.RcpInput) *runner.RcpOutput
  • func (sr *SSHRunner) SyncPut(input runner.RcpInput) *runner.RcpOutput

Variables

var (
	// ErrLocalPathIsFile remote path is directory
	ErrLocalPathIsFile = "local path cannot be a file when remote path is directory"
)

Types

type SFTPClient

type SFTPClient struct {
	FileTransBuf int
	// contains filtered or unexported fields
}

func NewSFTPClient

func NewSFTPClient(sc *SSHClient, fileTransBuf int) *SFTPClient

func (*SFTPClient) Close

func (sf *SFTPClient) Close()

func (*SFTPClient) Get

func (sf *SFTPClient) Get(localPath, remotePath string, bar *pb.ProgressBar) error

Get transfer file/directory from remote server

func (*SFTPClient) Put

func (sf *SFTPClient) Put(localPath, remotePath string, bar *pb.ProgressBar) error

Put transfer file/directory to remote server

func (*SFTPClient) RemotePathSize

func (sf *SFTPClient) RemotePathSize(remotePath string) (int64, error)

RemotePathSize remote path size with all file in it

type SSHClient

type SSHClient struct {
	User       string
	Password   string
	SSHKeyPath string
	Host       string
	Port       int
	// contains filtered or unexported fields
}

func NewSSHClient

func NewSSHClient(user, password, sshKeyPath, host string, port int) *SSHClient

func (*SSHClient) Close

func (sc *SSHClient) Close()

Close release resources

func (*SSHClient) ExecInteractiveCmd

func (sc *SSHClient) ExecInteractiveCmd(cmd string) error

ExecInteractiveCmd exec command with interactive

func (*SSHClient) ExecNointeractiveCmd

func (sc *SSHClient) ExecNointeractiveCmd(cmd string, timeout time.Duration) (status runner.OutputStaus, stdout, stderr *bytes.Buffer, err error)

ExecNointeractiveCmd exec command without interactive

type SSHRunner

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

SSHRunner execute command by ssh

func New

func New(user, password, sshKeyPath, host string, port, fileTransBuf int) *SSHRunner

func (*SSHRunner) ConcurrentExec

func (sr *SSHRunner) ConcurrentExec(input runner.ExecInput, outputChan chan *runner.ConcurrentExecOutput, limitChan chan int)

ConcurrentExec execute command sync

func (*SSHRunner) ConcurrentGet

func (sr *SSHRunner) ConcurrentGet(input runner.RcpInput, outputChan chan *runner.ConcurrentRcpOutput, limitChan chan int, pool *pb.Pool)

ConcurrentGet copy file to remote server concurrency

func (*SSHRunner) ConcurrentPut

func (sr *SSHRunner) ConcurrentPut(input runner.RcpInput, outputChan chan *runner.ConcurrentRcpOutput, limitChan chan int, pool *pb.Pool)

ConcurrentPut copy file from remote server concurrency

func (*SSHRunner) Login

func (sr *SSHRunner) Login(shell string) error

Login login to remote server

func (*SSHRunner) RemotePathSize

func (sr *SSHRunner) RemotePathSize(input runner.RcpInput) (int64, error)

func (*SSHRunner) SyncExec

func (sr *SSHRunner) SyncExec(input runner.ExecInput) *runner.ExecOutput

SyncExec execute command sync

func (*SSHRunner) SyncGet

func (sr *SSHRunner) SyncGet(input runner.RcpInput) *runner.RcpOutput

SyncGet copy file from remote server sync

func (*SSHRunner) SyncPut

func (sr *SSHRunner) SyncPut(input runner.RcpInput) *runner.RcpOutput

SyncPut copy file to remote server sync