connector

Documentation

Index

• type AuthMethod
  • func AuthByKey(username string, key io.Reader) (AuthMethod, error)
  • func AuthByPassword(username, password string) AuthMethod
• type Device
  • func (d *Device) String() string
• type SSHConnection
  • func NewSSSHConnection(device *Device, cfg *config.Config) (*SSHConnection, error)
  • func (c *SSHConnection) Close()
  • func (c *SSHConnection) Connect() error
  • func (c *SSHConnection) RunCommand(cmd string) (string, error)

Types

type AuthMethod

type AuthMethod func(*ssh.ClientConfig)

AuthMethod is the method to use to authenticate agaist the device

func AuthByKey

func AuthByKey(username string, key io.Reader) (AuthMethod, error)

AuthByKey uses public key authentication

func AuthByPassword

func AuthByPassword(username, password string) AuthMethod

AuthByPassword uses password authentication

type Device

type Device struct {
	Host         string
	Port         string
	Auth         AuthMethod
	ClientConfig ssh.ClientConfig
	DeviceConfig *config.DeviceConfig
}

func (*Device) String

func (d *Device) String() string

type SSHConnection

type SSHConnection struct {
	Host string
	// contains filtered or unexported fields
}

SSHConnection encapsulates the connection to the device

func NewSSSHConnection

func NewSSSHConnection(device *Device, cfg *config.Config) (*SSHConnection, error)

NewSSSHConnection connects to device

func (*SSHConnection) Close

func (c *SSHConnection) Close()

Close closes connection

func (*SSHConnection) Connect

func (c *SSHConnection) Connect() error

Connect connects to the device

func (*SSHConnection) RunCommand

func (c *SSHConnection) RunCommand(cmd string) (string, error)

RunCommand runs a command against the device