api

package

Go to main page

Versions in this module

v1

v1.0.16

Jan 2, 2026

v1.0.15

Dec 22, 2025

Changes in this version

+ type Backup struct

+ Content string

+ Date time.Time

+ Format string

+ Name string

+ Notes string

+ Size int64

+ Storage string

+ VMID int

+ Verification string

+ VolID string

+ type BackupOptions struct

+ Compression string

+ Mode string

+ Notes string

+ Notification string

+ Remove bool

+ Storage string

type Client

+ func (c *Client) CreateBackup(vm *VM, options BackupOptions) (string, error)

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

+ func (c *Client) GetBackups(vm *VM) ([]Backup, error)

+ func (c *Client) GetNodeStorages(nodeName string) ([]*Storage, error)

+ func (c *Client) GetTaskStatus(node, upid string) (*TaskStatus, error)

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

+ type TaskStatus struct

+ EndTime int64

+ ExitStatus string

+ ID string

+ Node string

+ PStart int64

+ StartTime int64

+ Status string

+ Type string

+ UPID string

+ User string

v1.0.14

Dec 7, 2025

Changes in this version

type Client

+ func (c *Client) BaseHostname() string

+ func (c *Client) GetCache() interfaces.Cache

type ClusterTask

+ SourceProfile string

+ type ConnectionSummary struct

+ ConnectedCount int

+ ErrorCount int

+ GroupName string

+ ProfileStatus map[string]string

+ TotalProfiles int

+ type GroupClientManager struct

+ func NewGroupClientManager(groupName string, logger interfaces.Logger, cache interfaces.Cache) *GroupClientManager

+ func (m *GroupClientManager) Close()

+ func (m *GroupClientManager) ExecuteOnAllProfiles(ctx context.Context, operation ProfileOperation) []ProfileResult

+ func (m *GroupClientManager) ExecuteOnProfile(ctx context.Context, profileName string, operation ProfileOperation) (interface{}, error)

+ func (m *GroupClientManager) FindNodeByNameInGroup(ctx context.Context, nodeName string) (*Node, string, error)

+ func (m *GroupClientManager) FindVMByIDInGroup(ctx context.Context, vmID int) (*VM, string, error)

+ func (m *GroupClientManager) GetAllClients() []*ProfileClient

+ func (m *GroupClientManager) GetClient(profileName string) (*ProfileClient, bool)

+ func (m *GroupClientManager) GetConnectedClients() []*ProfileClient

+ func (m *GroupClientManager) GetConnectionSummary() ConnectionSummary

+ func (m *GroupClientManager) GetGroupClusterResources(ctx context.Context, fresh bool) ([]*Node, []*VM, error)

+ func (m *GroupClientManager) GetGroupData(ctx context.Context, operation ProfileOperation, ...) (interface{}, error)

+ func (m *GroupClientManager) GetGroupName() string

+ func (m *GroupClientManager) GetGroupNodes(ctx context.Context) ([]*Node, error)

+ func (m *GroupClientManager) GetGroupTasks(ctx context.Context) ([]*ClusterTask, error)

+ func (m *GroupClientManager) GetGroupVMs(ctx context.Context) ([]*VM, error)

+ func (m *GroupClientManager) GetNodeFromGroup(ctx context.Context, profileName string, nodeName string) (*Node, error)

+ func (m *GroupClientManager) GetVMFromGroup(ctx context.Context, profileName string, nodeName string, vmType string, ...) (*VM, error)

+ func (m *GroupClientManager) Initialize(ctx context.Context, profiles []ProfileEntry) error

+ func (m *GroupClientManager) RefreshAllFailedProfiles(ctx context.Context, profileConfigs map[string]interfaces.Config) map[string]error

+ func (m *GroupClientManager) RefreshProfileConnection(ctx context.Context, profileName string, profileConfig interfaces.Config) error

type Node

+ SourceProfile string

+ type ProfileClient struct

+ Client *Client

+ LastErr error

+ ProfileName string

+ Status ProfileConnectionStatus

+ func (pc *ProfileClient) GetStatus() (ProfileConnectionStatus, error)

+ func (pc *ProfileClient) SetStatus(status ProfileConnectionStatus, err error)

+ type ProfileConnectionStatus int

+ const ProfileStatusConnected

+ const ProfileStatusDisconnected

+ const ProfileStatusError

+ const ProfileStatusUnknown

+ func (s ProfileConnectionStatus) String() string

+ type ProfileEntry struct

+ Config interfaces.Config

+ Name string

+ type ProfileOperation func(profileName string, client *Client) (interface{}, error)

+ type ProfileResult struct

+ Data interface{}

+ Error error

+ ProfileName string

+ Success bool

type VM

+ SourceProfile string

v1.0.13

Nov 29, 2025

v1.0.12

Nov 25, 2025

Changes in this version

type Client

+ func (c *Client) WaitForTaskCompletion(upid string, operationName string, maxWait time.Duration) error

