pve

import "github.com/iolave/go-proxmox/pkg/pve"

Constants

Credentials error messages.

const (
    CREDENTIALS_NOT_DETECTED_ERROR    = "credentials could not be detected from env"
    CREDENTIALS_NOT_SUPPORTED_ERROR   = "credentials type not supported yet"
    CREDENTIALS_MISSING_REQUEST_ERROR = "*http.Request parameter is nil"
)

type APTRepoInfoError

type APTRepoInfoError struct {
    Error string `json:"error"` // The error message.
    Path  string `json:"path"`  // Path to the problematic file.
}

type APTRepoInfoFile

type APTRepoInfoFile struct {
    Digest       []int                 `json:"digest"`       // Digest of the file as bytes.
    FileType     string                `json:"file-type"`    // Format of the file ("list", "sources").
    Path         string                `json:"path"`         // Path to the problematic file.
    Repositories []APTRepoInfoFileRepo `json:"repositories"` // The parsed repositories.
}

type APTRepoInfoFileRepo

type APTRepoInfoFileRepo struct {
    Comment    string                   // Associated comment.
    Components []string                 // List of repository components
    Enabled    bool                     // Whether the repository is enabled or not.
    FileType   string                   // Format of the defining file ("list", "sources").
    Options    []APTRepoInfoFileRepoOpt // Additional options.
    Suites     []string                 // List of package distribuitions
    Types      []string                 // List of package types ("deb", "deb-src").
    URIs       []string                 // List of repository URIs.
}

type APTRepoInfoFileRepoOpt

type APTRepoInfoFileRepoOpt struct {
    Key    string
    Values []string
}

type APTRepoInfoInfos

type APTRepoInfoInfos struct {
    Index    string `json:"index"`    // Index of the associated repository within the file.
    Kind     string `json:"kind"`     // Kind of the information (e.g. warning).
    Message  string `json:"message"`  // Information message.
    Path     string `json:"path"`     // Path to the associated file.
    Property string `json:"property"` // Property from which the info originates.
}

type APTRepoInfoStdRepo

type APTRepoInfoStdRepo struct {
    Handle string `json:"handle"` // Handle to identify the repository.
    Name   string `json:"name"`   // Full name of the repository.
    Status *bool  `json:"status"` // Indicating enabled/disabled status, if the repository is configured.
}

type Config

type Config struct {
    Host               string
    Port               int
    InsecureSkipVerify bool
    CfServiceToken     *cloudflare.ServiceToken
    APIWrapper         bool
}

type CreateLxcRequest

type CreateLxcRequest struct {
    Node               string         // The cluster node name.
    OSTemplate         string         // The OS template or backup file (in format "{STORAGE_ID}:{TYPE}/{TEMPLATE_NAME}", i.e. "local:vztmpl/debian-12-standard_12.7-1_amd64.tar.zst")
    VMID               int            // The (unique) ID of the VM.
    Arch               LxcArch        // OS architecture type.
    BWLimit            int            // Override I/O bandwidth limit (in KiB/s).
    CMode              LxcConsoleMode // Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login).
    Console            bool           // Attach a console device (/dev/console) to the container.
    Cores              int            // The number of cores assigned to the container. A container can use all available cores by default.
    CPULimit           int            // Limit of CPU usage. NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
    CPUUnits           int            // CPU weight for a container. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this container gets. Number is relative to the weights of all the other running guests.
    Debug              bool           // Try to be more verbose. For now this only enables debug log-level on start.
    Desc               string         // Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file.
    Features           LXCFeatures    // Allow containers access to advanced features.
    Force              bool           // Allow to overwrite existing container.
    Hookscript         string         // Script that will be exectued during various steps in the containers lifetime.
    Hostname           string         // Set a host name for the container.
    IgnoreUnpackErrors bool           // Ignore errors when extracting the template.
    Lock               LxcLock        // Lock/unlock the container.
    Memory             int            // Amount of RAM for the container in MB.
    Nameserver         string         // Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
    Net                []LxcNet       // Specifies network interfaces for the container.
    OnBoot             bool           // Specifies whether a container will be started during system bootup.
    OSType             string         // OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup. debian | devuan | ubuntu | centos | fedora | opensuse | archlinux | alpine | gentoo | nixos | unmanaged
    Password           string         // Sets root password inside container.
    Pool               string         // Add the VM to the specified pool.
    Protection         bool           // Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
    Restore            bool           // Mark this as restore task.
    RootFS             string         // Use volume as container root (in format "{STORAGE_ID}:{SIZE_IN_GIGS}", i.e. "local-lvm:8", if value not specified it defaults to "local-lvm:8", TODO: make this a struct).
    Searchdomain       string         // Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
    SSHPublicKeys      string         // Setup public SSH keys (one key per line, OpenSSH format).
    Startup            string         // make this a struct Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.
    Storage            string         // Default Storage.
    Swap               int            // Amount of SWAP for the container in MB.
    Tags               string         // Tags of the Container. This is only meta information.
    Template           bool           // Enable/disable Template.
    Timezone           string         // Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tab
    TTY                int            // Specify the number of tty available to the container.
    Unique             bool           // Assign a unique random ethernet address.
    Unprivileged       bool           // Makes the container run as unprivileged user. (Should not be modified manually.)

}

type CreateNodeFirewallRuleRequest

type CreateNodeFirewallRuleRequest struct {
    Action          string           `in:"nonzero;form=action"`      // Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. Format: [A-Za-z][A-Za-z0-9\-\_]+.
    Node            string           `in:"nonzero;path=node"`        // The cluster node name.
    Type            string           `in:"nonzero;form=type"`        // Rule type. Values: in | out | forward | group.
    Comment         string           `in:"omitempty;form=comment"`   // Optional. Descriptive comment.
    Destination     string           `in:"omitempty;form=dest"`      // Optional. Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.
    Digest          string           `in:"omitempty;form=digest"`    // Optional. Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.
    DestinationPort string           `in:"omitempty;form=dport"`     // Optional. Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges.
    Enable          int              `in:"omitempty;form=enable"`    // Optional. Flag to enable/disable a rule. Values: (0 - N).
    ICMPType        string           `in:"omitempty;form=icmp-type"` // Optional. Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'.
    Interface       string           `in:"omitempty;form=iface"`     // Optional. Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings.
    LogLevel        FirewallLogLevel `in:"omitempty;form=log"`       // Optional. Log level for firewall rule.
    Macro           string           `in:"omitempty;form=macro"`     // Optional. Use predefined standard macro.
    Pos             int              `in:"omitempty;form=pos"`       // Optional. Update rule at position <pos>.
    Proto           string           `in:"omitempty;form=proto"`     // Optional. IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.
    Source          string           `in:"omitempty;form=source"`    // Optional. Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.
    Sport           string           `in:"omitempty;form=sport"`     // Optional. Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges.
}

type CredentialType

Proxmox api client available credential types

type CredentialType int

TODO: Add CREDENTIALS_PASSWORD support

const (
    CREDENTIALS_TOKEN CredentialType = iota
    CREDENTIALS_PASSWORD
)

type Credentials

Credentials store proxmox api credentials.

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

func NewEnvCreds

func NewEnvCreds() (*Credentials, error)

NewEnvCreds get environment variables values and detects the type of credentials based on which envs are configured.

It returns an error when a credential type is not detected.

func NewTokenCreds

func NewTokenCreds(user, tokenName, token string) *Credentials

NewTokenCreds returns a struct containing proxmox token credentials that can be passed to a pve api constructor.

To create a pve token, read the docs.

func (*Credentials) Set

func (c *Credentials) Set(req *http.Request) error

Set adds the corresponding PVE authorization headers to the req parameter.

* It returns an error with the CREDENTIALS\_MISSING\_REQUEST\_ERROR message when nil is passed to the req parameter.

* It returns an error with the CREDENTIALS\_NOT\_SUPPORTED\_ERROR message when CredentialType is not supported.

type DeleteLXCOptions

type DeleteLXCOptions struct {
    DestroyUnreferencedDisks *bool // If set, destroy additionally all disks with the VMID from all enabled storages which are not referenced in the config.
    Force                    *bool // Force destroy, even if running.
    Purge                    *bool // Remove container from all related configurations. For example, backup jobs, replication jobs or HA. Related ACLs and Firewall entries will *always* be removed.
}

type FirewallLogEntry

Proxmox firewall log entry.

type FirewallLogEntry struct {
    Id   int    `json:"n"`
    Text string `json:"t"`
}

type FirewallLogLevel

Promox firewall available log levels.

type FirewallLogLevel string

const (
    FIREWALL_LOG_LEVEL_EMERG  FirewallLogLevel = "emerg"
    FIREWALL_LOG_LEVEL_ALERT  FirewallLogLevel = "alert"
    FIREWALL_LOG_LEVEL_CRIT   FirewallLogLevel = "crit"
    FIREWALL_LOG_LEVEL_ERR    FirewallLogLevel = "err"
    FIREWALL_LOG_LEVEL_WARN   FirewallLogLevel = "warning"
    FIREWALL_LOG_LEVEL_NOTICE FirewallLogLevel = "notice"
    FIREWALL_LOG_LEVEL_INFO   FirewallLogLevel = "info"
    FIREWALL_LOG_LEVEL_DEBUG  FirewallLogLevel = "debug"
    FIREWALL_LOG_LEVEL_NOLOG  FirewallLogLevel = "nolog"
)

