ssh

Documentation

Index

• Constants
• func NewErrUserHasNoPermission(username string) error
• type Client
  • func NewClient(username string, password string, agent bool, agentSocket string, ...) (Client, error)
• type NodeResolver
• type ProxmoxNode

Constants

const (
	// TrySudo is a shell function that tries to execute a command with sudo if the user has sudo permissions.
	TrySudo = `try_sudo(){ if [ $(sudo -n pvesm apiinfo 2>&1 | grep "APIVER" | wc -l) -gt 0 ]; then sudo $1; else $1; fi }`
)

Functions

func NewErrUserHasNoPermission

func NewErrUserHasNoPermission(username string) error

NewErrUserHasNoPermission creates a new error indicating that the SSH user does not have required permissions.

Types

type Client

type Client interface {
	// Username returns the SSH username.
	Username() string

	// ExecuteNodeCommands executes a command on a node.
	ExecuteNodeCommands(ctx context.Context, nodeName string, commands []string) ([]byte, error)

	// NodeUpload uploads a file to a node.
	NodeUpload(ctx context.Context, nodeName string,
		remoteFileDir string, fileUploadRequest *api.FileUploadRequest) error

	// NodeStreamUpload uploads a file to a node by streaming its content over SSH.
	NodeStreamUpload(ctx context.Context, nodeName string,
		remoteFileDir string, fileUploadRequest *api.FileUploadRequest) error
}

Client is an interface for performing SSH requests against the Proxmox Nodes.

func NewClient

func NewClient(
	username string, password string,
	agent bool, agentSocket string,
	privateKey string,
	socks5Server string, socks5Username string, socks5Password string,
	nodeResolver NodeResolver,
) (Client, error)

NewClient creates a new SSH client.

type NodeResolver

type NodeResolver interface {
	Resolve(ctx context.Context, nodeName string) (ProxmoxNode, error)
}

NodeResolver is an interface for resolving node names to IP addresses to use for SSH connection.

type ProxmoxNode

type ProxmoxNode struct {
	Address string
	Port    int32
}

ProxmoxNode represents node address and port for SSH connection.