proxmox

package
v0.0.0-...-468e9b0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 13, 2024 License: MIT Imports: 21 Imported by: 0

Documentation

Index

Constants

View Source 
const Error_NewUserID string = "no username or realm specified, syntax is \"username@realm\""
View Source 
const TaskStatusCheckInterval = 2

TaskStatusCheckInterval - time between async checks in seconds

Variables

View Source 
var Debug = new(bool)

Functions

func AddToList 

func AddToList(list, newItem string) string

func ArrayToCSV 

func ArrayToCSV(array interface{}) (csv string)

Convert Array to a comma (,) delimited list

func ArrayToStringType 

func ArrayToStringType(inputarray []interface{}) (array []string)

Convert Array of type []interface{} to array of type []string

func BoolInvert 

func BoolInvert(b bool) bool

func CSVtoArray 

func CSVtoArray(csv string) []string

func CheckFileExistence 

func CheckFileExistence(fileName string, files *[]Content_FileProperties) bool

Check if a file with the specific name exists in the list of files.

func CheckUserExistence 

func CheckUserExistence(userId UserID, client *Client) (existence bool, err error)

Check if the user already exists in proxmox.

func DeleteFile 

func DeleteFile(client *Client, node string, content Content_File) (err error)

Deletes te specified file from the specified storage.

func DeleteSnapshot 

func DeleteSnapshot(c *Client, vmr *VmRef, snapshot string) (exitStatus string, err error)

func DiskSizeGB 

func DiskSizeGB(dcSize interface{}) float64

Convert a disk-size string to a GB float

func DownloadIsoFromUrl 

func DownloadIsoFromUrl(client *Client, content ConfigContent_Iso) (err error)

Download an Iso file from a given URL. https://pve.proxmox.com/pve-docs/api-viewer/#/nodes/{node}/storage/{storage}/download-url

func DownloadLxcTemplate 

func DownloadLxcTemplate(client *Client, content ConfigContent_Template) (err error)

Download an LXC template.

func ErrorItemExists 

func ErrorItemExists(item, text string) error

func ErrorItemNotExists 

func ErrorItemNotExists(item, text string) error

func ErrorKeyEmpty 

func ErrorKeyEmpty(text string) error

func ErrorKeyNotSet 

func ErrorKeyNotSet(text string) error

func FormatDiskParam 

func FormatDiskParam(disk QemuDevice) string

Given a QemuDevice (represesting a disk), return a param string to give to ProxMox

func FormatUsbParam 

func FormatUsbParam(usb QemuDevice) string

Given a QemuDevice (represesting a usb), return a param string to give to ProxMox

func ItemInKeyOfArray 

func ItemInKeyOfArray(array []interface{}, key, value string) (existance bool)

Check the value of a key in a nested array of map[string]interface{}

func Itob 

func Itob(i int) bool

func ListFiles 

func ListFiles(client *Client, node, storage string, content ContentType) (files *[]Content_FileProperties, err error)

List all files of the given type in the the specified storage

func ListGroups 

func ListGroups(client *Client) (*[]ConfigGroup, error)

Returns a list of all existing groups

func ListSnapshots 

func ListSnapshots(c *Client, vmr *VmRef) (taskResponse []interface{}, err error)

func ListTemplates 

func ListTemplates(client *Client, node string) (templateList *[]TemplateItem, err error)

List all LXC templates available for download.

func ListUsers 

func ListUsers(client *Client, full bool) (*[]ConfigUser, error)

List all users that exist in proxmox Setting full to TRUE the output wil include group information. Depending on the number of existing groups it take substantially longer to parse

func MaxVmId 

func MaxVmId(client *Client) (max int, err error)

func NewUserIDs 

func NewUserIDs(userIds string) (*[]UserID, error)

Converts an comma separated list of "username@realm" to a array of UserID objects

func ParamsToBody 

func ParamsToBody(params map[string]interface{}) (body []byte)

func ParamsToBodyWithAllEmpty 

func ParamsToBodyWithAllEmpty(params map[string]interface{}) (body []byte)

func ParamsToBodyWithEmpty 

func ParamsToBodyWithEmpty(params map[string]interface{}, allowedEmpty []string) (body []byte)

func ParamsToValues 

func ParamsToValues(params map[string]interface{}) (vals url.Values)

func ParamsToValuesWithAllEmpty 

func ParamsToValuesWithAllEmpty(params map[string]interface{}, allowedEmpty []string, allowEmpty bool) (vals url.Values)

func ParamsToValuesWithEmpty 

func ParamsToValuesWithEmpty(params map[string]interface{}, allowedEmpty []string) (vals url.Values)

func ParseSubConf 

func ParseSubConf(
	element string,
	separator string,
) (key string, value interface{})

ParseSubConf - Parse standard sub-conf strings `key=value`.

func PointerBool 

func PointerBool(boolean bool) *bool

Creates a pointer to a bool

func PointerInt 

func PointerInt(number int) *int

Creates a pointer to an int

func PointerString 

func PointerString(text string) *string

Creates a pointer to a string

func RemoveSshForwardUsernet 

func RemoveSshForwardUsernet(vmr *VmRef, client *Client) (err error)

device_del net1 netdev_del net1

func ResponseJSON 

func ResponseJSON(resp *http.Response) (jbody map[string]interface{}, err error)

func RollbackSnapshot 

func RollbackSnapshot(c *Client, vmr *VmRef, snapshot string) (exitStatus string, err error)

func SendKeysString 

func SendKeysString(vmr *VmRef, client *Client, keys string) (err error)

func SshForwardUsernet 

func SshForwardUsernet(vmr *VmRef, client *Client) (sshPort string, err error)

This is because proxmox create/config API won't let us make usernet devices

func TypedResponse 

func TypedResponse(resp *http.Response, v interface{}) error

func UpdateSnapshotDescription 

func UpdateSnapshotDescription(c *Client, vmr *VmRef, snapshot, description string) (err error)

Can only be used to update the description of an already existing snapshot

func ValidateArrayEven 

func ValidateArrayEven(array interface{}, text string) error

func ValidateArrayNotEmpty 

func ValidateArrayNotEmpty(array interface{}, text string) error

func ValidateFilePath 

func ValidateFilePath(path, text string) error

func ValidateIntGreater 

func ValidateIntGreater(min, value int, text string) error

func ValidateIntGreaterOrEquals 

func ValidateIntGreaterOrEquals(min, value int, text string) error

func ValidateIntInRange 

func ValidateIntInRange(min, max, value int, text string) error

func ValidateStringInArray 

func ValidateStringInArray(array []string, value, text string) error

func ValidateStringNotEmpty 

func ValidateStringNotEmpty(value, text string) error

func ValidateStringsEqual 

func ValidateStringsEqual(value1, value2, text string) error

check if a key is allowed to be changed after creation.

func WaitForShutdown 

func WaitForShutdown(vmr *VmRef, client *Client) (err error)

Useful waiting for ISO install to complete

Types

type AgentNetworkInterface 

type AgentNetworkInterface struct {
	MACAddress  string
	IPAddresses []net.IP
	Name        string
	Statistics  map[string]int64
}

func (*AgentNetworkInterface) UnmarshalJSON 

func (a *AgentNetworkInterface) UnmarshalJSON(b []byte) error

type Client 

type Client struct {
	ApiUrl      string
	Username    string
	Password    string
	Otp         string
	TaskTimeout int
	// contains filtered or unexported fields
}

Client - URL, user and password to specific Proxmox node

func NewClient 

func NewClient(apiUrl string, hclient *http.Client, http_headers string, tls *tls.Config, proxyString string, taskTimeout int) (client *Client, err error)

func (*Client) AddQemuIPSet 

func (c *Client) AddQemuIPSet(vmr *VmRef, name string, params map[string]interface{}) (exitStatus interface{}, err error)

AddQemuIPSet - Add IP or Network to IPSet.

func (Client) ApplyNetwork 

func (c Client) ApplyNetwork(node string) (exitStatus string, err error)

ApplyNetwork applies the pending network configuration on the passed in node. It returns the body from the API response and any HTTP error the API returns.

func (*Client) CheckAcmePluginExistence 

func (c *Client) CheckAcmePluginExistence(id string) (existance bool, err error)

func (*Client) CheckMetricServerExistence 

func (c *Client) CheckMetricServerExistence(id string) (existance bool, err error)

func (*Client) CheckStorageExistance 

func (c *Client) CheckStorageExistance(id string) (existance bool, err error)

func (*Client) CheckTask 