type GetAccessPermisionsRequest

type GetAccessPermisionsRequest struct {
    UserID string `in:"omitempty;query=userid"` // User ID or full API token ID.
}

type GetAccessPermisionsResponse

type GetAccessPermisionsResponse struct {
    Access       map[string]bool
    AccessGroups map[string]bool
    Nodes        map[string]bool
    Pool         map[string]bool
    SDN          map[string]bool
    Storage      map[string]bool
    VMS          map[string]bool
}

type GetClusterFirewallAliasesResponse

type GetClusterFirewallAliasesResponse struct {
    CIDR    string `json:"cidr"`
    Digest  string `json:"digest"`
    Name    string `json:"name"`
    Comment string `json:"comment"`
}

type GetClusterFirewallIPSetResponse

type GetClusterFirewallIPSetResponse struct {
    Digest  string `json:"digest"`
    Name    string `json:"name"`
    Comment string `json:"comment"`
}

type GetClusterFirewallRulesResponse

type GetClusterFirewallRulesResponse struct {
    Pos int `json:"pos"`
}

type GetLxcInterfaceResponse

type GetLxcInterfaceResponse struct {
    Name      string `json:"name"`
    HWAddress string `json:"hwaddr"`
    IPv4      string `json:"inet"`
    IPv6      string `json:"inet6"`
}

type GetLxcStatusResponse

type GetLxcStatusResponse struct {
    CPUs      int `json:"cpus"`      // Maximum usable CPUs.
    Disk      int `json:"disk"`      // Root disk image space-usage in bytes.
    DiskRead  int `json:"diskread"`  // The amount of bytes the guest read from it's block devices since the guest was started. (Note: This info is not available for all storage types.)
    DiskWrite int `json:"diskwrite"` // The amount of bytes the guest wrote from it's block devices since the guest was started. (Note: This info is not available for all storage types.)
    // TODO: add ha object support
    //ha        object  // HA manager service status.
    Lock     string `json:"lock"`     // The current config lock, if any.
    MaxDisk  int    `json:"maxdisk"`  // Root disk image size in bytes.
    MaxMem   int    `json:"maxmem"`   // Maximum memory in bytes.
    MaxSwap  int    `json:"maxswap"`  // Maximum SWAP memory in bytes.
    Name     string `json:"name"`     // Container name.
    NetIn    int    `json:"netin"`    // The amount of traffic in bytes that was sent to the guest over the network since it was started.
    NetOut   int    `json:"netout"`   // The amount of traffic in bytes that was sent from the guest over the network since it was started.
    Status   string `json:"status"`   // LXC Container status.
    Tags     string `json:"tags"`     // The current configured tags, if any.
    Template int    `json:"template"` // Determines if the guest is a template.
    Uptime   int    `json:"uptime"`   // Uptime in seconds.
    ID       int    `json:"vmid"`     // The (unique) ID of the VM.
}

type GetNodeAPTRepoInfo

type GetNodeAPTRepoInfo struct {
    Digest   string               `json:"digest"`         // Common digest of all files.
    Errors   []APTRepoInfoError   `json:"errors"`         // List of problematic repository files.
    Files    []APTRepoInfoFile    `json:"files"`          // List of parsed repository files.
    Infos    []APTRepoInfoInfos   `json:"infos"`          // Additional information/warnings for APT repositories.
    StdRepos []APTRepoInfoStdRepo `json:"standard-repos"` // List of standard repositories and their configuration status.
}

type GetNodeDatastoreContentResponse

TODO: Add missing verification property from docs.

type GetNodeDatastoreContentResponse struct {
    Format    string  `json:"format"`    // Format identifier ('raw', 'qcow2', 'subvol', 'iso', 'tgz' ...)
    Size      int     `json:"size"`      // Volume size in bytes.
    VolumeID  string  `json:"volid"`     // Volume identifier.
    CreatedAt *int    `json:"ctime"`     // Creation time (seconds since the UNIX Epoch).
    Encrypted *string `json:"encrypted"` // If whole backup is encrypted, value is the fingerprint or '1'  if encrypted. Only useful for the Proxmox Backup Server storage type.
    Notes     *string `json:"notes"`     // Optional notes. If they contain multiple lines, only the first one is returned here.
    Parent    *string `json:"parent"`    // Volume identifier of parent (for linked cloned).
    Protected *bool   `json:"protected"` // Protection status. Currently only supported for backups.
    Used      *int    `json:"used"`      // Used space. Please note that most storage plugins do not report anything useful here.
    VmID      *int    `json:"vmid"`      // Associated Owner VMID.
}

