executor

package

Go to main page

Versions in this module

v0

v0.8.0

Jul 28, 2025

Changes in this version

type SshCExecutor

+ CiscoDevice bool

+ CiscoPrompt string

+ func (e *SshCExecutor) RunCommandWithOutputOnCiscoDevice(nodeName, command string, envs map[string]string, ...) (int, error)

type SshCSession

+ CiscoPrompt string

v0.7.0

Jul 28, 2025

Changes in this version

+ func ResizeWindowHandler(sigs chan os.Signal, stdin *os.File, session *SshCSession)

type SshCExecutor

+ Cancel context.CancelFunc

+ Ctx context.Context

+ LocalListener net.Listener

+ LocalListenerWg sync.WaitGroup

+ TimeoutSecs *uint

+ TunnelChain []*TunnelHop

+ TunnelLocalAddr string

+ TunnelLocalBind bool

+ TunnelLocalPort int

+ func (s *SshCExecutor) BuildChain() (*ssh.Client, error)

+ type TunnelHop struct

+ Client *ssh.Client

+ ConnProtocol string

+ Host string

+ Pass string

+ Port int

+ PrivateKey string

+ PrivateKeyPass string

+ TimeoutSecs *uint

+ User string

+ func NewTunnelHop(r *specs.Remote) (*TunnelHop, error)

v0.6.2

Dec 10, 2024

v0.6.1

Dec 8, 2024

v0.6.0

Dec 8, 2024

v0.5.0

Jul 3, 2024

v0.4.0

Jun 6, 2024

v0.3.0

May 25, 2024

v0.2.0

May 24, 2024

v0.1.0

May 23, 2024

Changes in this version

+ type SshCEmitter struct

+ HostWriterStderr io.WriteCloser

+ HostWriterStdout io.WriteCloser

+ SshWriterStderr io.WriteCloser

+ SshWriterStdout io.WriteCloser

+ func NewSshCEmitter() *SshCEmitter

+ func (e *SshCEmitter) DebugLog(color bool, args ...interface{})

+ func (e *SshCEmitter) Emits(eType SshCExecutorEvent, data map[string]interface{})

+ func (e *SshCEmitter) ErrorLog(color bool, args ...interface{})

+ func (e *SshCEmitter) GetHostWriterStderr() io.WriteCloser

+ func (e *SshCEmitter) GetHostWriterStdout() io.WriteCloser

+ func (e *SshCEmitter) GetSshWriterStderr() io.WriteCloser

+ func (e *SshCEmitter) GetSshWriterStdout() io.WriteCloser

+ func (e *SshCEmitter) InfoLog(color bool, args ...interface{})

+ func (e *SshCEmitter) SetHostWriterStderr(w io.WriteCloser)

+ func (e *SshCEmitter) SetHostWriterStdout(w io.WriteCloser)

+ func (e *SshCEmitter) SetSshWriterStderr(w io.WriteCloser)

+ func (e *SshCEmitter) SetSshWriterStdout(w io.WriteCloser)

+ func (e *SshCEmitter) WarnLog(color bool, args ...interface{})

+ type SshCEmitterWriter struct

+ Type string

+ func NewSshCEmitterWriter(t string) *SshCEmitterWriter

+ func (e *SshCEmitterWriter) Close() error

+ func (e *SshCEmitterWriter) Write(p []byte) (int, error)

+ type SshCExecutor struct

+ Client *ssh.Client

+ ConfigDir string

+ ConnProtocol string

+ Emitter SshCExecutorEmitter

+ Endpoint string

+ Entrypoint []string

+ Host string

+ Pass string

+ Port int

+ PrivateKey string

+ PrivateKeyPass string

+ RuntimeCmdsOutput bool

+ Sessions map[string]*SshCSession

+ SftpClient *sftp.Client

+ ShowCmdsOutput bool

+ TTYOpISpeed uint32