func (c *Client) CheckTask(resp *http.Response) (exitStatus string, err error)

CheckTask polls the API to check if the Proxmox task has been completed. It returns the body of the HTTP response and any HTTP error occurred during the request.

func (*Client) CheckVmRef 

func (c *Client) CheckVmRef(vmr *VmRef) (err error)

func (*Client) CloneLxcContainer 

func (c *Client) CloneLxcContainer(vmr *VmRef, vmParams map[string]interface{}) (exitStatus string, err error)

func (*Client) CloneQemuVm 

func (c *Client) CloneQemuVm(vmr *VmRef, vmParams map[string]interface{}) (exitStatus string, err error)

func (*Client) CreateAcmeAccount 

func (c *Client) CreateAcmeAccount(params map[string]interface{}) (exitStatus string, err error)

func (*Client) CreateAcmePlugin 

func (c *Client) CreateAcmePlugin(params map[string]interface{}) error

func (*Client) CreateItemReturnStatus 

func (c *Client) CreateItemReturnStatus(params map[string]interface{}, url string) (exitStatus string, err error)

CreateItemReturnStatus creates an item on the Proxmox API. It returns the body of the HTTP response and any HTTP error occurred during the request.

func (*Client) CreateLxcContainer 

func (c *Client) CreateLxcContainer(node string, vmParams map[string]interface{}) (exitStatus string, err error)

func (*Client) CreateMetricServer 

func (c *Client) CreateMetricServer(id string, params map[string]interface{}) error

func (*Client) CreateNetwork 

func (c *Client) CreateNetwork(node string, params map[string]interface{}) (exitStatus string, err error)

CreateNetwork creates a network with the configuration of the passed in parameters on the passed in node. It returns the body from the API response and any HTTP error the API returns.

func (*Client) CreateNewDisk 

func (c *Client) CreateNewDisk(vmr *VmRef, disk string, volume string) (exitStatus interface{}, err error)

CreateNewDisk - This method allows simpler disk creation for direct client users It should work for any existing container and virtual machine

func (*Client) CreatePool 

func (c *Client) CreatePool(poolid string, comment string) error

func (*Client) CreateQemuIPSet 

func (c *Client) CreateQemuIPSet(vmr *VmRef, params map[string]interface{}) (exitStatus interface{}, err error)

CreateQemuIPSet - Create new IPSet

func (*Client) CreateQemuSnapshot 

func (c *Client) CreateQemuSnapshot(vmr *VmRef, snapshotName string) (exitStatus string, err error)

DEPRECATED superseded by CreateSnapshot()

func (*Client) CreateQemuVm 

func (c *Client) CreateQemuVm(node string, vmParams map[string]interface{}) (exitStatus string, err error)

func (*Client) CreateStorage 

func (c *Client) CreateStorage(params map[string]interface{}) error

func (*Client) CreateTemplate 

func (c *Client) CreateTemplate(vmr *VmRef) error

func (*Client) CreateVMDisk 

func (c *Client) CreateVMDisk(
	nodeName string,
	storageName string,
	fullDiskName string,
	diskParams map[string]interface{},
) error

CreateVMDisk - Create single disk for VM on host node.

func (*Client) CreateVNCProxy 

func (c *Client) CreateVNCProxy(vmr *VmRef, params map[string]interface{}) (vncProxyRes map[string]interface{}, err error)

CreateVNCProxy - Creates a TCP VNC proxy connections

func (*Client) Delete 

func (c *Client) Delete(url string) (err error)

Makes a DELETE request without waiting on proxmox for the task to complete. It returns the HTTP error as 'err'.

func (*Client) DeleteAcmeAccount 

func (c *Client) DeleteAcmeAccount(id string) (exitStatus string, err error)

func (*Client) DeleteAcmePlugin 

func (c *Client) DeleteAcmePlugin(id string) (err error)

func (*Client) DeleteMetricServer 

func (c *Client) DeleteMetricServer(id string) error

func (*Client) DeleteNetwork 

func (c *Client) DeleteNetwork(node string, iface string) (exitStatus string, err error)

DeleteNetwork deletes the network with the passed in iface name on the passed in node. It returns the body from the API response and any HTTP error the API returns.

func (*Client) DeletePool 

func (c *Client) DeletePool(poolid string) error

func (*Client) DeleteQemuIPSet 

func (c *Client) DeleteQemuIPSet(vmr *VmRef, IPSetName string) (exitStatus interface{}, err error)

DeleteQemuIPSet - Delete IPSet

func (*Client) DeleteQemuIPSetNetwork 

func (c *Client) DeleteQemuIPSetNetwork(vmr *VmRef, IPSetName string, network string, params map[string]interface{}) (exitStatus interface{}, err error)

DeleteQemuIPSetNetwork - Remove IP or Network from IPSet.

func (*Client) DeleteQemuSnapshot 

func (c *Client) DeleteQemuSnapshot(vmr *VmRef, snapshotName string) (exitStatus string, err error)

DEPRECATED superseded by DeleteSnapshot()

func (*Client) DeleteStorage 

func (c *Client) DeleteStorage(id string) error

func (*Client) DeleteVMDisks 

func (c *Client) DeleteVMDisks(
	node string,
	disks []string,
) error

DeleteVMDisks - Delete VM disks from host node. By default the VM disks are deleted when the VM is deleted, so mainly this is used to delete the disks in case VM creation didn't complete.

func (*Client) DeleteVm 

func (c *Client) DeleteVm(vmr *VmRef) (exitStatus string, err error)

func (*Client) DeleteVmParams 

func (c *Client) DeleteVmParams(vmr *VmRef, params map[string]interface{}) (exitStatus string, err error)

func (*Client) DeleteVolume 

func (c *Client) DeleteVolume(vmr *VmRef, storageName string, volumeName string) (exitStatus interface{}, err error)

DeleteVolume - Delete volume

func (*Client) DeleteWithTask 

func (c *Client) DeleteWithTask(url string) (exitStatus string, err error)

Makes a DELETE request and waits on proxmox for the task to complete. It returns the status of the test as 'exitStatus' and the HTTP error as 'err'.

func (*Client) EnableStorage 

func (c *Client) EnableStorage(id string) error

storage

func (*Client) GetAcmeAccountConfig 

func (c *Client) GetAcmeAccountConfig(id string) (config map[string]interface{}, err error)

func (*Client) GetAcmeAccountList 

func (c *Client) GetAcmeAccountList() (accounts map[string]interface{}, err error)

ACME Account

func (*Client) GetAcmeDirectoriesUrl 

func (c *Client) GetAcmeDirectoriesUrl() (url []string, err error)

ACME

func (*Client) GetAcmePluginConfig 

func (c *Client) GetAcmePluginConfig(id string) (config map[string]interface{}, err error)

func (*Client) GetAcmePluginList 

func (c *Client) GetAcmePluginList() (accounts map[string]interface{}, err error)

ACME Plugin

func (*Client) GetAcmeTosUrl 

func (c *Client) GetAcmeTosUrl() (url string, err error)

func (*Client) GetExecStatus 

func (c *Client) GetExecStatus(vmr *VmRef, pid string) (status map[string]interface{}, err error)

GetExecStatus - Gets the status of the given pid started by the guest-agent

func (*Client) GetItemConfig 

func (c *Client) GetItemConfig(url, text, message string) (config map[string]interface{}, err error)

func (*Client) GetItemConfigInterfaceArray 

func (c *Client) GetItemConfigInterfaceArray(url, text, message string) ([]interface{}, error)

func (*Client) GetItemConfigMapStringInterface 

func (c *Client) GetItemConfigMapStringInterface(url, text, message string) (map[string]interface{}, error)

Shared

func (*Client) GetItemConfigString 

func (c *Client) GetItemConfigString(url, text, message string) (string, error)

func (*Client) GetItemList 

func (c *Client) GetItemList(url string) (list map[string]interface{}, err error)

func (*Client) GetItemListInterfaceArray 

func (c *Client) GetItemListInterfaceArray(url string) ([]interface{}, error)

func (*Client) GetJsonRetryable 

func (c *Client) GetJsonRetryable(url string, data *map[string]interface{}, tries int) error

func (*Client) GetMetricServerConfig 

func (c *Client) GetMetricServerConfig(id string) (config map[string]interface{}, err error)

Metrics

func (*Client) GetMetricsServerList 

func (c *Client) GetMetricsServerList() (metricServers map[string]interface{}, err error)

func (*Client) GetNetworkInterface 