type GetNodeDatastoreResponse

type GetNodeDatastoreResponse struct {
    Content      string   `json:"content"`       // Allowed storage content types.
    Storage      string   `json:"storage"`       // The storage identifier.
    Type         string   `json:"type"`          // Storage type.
    Active       *bool    `json:"active"`        // Set when storage is accessible.
    Available    *int     `json:"avail"`         // Available storage space in bytes.
    Enabled      *bool    `json:"enabled"`       // Set when storage is enabled (not disabled).
    Shared       *bool    `json:"shared"`        // Shared flag from storage configuration.
    TotalSpace   *int     `json:"total"`         // Total storage space in bytes.
    UsedSpace    *int     `json:"used"`          // Total storage space in bytes.
    UsedFraction *float64 `json:"used_fraction"` // Used fraction (used/total).
}

type GetNodeFirewallRuleResponse

type GetNodeFirewallRuleResponse[Position interface{ int | string }] struct {
    ID              string
    Action          string           `json:"action"`
    Comment         string           `json:"comment"`
    Destination     string           `json:"dest"`
    DestinationPort string           `json:"dport"`
    Enable          int              `json:"enable"`
    ICMPType        string           `json:"icmp-type"`
    Interface       string           `json:"iface"`
    IPVersion       int              `json:"ipversion"`
    LogLevel        FirewallLogLevel `json:"log"`
    Macro           string           `json:"macro"`
    Pos             Position         `json:"pos"`
    Proto           string           `json:"proto"`
    Source          string           `json:"source"`
    Sport           string           `json:"sport"`
    Type            string           `json:"type"`
}

type GetNodeLxcsResponse

type GetNodeLxcsResponse struct {
    Status  LxcStatus `json:"status"`
    VMID    int       `json:"vmid"`
    Cpus    *int      `json:"cpus"`
    Lock    *string   `json:"lock"`
    MaxDisk *int      `json:"maxdisk"`
    MaxMem  *int      `json:"maxmem"`
    MaxSwap *int      `json:"maxswap"`
    Name    *string   `json:"name"`
    Tags    *string   `json:"tags"`
    Uptime  *int      `json:"uptime"`
}

type GetNodeResponse

type GetNodeResponse struct {
    Node           string     `json:"node"`
    Status         NodeStatus `json:"status"`
    CPU            float64    `json:"cpu"`
    Level          string     `json:"level"`
    MaxCpu         int        `json:"maxcpu"`
    MaxMem         int        `json:"maxmem"`
    Mem            int        `json:"mem"`
    SSLFingerprint string     `json:"ssl_fingerprint"`
    Uptime         int        `json:"uptime"`
}

type GetVersionResponse

type GetVersionResponse struct {
    Release string `json:"release"`
    Version string `json:"version"`
    RepoID  string `json:"repoid"`
}

type LXCFeatures

TODO: Add mount support mount

type LXCFeatures struct {
    ForceRWSys *bool
    Fuse       *bool
    KeyCTL     *bool
    MKNod      *bool
    Nesting    *bool
}

func (*LXCFeatures) String

func (f *LXCFeatures) String() string

type LXCRebootRequest

type LXCRebootRequest struct {
    Node    string `in:"nonzero;path=node"`      // The cluster node name.
    ID      int    `in:"nonzero;path=id"`        // The (unique) ID of the VM.
    Timeout int    `in:"omitempty;path=timeout"` // Wait maximal timeout seconds.
}

type LXCResumeRequest

type LXCResumeRequest struct {
    Node string `in:"nonzero;path=node"` // The cluster node name.
    ID   int    `in:"nonzero;path=id"`   // The (unique) ID of the VM.
}

type LXCShutdownRequest

type LXCShutdownRequest struct {
    Node    string `in:"nonzero;path=node"`        // The cluster node name.
    ID      int    `in:"nonzero;path=id"`          // The (unique) ID of the VM.
    Force   int    `in:"omitempty;form=forceStop"` // Make sure the Container stops. Defaults to 0 (false).
    Timeout int    `in:"omitempty;path=timeout"`   // Wait maximal timeout seconds. Defaults to 60.
}

type LXCStartRequest

type LXCStartRequest struct {
    Node     string `in:"nonzero;path=node"`       // The cluster node name.
    ID       int    `in:"nonzero;path=id"`         // The (unique) ID of the VM.
    Debug    int    `in:"omitempty;form=debug"`    // If set, enables very verbose debug log-level on start. Defaults to 0 (false).
    SkipLock int    `in:"omitempty;form=skiplock"` // Ignore locks - only root is allowed to use this option.
}