+ TTYOpOSpeed uint32

+ User string

+ func NewSshCExecutor(endpoint, host string, port int) *SshCExecutor

+ func NewSshCExecutorFromRemote(rname string, r *specs.Remote) (*SshCExecutor, error)

+ func (e *SshCExecutor) GetEmitter() SshCExecutorEmitter

+ func (e *SshCExecutor) RunCommand(nodeName, command string, envs map[string]string, entryPoint []string) (int, error)

+ func (e *SshCExecutor) RunCommandWithOutput(nodeName, command string, envs map[string]string, ...) (int, error)

+ func (e *SshCExecutor) RunCommandWithOutput4Var(nodeName, command, outVar, errVar string, envs *map[string]string, ...) (int, error)

+ func (e *SshCExecutor) RunHostCommand(command string, envs map[string]string, entryPoint []string) (int, error)

+ func (e *SshCExecutor) RunHostCommandWithOutput(command string, envs map[string]string, outBuffer, errBuffer io.WriteCloser, ...) (int, error)

+ func (e *SshCExecutor) RunHostCommandWithOutput4Var(command, outVar, errVar string, envs *map[string]string, entryPoint []string) (int, error)

+ func (e *SshCExecutor) SetEmitter(emitter SshCExecutorEmitter)

+ func (s *SshCExecutor) Close()

+ func (s *SshCExecutor) GetClient() *ssh.Client

+ func (s *SshCExecutor) GetConnProtocol() string

+ func (s *SshCExecutor) GetEndpoint() string

+ func (s *SshCExecutor) GetHost() string

+ func (s *SshCExecutor) GetPass() string

+ func (s *SshCExecutor) GetPort() int

+ func (s *SshCExecutor) GetPrivateKey() string

+ func (s *SshCExecutor) GetPrivateKeyPass() string

+ func (s *SshCExecutor) GetRuntimeCmdsOutput() bool

+ func (s *SshCExecutor) GetSession(n string) (*SshCSession, error)

+ func (s *SshCExecutor) GetSftpClient() *sftp.Client

+ func (s *SshCExecutor) GetShellSession(n, termType string, h, w int, echo bool) (*SshCSession, error)

+ func (s *SshCExecutor) GetShellSessionWithTermSetup(n, termType string, stdin *os.File, stdout, stderr io.Writer) (*SshCSession, TermShellRestoreCb, error)

+ func (s *SshCExecutor) GetShowCmdsOutput() bool

+ func (s *SshCExecutor) GetUser() string

+ func (s *SshCExecutor) RecursiveMkdir(dir string, mode *os.FileMode, uid int, gid int, ensurePerms bool) error

+ func (s *SshCExecutor) RecursivePullFile(nodeName, sourcePath, targetPath string, localAsTarget, ensurePerms bool) error

+ func (s *SshCExecutor) RecursivePushFile(nodeName, source, target string, ensurePerms bool) error

+ func (s *SshCExecutor) RemoveSession(n string) error

+ func (s *SshCExecutor) ResetSession(n string) (*SshCSession, error)

+ func (s *SshCExecutor) Setup() error

+ func (s *SshCExecutor) SetupSftp(opts ...sftp.ClientOption) error

+ type SshCExecutorEmitter interface

+ DebugLog func(color bool, args ...interface{})

+ Emits func(eType SshCExecutorEvent, data map[string]interface{})

+ ErrorLog func(color bool, args ...interface{})

+ InfoLog func(color bool, args ...interface{})

+ WarnLog func(color bool, args ...interface{})

+ type SshCExecutorEvent string

+ const SshClientSetupDone

+ const SshContainerConnected

+ type SshCSession struct

+ Name string

+ func NewSshCSession(name string, s *ssh.Session) *SshCSession

+ func (s *SshCSession) GetName() string

+ func (s *SshCSession) GetRawSession() *ssh.Session

+ type TermShellRestoreCb func() error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL