device

Documentation

Index

• Constants
• func AllCiphers() []string
• func AllHostKeyAlgorithms() []string
• func AllKeyExchanges() []string
• func UsernamePasswordConfig(username, password string) *ssh.ClientConfig
• type Connection
  • func NewConnection(stdin io.WriteCloser, stdout io.Reader) Connection
  • func NewSSHConnection(host string, port uint16, config *ssh.ClientConfig) (Connection, func(), error)
• type Device
• type InputCondition
• type Result
• type Settings

Constants

const DefaultTimeout = 30 * time.Second

Functions

func AllCiphers

func AllCiphers() []string

func AllHostKeyAlgorithms

func AllHostKeyAlgorithms() []string

func AllKeyExchanges

func AllKeyExchanges() []string

func UsernamePasswordConfig

func UsernamePasswordConfig(username, password string) *ssh.ClientConfig

Types

type Connection

type Connection interface {
	Start(ctx context.Context) error
	Stop() error
	Send(data []byte) error
	ReadUntilFunc(ctx context.Context, timeout time.Duration, f InputCondition) ([]byte, error)
}

Connection is the low-level I/O interface for a device session.

func NewConnection

func NewConnection(stdin io.WriteCloser, stdout io.Reader) Connection

NewConnection creates a Connection from an SSH stdin/stdout pair.

func NewSSHConnection

func NewSSHConnection(host string, port uint16, config *ssh.ClientConfig) (Connection, func(), error)

NewSSHConnection dials an SSH session and returns a DeviceConnection plus a done() function that closes the session and client when called.

type Device

type Device interface {
	Initialize(ctx context.Context) error
	DisablePaging(ctx context.Context) error
	Cmd(ctx context.Context, timeout time.Duration, command string) (*Result, error)
}

Device is the minimal interface for interacting with a network switch.

type InputCondition

type InputCondition func([]byte) bool

InputCondition returns true when the accumulated output satisfies a completion criterion.

type Result

type Result struct {
	Command string
	Output  string
	Failed  bool
	FailMsg string
}

Result is the output of a single command execution.

type Settings

type Settings struct {
	DriverName     string
	Connection     Connection
	Timeout        time.Duration // default command timeout; 0 uses DefaultTimeout
	EnablePassword *string       // nil means no enable password is required
}

Settings holds the connection and timing configuration shared by all drivers.