api

Aug 19, 2025

Changes in this version

type VMConfig

+ Hostname string

+ Name string

Aug 9, 2025

Changes in this version

type Client

+ func (c *Client) ResetVM(vm *VM) error

+ func (c *Client) ShutdownVM(vm *VM) error

Aug 3, 2025

Changes in this version

type Client

+ func (c *Client) CreateSnapshot(vm *VM, name string, options *SnapshotOptions) error

+ func (c *Client) DeleteSnapshot(vm *VM, snapshotName string) error

+ func (c *Client) GetSnapshots(vm *VM) ([]Snapshot, error)

+ func (c *Client) RollbackToSnapshot(vm *VM, snapshotName string) error

+ type Snapshot struct

+ Description string

+ Name string

+ Parent string

+ SnapTime time.Time

+ VMState bool

+ type SnapshotOptions struct

+ Description string

+ VMState bool

Jul 16, 2025

Changes in this version

type Client

+ func (c *Client) GetVMConfig(vm *VM) (*VMConfig, error)

+ func (c *Client) ResizeVMStorage(vm *VM, disk string, size string) error

+ func (c *Client) UpdateVMConfig(vm *VM, config *VMConfig) error

+ func (c *Client) UpdateVMResources(vm *VM, cores int, memory int64) error

type StorageDevice

+ Media string

+ type VMConfig struct

+ BootOrder string

+ CPUType string

+ Cores int

+ Description string

+ Disks map[string]int64

+ MaxMem int64

+ Memory int64

+ OnBoot *bool

+ Sockets int

+ Swap int64

Jun 30, 2025

Changes in this version

+ const ActionMigrate

+ const EndpointAccessTicket

+ const HTTPMethodDELETE

+ const HTTPMethodPOST

+ const HTTPMethodPUT

type Client

+ func (c *Client) MigrateVM(vm *VM, options *MigrationOptions) error

+ type MigrationOptions struct

+ BandwidthLimit int

+ Delete bool

+ Force bool

+ MigrationNetwork string

+ MigrationType string

+ Online *bool

+ Target string

+ TargetStorage string

Jun 23, 2025

Changes in this version

+ const PageTasks

type Client

+ func (c *Client) Delete(path string) error

+ func (c *Client) DeleteVM(vm *VM) error

+ func (c *Client) DeleteVMWithOptions(vm *VM, options *DeleteVMOptions) error

+ func (c *Client) GetClusterTasks() ([]*ClusterTask, error)

+ type ClusterTask struct

+ EndTime int64

+ ID string

+ Node string

+ Saved string

+ StartTime int64

+ Status string

+ TokenID string

+ Type string

+ UPID string

+ User string

+ type DeleteVMOptions struct

+ DestroyUnreferencedDisks bool

+ Force bool

+ Purge bool

+ SkipLock bool

Jun 22, 2025

Changes in this version

+ type ConfiguredNetwork struct

+ Bridge string

+ Firewall bool

+ Gateway string

+ IP string

+ Interface string

+ MACAddr string

+ Model string

+ Rate string

+ VLAN string

+ type StorageDevice struct

+ Backup bool

+ Cache string

+ Device string

+ Discard string

+ Format string

+ IOThread bool

+ Replicate bool

+ SSD bool

+ Serial string

+ Size string

+ Storage string

type VM

+ Architecture string

+ BootOrder string

+ CPUCores int

+ CPUSockets int

+ ConfiguredNetworks []ConfiguredNetwork

+ Description string

+ OSType string

+ OnBoot bool

+ StorageDevices []StorageDevice

Jun 20, 2025

Changes in this version

+ func FormatBytes(bytes int64) string

+ func FormatUptime(seconds int64) string

+ func ParseVMID(input interface{}) (int, error)

+ func SafeBoolValue(value interface{}) bool

+ func SafeFloatValue(value interface{}) float64

+ func SafeStringValue(value interface{}) string

type Client

+ func (c *Client) GetAuthToken() string

+ func (c *Client) GetBaseURL() string

+ func (c *Client) GetNodeVNCShellWithWebSocket(nodeName string) (*VNCProxyResponse, error)

+ func (c *Client) GetVNCProxyWithWebSocket(vm *VM) (*VNCProxyResponse, error)

type VNCProxyResponse

+ Password string

Jun 6, 2025

Changes in this version

+ const ActionOpenShell

+ const ActionRefresh

+ const ClusterDataTTL

+ const IPTypeIPv4

+ const IPTypeIPv6

+ const LoopbackInterface

+ const NodeDataTTL