v1.0.11

Nov 21, 2025

v1.0.10

Nov 14, 2025

v1.0.9

Nov 12, 2025

Changes in this version

type Client

+ func (c *Client) ExecGuestAgentCommand(vm *VM, command []string) (int, error)

+ func (c *Client) ExecuteGuestAgentCommand(ctx context.Context, vm *VM, command []string, timeout time.Duration) (stdout, stderr string, exitCode int, err error)

+ func (c *Client) GetGuestAgentExecStatus(vm *VM, pid int) (*GuestAgentExecStatus, error)

+ type GuestAgentExecRequest struct

+ Command []string

+ type GuestAgentExecResponse struct

+ PID int

+ type GuestAgentExecStatus struct

+ ErrData string

+ ErrTrunc bool

+ ExitCode *int

+ Exited int

+ OutData string

+ OutTrunc bool

+ Signal *int

v1.0.8

Nov 5, 2025

v1.0.7

Oct 22, 2025

Changes in this version

+ const DefaultAPITimeout

+ const DefaultMaxAttempts

+ const DefaultRetryCount

v1.0.6

Sep 13, 2025

v1.0.5

Aug 25, 2025

Changes in this version

+ const ActionMigrate

+ const ActionOpenShell

+ const ActionRefresh

+ const ClusterDataTTL

+ const EndpointAccessTicket

+ const HTTPMethodDELETE

+ const HTTPMethodPOST

+ const HTTPMethodPUT

+ const IPTypeIPv4

+ const IPTypeIPv6

+ const LoopbackInterface

+ const NodeDataTTL

+ const NodeType

+ const PageGuests

+ const PageNodes

+ const PageTasks

+ const ResourceDataTTL

+ const StringNA

+ const StringTrue

+ const VMDataTTL

+ const VMStatusRunning

+ const VMStatusStopped

+ const VMTypeLXC

+ const VMTypeQemu

+ func ExampleUsage()

+ func FormatBytes(bytes int64) string

+ func FormatUptime(seconds int64) string

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

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

+ func SafeBoolValue(value interface{}) bool

+ func SafeFloatValue(value interface{}) float64

+ func SafeStringValue(value interface{}) 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) CreateSnapshot(vm *VM, name string, options *SnapshotOptions) error

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

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

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

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

+ 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) GetAuthToken() string

+ func (c *Client) GetBaseURL() string

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

+ func (c *Client) GetClusterTasks() ([]*ClusterTask, 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) GetNodeVNCShellWithWebSocket(nodeName string) (*VNCProxyResponse, error)

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

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

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

+ func (c *Client) GetVNCProxyWithWebSocket(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) MigrateVM(vm *VM, options *MigrationOptions) 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) ResetVM(vm *VM) error

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

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

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

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

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

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

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

+ func (c *Client) UpdateVMResources(vm *VM, cores int, memory int64) 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 ClusterTask struct

+ EndTime int64

+ ID string

+ Node string

+ Saved string

+ StartTime int64

+ Status string

+ TokenID string

+ Type string

+ UPID string

+ User string

+ type ConfiguredNetwork struct

+ Bridge string

+ Firewall bool

+ Gateway string

+ IP string

+ Interface string

+ MACAddr string

+ Model string

+ Rate string

+ VLAN string

+ type DeleteVMOptions struct

+ DestroyUnreferencedDisks bool

+ Force bool

+ Purge bool

+ SkipLock bool

+ 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 MigrationOptions struct

+ BandwidthLimit int

+ Delete bool

+ Force bool

+ MigrationNetwork string

+ MigrationType string

+ Online *bool

+ Target string

+ TargetStorage 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 Snapshot struct

+ Description string

+ Name string

+ Parent string

+ SnapTime time.Time

+ VMState bool

+ type SnapshotOptions struct

+ Description string

+ VMState bool

+ 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 StorageDevice struct

+ Backup bool

+ Cache string

+ Device string

+ Discard string

+ Format string

+ IOThread bool

+ Media string

+ Replicate bool

+ SSD bool

+ Serial string

+ Size string

+ Storage string

+ 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

+ Architecture string

+ BootOrder string

+ CPU float64

+ CPUCores int

+ CPUSockets int

+ ConfiguredMACs map[string]bool

+ ConfiguredNetworks []ConfiguredNetwork

+ Description string

+ 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

+ OSType string

+ OnBoot bool

+ Pool string

+ Status string

+ StorageDevices []StorageDevice

+ Tags string

+ Template bool

+ Type string

+ Uptime int64

+ type VMConfig struct

+ BootOrder string

+ CPUType string

+ Cores int

+ Description string

+ Disks map[string]int64

+ Hostname string

+ MaxMem int64

+ Memory int64

+ Name string

+ OnBoot *bool

+ Sockets int

+ Swap int64

+ type VNCProxyResponse struct

+ Cert string

+ Password string

+ Port string

+ Ticket string

+ User string

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