type LXCStopRequest

type LXCStopRequest struct {
    Node             string `in:"nonzero;path=node"`                // The cluster node name.
    ID               int    `in:"nonzero;path=id"`                  // The (unique) ID of the VM.
    OverruleShutdown int    `in:"omitempty;form=overrule-shutdown"` // Try to abort active 'vzshutdown' tasks before stopping. Defaults to 0 (false).
    SkipLock         int    `in:"omitempty;form=skiplock"`          // Ignore locks - only root is allowed to use this option.
}

type LXCSuspendRequest

type LXCSuspendRequest struct {
    Node string `in:"nonzero;path=node"` // The cluster node name.
    ID   int    `in:"nonzero;path=id"`   // The (unique) ID of the VM.
}

type LxcArch

type LxcArch string

const (
    LXC_ARCH_AMD64   LxcArch = "amd64"
    LXC_ARCH_I386    LxcArch = "i386"
    LXC_ARCH_ARM64   LxcArch = "arm64"
    LXC_ARCH_ARMHF   LxcArch = "armhf"
    LXC_ARCH_RISCV32 LxcArch = "riscv32"
    LXC_ARCH_RISCV64 LxcArch = "riscv64"
)

type LxcConsoleMode

type LxcConsoleMode string

const (
    LXC_CONSOLE_MODE_SHELL   LxcConsoleMode = "shell"
    LXC_CONSOLE_MODE_CONSOLE LxcConsoleMode = "console"
    LXC_CONSOLE_MODE_TTY     LxcConsoleMode = "tty"
)

type LxcLock

type LxcLock string

const (
    LXC_LOCK_BACKUP          LxcLock = "backup"
    LXC_LOCK_CREATE          LxcLock = "create"
    LXC_LOCK_DESTROYED       LxcLock = "destroyed"
    LXC_LOCK_DISK            LxcLock = "disk"
    LXC_LOCK_FSTRIM          LxcLock = "fstrim"
    LXC_LOCK_MIGRATE         LxcLock = "migrate"
    LXC_LOCK_MOUNTED         LxcLock = "mounted"
    LXC_LOCK_ROLLBACK        LxcLock = "rollback"
    LXC_LOCK_SNAPSHOT        LxcLock = "snapshot"
    LXC_LOCK_SNAPSHOT_DELETE LxcLock = "snapshot-delete"
)

type LxcNet

TODO: Add support for trunks (vlans).

type LxcNet struct {
    Name     string
    Bridge   string // Bridge identifier (vmbr1).
    Firewall bool
    GW       string // GatewayIPv4.
    GW6      string // GatewayIPv6.
    HWAddr   string // XX:XX:XX:XX:XX:XX
    IP       string // IPv4/CIDR | dhcp | manual
    IP6      string // IPv6/CIDR | auto | dhcp | manua
    LinkDown bool
    MTU      int
    Rate     int // bmps
    Tag      int
}

func (*LxcNet) String

func (n *LxcNet) String() string

type LxcStatus

type LxcStatus string

const (
    LXC_STATUS_STOPPED LxcStatus = "stopped"
    LXC_STATUS_RUNNING LxcStatus = "running"
)

type NodeAPTIndex

type NodeAPTIndex struct {
    ID string `json:"id"`
}

type NodeStatus

Proxmox availabe node statuses

type NodeStatus string

const (
    NODE_STATUS_ONLINE  NodeStatus = "online"
    NODE_STATUS_OFFLINE NodeStatus = "offline"
    NODE_STATUS_UNKNOWN NodeStatus = "unknown"
)

type PVE

type PVE struct {

    // PVE API implementations
    Access  *PVEAccessService
    Node    *PVENodeService
    Cluster *PVEClusterService
    LXC     *PVELxcService
    // contains filtered or unexported fields
}

func New

func New(config Config) (*PVE, error)

func NewWithCredentials

func NewWithCredentials(config Config, creds *Credentials) (*PVE, error)

func (*PVE) GetVersion

func (api *PVE) GetVersion() (GetVersionResponse, error)

GetVersion retrieves proxmox version.

type PVEAccessService

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

func (*PVEAccessService) GetPermissions

func (s *PVEAccessService) GetPermissions(req GetAccessPermisionsRequest) (res GetAccessPermisionsResponse, err error)

GetPermissions retrieve effective permissions of given user/token.

GET /access/permissions: each user/token is allowed to dump their own permissions (or that of owned tokens). A user can dump the permissions of another user or their tokens if they have 'Sys.Audit' permission on /access.

type PVEClusterFirewallService

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

func (*PVEClusterFirewallService) CreateAlias

