proxmox

package

v0.7.5 Latest Latest Go to latest Published: Nov 3, 2025 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation ¶

Overview ¶

Package proxmox defines Proxmox Client interface.

Index ¶

type Client
type Logger
type VMCloneRequest
type VMCloneResponse
type VirtualMachineOption

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Client ¶

type Client interface {
	CloneVM(ctx context.Context, templateID int, clone VMCloneRequest) (VMCloneResponse, error)

	ConfigureVM(ctx context.Context, vm *proxmox.VirtualMachine, options ...VirtualMachineOption) (*proxmox.Task, error)

	FindVMResource(ctx context.Context, vmID uint64) (*proxmox.ClusterResource, error)
	FindVMTemplateByTags(ctx context.Context, templateTags []string) (string, int32, error)

	CheckID(ctx context.Context, vmID int64) (bool, error)

	GetVM(ctx context.Context, nodeName string, vmID int64) (*proxmox.VirtualMachine, error)

	DeleteVM(ctx context.Context, nodeName string, vmID int64) (*proxmox.Task, error)

	GetTask(ctx context.Context, upID string) (*proxmox.Task, error)

	GetReservableMemoryBytes(ctx context.Context, nodeName string, nodeMemoryAdjustment uint64) (uint64, error)

	ResizeDisk(ctx context.Context, vm *proxmox.VirtualMachine, disk, size string) (*proxmox.Task, error)

	ResumeVM(ctx context.Context, vm *proxmox.VirtualMachine) (*proxmox.Task, error)

	StartVM(ctx context.Context, vm *proxmox.VirtualMachine) (*proxmox.Task, error)

	TagVM(ctx context.Context, vm *proxmox.VirtualMachine, tag string) (*proxmox.Task, error)

	UnmountCloudInitISO(ctx context.Context, vm *proxmox.VirtualMachine, device string) error

	CloudInitStatus(ctx context.Context, vm *proxmox.VirtualMachine) (bool, error)

	QemuAgentStatus(ctx context.Context, vm *proxmox.VirtualMachine) error
}

Client Global Proxmox client interface.

type Logger ¶

type Logger struct{}

Logger implements go-proxmox.LeveledLoggerInterface and uses klog as log sink.

Methods from the interface are mapped

Errorf = Errorf
Warnf = V(0).Infof
Infof = V(2).Infof
Debugf = V(4).Infof

func (Logger) Debugf ¶

func (Logger) Debugf(format string, args ...interface{})

Debugf logs message at debug level.

func (Logger) Errorf ¶

func (Logger) Errorf(format string, args ...interface{})

Errorf logs message at error level.

func (Logger) Infof ¶

func (Logger) Infof(format string, args ...interface{})

Infof logs message at info level.

func (Logger) Warnf ¶

func (Logger) Warnf(format string, args ...interface{})

Warnf logs message at warn level.

type VMCloneRequest ¶

type VMCloneRequest struct {
	Node        string `json:"node"`
	NewID       int    `json:"newID"`
	Name        string `json:"name"`
	Description string `json:"description,omitempty"`
	Format      string `json:"format,omitempty"`
	Full        uint8  `json:"full,omitempty"`
	Pool        string `json:"pool,omitempty"`
	SnapName    string `json:"snapname,omitempty"`
	Storage     string `json:"storage,omitempty"`
	Target      string `json:"target,omitempty"`
}

VMCloneRequest Is the object used to clone a VM.

type VMCloneResponse ¶

type VMCloneResponse struct {
	NewID int64         `json:"newId,omitempty"`
	Task  *proxmox.Task `json:"task,omitempty"`
}

VMCloneResponse response returned when cloning a VM.

type VirtualMachineOption ¶

type VirtualMachineOption = proxmox.VirtualMachineOption

VirtualMachineOption is an alias for VirtualMachineOption to prevent import conflicts.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
goproxmox Package goproxmox implements a client for Proxmox resource lifecycle management.	Package goproxmox implements a client for Proxmox resource lifecycle management.
proxmoxtest

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL