ssh

Documentation

Index

• func CopyFromRemote(host *RemoteHost, remoteFile *RemoteFile, destinationPath string) (stderr string, err error)
• func CopyToRemote(host *RemoteHost, file *RemoteFile) (combinedOutput string, err error)
• func ExecuteRemote(host *RemoteHost, script string) (combinedOutput string, err error)
• func PublicKeyAuth(sshPrivateKeyPath string) (ssh.AuthMethod, error)
• type AuthConfig
• type JumpBox
• type RemoteFile
• type RemoteHost

Functions

func CopyFromRemote

func CopyFromRemote(host *RemoteHost, remoteFile *RemoteFile, destinationPath string) (stderr string, err error)

CopyFromRemote copies a remote file to the local host

func CopyToRemote

func CopyToRemote(host *RemoteHost, file *RemoteFile) (combinedOutput string, err error)

CopyToRemote copies a file to a remote host

func ExecuteRemote

func ExecuteRemote(host *RemoteHost, script string) (combinedOutput string, err error)

ExecuteRemote executes a script in a remote host

func PublicKeyAuth

func PublicKeyAuth(sshPrivateKeyPath string) (ssh.AuthMethod, error)

PublicKeyAuth returns an AuthMethod that uses a ssh key pair

Types

type AuthConfig

type AuthConfig struct {
	User           string
	Password       string
	PrivateKeyPath string
}

type JumpBox

type JumpBox struct {
	URI             string
	Port            int
	OperatingSystem api.OSType
	AuthConfig      *AuthConfig
}

type RemoteFile

type RemoteFile struct {
	Path        string
	Permissions string
	Owner       string
	Content     []byte
}

type RemoteHost

type RemoteHost struct {
	URI             string
	Port            int
	OperatingSystem api.OSType
	AuthConfig      *AuthConfig
	Jumpbox         *JumpBox
}