func (c *Client) GetNetworkInterface(node string, iface string) (exitStatus string, err error)

GetNetworkInterface gets a json encoded object containing the configuration of the network interface with the name passed in as iface from the passed in node. It returns the body from the API response and any HTTP error the API returns.

func (*Client) GetNetworkList 

func (c *Client) GetNetworkList(node string, typeFilter string) (exitStatus string, err error)

GetNetworkList gets a json encoded list of currently configured network interfaces on the passed in node. The typeFilter parameter can be used to filter by interface type. Pass in the empty string "" for typeFilter to list all network interfaces on the node. It returns the body from the API response and any HTTP error the API returns.

func (*Client) GetNextID 

func (c *Client) GetNextID(currentID int) (nextID int, err error)

GetNextID - Get next free VMID

func (*Client) GetNodeList 

func (c *Client) GetNodeList() (list map[string]interface{}, err error)

func (*Client) GetPoolInfo 

func (c *Client) GetPoolInfo(poolid string) (poolInfo map[string]interface{}, err error)

func (*Client) GetPoolList 

func (c *Client) GetPoolList() (pools map[string]interface{}, err error)

func (*Client) GetQemuFirewallOptions 

func (c *Client) GetQemuFirewallOptions(vmr *VmRef) (firewallOptions map[string]interface{}, err error)

GetQemuFirewallOptions - Get VM firewall options.

func (*Client) GetQemuIPSet 

func (c *Client) GetQemuIPSet(vmr *VmRef) (ipsets map[string]interface{}, err error)

GetQemuIPSet - List IPSets

func (*Client) GetResourceList 

func (c *Client) GetResourceList(resourceType string) (list map[string]interface{}, err error)

GetResourceList returns a list of all enabled proxmox resources. For resource types that can be in a disabled state, disabled resources will not be returned

func (*Client) GetStorageConfig 

func (c *Client) GetStorageConfig(id string) (config map[string]interface{}, err error)

func (*Client) GetStorageContent 

func (c *Client) GetStorageContent(vmr *VmRef, storageName string) (data map[string]interface{}, err error)

func (*Client) GetStorageList 

func (c *Client) GetStorageList() (metricServers map[string]interface{}, err error)

func (*Client) GetStorageStatus 

func (c *Client) GetStorageStatus(vmr *VmRef, storageName string) (storageStatus map[string]interface{}, err error)

func (*Client) GetTaskExitstatus 

func (c *Client) GetTaskExitstatus(taskUpid string) (exitStatus interface{}, err error)

func (*Client) GetUserPermissions 

func (c *Client) GetUserPermissions(id UserID, path string) (permissions []string, err error)

func (*Client) GetVersion 

func (c *Client) GetVersion() (data map[string]interface{}, err error)

func (*Client) GetVmAgentNetworkInterfaces 

func (c *Client) GetVmAgentNetworkInterfaces(vmr *VmRef) ([]AgentNetworkInterface, error)

func (*Client) GetVmConfig 

func (c *Client) GetVmConfig(vmr *VmRef) (vmConfig map[string]interface{}, err error)

func (*Client) GetVmInfo 

func (c *Client) GetVmInfo(vmr *VmRef) (vmInfo map[string]interface{}, err error)

func (*Client) GetVmList 

func (c *Client) GetVmList() (list map[string]interface{}, err error)

func (*Client) GetVmRefByName 

func (c *Client) GetVmRefByName(vmName string) (vmr *VmRef, err error)

func (*Client) GetVmRefsByName 

func (c *Client) GetVmRefsByName(vmName string) (vmrs []*VmRef, err error)

func (*Client) GetVmSpiceProxy 

func (c *Client) GetVmSpiceProxy(vmr *VmRef) (vmSpiceProxy map[string]interface{}, err error)

func (*Client) GetVmState 

func (c *Client) GetVmState(vmr *VmRef) (vmState map[string]interface{}, err error)

func (*Client) HandleTaskError 

func (c *Client) HandleTaskError(resp *http.Response) (exitStatus string)

HandleTaskError reads the body from the passed in HTTP response and closes it. It returns the body of the passed in HTTP response.

func (*Client) HibernateVm 

func (c *Client) HibernateVm(vmr *VmRef) (exitStatus string, err error)

func (*Client) ListQemuSnapshot 

func (c *Client) ListQemuSnapshot(vmr *VmRef) (taskResponse map[string]interface{}, exitStatus string, err error)

DEPRECATED superseded by ListSnapshots()

func (*Client) Login 

func (c *Client) Login(username string, password string, otp string) (err error)

func (*Client) MigrateNode 

func (c *Client) MigrateNode(vmr *VmRef, newTargetNode string, online bool) (exitStatus interface{}, err error)

MigrateNode - Migrate a VM

func (*Client) MonitorCmd 

func (c *Client) MonitorCmd(vmr *VmRef, command string) (monitorRes map[string]interface{}, err error)

func (*Client) MoveLxcDisk 

func (c *Client) MoveLxcDisk(vmr *VmRef, disk string, storage string) (exitStatus interface{}, err error)

func (*Client) MoveQemuDisk 

func (c *Client) MoveQemuDisk(vmr *VmRef, disk string, storage string) (exitStatus interface{}, err error)

MoveQemuDisk - Move a disk from one storage to another

func (*Client) MoveQemuDiskToVM 

func (c *Client) MoveQemuDiskToVM(vmrSource *VmRef, disk string, vmrTarget *VmRef) (exitStatus interface{}, err error)

MoveQemuDiskToVM - Move a disk to a different VM, using the same storage

func (*Client) PauseVm 

func (c *Client) PauseVm(vmr *VmRef) (exitStatus string, err error)

func (*Client) Post 

func (c *Client) Post(Params map[string]interface{}, url string) (err error)

Makes a POST request without waiting on proxmox for the task to complete. It returns the HTTP error as 'err'.

func (*Client) PostWithTask 

func (c *Client) PostWithTask(Params map[string]interface{}, url string) (exitStatus string, err error)

Makes a POST request and waits on proxmox for the task to complete. It returns the status of the test as 'exitStatus' and the HTTP error as 'err'.

func (*Client) Put 

func (c *Client) Put(Params map[string]interface{}, url string) (err error)

Makes a PUT request without waiting on proxmox for the task to complete. It returns the HTTP error as 'err'.

func (*Client) PutWithTask 

func (c *Client) PutWithTask(Params map[string]interface{}, url string) (exitStatus string, err error)

Makes a PUT request and waits on proxmox for the task to complete. It returns the status of the test as 'exitStatus' and the HTTP error as 'err'.

func (*Client) QemuAgentExec 

func (c *Client) QemuAgentExec(vmr *VmRef, params map[string]interface{}) (result map[string]interface{}, err error)

QemuAgentExec - Executes the given command in the vm via the guest-agent and returns an object with the pid.

func (*Client) QemuAgentFileWrite 

func (c *Client) QemuAgentFileWrite(vmr *VmRef, params map[string]interface{}) (err error)

QemuAgentFileWrite - Writes the given file via guest agent.

func (*Client) QemuAgentPing 

func (c *Client) QemuAgentPing(vmr *VmRef) (pingRes map[string]interface{}, err error)

QemuAgentPing - Execute ping.

func (*Client) QemuAgentSetUserPassword 

func (c *Client) QemuAgentSetUserPassword(vmr *VmRef, params map[string]interface{}) (result map[string]interface{}, err error)

QemuAgentSetUserPassword - Sets the password for the given user to the given password.

func (*Client) ReadVMHA 

func (c *Client) ReadVMHA(vmr *VmRef) (err error)

func (*Client) RebootNode 

func (c *Client) RebootNode(node string) (exitStatus string, err error)

func (*Client) ResetVm 

func (c *Client) ResetVm(vmr *VmRef) (exitStatus string, err error)

func (*Client) ResizeQemuDisk 

func (c *Client) ResizeQemuDisk(vmr *VmRef, disk string, moreSizeGB int) (exitStatus interface{}, err error)

ResizeQemuDisk allows the caller to increase the size of a disk by the indicated number of gigabytes

func (*Client) ResizeQemuDiskRaw 

func (c *Client) ResizeQemuDiskRaw(vmr *VmRef, disk string, size string) (exitStatus interface{}, err error)

ResizeQemuDiskRaw allows the caller to provide the raw resize string to be send to proxmox. See the proxmox API documentation for full information, but the short version is if you prefix your desired size with a '+' character it will ADD size to the disk. If you just specify the size by itself it will do an absolute resizing to the specified size. Permitted suffixes are K, M, G, T to indicate order of magnitude (kilobyte, megabyte, etc). Decrease of disk size is not permitted.