+ const NodeType

+ const PageGuests

+ const PageNodes

+ const ResourceDataTTL

+ const StringNA

+ const StringTrue

+ const VMDataTTL

+ const VMStatusRunning

+ const VMStatusStopped

+ const VMTypeLXC

+ const VMTypeQemu

+ func ExampleUsage()

+ func GetFirstNonLoopbackIP(interfaces []NetworkInterface, preferIPv4 bool) string

+ type AuthManager struct

+ func NewAuthManagerWithPassword(httpClient *HTTPClient, username, password string, logger interfaces.Logger) *AuthManager

+ func NewAuthManagerWithToken(httpClient *HTTPClient, token string, logger interfaces.Logger) *AuthManager

+ func (am *AuthManager) ClearToken()

+ func (am *AuthManager) EnsureAuthenticated() error

+ func (am *AuthManager) GetValidToken(ctx context.Context) (*AuthToken, error)

+ func (am *AuthManager) IsTokenAuth() bool

+ type AuthToken struct

+ CSRFToken string

+ ExpiresAt time.Time

+ Ticket string

+ Username string

+ func (t *AuthToken) IsValid() bool

+ type CPUInfo struct

+ Cores int

+ Cpus int

+ Model string

+ Sockets int

+ type Client struct

+ Cluster *Cluster

+ func NewClient(config interfaces.Config, options ...ClientOption) (*Client, error)

+ func (c *Client) ClearAPICache()

+ func (c *Client) EnrichVMs(cluster *Cluster) error

+ func (c *Client) FastGetClusterStatus(onEnrichmentComplete func()) (*Cluster, error)

+ func (c *Client) GenerateNodeVNCURL(nodeName string) (string, error)

+ func (c *Client) GenerateVNCURL(vm *VM) (string, error)

+ func (c *Client) Get(path string, result *map[string]interface{}) error

+ func (c *Client) GetClusterStatus() (*Cluster, error)

+ func (c *Client) GetDetailedVmInfo(node, vmType string, vmid int) (*VM, error)

+ func (c *Client) GetFreshClusterStatus() (*Cluster, error)

+ func (c *Client) GetGuestAgentFilesystems(vm *VM) ([]Filesystem, error)

+ func (c *Client) GetGuestAgentInterfaces(vm *VM) ([]NetworkInterface, error)

+ func (c *Client) GetLxcInterfaces(vm *VM) ([]NetworkInterface, error)

+ func (c *Client) GetNoRetry(path string, result *map[string]interface{}) error

+ func (c *Client) GetNodeConfig(nodeName string) (map[string]interface{}, error)

+ func (c *Client) GetNodeStatus(nodeName string) (*Node, error)

+ func (c *Client) GetNodeVNCShell(nodeName string) (*VNCProxyResponse, error)

+ func (c *Client) GetVNCProxy(vm *VM) (*VNCProxyResponse, error)

+ func (c *Client) GetVmList(ctx context.Context) ([]map[string]interface{}, error)

+ func (c *Client) GetVmStatus(vm *VM) error

+ func (c *Client) GetWithCache(path string, result *map[string]interface{}, ttl time.Duration) error

+ func (c *Client) GetWithRetry(path string, result *map[string]interface{}, maxRetries int) error

+ func (c *Client) IsUsingTokenAuth() bool

+ func (c *Client) ListNodes() ([]Node, error)

+ func (c *Client) Post(path string, data interface{}) error

+ func (c *Client) PostWithResponse(path string, data interface{}, result *map[string]interface{}) error

+ func (c *Client) RefreshNodeData(nodeName string) (*Node, error)

+ func (c *Client) RefreshVMData(vm *VM, onEnrichmentComplete func(*VM)) (*VM, error)

+ func (c *Client) RestartVM(vm *VM) error

+ func (c *Client) StartVM(vm *VM) error

+ func (c *Client) StopVM(vm *VM) error

+ func (c *Client) Version(ctx context.Context) (float64, error)

+ type ClientOption func(*ClientOptions)

+ func WithCache(cache interfaces.Cache) ClientOption

+ func WithLogger(logger interfaces.Logger) ClientOption

+ type ClientOptions struct

+ Cache interfaces.Cache

+ Logger interfaces.Logger

+ type Cluster struct

+ CPUUsage float64

+ MemoryTotal float64

+ MemoryUsed float64

+ Name string

+ Nodes []*Node

+ OnlineNodes int

+ Quorate bool

+ StorageManager *StorageManager

+ StorageTotal int64

+ StorageUsed int64

+ TotalCPU float64