func (s *PVEClusterFirewallService) CreateAlias(name, cidr string, comment *string) error

CreateAlias creates a cluster firewall IP or Network Alias.

func (*PVEClusterFirewallService) DeleteAlias

func (s *PVEClusterFirewallService) DeleteAlias(name string, digest *string) error

DeleteAlias removes a cluster firewall IP or Network alias.

Digest prevents changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.

func (*PVEClusterFirewallService) GetAlias

func (s *PVEClusterFirewallService) GetAlias(name string) (GetClusterFirewallAliasesResponse, error)

GetAlias retrieves cluster firewall alias by it's name.

func (*PVEClusterFirewallService) GetAliases

func (s *PVEClusterFirewallService) GetAliases() ([]GetClusterFirewallAliasesResponse, error)

GetAliases retrieves all cluster firewall aliases.

func (*PVEClusterFirewallService) GetIPSet

func (s *PVEClusterFirewallService) GetIPSet() ([]GetClusterFirewallIPSetResponse, error)

GetIPSet retrieves all cluster firewall IPSets.

func (*PVEClusterFirewallService) GetRules

func (s *PVEClusterFirewallService) GetRules() ([]GetClusterFirewallRulesResponse, error)

GetRules retrieves all cluster firewall rules.

func (*PVEClusterFirewallService) UpdateAlias

func (s *PVEClusterFirewallService) UpdateAlias(name, cidr string, comment *string, digest *string, rename *string) error

UpdateAlias updates a cluster firewall IP or Network alias.

Digest prevents changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.

type PVEClusterService

type PVEClusterService struct {
    Firewall *PVEClusterFirewallService
    // contains filtered or unexported fields
}

func (*PVEClusterService) GetNextVMID

func (s *PVEClusterService) GetNextVMID() (int, error)

GetNextVMID returns the next available VMID.

func (*PVEClusterService) GetRandomVMID

func (s *PVEClusterService) GetRandomVMID() (id int, err error)

GetRandomVMID chooses a random vmid and checks wether it's available or not.

GET /cluster/resources is accessible by all authenticated users.

func (*PVEClusterService) GetVMIDs

func (s *PVEClusterService) GetVMIDs() (ids []int, err error)

GetVMIDs retrieves all vmids in the cluster.

GET /cluster/resources is accessible by all authenticated users.

func (*PVEClusterService) IsVMIDAvailable

func (s *PVEClusterService) IsVMIDAvailable(id int) (avaialble bool, err error)

IsVMIDAvailable checks if a vmid is available or not.

GET /cluster/resources is accessible by all authenticated users.

type PVELxcService

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

func (*PVELxcService) Create

func (s *PVELxcService) Create(req CreateLxcRequest) (vmid int, err error)

Create creates an LXC container and return useful information to interact with it after it's creation. If VMID property is lower than 100 a VMID will be generated automatically.

POST /nodes/{node}/lxc requires the 'VM.Allocate' permission on /vms/{vmid} or on the VM pool /pool/{pool}. For restore, it is enough if the user has 'VM.Backup' permission and the VM already exists. You also need 'Datastore.AllocateSpace' permissions on the storage.

func (*PVELxcService) Delete

func (s *PVELxcService) Delete(node string, vmid int, opts *DeleteLXCOptions) (res string, err error)

Delete destroy the container (also delete all uses files).

• if opts is set, the request might fail.
• opts.Force default value is false.
• opts.DestroyUnreferencedDisks default value is false.

DELETE /nodes/:node/lxc/:vmid requires the "VM.Allocate" permission.

func (*PVELxcService) Exec

func (s *PVELxcService) Exec(id int, shell string, cmd string) (out string, exitCode int, err error)

Exec executes a comand inside an lxc.

• If the lxc is not found an error will be returned.
• If the client fails to execute the command, an error will be returned.

This is part of the custom features the go proxmox api wrapper provides. It ONLY works if the api wrapper is installed in a proxmox node instance.

POST /custom-api/v1/lxc/{id}/exec requires the "VM.Console" permission.

func (*PVELxcService) Get

func (s *PVELxcService) Get(node string, vmid int) (res []struct {
    Subdir string `json:"subdir"`
}, err error)

Get returns node's lxc index.

GET /nodes/:node/lxc/:vmid accessible by all authenticated users.

func (*PVELxcService) GetAll

func (s *PVELxcService) GetAll(node string) ([]GetNodeLxcsResponse, error)

GetAll returns node's lxc index per node.

func (*PVELxcService) GetInterfaceByName

func (s *PVELxcService) GetInterfaceByName(node string, id int, name string) (res GetLxcInterfaceResponse, err error)