func (*Client) ResumeVm 

func (c *Client) ResumeVm(vmr *VmRef) (exitStatus string, err error)

func (*Client) RevertNetwork 

func (c *Client) RevertNetwork(node string) (exitStatus string, err error)

RevertNetwork reverts the pending network configuration on the passed in node. It returns the body from the API response and any HTTP error the API returns.

func (*Client) RollbackQemuVm 

func (c *Client) RollbackQemuVm(vmr *VmRef, snapshot string) (exitStatus string, err error)

DEPRECATED superseded by RollbackSnapshot()

func (*Client) Sendkey 

func (c *Client) Sendkey(vmr *VmRef, qmKey string) error

func (*Client) SetAPIToken 

func (c *Client) SetAPIToken(userID, token string)

SetAPIToken specifies a pair of user identifier and token UUID to use for authenticating API calls. If this is set, a ticket from calling `Login` will not be used.

- `userID` is expected to be in the form `USER@REALM!TOKENID` - `token` is just the UUID you get when initially creating the token

See https://pve.proxmox.com/wiki/User_Management#pveum_tokens

func (*Client) SetLxcConfig 

func (c *Client) SetLxcConfig(vmr *VmRef, vmParams map[string]interface{}) (exitStatus interface{}, err error)

SetLxcConfig - send config options

func (*Client) SetQemuFirewallOptions 

func (c *Client) SetQemuFirewallOptions(vmr *VmRef, fwOptions map[string]interface{}) (exitStatus interface{}, err error)

SetQemuFirewallOptions - Set Firewall options.

func (*Client) SetVmConfig 

func (c *Client) SetVmConfig(vmr *VmRef, params map[string]interface{}) (exitStatus interface{}, err error)

SetVmConfig - send config options

func (*Client) ShutdownNode 

func (c *Client) ShutdownNode(node string) (exitStatus string, err error)

func (*Client) ShutdownVm 

func (c *Client) ShutdownVm(vmr *VmRef) (exitStatus string, err error)

func (*Client) StartVm 

func (c *Client) StartVm(vmr *VmRef) (exitStatus string, err error)

func (*Client) StatusChangeVm 

func (c *Client) StatusChangeVm(vmr *VmRef, params map[string]interface{}, setStatus string) (exitStatus string, err error)

func (*Client) StopVm 

func (c *Client) StopVm(vmr *VmRef) (exitStatus string, err error)

func (*Client) UpdateAcmeAccountEmails 

func (c *Client) UpdateAcmeAccountEmails(id, emails string) (exitStatus string, err error)

func (*Client) UpdateAcmePlugin 

func (c *Client) UpdateAcmePlugin(id string, params map[string]interface{}) error

func (*Client) UpdateItemReturnStatus 

func (c *Client) UpdateItemReturnStatus(params map[string]interface{}, url string) (exitStatus string, err error)

UpdateItemReturnStatus updates an item on the Proxmox API. It returns the body of the HTTP response and any HTTP error occurred during the request.

func (*Client) UpdateMetricServer 

func (c *Client) UpdateMetricServer(id string, params map[string]interface{}) error

func (*Client) UpdateNetwork 

func (c *Client) UpdateNetwork(node string, iface string, params map[string]interface{}) (exitStatus string, err error)

UpdateNetwork updates the network corresponding to the passed in interface name on the passed in node with the configuration in the passed in parameters. It returns the body from the API response and any HTTP error the API returns.

func (*Client) UpdatePoolComment 

func (c *Client) UpdatePoolComment(poolid string, comment string) error

func (*Client) UpdateStorage 

func (c *Client) UpdateStorage(id string, params map[string]interface{}) error

func (*Client) UpdateVMHA 

func (c *Client) UpdateVMHA(vmr *VmRef, haState string, haGroup string) (exitStatus interface{}, err error)

func (*Client) UpdateVMPool 

func (c *Client) UpdateVMPool(vmr *VmRef, pool string) (exitStatus interface{}, err error)

func (*Client) Upload 

func (c *Client) Upload(node string, storage string, contentType string, filename string, file io.Reader) error

func (*Client) VMIdExists 

func (c *Client) VMIdExists(vmID int) (exists bool, err error)

VMIdExists - If you pass an VMID that exists it will return true, otherwise it wil return false

func (*Client) VzDump 

func (c *Client) VzDump(vmr *VmRef, params map[string]interface{}) (exitStatus interface{}, err error)

VzDump - Create backup

func (*Client) WaitForCompletion 

func (c *Client) WaitForCompletion(taskResponse map[string]interface{}) (waitExitStatus string, err error)

WaitForCompletion - poll the API for task completion

type ConfigAcmeAccount 

type ConfigAcmeAccount struct {
	Name      string   `json:"name"`
	Contact   []string `json:"contact"`
	Directory string   `json:"directory"`
	Tos       bool     `json:"tos,omitempty"`
}

Acme Account options for the Proxmox API

func NewConfigAcmeAccountFromApi 

func NewConfigAcmeAccountFromApi(id string, client *Client) (config *ConfigAcmeAccount, err error)

func NewConfigAcmeAccountFromJson 

func NewConfigAcmeAccountFromJson(input []byte) (config *ConfigAcmeAccount, err error)

func (ConfigAcmeAccount) CreateAcmeAccount 

func (config ConfigAcmeAccount) CreateAcmeAccount(acmeId string, client *Client) (err error)

type ConfigAcmePlugin 

type ConfigAcmePlugin struct {
	ID              string   `json:"pluginid"`
	API             string   `json:"api"`
	Data            string   `json:"data,omitempty"`
	Enable          bool     `json:"enable"`
	Nodes           []string `json:"nodes,omitempty"`
	ValidationDelay int      `json:"validation-delay"`
}

Acme Plugin options for the Proxmox API

func NewConfigAcmePluginFromApi 

func NewConfigAcmePluginFromApi(id string, client *Client) (config *ConfigAcmePlugin, err error)

func NewConfigAcmePluginFromJson 

func NewConfigAcmePluginFromJson(input []byte) (config *ConfigAcmePlugin, err error)

func (ConfigAcmePlugin) CreateAcmePlugin 

func (config ConfigAcmePlugin) CreateAcmePlugin(client *Client) (err error)

func (ConfigAcmePlugin) SetAcmePlugin 

func (config ConfigAcmePlugin) SetAcmePlugin(pluginId string, client *Client) (err error)

func (ConfigAcmePlugin) UpdateAcmePlugin 

func (config ConfigAcmePlugin) UpdateAcmePlugin(client *Client) (err error)

type ConfigContent_Iso 

type ConfigContent_Iso struct {
	Checksum          string
	ChecksumAlgorithm string
	DownloadUrl       string
	Filename          string
	Node              string
	Storage           string
}

func (ConfigContent_Iso) Validate 

func (content ConfigContent_Iso) Validate() (err error)

Return an error if the one of the values is empty.

type ConfigContent_Template 

type ConfigContent_Template struct {
	Node     string
	Storage  string
	Template string
}

func (ConfigContent_Template) Validate 

func (content ConfigContent_Template) Validate() (err error)

Return an error if the one of the values is empty.

type ConfigGroup 

type ConfigGroup struct {
	Name    GroupName `json:"name"`
	Comment string    `json:"comment,omitempty"`
	// Setting the Members will update the group membership to only include the specified members.
	Members *[]UserID `json:"members,omitempty"`
}

func NewConfigGroupFromApi 

func NewConfigGroupFromApi(groupId GroupName, client *Client) (*ConfigGroup, error)

func (*ConfigGroup) Create 

func (config *ConfigGroup) Create(client *Client) error

Creates the specified group

func (*ConfigGroup) Set 

func (config *ConfigGroup) Set(client *Client) (err error)

Created or updates the specified group

func (*ConfigGroup) Update 

func (config *ConfigGroup) Update(client *Client) error

Updates the specified group

func (*ConfigGroup) Validate 

func (config *ConfigGroup) Validate(create bool) (err error)

Validates all items and sub items of the ConfigGroup

type ConfigLxc 

