proxmox

Documentation

Index

• type Client
  • func NewClient(apiClient api.Client, sshClient ssh.Client, tmpDirOverride string) Client

Types

type Client

type Client interface {
	// Access returns a client for managing access control.
	Access() *access.Client

	// Cluster returns a client for managing the cluster.
	Cluster() *cluster.Client

	// Node returns a client for managing resources on a specific node.
	Node(nodeName string) *nodes.Client

	// Pool returns a client for managing resource pools.
	Pool() *pools.Client

	// Storage returns a client for managing storage.
	Storage() *storage.Client

	// Version returns a client for getting the version of the Proxmox Virtual Environment API.
	Version() *version.Client

	// API returns a lower-level REST API client.
	API() api.Client

	// SSH returns a lower-level SSH client.
	SSH() ssh.Client

	// TempDir returns (possibly overridden) os.TempDir().
	TempDir() string
}

Client defines a client interface for the Proxmox Virtual Environment API.

func NewClient

func NewClient(apiClient api.Client, sshClient ssh.Client, tmpDirOverride string) Client

NewClient creates a new API client.