GetInterfaceByName gets an specific lxc interface by name. If the lxc status is stopped, both res and err will be nil. If the interface name is not found, an error will be returned.

GET /nodes/{node}/lxc/{id}/interfaces requires the "VM.Audit" permission.

func (*PVELxcService) GetInterfaces

func (s *PVELxcService) GetInterfaces(node string, id int) (res []GetLxcInterfaceResponse, err error)

GetInterfaces gets all lxc interfaces. If the lxc status is stopped or it doesnt exist, both res and err will be nil.

GET /nodes/{node}/lxc/{id}/interfaces requires the "VM.Audit" permission.

func (*PVELxcService) GetStatus

func (s *PVELxcService) GetStatus(node string, id int) (res GetLxcStatusResponse, err error)

GetStatus gets an lxc status.

POST /nodes/{node}/lxc/{id}/status/current requires the "VM.PowerMgmt" permission.

func (*PVELxcService) Reboot

func (s *PVELxcService) Reboot(req LXCRebootRequest) (string, error)

Reboot reboots an lxc by shutting it down, and starting it again. Applies pending changes.

POST /nodes/{node}/lxc/{id}/status/reboot requires the "VM.PowerMgmt" permission.

func (*PVELxcService) Resume

func (s *PVELxcService) Resume(req LXCResumeRequest) (string, error)

Resume resumes an lxc.

POST /nodes/{node}/lxc/{id}/status/resume requires the "VM.PowerMgmt" permission.

func (*PVELxcService) Shutdown

func (s *PVELxcService) Shutdown(req LXCShutdownRequest) (string, error)

Shutdown shutdowns an lxc. This will trigger a clean shutdown of the container, see lxc-stop(1) for details.

POST /nodes/{node}/lxc/{id}/status/shutdown requires the "VM.PowerMgmt" permission.

func (*PVELxcService) Start

func (s *PVELxcService) Start(req LXCStartRequest) (string, error)

Start starts an lxc container.

POST /nodes/{node}/lxc/{id}/status/start requires the "VM.PowerMgmt" permission.

func (*PVELxcService) Stop

func (s *PVELxcService) Stop(req LXCStopRequest) (string, error)

Stop stops an lxc container. This will abruptly stop all processes running in the container.

POST /nodes/{node}/lxc/{id}/status/stop requires the "VM.PowerMgmt" permission.

func (*PVELxcService) Suspend

func (s *PVELxcService) Suspend(req LXCSuspendRequest) (string, error)

Suspend suspends an lxc. This is experimental.

POST /nodes/{node}/lxc/{id}/status/suspend requires the "VM.PowerMgmt" permission.

type PVENodeAPTService

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

func (*PVENodeAPTService) AddStdRepo

func (s *PVENodeAPTService) AddStdRepo(node, handle string, digest *string) error

AddStdRepo adds a standard repository to the configuration.

• node: Cluster node name.
• handle: Handle that identifies a repository.
• digest: Digest to detect modifications.

PUT /nodes/:node/apt/repositoreies requires the "Sys.Modify" permission.

func (*PVENodeAPTService) GetChangelog

func (s *PVENodeAPTService) GetChangelog(node, name string, version *string) (string, error)

GetChangelog returns the changelog for a given pacakge name. If version is nil, the latest version available will be considered and otherwise, it will return the changelog found for the given version.

GET /nodes/:node/apt/changelog requires the "Sys.Audit" permission.

func (*PVENodeAPTService) GetIndex

func (s *PVENodeAPTService) GetIndex(node string) ([]NodeAPTIndex, error)

GetIndex returns node's directory index for apt (Advanced Package Tool).

GET /nodes/:node/apt accessible by all authenticated users.

func (*PVENodeAPTService) GetPVEInfo

func (s *PVENodeAPTService) GetPVEInfo(node string) (interface{}, error)

GetPVEInfo get package information for important Proxmox packages.

TODO: docs lacks of response definition (map it).

• node: Cluster node name.

GET /nodes/:node/apt/versions requires the "Sys.Audit" permission.

func (*PVENodeAPTService) GetRepoInfo

func (s *PVENodeAPTService) GetRepoInfo(node string) (GetNodeAPTRepoInfo, error)

GetRepoInfo returns APT repository information.

GET /nodes/:node/apt/repositories requires the "Sys.Audit" permission.

func (*PVENodeAPTService) ListUpdates

func (s *PVENodeAPTService) ListUpdates(node string) (interface{}, error)

ListUpdates list available updates.

TODO: docs lacks of response definition (map it).

• node: Cluster node name.

GET /nodes/:node/apt/update requires the "Sys.Modify" permission.

func (*PVENodeAPTService) SetRepoProps

