host

Documentation

Index

• type Attribute
  • func Address(addr string) Attribute
  • func Auth(a *auth.Auth) Attribute
  • func Auths(a ...*auth.Auth) Attribute
  • func Key(username string, passphrase string, key io.Reader) Attribute
  • func Name(name string) Attribute
  • func Password(username, password string) Attribute
  • func Port(port uint16) Attribute
  • func PublicKey(key io.Reader) Attribute
  • func Tag(tag string) Attribute
  • func Tags(tags ...string) Attribute
  • func Timeout(ttl time.Duration) Attribute
• type Host
  • func New(attributes ...Attribute) (Host, error)

Types

type Attribute

type Attribute func(Host) error

func Address

func Address(addr string) Attribute

func Auth

func Auth(a *auth.Auth) Attribute

func Auths

func Auths(a ...*auth.Auth) Attribute

func Key

func Key(username string, passphrase string, key io.Reader) Attribute

func Name

func Name(name string) Attribute

func Password

func Password(username, password string) Attribute

func Port

func Port(port uint16) Attribute

func PublicKey

func PublicKey(key io.Reader) Attribute

func Tag

func Tag(tag string) Attribute

func Tags

func Tags(tags ...string) Attribute

func Timeout

func Timeout(ttl time.Duration) Attribute

type Host

type Host interface {
	Clone(attributes ...Attribute) (Host, error)
	Command(ctx context.Context, name string, options ...command.Option) (*command.Command, error)
	Fs(ctx context.Context, opts ...sftp.ClientOption) (afero.Fs, error)
	Tags() []string
	String() string
	Name() string
}

func New

func New(attributes ...Attribute) (Host, error)