type ConfigLxc struct {
	Ostemplate         string      `json:"ostemplate"`
	Arch               string      `json:"arch"`
	BWLimit            int         `json:"bwlimit,omitempty"`
	Clone              string      `json:"clone,omitempty"`
	CloneStorage       string      `json:"clone-storage,omitempty"`
	CMode              string      `json:"cmode"`
	Console            bool        `json:"console"`
	Cores              int         `json:"cores,omitempty"`
	CPULimit           int         `json:"cpulimit"`
	CPUUnits           int         `json:"cpuunits"`
	Description        string      `json:"description,omitempty"`
	Features           QemuDevice  `json:"features,omitempty"`
	Force              bool        `json:"force,omitempty"`
	Full               bool        `json:"full,omitempty"`
	HaState            string      `json:"hastate,omitempty"`
	HaGroup            string      `json:"hagroup,omitempty"`
	Hookscript         string      `json:"hookscript,omitempty"`
	Hostname           string      `json:"hostname,omitempty"`
	IgnoreUnpackErrors bool        `json:"ignore-unpack-errors,omitempty"`
	Lock               string      `json:"lock,omitempty"`
	Memory             int         `json:"memory"`
	Mountpoints        QemuDevices `json:"mountpoints,omitempty"`
	Nameserver         string      `json:"nameserver,omitempty"`
	Networks           QemuDevices `json:"networks,omitempty"`
	OnBoot             bool        `json:"onboot"`
	OsType             string      `json:"ostype,omitempty"`
	Password           string      `json:"password,omitempty"`
	Pool               string      `json:"pool,omitempty"`
	Protection         bool        `json:"protection"`
	Restore            bool        `json:"restore,omitempty"`
	RootFs             QemuDevice  `json:"rootfs,omitempty"`
	SearchDomain       string      `json:"searchdomain,omitempty"`
	Snapname           string      `json:"snapname,omitempty"`
	SSHPublicKeys      string      `json:"ssh-public-keys,omitempty"`
	Start              bool        `json:"start"`
	Startup            string      `json:"startup,omitempty"`
	Storage            string      `json:"storage"`
	Swap               int         `json:"swap"`
	Template           bool        `json:"template,omitempty"`
	Tty                int         `json:"tty"`
	Unique             bool        `json:"unique,omitempty"`
	Unprivileged       bool        `json:"unprivileged"`
	Tags               string      `json:"tags"`
	Unused             []string    `json:"unused,omitempty"`
}

LXC options for the Proxmox API

func NewConfigLxc 

func NewConfigLxc() ConfigLxc

func NewConfigLxcFromApi 

func NewConfigLxcFromApi(vmr *VmRef, client *Client) (config *ConfigLxc, err error)

func NewConfigLxcFromJson 

func NewConfigLxcFromJson(input []byte) (config ConfigLxc, err error)

func (ConfigLxc) CloneLxc 

func (config ConfigLxc) CloneLxc(vmr *VmRef, client *Client) (err error)

func (ConfigLxc) CreateLxc 

func (config ConfigLxc) CreateLxc(vmr *VmRef, client *Client) (err error)

create LXC container using the Proxmox API

func (ConfigLxc) UpdateConfig 

func (config ConfigLxc) UpdateConfig(vmr *VmRef, client *Client) (err error)

type ConfigMetrics 

type ConfigMetrics struct {
	Name     string                 `json:"name"`
	Port     int                    `json:"port"`
	Server   string                 `json:"server"`
	Type     string                 `json:"type"` //type key is only used on create
	Enable   bool                   `json:"enable"`
	MTU      int                    `json:"mtu"`
	Timeout  int                    `json:"timeout,omitempty"`
	Graphite *ConfigMetricsGraphite `json:"graphite,omitempty"`
	InfluxDB *ConfigMetricsInfluxDB `json:"influxdb,omitempty"`
}

Metrics options for the Proxmox API

func InstantiateConfigMetrics 

func InstantiateConfigMetrics() *ConfigMetrics

func NewConfigMetricsFromApi 

func NewConfigMetricsFromApi(metricsId string, client *Client) (config *ConfigMetrics, err error)

func NewConfigMetricsFromJson 

func NewConfigMetricsFromJson(input []byte) (config *ConfigMetrics, err error)

func (*ConfigMetrics) CreateMetrics 

func (config *ConfigMetrics) CreateMetrics(client *Client) (err error)

func (*ConfigMetrics) RemoveMetricsNestedStructs 

func (config *ConfigMetrics) RemoveMetricsNestedStructs()

func (*ConfigMetrics) SetMetrics 

func (config *ConfigMetrics) SetMetrics(metricsId string, client *Client) (err error)

func (*ConfigMetrics) UpdateMetrics 

func (config *ConfigMetrics) UpdateMetrics(client *Client) (err error)

func (*ConfigMetrics) ValidateMetrics 

func (config *ConfigMetrics) ValidateMetrics() (err error)

type ConfigMetricsGraphite 

type ConfigMetricsGraphite struct {
	Protocol string `json:"protocol"`
	Path     string `json:"path,omitempty"`
}

type ConfigMetricsInfluxDB 

type ConfigMetricsInfluxDB struct {
	ApiPathPrefix     string `json:"api-path-prefix,omitempty"`
	Bucket            string `json:"bucket,omitempty"`
	Protocol          string `json:"protocol"`
	MaxBodySize       int    `json:"max-body-size,omitempty"`
	Organization      string `json:"organization,omitempty"`
	Token             string `json:"token,omitempty"` //token key is never returned from api
	VerifyCertificate bool   `json:"verify-certificate"`
}

type ConfigNetwork 

type ConfigNetwork struct {
	Iface              string `json:"iface,omitempty"`
	Node               string `json:"node,omitempty"`
	Type               string `json:"type,omitempty"`
	Address            string `json:"address,omitempty"`
	Address6           string `json:"address6,omitempty"`
	Autostart          bool   `json:"autostart,omitempty"`
	BondPrimary        string `json:"bond-primary,omitempty"`
	BondMode           string `json:"bond_mode,omitempty"`
	BondXmitHashPolicy string `json:"bond_xmit_hash_policy,omitempty"`
	BridgePorts        string `json:"bridge_ports,omitempty"`
	BridgeVlanAware    bool   `json:"bridge_vlan_aware,omitempty"`
	CIDR               string `json:"cidr,omitempty"`
	CIDR6              string `json:"cidr6,omitempty"`
	Comments           string `json:"comments,omitempty"`
	Comments6          string `json:"comments6,omitempty"`
	Gateway            string `json:"gateway,omitempty"`
	Gateway6           string `json:"gateway6,omitempty"`
	MTU                int    `json:"mtu,omitempty"`
	Netmask            string `json:"netmask,omitempty"`
	Netmask6           int    `json:"netmask6,omitempty"`
	OVSBonds           string `json:"ovs_bonds,omitempty"`
	OVSBridge          string `json:"ovs_bridge,omitempty"`
	OVSOptions         string `json:"ovs_options,omitempty"`
	OVSPorts           string `json:"ovs_ports,omitempty"`
	OVSTag             int    `json:"ovs_tag,omitempty"`
	Slaves             string `json:"slaves,omitempty"`
	VlanID             int    `json:"vlan-id,omitempty"`
	VlanRawDevice      string `json:"vlan-raw-device,omitempty"`
}

ConfigNetwork maps go variables to API parameters.

func NewConfigNetworkFromJSON 

func NewConfigNetworkFromJSON(input []byte) (config *ConfigNetwork, err error)

NewConfigNetworkFromJSON takes in a byte array from a json encoded network configuration and stores it in config. It returns the newly created config with the passed in configuration stored and an error if one occurs unmarshalling the input data.

func (ConfigNetwork) CreateNetwork 

func (config ConfigNetwork) CreateNetwork(client *Client) (err error)

CreateNetwork creates a network on the Proxmox host with the stored config. It returns an error if the creation of the network fails.

func (ConfigNetwork) UpdateNetwork 

func (config ConfigNetwork) UpdateNetwork(client *Client) (err error)

UpdateNetwork updates a network on the Proxmox host with the stored config. It returns an error if updating the network fails.

type ConfigQemu 