func (s *PVENodeAPTService) SetRepoProps(index int, node, filePath string, digest *string, enabled *bool) error

SetRepoProps changes the properties of a repository (currently only allows enabling/disabling).

• "index": Index within the file (starting from 0).
• "node": Cluster node name.
• "filePath": Path to the containing file.
• "digest": Digest to detect modifications.
• "enabled": Whether the repository should be enabled or not.

POST /nodes/:node/apt/repositoreies requires the "Sys.Modify" permission.

func (*PVENodeAPTService) UpdateIndex

func (s *PVENodeAPTService) UpdateIndex(node string, notify, quiet bool) (string, error)

UpdateIndex this is used to resynchronize the package index files from their sources (apt-get update).

• node: Cluster node name.
• notify: Send notification about new packages.
• quiet: Only produces output suitable for logging, omitting progress indicators.

POST /nodes/:node/apt/update requires the "Sys.Modify" permission.

type PVENodeFirewallService

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

func (*PVENodeFirewallService) DeleteRule

func (s *PVENodeFirewallService) DeleteRule(node, id string) error

DeleteRule deletes a node's firewall rule using it's id.

• TODO: add digest support.

DELETE /nodes/{node}/firewall/rules/{pos} requires the "Sys.Modify" permission.

func (*PVENodeFirewallService) DeleteRuleByPos

func (s *PVENodeFirewallService) DeleteRuleByPos(node string, pos int) error

DeleteRuleByPos deletes a node's firewall rule using it's position (pos).

• TODO: add digest support.

DELETE /nodes/{node}/firewall/rules/{pos} requires the "Sys.Modify" permission.

func (*PVENodeFirewallService) GetRule

func (s *PVENodeFirewallService) GetRule(node string, id string) (*GetNodeFirewallRuleResponse[int], error)

GetRule finds a single node's firewall rule using it's custom id within the comment field. If the rule is not found, both result and error will be nil.

GET /nodes/{node}/firewall/rules requires the "Sys.Audit" permission.

func (*PVENodeFirewallService) GetRules

func (s *PVENodeFirewallService) GetRules(node string) ([]GetNodeFirewallRuleResponse[int], error)

GetRules retrieves node's firewall rules.

func (*PVENodeFirewallService) GetRulesByPos

func (s *PVENodeFirewallService) GetRulesByPos(node string, pos int) (GetNodeFirewallRuleResponse[string], error)

GetRulesByPos Retrieves a single node's firewall rule using rule's position (pos) as an index.

func (*PVENodeFirewallService) NewRule

func (s *PVENodeFirewallService) NewRule(req CreateNodeFirewallRuleRequest) (string, error)

NewRule creates a new node firewall rule. It adds metadata within the proxmox comment field with the format [id=uuid].

POST /nodes/{node}/firewall/rules requires the "Sys.Modify" permission.

func (*PVENodeFirewallService) ReadLog

func (s *PVENodeFirewallService) ReadLog(node string) ([]FirewallLogEntry, error)

ReadLog Retrieves node's firewall log entries.

TODO: Add missing limit, since, start, until parameters shown in docs.

type PVENodeService

type PVENodeService struct {
    APT      *PVENodeAPTService
    Firewall *PVENodeFirewallService
    Storage  *PVENodeStorageService
    // contains filtered or unexported fields
}

func (*PVENodeService) Get

func (service *PVENodeService) Get(node string) (GetNodeResponse, error)

Get retrieves a single nodes.

func (*PVENodeService) GetAll

func (service *PVENodeService) GetAll() ([]GetNodeResponse, error)

GetAll retrieves all nodes.

type PVENodeStorageService

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

func (*PVENodeStorageService) DownloadISOToDatastore

func (s *PVENodeStorageService) DownloadISOToDatastore(node, storageId, fileName, URL string) error

DownloadISOToDatastore downloads an iso from an url into a node's datastore.

TODO: Add optional parameters.

func (*PVENodeStorageService) DownloadVZTemplateToDatastore

func (s *PVENodeStorageService) DownloadVZTemplateToDatastore(node, storageId, fileName, URL string) error

DownloadVZTemplateToDatastore downloads a vztemplate from an url into a node's datastore.

TODO: Add optional parameters.

func (*PVENodeStorageService) GetDatastoreContent

func (s *PVENodeStorageService) GetDatastoreContent(node, storageId string) ([]GetNodeDatastoreContentResponse, error)

GetDatastoreContent retrieves node's datastores info.

TODO: Add optional parameters.

func (*PVENodeStorageService) GetDatastores

func (s *PVENodeStorageService) GetDatastores(node string) ([]GetNodeDatastoreResponse, error)

GetDatastores retrieves node's datastores info.