Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

ssh

package

Go to main page

Versions in this module

v6

v6.4.1

Oct 17, 2020

v6.4.0

Aug 29, 2020

v6.3.1

Jul 9, 2020

v6.3.0

Jun 17, 2020

Changes in this version

+ type DeploymentFetcher func() (boshdir.Deployment, error)

+ type HostBuilder interface

+ BuildHost func(slug boshdir.AllOrInstanceGroupOrInstanceSlug, username string, ...) (boshdir.Host, error)

+ func NewHostBuilder() HostBuilder

v6.2.1

Feb 8, 2020

v6.2.0

Jan 15, 2020

v6.1.1

Oct 19, 2019

v6.1.0

Sep 14, 2019

v6.0.0

Aug 3, 2019

Changes in this version

+ type Client interface

+ Dial func(net, addr string) (net.Conn, error)

+ Listen func(net, addr string) (net.Listener, error)

+ Start func() error

+ Stop func() error

+ type ClientConnectRetryStrategy struct

+ AuthFailureTimeout time.Duration

+ ConnectionRefusedTimeout time.Duration

+ TimeService clock.Clock

+ func (s *ClientConnectRetryStrategy) IsRetryable(err error) bool

+ type ClientFactory struct

+ func NewClientFactory(logger boshlog.Logger) ClientFactory

+ func (f ClientFactory) New(opts ClientOpts) Client

+ type ClientImpl struct

+ func (s *ClientImpl) Dial(n, addr string) (net.Conn, error)

+ func (s *ClientImpl) Listen(n, addr string) (net.Listener, error)

+ func (s *ClientImpl) Start() error

+ func (s *ClientImpl) Stop() error

+ type ClientOpts struct

+ DisableSOCKS bool

+ Host string

+ Password string

+ Port int

+ PrivateKey string

+ User string

+ type ComboRunner struct

+ func NewComboRunner(cmdRunner boshsys.CmdRunner, ...) ComboRunner

+ func (r ComboRunner) Run(connOpts ConnectionOpts, result boshdir.SSHResult, ...) error

+ type ConnectionOpts struct

+ GatewayDisable bool

+ GatewayHost string

+ GatewayPrivateKeyPath string

+ GatewayUsername string

+ PrivateKey string

+ RawOpts []string

+ SOCKS5Proxy string

+ type InstanceWriter interface

+ End func(exitStatus int, err error)

+ Stderr func() io.Writer

+ Stdout func() io.Writer

+ type InteractiveRunner struct

+ func NewInteractiveRunner(comboRunner ComboRunner) InteractiveRunner

+ func (r InteractiveRunner) Run(connOpts ConnectionOpts, result boshdir.SSHResult, rawCmd []string) error

+ type NonInteractiveRunner struct

+ func NewNonInteractiveRunner(comboRunner ComboRunner) NonInteractiveRunner

+ func (r NonInteractiveRunner) Run(connOpts ConnectionOpts, result boshdir.SSHResult, rawCmd []string) error

+ type Provider struct

+ func NewProvider(cmdRunner boshsys.CmdRunner, fs boshsys.FileSystem, ui boshui.UI, ...) Provider

+ func (p Provider) NewResultsSSHRunner(interactive bool) Runner

+ func (p Provider) NewSCPRunner() SCPRunner

+ func (p Provider) NewSSHRunner(interactive bool) Runner

+ type ResultsWriter struct

+ func NewResultsWriter(ui boshui.UI) *ResultsWriter

+ func (w *ResultsWriter) Flush()

+ func (w *ResultsWriter) ForInstance(jobName, indexOrID string) InstanceWriter

+ type Runner interface

+ Run func(ConnectionOpts, boshdir.SSHResult, []string) error

+ type SCPArgs struct

+ func NewSCPArgs(rawArgs []string, recursive bool) SCPArgs

+ func (a SCPArgs) AllOrInstanceGroupOrInstanceSlug() (boshdir.AllOrInstanceGroupOrInstanceSlug, error)

+ func (a SCPArgs) ForHost(host boshdir.Host) []string

+ type SCPRunner interface

+ Run func(ConnectionOpts, boshdir.SSHResult, SCPArgs) error

+ type SCPRunnerImpl struct

+ func NewSCPRunner(comboRunner ComboRunner) SCPRunnerImpl

+ func (r SCPRunnerImpl) Run(connOpts ConnectionOpts, result boshdir.SSHResult, scpArgs SCPArgs) error

+ type SSHArgs struct

+ CmdExistenceChecker cmdExistenceChecker

+ ConnOpts ConnectionOpts

+ ForceTTY bool

+ KnownHostsFile boshsys.File

+ PrivKeyFile boshsys.File

+ Result boshdir.SSHResult

+ Socks5Proxy *proxy.Socks5Proxy

+ func NewSSHArgs(connOpts ConnectionOpts, result boshdir.SSHResult, forceTTY bool, ...) SSHArgs

+ func (a SSHArgs) LoginForHost(host boshdir.Host) []string

+ func (a SSHArgs) OptsForHost(host boshdir.Host) []string

+ type Session interface

+ Finish func() error

+ Start func() (SSHArgs, error)

+ type SessionImpl struct

+ func NewSessionImpl(connOpts ConnectionOpts, sessOpts SessionImplOpts, result boshdir.SSHResult, ...) *SessionImpl

+ func (r *SessionImpl) Finish() error

+ func (r *SessionImpl) Start() (SSHArgs, error)

+ type SessionImplOpts struct

+ ForceTTY bool

+ type StreamingWriter struct

+ func NewStreamingWriter(comboWriter *boshui.ComboWriter) *StreamingWriter

+ func (w StreamingWriter) Flush()

+ func (w StreamingWriter) ForInstance(jobName, indexOrID string) InstanceWriter

+ type Writer interface

+ Flush func()

+ ForInstance func(jobName, indexOrID string) InstanceWriter

Other modules containing this package

gopkg.in/cloudfoundry/bosh-cli.v0

gopkg.in/cloudfoundry/bosh-cli.v2

gopkg.in/cloudfoundry/bosh-cli.v3

gopkg.in/cloudfoundry/bosh-cli.v4

gopkg.in/cloudfoundry/bosh-cli.v5