ssh

Documentation

Index

• type Transport
  • func Dial(ctx context.Context, network, addr string, config *ssh.ClientConfig) (*Transport, error)
  • func NewTransport(client *ssh.Client) (*Transport, error)
  • func (t *Transport) Close() error

Types

type Transport

type Transport struct {
	// contains filtered or unexported fields
}

Transport implements RFC6242 for implementing NETCONF protocol over SSH.

func Dial

func Dial(ctx context.Context, network, addr string, config *ssh.ClientConfig) (*Transport, error)

Dial will connect to a ssh server and issues a transport, it's used as a convenience function as essentially is the same as

	c, err := ssh.Dial(network, addr, config)
 	if err != nil { /* ... handle error ... */ }
 	t, err := NewTransport(c)

When the transport is closed the underlying connection is also closed.

func NewTransport

func NewTransport(client *ssh.Client) (*Transport, error)

NewTransport will create a new ssh transport as defined in RFC6242 for use with netconf. Unlike Dial, the underlying client will not be automatically closed when the transport is closed (however any sessions and subsystems are still closed).

func (*Transport) Close

func (t *Transport) Close() error

Close will close the underlying transport. If the connection was created with Dial then then underlying ssh.Client is closed as well. If not only the sessions is closed.