+ TotalNodes int

+ Version string

+ type ExampleConfig struct

+ func NewExampleConfig(addr, user, password, realm string, insecure bool) *ExampleConfig

+ func (c *ExampleConfig) GetAPIToken() string

+ func (c *ExampleConfig) GetAddr() string

+ func (c *ExampleConfig) GetInsecure() bool

+ func (c *ExampleConfig) GetPassword() string

+ func (c *ExampleConfig) GetRealm() string

+ func (c *ExampleConfig) GetTokenID() string

+ func (c *ExampleConfig) GetTokenSecret() string

+ func (c *ExampleConfig) GetUser() string

+ func (c *ExampleConfig) IsUsingTokenAuth() bool

+ type ExampleLogger struct

+ func (l *ExampleLogger) Debug(format string, args ...interface{})

+ func (l *ExampleLogger) Error(format string, args ...interface{})

+ func (l *ExampleLogger) Info(format string, args ...interface{})

+ type Filesystem struct

+ Device string

+ IsRoot bool

+ IsSystemDrive bool

+ Mountpoint string

+ Name string

+ TotalBytes int64

+ Type string

+ UsedBytes int64

+ type HTTPClient struct

+ func NewHTTPClient(httpClient *http.Client, baseURL string, logger interfaces.Logger) *HTTPClient

+ func (hc *HTTPClient) Delete(ctx context.Context, path string, result *map[string]interface{}) error

+ func (hc *HTTPClient) Get(ctx context.Context, path string, result *map[string]interface{}) error

+ func (hc *HTTPClient) GetWithRetry(ctx context.Context, path string, result *map[string]interface{}, ...) error

+ func (hc *HTTPClient) Post(ctx context.Context, path string, data interface{}, ...) error

+ func (hc *HTTPClient) Put(ctx context.Context, path string, data interface{}, ...) error

+ func (hc *HTTPClient) SetAPIToken(token string)

+ func (hc *HTTPClient) SetAuthManager(authManager *AuthManager)

+ type IPAddress struct

+ Address string

+ Prefix int

+ Type string

+ type NetworkInterface struct

+ IPAddresses []IPAddress

+ IsLoopback bool

+ MACAddress string

+ Name string

+ Statistics NetworkInterfaceStatistics

+ type NetworkInterfaceStatistics struct

+ RxBytes int64

+ RxDropped int64

+ RxErrors int64

+ RxPackets int64

+ TxBytes int64

+ TxDropped int64

+ TxErrors int64

+ TxPackets int64

+ type Node struct

+ CGroupMode int

+ CPUCount float64

+ CPUInfo *CPUInfo

+ CPUUsage float64

+ ID string

+ IP string

+ KernelVersion string

+ Level string

+ LoadAvg []string

+ MemoryTotal float64

+ MemoryUsed float64

+ Name string

+ Online bool

+ Storage *Storage

+ TotalStorage int64

+ Uptime int64

+ UsedStorage int64

+ VMs []*VM

+ Version string

+ type Storage struct

+ Content string

+ Disk int64

+ ID string

+ MaxDisk int64

+ Name string

+ Node string

+ Plugintype string

+ Shared int

+ Status string

+ Type string

+ func (s *Storage) GetTotalGB() float64

+ func (s *Storage) GetUsageGB() float64

+ func (s *Storage) GetUsagePercent() float64

+ func (s *Storage) IsShared() bool

+ type StorageManager struct

+ AllStorages []*Storage

+ LocalStorages []*Storage

+ SharedStorages []*Storage

+ UniqueStorages []*Storage

+ func NewStorageManager() *StorageManager

+ func (sm *StorageManager) AddStorage(storage *Storage)

+ func (sm *StorageManager) GetTotalCapacity() int64

+ func (sm *StorageManager) GetTotalUsage() int64

+ type VM struct

+ AgentEnabled bool

+ AgentRunning bool

+ CPU float64

+ ConfiguredMACs map[string]bool

+ Disk int64

+ DiskRead int64

+ DiskWrite int64

+ Enriched bool

+ Filesystems []Filesystem

+ HAState string

+ ID int

+ IP string

+ Lock string

+ MaxDisk int64

+ MaxMem int64

+ Mem int64

+ Name string

+ NetIn int64

+ NetInterfaces []NetworkInterface

+ NetOut int64

+ Node string

+ Pool string

+ Status string

+ Tags string

+ Template bool

+ Type string

+ Uptime int64

+ type VNCProxyResponse struct

+ Cert string

+ Port string

+ Ticket string

+ User string