type ConfigQemu struct {
	VmID            int         `json:"vmid,omitempty"`
	Name            string      `json:"name,omitempty"`
	Description     string      `json:"description,omitempty"`
	Pool            string      `json:"pool,omitempty"`
	Bios            string      `json:"bios,omitempty"`
	EFIDisk         QemuDevice  `json:"efidisk,omitempty"`
	Machine         string      `json:"machine,omitempty"`
	Onboot          *bool       `json:"onboot,omitempty"`
	Startup         string      `json:"startup,omitempty"`
	Tablet          *bool       `json:"tablet,omitempty"`
	Agent           int         `json:"agent,omitempty"`
	Memory          int         `json:"memory,omitempty"`
	Balloon         int         `json:"balloon,omitempty"`
	QemuOs          string      `json:"ostype,omitempty"`
	QemuCores       int         `json:"cores,omitempty"`
	QemuSockets     int         `json:"sockets,omitempty"`
	QemuVcpus       int         `json:"vcpus,omitempty"`
	QemuCpu         string      `json:"cpu,omitempty"`
	QemuNuma        *bool       `json:"numa,omitempty"`
	QemuKVM         *bool       `json:"kvm,omitempty"`
	Hotplug         string      `json:"hotplug,omitempty"`
	QemuIso         string      `json:"iso,omitempty"`
	QemuPxe         bool        `json:"pxe,omitempty"`
	FullClone       *int        `json:"fullclone,omitempty"`
	Boot            string      `json:"boot,omitempty"`
	BootDisk        string      `json:"bootdisk,omitempty"`
	Scsihw          string      `json:"scsihw,omitempty"`
	QemuDisks       QemuDevices `json:"disk,omitempty"`
	QemuUnusedDisks QemuDevices `json:"unused,omitempty"`
	QemuVga         QemuDevice  `json:"vga,omitempty"`
	QemuNetworks    QemuDevices `json:"network,omitempty"`
	QemuSerials     QemuDevices `json:"serial,omitempty"`
	QemuUsbs        QemuDevices `json:"usb,omitempty"`
	QemuPCIDevices  QemuDevices `json:"hostpci,omitempty"`
	Hookscript      string      `json:"hookscript,omitempty"`
	HaState         string      `json:"hastate,omitempty"`
	HaGroup         string      `json:"hagroup,omitempty"`
	Tags            string      `json:"tags,omitempty"`
	Args            string      `json:"args,omitempty"`

	// cloud-init options
	CIuser     string      `json:"ciuser,omitempty"`
	CIpassword string      `json:"cipassword,omitempty"`
	CIcustom   string      `json:"cicustom,omitempty"`
	Ipconfig   IpconfigMap `json:"ipconfig,omitempty"`

	Searchdomain string `json:"searchdomain,omitempty"`
	Nameserver   string `json:"nameserver,omitempty"`
	Sshkeys      string `json:"sshkeys,omitempty"`
}

ConfigQemu - Proxmox API QEMU options

func NewConfigQemuFromApi 

func NewConfigQemuFromApi(vmr *VmRef, client *Client) (config *ConfigQemu, err error)

func NewConfigQemuFromJson 

func NewConfigQemuFromJson(input []byte) (config *ConfigQemu, err error)

func (ConfigQemu) CloneVm 

func (config ConfigQemu) CloneVm(sourceVmr *VmRef, vmr *VmRef, client *Client) (err error)

CloneVm Example: Request

nodes/proxmox1-xx/qemu/1012/clone

newid:145 name:tf-clone1 target:proxmox1-xx full:1 storage:xxx

func (ConfigQemu) CreateIpconfigParams 

func (c ConfigQemu) CreateIpconfigParams(vmID int, params map[string]interface{}) error

Create parameters for each Cloud-Init ipconfig entry.

func (ConfigQemu) CreateQemuDisksParams 

func (c ConfigQemu) CreateQemuDisksParams(
	vmID int,
	params map[string]interface{},
	cloned bool,
) error

Create parameters for each disk.

func (ConfigQemu) CreateQemuEfiParams 

func (c ConfigQemu) CreateQemuEfiParams(
	params map[string]interface{},
) error

Create efi parameter.

func (ConfigQemu) CreateQemuMachineParam 

func (c ConfigQemu) CreateQemuMachineParam(
	params map[string]interface{},
) error

Create parameters for serial interface

func (ConfigQemu) CreateQemuNetworksParams 

func (c ConfigQemu) CreateQemuNetworksParams(vmID int, params map[string]interface{}) error

Create parameters for each Nic device.

func (ConfigQemu) CreateQemuPCIsParams 

func (c ConfigQemu) CreateQemuPCIsParams(
	vmID int,
	params map[string]interface{},
) error

Create parameters for each PCI Device

func (ConfigQemu) CreateQemuSerialsParams 

func (c ConfigQemu) CreateQemuSerialsParams(
	vmID int,
	params map[string]interface{},
) error

Create parameters for serial interface

func (ConfigQemu) CreateQemuUsbsParams 

func (c ConfigQemu) CreateQemuUsbsParams(
	vmID int,
	params map[string]interface{},
) error

Create parameters for usb interface

func (ConfigQemu) CreateVm 

func (config ConfigQemu) CreateVm(vmr *VmRef, client *Client) (err error)

CreateVm - Tell Proxmox API to make the VM

func (ConfigQemu) HasCloudInit 

func (config ConfigQemu) HasCloudInit() bool

HasCloudInit - are there cloud-init options?

func (ConfigQemu) String 

func (c ConfigQemu) String() string

func (ConfigQemu) UpdateConfig 

func (config ConfigQemu) UpdateConfig(vmr *VmRef, client *Client) (err error)

type ConfigSnapshot 

type ConfigSnapshot struct {
	Name        string `json:"name,omitempty"`
	Description string `json:"description,omitempty"`
	VmState     bool   `json:"ram,omitempty"`
}

func (*ConfigSnapshot) CreateSnapshot 

func (config *ConfigSnapshot) CreateSnapshot(c *Client, guestId uint) (err error)

type ConfigStorage 

type ConfigStorage struct {
	ID              string                        `json:"id"`
	Enable          bool                          `json:"enable"`
	Nodes           []string                      `json:"nodes,omitempty"`
	Type            string                        `json:"type"`
	Directory       *ConfigStorageDirectory       `json:"directory,omitempty"`
	LVM             *ConfigStorageLVM             `json:"lvm,omitempty"`
	LVMThin         *ConfigStorageLVMThin         `json:"lvm-thin,omitempty"`
	NFS             *ConfigStorageNFS             `json:"nfs,omitempty"`
	SMB             *ConfigStorageSMB             `json:"smb,omitempty"`
	GlusterFS       *ConfigStorageGlusterFS       `json:"glusterfs,omitempty"`
	ISCSI           *ConfigStorageISCSI           `json:"iscsi,omitempty"`
	CephFS          *ConfigStorageCephFS          `json:"cephfs,omitempty"`
	RBD             *ConfigStorageRBD             `json:"rbd,omitempty"`
	ZFSoverISCSI    *ConfigStorageZFSoverISCSI    `json:"zfs-over-iscsi,omitempty"`
	ZFS             *ConfigStorageZFS             `json:"zfs,omitempty"`
	PBS             *ConfigStoragePBS             `json:"pbs,omitempty"`
	Content         *ConfigStorageContent         `json:"content,omitempty"`
	BackupRetention *ConfigStorageBackupRetention `json:"backupretention,omitempty"`
}

Storage options for the Proxmox API

func NewConfigStorageFromApi 

func NewConfigStorageFromApi(storageid string, client *Client) (config *ConfigStorage, err error)

func NewConfigStorageFromJson 

func NewConfigStorageFromJson(input []byte) (config *ConfigStorage, err error)

func (*ConfigStorage) Create 

func (config *ConfigStorage) Create(id string, errorSupression bool, client *Client) (err error)

func (*ConfigStorage) CreateWithValidate 

func (config *ConfigStorage) CreateWithValidate(id string, client *Client) (err error)

func (*ConfigStorage) RemapFromAPI 

func (config *ConfigStorage) RemapFromAPI()

func (*ConfigStorage) RemapToAPI 

func (config *ConfigStorage) RemapToAPI()

func (*ConfigStorage) SetDefaults 

func (config *ConfigStorage) SetDefaults()

func (*ConfigStorage) Update 

func (config *ConfigStorage) Update(id string, client *Client) (err error)

func (*ConfigStorage) UpdateWithValidate 

func (config *ConfigStorage) UpdateWithValidate(id string, client *Client) (err error)

func (*ConfigStorage) Validate 

func (newConfig *ConfigStorage) Validate(id string, create bool, client *Client) (err error)

type ConfigStorageBackupRetention 

type ConfigStorageBackupRetention struct {
	Last    *int `json:"last,omitempty"`
	Hourly  *int `json:"hourly,omitempty"`
	Daily   *int `json:"daily,omitempty"`
	Monthly *int `json:"monthly,omitempty"`
	Weekly  *int `json:"weekly,omitempty"`
	Yearly  *int `json:"yearly,omitempty"`
}

