task

Documentation

Overview

Package task implements various Task plugins that can be run over Hosts

Index

• type RemoteCommand
  • func (t *RemoteCommand) Metadata() *gornir.TaskMetadata
  • func (t *RemoteCommand) Run(ctx context.Context, logger gornir.Logger, host *gornir.Host) (gornir.TaskInstanceResult, error)
• type RemoteCommandResults
  • func (r RemoteCommandResults) String() string
• type SFTPUpload
  • func (t *SFTPUpload) Metadata() *gornir.TaskMetadata
  • func (t *SFTPUpload) Run(ctx context.Context, logger gornir.Logger, host *gornir.Host) (gornir.TaskInstanceResult, error)
• type SFTPUploadResult
  • func (r SFTPUploadResult) String() string

Types

type RemoteCommand

type RemoteCommand struct {
	Command string               // Command to execute
	Meta    *gornir.TaskMetadata // Task metadata
}

RemoteCommand will open a new Session on an already opened ssh connection and execute the given command

func (*RemoteCommand) Metadata

func (t *RemoteCommand) Metadata() *gornir.TaskMetadata

Metadata returns the task metadata

func (*RemoteCommand) Run

func (t *RemoteCommand) Run(ctx context.Context, logger gornir.Logger, host *gornir.Host) (gornir.TaskInstanceResult, error)

Run runs a command on a remote device via ssh

type RemoteCommandResults

type RemoteCommandResults struct {
	Stdout []byte // Stdout written by the command
	Stderr []byte // Stderr written by the command
}

RemoteCommandResults is the result of calling RemoteCommand

func (RemoteCommandResults) String

func (r RemoteCommandResults) String() string

String implemente Stringer interface

type SFTPUpload

type SFTPUpload struct {
	Src  string
	Dst  string
	Meta *gornir.TaskMetadata // Task metadata
}

SFTPUpload will open a new SFTP session on an already opened ssh and upload a file

func (*SFTPUpload) Metadata

func (t *SFTPUpload) Metadata() *gornir.TaskMetadata

Metadata returns the task metadata

func (*SFTPUpload) Run

func (t *SFTPUpload) Run(ctx context.Context, logger gornir.Logger, host *gornir.Host) (gornir.TaskInstanceResult, error)

Run implements will upload a file via sftp

type SFTPUploadResult

type SFTPUploadResult struct {
	Bytes int64 // Bytes written
}

SFTPUploadResult is the result of calling SFTPUpload

func (SFTPUploadResult) String

func (r SFTPUploadResult) String() string

String implemente Stringer interface