configssh

Documentation

Index

• type Client
  • func (c *Client) Dial(endpoint string) (err error)
  • func (c *Client) SFTPClient() (*SFTPClient, error)
• type SFTPClient
• type SSHClientSettings
  • func (scs *SSHClientSettings) ToClient(_ component.Host, _ component.TelemetrySettings) (*Client, error)

Types

type Client

type Client struct {
	*ssh.Client
	*ssh.ClientConfig
	DialFunc func(network, address string, config *ssh.ClientConfig) (*ssh.Client, error)
}

func (*Client) Dial

func (c *Client) Dial(endpoint string) (err error)

Dial starts an SSH session.

func (*Client) SFTPClient

func (c *Client) SFTPClient() (*SFTPClient, error)

type SFTPClient

type SFTPClient struct {
	*sftp.Client
	*ssh.ClientConfig
}

type SSHClientSettings

type SSHClientSettings struct {
	// Endpoint is always required
	Endpoint string        `mapstructure:"endpoint"`
	Timeout  time.Duration `mapstructure:"timeout"`

	// authentication requires a Username and either a Password or KeyFile
	Username string `mapstructure:"username"`
	Password string `mapstructure:"password"`
	KeyFile  string `mapstructure:"key_file"`

	// file path to the known_hosts
	KnownHosts string `mapstructure:"known_hosts"`

	// IgnoreHostKey provides an insecure path to quickstarts and testing
	IgnoreHostKey bool `mapstructure:"ignore_host_key"`
}

func (*SSHClientSettings) ToClient

func (scs *SSHClientSettings) ToClient(_ component.Host, _ component.TelemetrySettings) (*Client, error)

ToClient creates an SSHClient.