func (*ConfigStorageBackupRetention) AllNil 

func (b *ConfigStorageBackupRetention) AllNil() bool

func (*ConfigStorageBackupRetention) MapStorageBackupRetention 

func (b *ConfigStorageBackupRetention) MapStorageBackupRetention() string

func (*ConfigStorageBackupRetention) Validate 

func (b *ConfigStorageBackupRetention) Validate() (err error)

type ConfigStorageCephFS 

type ConfigStorageCephFS struct {
	Monitors  []string `json:"monitors"`
	SecretKey *string  `json:"secret-key,omitempty"`
	Username  string   `json:"username"`
	FSname    string   `json:"fs-name"`
}

type ConfigStorageContent 

type ConfigStorageContent struct {
	Backup    *bool `json:"backup,omitempty"`    //backup
	Iso       *bool `json:"iso,omitempty"`       //iso
	Template  *bool `json:"template,omitempty"`  //vztmpl
	DiskImage *bool `json:"diskimage,omitempty"` //images
	Container *bool `json:"container,omitempty"` //rootdir
	Snippets  *bool `json:"snippets,omitempty"`  //snippets
}

func (*ConfigStorageContent) MapStorageContent 

func (c *ConfigStorageContent) MapStorageContent(array []bool) (list string)

func (*ConfigStorageContent) Validate 

func (c *ConfigStorageContent) Validate(storageType string) error

type ConfigStorageDirectory 

type ConfigStorageDirectory struct {
	Path          string  `json:"path"`
	Preallocation *string `json:"preallocation,omitempty"`
	Shared        bool    `json:"shared"`
}

Storage Types

func (*ConfigStorageDirectory) SetDefaults 

func (directory *ConfigStorageDirectory) SetDefaults()

type ConfigStorageGlusterFS 

type ConfigStorageGlusterFS struct {
	Server1       string  `json:"server1"`
	Server2       string  `json:"server2,omitempty"`
	Preallocation *string `json:"preallocation,omitempty"`
	Volume        string  `json:"volume"`
}

func (*ConfigStorageGlusterFS) SetDefaults 

func (glusterfs *ConfigStorageGlusterFS) SetDefaults()

type ConfigStorageISCSI 

type ConfigStorageISCSI struct {
	Portal string `json:"portal"`
	Target string `json:"target"`
}

type ConfigStorageLVM 

type ConfigStorageLVM struct {
	VGname string `json:"vgname"`
	Shared bool   `json:"shared,omitempty"`
}

type ConfigStorageLVMThin 

type ConfigStorageLVMThin struct {
	VGname   string `json:"vgname"`
	Thinpool string `json:"thinpool"`
}

type ConfigStorageNFS 

type ConfigStorageNFS struct {
	Server        string  `json:"server"`
	Export        string  `json:"export"`
	Preallocation *string `json:"preallocation,omitempty"`
	Version       *string `json:"version,omitempty"`
}

func (*ConfigStorageNFS) SetDefaults 

func (nfs *ConfigStorageNFS) SetDefaults()

type ConfigStoragePBS 

type ConfigStoragePBS struct {
	Server      string  `json:"server"`
	Datastore   string  `json:"datastore"`
	Username    string  `json:"username"`
	Password    *string `json:"password,omitempty"`
	Fingerprint string  `json:"fingerprint,omitempty"`
	Port        *int    `json:"port,omitempty"`
	Namespace   string  `json:"namespace,omitempty"`
}

func (*ConfigStoragePBS) SetDefaults 

func (pbs *ConfigStoragePBS) SetDefaults()

type ConfigStorageRBD 

type ConfigStorageRBD struct {
	Pool      string   `json:"pool"`
	Monitors  []string `json:"monitors"`
	Username  string   `json:"username"`
	Keyring   *string  `json:"keyring,omitempty"`
	Namespace string   `json:"namespace"`
	KRBD      bool     `json:"krbd"`
}

type ConfigStorageSMB 

type ConfigStorageSMB struct {
	Username      string  `json:"username"`
	Share         string  `json:"share"`
	Preallocation *string `json:"preallocation,omitempty"`
	Domain        string  `json:"domain"`
	Server        string  `json:"server"`
	Password      *string `json:"password,omitempty"`
	Version       *string `json:"version,omitempty"`
}

func (*ConfigStorageSMB) SetDefaults 

func (smb *ConfigStorageSMB) SetDefaults()

type ConfigStorageZFS 

type ConfigStorageZFS struct {
	Pool          string  `json:"pool"`
	Blocksize     *string `json:"blocksize,omitempty"`
	Thinprovision bool    `json:"thinprovision,omitempty"`
}

func (*ConfigStorageZFS) SetDefaults 

func (zfs *ConfigStorageZFS) SetDefaults()

type ConfigStorageZFSoverISCSI 

type ConfigStorageZFSoverISCSI struct {
	Portal        string                             `json:"portal"`
	Pool          string                             `json:"pool"`
	Blocksize     *string                            `json:"blocksize"`
	Target        string                             `json:"target"`
	ISCSIprovider string                             `json:"iscsiprovider"`
	Thinprovision bool                               `json:"thinprovision"`
	Comstar       *ConfigStorageZFSoverISCSI_Comstar `json:"comstar,omitempty"`
	Istgt         *ConfigStorageZFSoverISCSI_istgt   `json:"istgt,omitempty"`
	LIO           *ConfigStorageZFSoverISCSI_LIO     `json:"lio,omitempty"`
}

func (*ConfigStorageZFSoverISCSI) RemapFromAPI 

func (zfsoveriscsi *ConfigStorageZFSoverISCSI) RemapFromAPI()

func (*ConfigStorageZFSoverISCSI) RemapToAPI 

func (zfsoveriscsi *ConfigStorageZFSoverISCSI) RemapToAPI()

func (*ConfigStorageZFSoverISCSI) SetDefaults 

func (zfsoveriscsi *ConfigStorageZFSoverISCSI) SetDefaults()

type ConfigStorageZFSoverISCSI_Comstar 

type ConfigStorageZFSoverISCSI_Comstar struct {
	TargetGroup string `json:"target-group"`
	HostGroup   string `json:"host-group"`
	Writecache  bool   `json:"writecache"`
}

type ConfigStorageZFSoverISCSI_LIO 

type ConfigStorageZFSoverISCSI_LIO struct {
	TargetPortalGroup string `json:"targetportal-group"`
}

type ConfigStorageZFSoverISCSI_istgt 

type ConfigStorageZFSoverISCSI_istgt struct {
	Writecache bool `json:"writecache"`
}

type ConfigUser 

type ConfigUser struct {
	User      UserID       `json:"user"`
	Comment   string       `json:"comment,omitempty"`
	Email     string       `json:"email,omitempty"`
	Enable    bool         `json:"enable"`
	Expire    uint         `json:"expire"`
	FirstName string       `json:"firstname,omitempty"`
	Groups    *[]GroupName `json:"groups,omitempty"`
	Keys      string       `json:"keys,omitempty"`
	LastName  string       `json:"lastname,omitempty"`
	// Password is always empty when getting information from Proxmox
	Password UserPassword `json:"-"`
}

User options for the Proxmox API

func NewConfigUserFromApi 

func NewConfigUserFromApi(userId UserID, client *Client) (*ConfigUser, error)

func NewConfigUserFromJson 

func NewConfigUserFromJson(input []byte) (config *ConfigUser, err error)

func (ConfigUser) CreateUser 

func (config ConfigUser) CreateUser(client *Client) (err error)

func (ConfigUser) DeleteUser 

func (config ConfigUser) DeleteUser(client *Client) (err error)

func (*ConfigUser) SetUser 

func (config *ConfigUser) SetUser(userId UserID, password UserPassword, client *Client) (err error)

Create or update the user depending on if the user already exists or not. "userId" and "password" overwrite what is specified in "*ConfigUser".

func (*ConfigUser) UpdateUser 

func (config *ConfigUser) UpdateUser(client *Client) (err error)

func (ConfigUser) UpdateUserPassword 

func (config ConfigUser) UpdateUserPassword(client *Client) (err error)

func (ConfigUser) Validate 

func (config ConfigUser) Validate() (err error)

Validates all items and sub items in the ConfigUser struct

type ContentType 

type ContentType string
const (
	ContentType_Backup    ContentType = "backup"
	ContentType_Container ContentType = "container"
	ContentType_DiskImage ContentType = "diskimage"
	ContentType_Iso       ContentType = "iso"
	ContentType_Snippets  ContentType = "snippets"
	ContentType_Template  ContentType = "template"
)

func (ContentType) Validate 

func (c ContentType) Validate() (err error)

Returns an error if the enum value is invalid.

type Content_File 

type Content_File struct {
	Storage     string
	ContentType ContentType
	FilePath    string
}

func (Content_File) Validate 

func (c Content_File) Validate() (err error)

Return an error if the required fields are empty

type Content_FileProperties 

type Content_FileProperties struct {
	Name         string    `json:"name"`
	CreationTime time.Time `json:"time"`
	Format       string    `json:"format"`
	Size         uint      `json:"size"`
}

type GroupName 

type GroupName string

GroupName may only contain the following characters: abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890-_

func (GroupName) AddUsersToGroup 

func (group GroupName) AddUsersToGroup(members *[]UserID, client *Client) error

Add users to the specified group

func (GroupName) CheckExistence 

func (group GroupName) CheckExistence(client *Client) (bool, error)

Check if the specified group exists.

func (GroupName) Delete 

func (group GroupName) Delete(client *Client) (err error)

Deletes the specified group

func (GroupName) RemoveAllUsersFromGroup 

func (group GroupName) RemoveAllUsersFromGroup(client *Client) (err error)

Recursively remove all users from the specified group

func (GroupName) RemoveUsersFromGroup 

func (group GroupName) RemoveUsersFromGroup(members *[]UserID, client *Client) (err error)

Remove users from the specified group

func (GroupName) SetMembers 

func (group GroupName) SetMembers(members *[]UserID, client *Client) (err error)

Recursively add and remove users from the specified group so only the the specified users will be members of the group

func (GroupName) Validate 

func (group GroupName) Validate() error

Check if a groupname is valid.

type IpconfigMap 

type IpconfigMap map[int]interface{}

type QemuDevice 

type QemuDevice map[string]interface{}

func ParseConf 

func ParseConf(
	kvString string,
	confSeparator string,
	subConfSeparator string,
	implicitFirstKey string,
) QemuDevice

ParseConf - Parse standard device conf string `key1=val1,key2=val2`.

func ParseLxcDisk 

func ParseLxcDisk(diskStr string) QemuDevice

func ParsePMConf 

func ParsePMConf(
	kvString string,
	implicitFirstKey string,
) QemuDevice

type QemuDeviceParam 

type QemuDeviceParam []string

type QemuDevices 

type QemuDevices map[int]map[string]interface{}

type Response 

type Response struct {
	Resp *http.Response
	Body []byte
}

type Session 

type Session struct {
	ApiUrl     string
	AuthTicket string
	CsrfToken  string
	AuthToken  string // Combination of user, realm, token ID and UUID
	Headers    http.Header
	// contains filtered or unexported fields
}

func NewSession 

func NewSession(apiUrl string, hclient *http.Client, proxyString string, tls *tls.Config) (session *Session, err error)

func (*Session) Delete 

func (s *Session) Delete(
	url string,
	params *url.Values,
	headers *http.Header,
) (resp *http.Response, err error)

func (*Session) Do 

func (s *Session) Do(req *http.Request) (*http.Response, error)

func (*Session) Get 

func (s *Session) Get(
	url string,
	params *url.Values,
	headers *http.Header,
) (resp *http.Response, err error)

func (*Session) GetJSON 

func (s *Session) GetJSON(
	url string,
	params *url.Values,
	headers *http.Header,
	responseContainer interface{},
) (resp *http.Response, err error)

func (*Session) Head 

func (s *Session) Head(
	url string,
	params *url.Values,
	headers *http.Header,
) (resp *http.Response, err error)

func (*Session) Login 

func (s *Session) Login(username string, password string, otp string) (err error)

func (*Session) NewRequest 

func (s *Session) NewRequest(method, url string, headers *http.Header, body io.Reader) (req *http.Request, err error)

func (*Session) Post 

func (s *Session) Post(
	url string,
	params *url.Values,
	headers *http.Header,
	body *[]byte,
) (resp *http.Response, err error)

func (*Session) PostJSON 

func (s *Session) PostJSON(
	url string,
	params *url.Values,
	headers *http.Header,
	body interface{},
	responseContainer interface{},
) (resp *http.Response, err error)

func (*Session) Put 

func (s *Session) Put(
	url string,
	params *url.Values,
	headers *http.Header,
	body *[]byte,
) (resp *http.Response, err error)

func (*Session) Request 

func (s *Session) Request(
	method string,
	url string,
	params *url.Values,
	headers *http.Header,
	body *[]byte,
) (resp *http.Response, err error)

Perform a simple get to an endpoint

func (*Session) RequestJSON 

func (s *Session) RequestJSON(
	method string,
	url string,
	params *url.Values,
	headers *http.Header,
	body interface{},
	responseContainer interface{},
) (resp *http.Response, err error)

Perform a simple get to an endpoint and unmarshal returned JSON

func (*Session) SetAPIToken 

func (s *Session) SetAPIToken(userID, token string)

type Snapshot 

type Snapshot struct {
	Name        string      `json:"name"`
	SnapTime    uint        `json:"time,omitempty"`
	Description string      `json:"description,omitempty"`
	VmState     bool        `json:"ram,omitempty"`
	Children    []*Snapshot `json:"children,omitempty"`
	Parent      string      `json:"parent,omitempty"`
}

Used for formatting the output when retrieving snapshots

func FormatSnapshotsList 

func FormatSnapshotsList(taskResponse []interface{}) (list []*Snapshot)

Formats the taskResponse as a list of snapshots

func FormatSnapshotsTree 

func FormatSnapshotsTree(taskResponse []interface{}) (tree []*Snapshot)

Formats a list of snapshots as a tree of snapshots

type TemplateItem 

type TemplateItem struct {
	Architecture   string
	Description    string
	Headline       string
	InfoPage       string
	Location       string
	ManageURL      string
	OS             string
	Package        string
	Section        string
	SHA512Checksum string
	Source         string
	Template       string
	Type           string
	Version        string
}

type UserID 

type UserID struct {
	// TODO create custom type for Name.
	// the name only seems to allows some characters, and using the string type would imply that all characters are allowed.
	// https://bugzilla.proxmox.com/show_bug.cgi?id=4461
	Name string `json:"name"`
	// TODO create custom type for Realm.
	// the realm only allows some characters, and using the string type would imply that all characters are allowed.
	// https://bugzilla.proxmox.com/show_bug.cgi?id=4462
	Realm string `json:"realm"`
}

func NewUserID 

func NewUserID(userId string) (id UserID, err error)

Converts "username@realm" to a UserID object

func (UserID) ToString 

func (id UserID) ToString() string

Converts the userID to "username@realm" Returns an empty string when either the Name or Realm is empty

func (UserID) Validate 

func (id UserID) Validate() error

TODO improve when Name and Realm have their own types

type UserPassword 

type UserPassword string

May be empty or should be at least be 5 characters long.

func (UserPassword) Validate 

func (password UserPassword) Validate() error

type VmRef 

type VmRef struct {
	// contains filtered or unexported fields
}

VmRef - virtual machine ref parts map[type:qemu node:proxmox1-xx id:qemu/132 diskread:5.57424738e+08 disk:0 netin:5.9297450593e+10 mem:3.3235968e+09 uptime:1.4567097e+07 vmid:132 template:0 maxcpu:2 netout:6.053310416e+09 maxdisk:3.4359738368e+10 maxmem:8.592031744e+09 diskwrite:1.49663619584e+12 status:running cpu:0.00386980694947209 name:appt-app1-dev.xxx.xx]

func NewVmRef 

func NewVmRef(vmId int) (vmr *VmRef)

func (*VmRef) GetVmType 

func (vmr *VmRef) GetVmType() string

func (*VmRef) HaGroup 

func (vmr *VmRef) HaGroup() string

func (*VmRef) HaState 

func (vmr *VmRef) HaState() string

func (*VmRef) Node 

func (vmr *VmRef) Node() string

func (*VmRef) Pool 

func (vmr *VmRef) Pool() string

func (*VmRef) SetNode 

func (vmr *VmRef) SetNode(node string)

func (*VmRef) SetPool 

func (vmr *VmRef) SetPool(pool string)

func (*VmRef) SetVmType 

func (vmr *VmRef) SetVmType(vmType string)

func (*VmRef) VmId 

func (vmr *VmRef) VmId() int

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.