Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

proxmox

package module

Go to main page

Versions in this module

v0

v0.2.4

Aug 20, 2025

Changes in this version

+ const AVERAGE

+ const DefaultUserAgent

+ const DomainTypeAD

+ const DomainTypeLDAP

+ const DomainTypeOpenID

+ const DomainTypePVE

+ const DomainTypePam

+ const FieldSeparator

+ const LevelDebug

+ const LevelError

+ const LevelInfo

+ const LevelWarn

+ const MAX

+ const SpaceSeparator

+ const StatusVirtualMachinePaused

+ const StatusVirtualMachineRunning

+ const StatusVirtualMachineStopped

+ const StringSeparator

+ const TagCloudInit

+ const TagFormat

+ const TagSeperator

+ const TaskRunning

+ const TimeframeDay

+ const TimeframeHour

+ const TimeframeMonth

+ const TimeframeWeek

+ const TimeframeYear

+ const UserDataISOFormat

+ const VirtualMachineBackupCompressGzip

+ const VirtualMachineBackupCompressLzo

+ const VirtualMachineBackupCompressOne

+ const VirtualMachineBackupCompressZero

+ const VirtualMachineBackupCompressZstd

+ const VirtualMachineBackupModeSnapshot

+ const VirtualMachineBackupModeStop

+ const VirtualMachineBackupModeSuspend

+ const VirtualMachineBackupNotificationPolicyAlways

+ const VirtualMachineBackupNotificationPolicyFailure

+ const VirtualMachineBackupNotificationPolicyNever

+ var DefaultAgentWaitInterval = 100 * time.Millisecond

+ var DefaultWaitInterval = 1 * time.Second

+ var ErrNoop = errors.New("nothing to do")

+ var ErrNotAuthorized = errors.New("not authorized to access endpoint")

+ var ErrNotFound = errors.New("unable to find the item you are looking for")

+ var ErrTimeout = errors.New("the operation has timed out")

+ func IsErrNoop(err error) bool

+ func IsNotAuthorized(err error) bool

+ func IsNotFound(err error) bool

+ func IsTimeout(err error) bool

+ func MakeTag(v string) string

+ type ACL struct

+ Path string

+ Propagate IntOrBool

+ RoleID string

+ Type string

+ UGID string

+ type ACLOptions struct

+ Delete IntOrBool

+ Groups string

+ Path string

+ Propagate IntOrBool

+ Roles string

+ Tokens string

+ Users string

+ type ACLs []*ACL

+ type AgentExecStatus struct

+ ErrData string

+ ErrTruncated bool

+ ExitCode int

+ Exited int

+ OutData string

+ OutTruncated string

+ Signal bool

+ type AgentNetworkIPAddress struct

+ IPAddress string

+ IPAddressType string

+ MacAddress string

+ Prefix int

+ type AgentNetworkIface struct

+ HardwareAddress string

+ IPAddresses []*AgentNetworkIPAddress

+ Name string

+ type AgentOsInfo struct

+ ID string

+ KernelRelease string

+ KernelVersion string

+ Machine string

+ Name string

+ PrettyName string

+ Version string

+ VersionID string

+ type Appliance struct

+ Architecture string

+ Description string

+ Headline string

+ InfoPage string

+ ManageURL string

+ Node string

+ Os string

+ Package string

+ SHA512Sum string

+ Section string

+ Source string

+ Template string

+ Type string

+ Version string

+ type Appliances []*Appliance

+ type Backup struct

+ func (b *Backup) Delete(ctx context.Context) (*Task, error)

+ type Backups []*Backup

+ type CPUInfo struct

+ CPUs int

+ Cores int

+ Flags string

+ HVM string

+ MHZ StringOrInt

+ Mode string

+ Sockets int

+ UserHz int

+ type Ceph struct

+ func (ce *Ceph) Status(ctx context.Context) (*ClusterCephStatus, error)

+ type CephFsMap struct

+ ByRank []struct{ ... }

+ Epoch int

+ ID int

+ In int

+ Max int

+ Up int

+ UpStandby int

+ type CephHealth struct

+ Checks map[CephHealthCheckName]CephHealthCheck

+ Mutes []interface{}

+ Status string

+ type CephHealthCheck struct

+ Detail []CephHealthCheckDetail

+ Muted bool

+ Severity string

+ Summary CephHealthCheckSummary

+ type CephHealthCheckDetail struct

+ Message string

+ type CephHealthCheckName string

+ type CephHealthCheckSummary struct

+ Count int

+ Message string

+ type CephMgrActiveAddresses struct

+ Addrvec []CephMgrAddrVector

+ type CephMgrActiveClient struct

+ Addrvec []CephMgrAddrVector

+ Name string

+ type CephMgrAddrVector struct

+ Addr string

+ Nonce int

+ Type string

+ type CephMgrAlwaysOnModules struct

+ Octopus []string

+ Pacific []string

+ Quincy []string

+ Reef []string

+ Squid []string

+ type CephMgrAvailableModule struct

+ CanRun bool

+ ErrorString string

+ ModuleOptions CephMgrAvailableModuleOptions

+ Name string

+ type CephMgrAvailableModuleOption struct

+ DefaultValue string

+ Desc string

+ EnumAllowed []string

+ Flags int

+ Level string

+ LongDesc string

+ Max string

+ Min string

+ Name string

+ SeeAlso []interface{}

+ Tags []interface{}

+ Type string

+ type CephMgrAvailableModuleOptions struct

+ Interval CephMgrAvailableModuleOption

+ LogLevel CephMgrAvailableModuleOption

+ LogToCluster CephMgrAvailableModuleOption

+ LogToClusterLevel CephMgrAvailableModuleOption

+ LogToFile CephMgrAvailableModuleOption

+ SMTPDestination CephMgrAvailableModuleOption

+ SMTPFromName CephMgrAvailableModuleOption

+ SMTPHost CephMgrAvailableModuleOption

+ SMTPPassword CephMgrAvailableModuleOption

+ SMTPPort CephMgrAvailableModuleOption

+ SMTPSender CephMgrAvailableModuleOption

+ SMTPSsl CephMgrAvailableModuleOption

+ SMTPUser CephMgrAvailableModuleOption

+ type CephMgrMap struct

+ ActiveAddr string

+ ActiveAddrs CephMgrActiveAddresses

+ ActiveChange string

+ ActiveClients []CephMgrActiveClient

+ ActiveGid int

+ ActiveMgrFeatures int64

+ ActiveName string

+ AlwaysOnModules CephMgrAlwaysOnModules

+ Available bool

+ AvailableModules []CephMgrAvailableModule

+ Epoch int

+ LastFailureOsdEpoch int

+ Modules []string

+ Services CephMgrServices

+ Standbys []CephMgrStandby

+ type CephMgrServices struct

+ Dashboard string

+ Prometheus string

+ type CephMgrStandby struct

+ AvailableModules []CephMgrAvailableModule

+ Gid int

+ MgrFeatures int64

+ Name string

+ type CephMon struct

+ Addr string

+ CrushLocation string

+ Name string

+ Priority int

+ PublicAddr string

+ PublicAddrs struct{ ... }

+ Rank int

+ Weight int

+ type CephMonFeatures struct

+ Optional []interface{}

+ Persistent []string

+ type CephMonMap struct

+ Created time.Time

+ DisallowedLeaders string

+ ElectionStrategy int

+ Epoch int

+ Features CephMonFeatures

+ Fsid string

+ MinMonRelease int

+ MinMonReleaseName string

+ Modified time.Time

+ Mons []CephMon

+ Quorum []int

+ RemovedRanks string

+ StretchMode bool

+ TiebreakerMon string

+ type CephOsdMap struct

+ Epoch int

+ NumInOsds int

+ NumOsds int

+ NumRemappedPgs int

+ NumUpOsds int

+ OsdInSince int

+ OsdUpSince int

+ type CephPgMap struct

+ BytesAvail int64

+ BytesTotal int64

+ BytesUsed int64

+ DataBytes int64

+ NumObjects int

+ NumPgs int

+ NumPools int

+ PgsByState []struct{ ... }

+ ReadBytesSec int

+ ReadOpPerSec int

+ WriteBytesSec int

+ WriteOpPerSec int

+ type CephServiceMap struct

+ Epoch int

+ Modified string

+ Services struct{}

+ type Client struct

+ func NewClient(baseURL string, opts ...Option) *Client

+ func (c *Client) ACL(ctx context.Context) (acl ACLs, err error)

+ func (c *Client) APIToken(tokenID, secret string)

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

+ func (c *Client) ClusterStorage(ctx context.Context, name string) (storage *ClusterStorage, err error)

+ func (c *Client) ClusterStorages(ctx context.Context) (storages ClusterStorages, err error)

+ func (c *Client) Delete(ctx context.Context, p string, v interface{}) error

+ func (c *Client) DeleteClusterStorage(ctx context.Context, name string) (*Task, error)

+ func (c *Client) Domain(ctx context.Context, realm string) (domain *Domain, err error)

+ func (c *Client) Domains(ctx context.Context) (domains Domains, err error)

+ func (c *Client) Get(ctx context.Context, p string, v interface{}) error

+ func (c *Client) GetWithParams(ctx context.Context, p string, d interface{}, v interface{}) error

+ func (c *Client) Group(ctx context.Context, groupid string) (group *Group, err error)

+ func (c *Client) Groups(ctx context.Context) (groups Groups, err error)

+ func (c *Client) Login(ctx context.Context, username, password string) error

+ func (c *Client) NewClusterStorage(ctx context.Context, options ...ClusterStorageOptions) (*Task, error)

+ func (c *Client) NewDomain(ctx context.Context, realm string, domainType DomainType) error

+ func (c *Client) NewGroup(ctx context.Context, groupid, comment string) error

+ func (c *Client) NewPool(ctx context.Context, poolid, comment string) error

+ func (c *Client) NewRole(ctx context.Context, roleID string, privs string) (err error)

+ func (c *Client) NewUser(ctx context.Context, user *NewUser) (err error)

+ func (c *Client) Node(ctx context.Context, name string) (node *Node, err error)

+ func (c *Client) Nodes(ctx context.Context) (ns NodeStatuses, err error)

+ func (c *Client) Password(ctx context.Context, userid, password string) error

+ func (c *Client) Permissions(ctx context.Context, o *PermissionsOptions) (permissions Permissions, err error)

+ func (c *Client) Pool(ctx context.Context, poolid string, filters ...string) (pool *Pool, err error)

+ func (c *Client) Pools(ctx context.Context) (pools Pools, err error)

+ func (c *Client) Post(ctx context.Context, p string, d interface{}, v interface{}) error

+ func (c *Client) Put(ctx context.Context, p string, d interface{}, v interface{}) error

+ func (c *Client) Req(ctx context.Context, method, path string, data []byte, v interface{}) error

+ func (c *Client) Role(ctx context.Context, roleid string) (role Permission, err error)

+ func (c *Client) Roles(ctx context.Context) (roles Roles, err error)

+ func (c *Client) TermWebSocket(path string, term *Term) (chan []byte, chan []byte, chan error, func() error, error)

+ func (c *Client) Ticket(ctx context.Context, credentials *Credentials) (*Session, error)

+ func (c *Client) UpdateACL(ctx context.Context, acl ACL) error

+ func (c *Client) UpdateClusterStorage(ctx context.Context, name string, options ...ClusterStorageOptions) (*Task, error)

+ func (c *Client) Upload(path string, fields map[string]string, file *os.File, v interface{}) error

+ func (c *Client) User(ctx context.Context, userid string) (user *User, err error)

+ func (c *Client) Users(ctx context.Context) (users Users, err error)

+ func (c *Client) VNCWebSocket(path string, vnc *VNC) (chan []byte, chan []byte, chan error, func() error, error)

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

+ type Cluster struct

+ ID string

+ Name string

+ Nodes NodeStatuses

+ Quorate int

+ Version int

+ func (cl *Cluster) Ceph(ctx context.Context) (*Ceph, error)

+ func (cl *Cluster) CheckID(ctx context.Context, vmid int) (bool, error)

+ func (cl *Cluster) DeleteSDNVNet(ctx context.Context, name string) error

+ func (cl *Cluster) DeleteSDNZone(ctx context.Context, name string) error

+ func (cl *Cluster) FWGroup(ctx context.Context, name string) (group *FirewallSecurityGroup, err error)

+ func (cl *Cluster) FWGroups(ctx context.Context) (groups []*FirewallSecurityGroup, err error)

+ func (cl *Cluster) NewFWGroup(ctx context.Context, group *FirewallSecurityGroup) error

+ func (cl *Cluster) NewSDNVNet(ctx context.Context, vnet *VNetOptions) error

+ func (cl *Cluster) NewSDNZone(ctx context.Context, zone *SDNZoneOptions) error

+ func (cl *Cluster) NextID(ctx context.Context) (int, error)

+ func (cl *Cluster) Resources(ctx context.Context, filters ...string) (rs ClusterResources, err error)

+ func (cl *Cluster) SDNApply(ctx context.Context) error

+ func (cl *Cluster) SDNSubnets(ctx context.Context, VNetName string) (subnets []*VNetSubnet, err error)

+ func (cl *Cluster) SDNVNet(ctx context.Context, name string) (vnet *VNet, err error)

+ func (cl *Cluster) SDNVNets(ctx context.Context) (vnets []*VNet, err error)

+ func (cl *Cluster) SDNZone(ctx context.Context, name string) (zone *SDNZone, err error)

+ func (cl *Cluster) SDNZones(ctx context.Context, filters ...string) (zones []*SDNZone, err error)

+ func (cl *Cluster) Status(ctx context.Context) error

+ func (cl *Cluster) Tasks(ctx context.Context) (Tasks, error)

+ func (cl *Cluster) UnmarshalJSON(b []byte) error

+ func (cl *Cluster) UpdateSDNVNet(ctx context.Context, vnet *VNet) error

+ func (cl *Cluster) UpdateSDNZone(ctx context.Context, zone *SDNZoneOptions) error

+ type ClusterCephStatus struct

+ ElectionEpoch int

+ Fsid string

+ Fsmap CephFsMap

+ Health CephHealth

+ Mgrmap CephMgrMap

+ Monmap CephMonMap

+ Osdmap CephOsdMap

+ Pgmap CephPgMap

+ ProgressEvents struct{}

+ Quorum []int

+ QuorumAge int

+ QuorumNames []string

+ Servicemap CephServiceMap

+ type ClusterResource struct

+ CGroupMode uint64

+ CPU float64

+ Content string

+ Disk uint64

+ DiskRead uint64

+ DiskWrite uint64

+ HAstate string

+ ID string

+ Level string

+ MaxCPU uint64

+ MaxDisk uint64

+ MaxMem uint64

+ Mem uint64

+ Name string

+ NetIn uint64

+ NetOut uint64

+ Node string

+ PluginType string

+ Pool string

+ Shared uint64

+ Status string

+ Storage string

+ Tags string

+ Template uint64

+ Type string

+ Uptime uint64

+ VMID uint64

+ type ClusterResources []*ClusterResource

+ type ClusterStorage struct

+ Content string

+ Digest string

+ Path string

+ Storage string

+ Thinpool string

+ Type string

+ VgName string

+ type ClusterStorageOptions struct

+ Name string

+ Value string

+ type ClusterStorages []*ClusterStorage

+ type ConsolidationFunction string

+ type Container struct

+ CPUs int

+ ContainerConfig *ContainerConfig

+ MaxDisk uint64

+ MaxMem uint64

+ MaxSwap uint64

+ Name string

+ Node string

+ Status string

+ Tags string

+ Uptime uint64

+ VMID StringOrUint64

+ func (c *Container) AddTag(ctx context.Context, value string) (*Task, error)

+ func (c *Container) Clone(ctx context.Context, params *ContainerCloneOptions) (newid int, task *Task, err error)

+ func (c *Container) Config(ctx context.Context, options ...ContainerOption) (*Task, error)

+ func (c *Container) Delete(ctx context.Context) (task *Task, err error)

+ func (c *Container) DeleteFirewallAlias(ctx context.Context, name string) error

+ func (c *Container) DeleteFirewallIPSet(ctx context.Context, name string, force bool) error

+ func (c *Container) DeleteFirewallIPSetEntry(ctx context.Context, name string, cidr string, digest string) error

+ func (c *Container) DeleteFirewallRule(ctx context.Context, rulePos int) error

+ func (c *Container) DeleteSnapshot(ctx context.Context, snapshot string) (task *Task, err error)

+ func (c *Container) Feature(ctx context.Context) (hasFeature bool, err error)

+ func (c *Container) Firewall(ctx context.Context) (firewall *Firewall, err error)

+ func (c *Container) FirewallRules(ctx context.Context) (rules []*FirewallRule, err error)

+ func (c *Container) GetFirewallAlias(ctx context.Context, name string) (alias *FirewallAlias, err error)

+ func (c *Container) GetFirewallAliases(ctx context.Context) (aliases []*FirewallAlias, err error)

+ func (c *Container) GetFirewallIPSet(ctx context.Context) (ipsets []*FirewallIPSet, err error)

+ func (c *Container) GetFirewallIPSetEntries(ctx context.Context, name string) (entries []*FirewallIPSetEntry, err error)

+ func (c *Container) GetFirewallIPSetEntry(ctx context.Context, name string, cidr string) (entry *FirewallIPSetEntry, err error)

+ func (c *Container) GetFirewallOptions(ctx context.Context) (options *FirewallVirtualMachineOption, err error)

+ func (c *Container) GetFirewallRule(ctx context.Context, rulePos int) (rule *FirewallRule, err error)

+ func (c *Container) GetSnapshot(ctx context.Context, snapshot string) (snap []*ContainerSnapshot, err error)

+ func (c *Container) GetSnapshotConfig(ctx context.Context, snapshot string) (config map[string]interface{}, err error)

+ func (c *Container) HasTag(value string) bool

+ func (c *Container) Interfaces(ctx context.Context) (interfaces ContainerInterfaces, err error)

+ func (c *Container) Migrate(ctx context.Context, params *ContainerMigrateOptions) (task *Task, err error)

+ func (c *Container) MoveVolume(ctx context.Context, params *VirtualMachineMoveDiskOptions) (task *Task, err error)

+ func (c *Container) NewFirewallAlias(ctx context.Context, alias *FirewallAlias) error

+ func (c *Container) NewFirewallIPSet(ctx context.Context, ipset FirewallIPSetCreationOption) error

+ func (c *Container) NewFirewallIPSetEntry(ctx context.Context, name string, entry FirewallIPSetEntryCreationOption) error

+ func (c *Container) NewFirewallRule(ctx context.Context, rule *FirewallRule) error

+ func (c *Container) NewSnapshot(ctx context.Context, snapName string) (task *Task, err error)

+ func (c *Container) RRDData(ctx context.Context, timeframe Timeframe, ...) (rrddata []*RRDData, err error)

+ func (c *Container) Reboot(ctx context.Context) (task *Task, err error)

+ func (c *Container) RemoveTag(ctx context.Context, value string) (*Task, error)

+ func (c *Container) Resize(ctx context.Context, disk, size string) (task *Task, err error)

+ func (c *Container) Resume(ctx context.Context) (task *Task, err error)

+ func (c *Container) RollbackSnapshot(ctx context.Context, snapshot string, start bool) (task *Task, err error)

+ func (c *Container) Shutdown(ctx context.Context, force bool, timeout int) (task *Task, err error)

+ func (c *Container) Snapshots(ctx context.Context) (snapshots []*ContainerSnapshot, err error)

+ func (c *Container) SplitTags()

+ func (c *Container) Start(ctx context.Context) (task *Task, err error)

+ func (c *Container) Stop(ctx context.Context) (task *Task, err error)

+ func (c *Container) Suspend(ctx context.Context) (task *Task, err error)

+ func (c *Container) Template(ctx context.Context) error

+ func (c *Container) TermProxy(ctx context.Context) (term *Term, err error)

+ func (c *Container) TermWebSocket(term *Term) (chan []byte, chan []byte, chan error, func() error, error)

+ func (c *Container) UpdateFirewallAlias(ctx context.Context, name string, alias *FirewallAlias) error

+ func (c *Container) UpdateFirewallIPSetEntry(ctx context.Context, name string, cidr string, ...) error

+ func (c *Container) UpdateFirewallOptions(ctx context.Context, options *FirewallVirtualMachineOption) error

+ func (c *Container) UpdateFirewallRule(ctx context.Context, rulePos int, rule *FirewallRule) error

+ func (c *Container) UpdateSnapshot(ctx context.Context, snapshot string) error

+ func (c *Container) VNCProxy(ctx context.Context, vncOptions VNCProxyOptions) (vnc *VNC, err error)

+ func (c *Container) VNCWebSocket(vnc *VNC) (chan []byte, chan []byte, chan error, func() error, error)

+ type ContainerCloneOptions struct

+ BWLimit uint64

+ Description string

+ Full uint8

+ Hostname string

+ NewID int

+ Pool string

+ SnapName string

+ Storage string

+ Target string

+ type ContainerConfig struct

+ Arch string

+ CMode string

+ CPULimit int

+ CPUUnits int

+ Console IntOrBool

+ Cores int

+ Debug IntOrBool

+ Description string

+ Dev0 string

+ Dev1 string

+ Dev2 string

+ Dev3 string

+ Dev4 string

+ Dev5 string

+ Dev6 string

+ Dev7 string

+ Dev8 string

+ Dev9 string

+ Devs map[string]string

+ Digest string

+ Features string

+ HookScript string

+ Hostname string

+ LXC [][]string

+ Lock string

+ Memory int

+ Mp0 string

+ Mp1 string

+ Mp2 string

+ Mp3 string

+ Mp4 string

+ Mp5 string

+ Mp6 string

+ Mp7 string

+ Mp8 string

+ Mp9 string

+ Mps map[string]string

+ Nameserver string

+ Net0 string

+ Net1 string

+ Net2 string

+ Net3 string

+ Net4 string

+ Net5 string

+ Net6 string

+ Net7 string

+ Net8 string

+ Net9 string

+ Nets map[string]string

+ OSType string

+ OnBoot IntOrBool

+ Protection IntOrBool

+ RootFS string

+ SearchDomain string

+ Startup string

+ Swap int

+ TTY int

+ Tags string

+ TagsSlice []string

+ Template IntOrBool

+ Timezone string

+ Unprivileged IntOrBool

+ Unused0 string

+ Unused1 string

+ Unused2 string

+ Unused3 string

+ Unused4 string

+ Unused5 string

+ Unused6 string

+ Unused7 string

+ Unused8 string

+ Unused9 string

+ Unuseds map[string]string

+ func (cc *ContainerConfig) MergeDevs() map[string]string

+ func (cc *ContainerConfig) MergeMps() map[string]string

+ func (cc *ContainerConfig) MergeNets() map[string]string

+ func (cc *ContainerConfig) MergeUnuseds() map[string]string

+ func (cc *ContainerConfig) UnmarshalJSON(data []byte) error

+ type ContainerInterface struct

+ HWAddr string

+ Inet string

+ Inet6 string

+ Name string

+ type ContainerInterfaces []*ContainerInterface

+ type ContainerMigrateOptions struct

+ BWLimit uint64

+ Online IntOrBool

+ Restart IntOrBool

+ Target string

+ type ContainerOption struct

+ Name string

+ Value interface{}

+ type ContainerOptions []*ContainerOption

+ type ContainerSnapshot struct

+ Description string

+ Name string

+ Parent string

+ SnapshotCreationTime int64

+ type Containers []*Container

+ type Content struct

+ CTime uint64

+ Content string

+ Format string

+ Node string

+ Notes string

+ Path string

+ Size StringOrUint64

+ Storage string

+ URL string

+ Used StringOrUint64

+ VolID string

+ type Credentials struct

+ Otp string

+ Password string

+ Path string

+ Privs string

+ Realm string

+ Username string

+ type CustomCertificate struct

+ Certificates string

+ Force bool

+ Key string

+ Restart bool

+ type Domain struct

+ ACRValues string

+ AutoCreate IntOrBool

+ BaseDN string

+ BindDN string

+ CAPath string

+ CaseSensitive IntOrBool

+ Cert string

+ CertKey string

+ ClientID string

+ ClientKey string

+ Comment string

+ Default IntOrBool

+ DeleteList string

+ Digest string

+ Domain string

+ Filter string

+ GroupClasses string

+ GroupDN string

+ GroupFilter string

+ GroupName string

+ IssuerURL string

+ Mode string

+ Password string

+ Port int

+ Prompt string

+ Realm string

+ SSLVersion string

+ Scopes string

+ Secure IntOrBool

+ Server1 string

+ Server2 string

+ SyncAttributes string

+ SyncDefaults string

+ TFA string

+ Type string

+ UserAttr string

+ UserClasses string

+ Verify IntOrBool

+ func (d *Domain) Delete(ctx context.Context) error

+ func (d *Domain) Sync(ctx context.Context, options DomainSyncOptions) error

+ func (d *Domain) Update(ctx context.Context) error

+ type DomainSyncOptions struct

+ DryRun bool

+ EnableNew bool

+ RemoveVanished string

+ Scope string

+ type DomainType string

+ type Domains []*Domain

+ type Firewall struct

+ Aliases []*FirewallAlias

+ Ipset []*FirewallIPSet

+ Options *FirewallNodeOption

+ Rules []*FirewallRule

+ type FirewallAlias struct

+ Cidr string

+ Comment string

+ Digest string

+ Name string

+ type FirewallIPSet struct

+ Comment string

+ Digest string

+ Name string

+ type FirewallIPSetCreationOption struct

+ Comment string

+ Digest string

+ Name string

+ Rename string

+ type FirewallIPSetEntry struct

+ CIDR string

+ Comment string

+ Digest string

+ NoMatch bool

+ type FirewallIPSetEntryCreationOption struct

+ CIDR string

+ Comment string

+ NoMatch bool

+ type FirewallIPSetEntryUpdateOption struct

+ Comment string

+ Digest string

+ NoMatch bool

+ type FirewallNodeOption struct

+ Enable bool

+ LogLevelIn string

+ LogLevelOut string

+ LogNfConntrack bool

+ NFConntrackAllowInvalid bool

+ NFConntrackMax int

+ NFConntrackTCPTimeoutEstablished int

+ NFConntrackTCPTimeoutSynRecv int

+ Nosmurfs bool

+ Ntp bool

+ ProtectionSynflood bool

+ ProtectionSynfloodBurst int

+ ProtectionSynfloodRate int

+ SmurfLogLevel string

+ TCPFlagsLogLevel string

+ TCPflags bool

+ type FirewallRule struct

+ Action string

+ Comment string

+ Dest string

+ Dport string

+ Enable int

+ IcmpType string

+ Iface string

+ Log string

+ Macro string

+ Pos int

+ Proto string

+ Source string

+ Sport string

+ Type string

+ func (r *FirewallRule) IsEnable() bool

+ type FirewallSecurityGroup struct

+ Comment string

+ Group string

+ Rules []*FirewallRule

+ func (g *FirewallSecurityGroup) Delete(ctx context.Context) error

+ func (g *FirewallSecurityGroup) GetRules(ctx context.Context) ([]*FirewallRule, error)

+ func (g *FirewallSecurityGroup) RuleCreate(ctx context.Context, rule *FirewallRule) error

+ func (g *FirewallSecurityGroup) RuleDelete(ctx context.Context, rulePos int) error

+ func (g *FirewallSecurityGroup) RuleUpdate(ctx context.Context, rule *FirewallRule) error

+ type FirewallVirtualMachineOption struct

+ Dhcp bool

+ Enable bool

+ Ipfilter bool

+ LogLevelIn string

+ LogLevelOut string

+ Macfilter bool

+ Ntp bool

+ PolicyIn string

+ PolicyOut string

+ Radv bool

+ type Group struct

+ Comment string

+ GroupID string

+ Members []string

+ Users string

+ func (g *Group) Delete(ctx context.Context) error

+ func (g *Group) Update(ctx context.Context) error

+ type Groups []*Group

+ type HA struct

+ Managed int

+ type IPAM struct

+ Gateway int

+ Hostname string

+ IP string

+ Mac string

+ Subnet string

+ VMID string

+ VNet string

+ Zone string

+ type ISO struct

+ func (i *ISO) Delete(ctx context.Context) (*Task, error)

+ type ISOs []*ISO

+ type IntOrBool bool

+ func (b *IntOrBool) MarshalJSON() ([]byte, error)

+ func (b *IntOrBool) UnmarshalJSON(i []byte) error

+ type IsTemplate bool

+ func (it *IsTemplate) UnmarshalJSON(b []byte) error

+ type Ksm struct

+ Shared int64

+ type LeveledLogger struct

+ Level int

+ func (l *LeveledLogger) Debugf(format string, v ...interface{})

+ func (l *LeveledLogger) Errorf(format string, v ...interface{})

+ func (l *LeveledLogger) Infof(format string, v ...interface{})

+ func (l *LeveledLogger) Warnf(format string, v ...interface{})

+ type LeveledLoggerInterface interface

+ Debugf func(format string, v ...interface{})

+ Errorf func(format string, v ...interface{})

+ Infof func(format string, v ...interface{})

+ Warnf func(format string, v ...interface{})

+ type Log map[int]string

+ func (l *Log) UnmarshalJSON(b []byte) error

+ type Memory struct

+ Free uint64

+ Total uint64

+ Used uint64

+ type NetRange struct

+ EndAddress string

+ StartAddress string

+ type NewAPIToken struct

+ FullTokenID string

+ Info interface{}

+ Value string

+ type NewUser struct

+ Comment string

+ Email string

+ Enable bool

+ Expire int

+ Firstname string

+ Groups []string

+ Keys []string

+ Lastname string

+ Password string

+ UserID string

+ type Node struct

+ CPU float64

+ CPUInfo CPUInfo

+ Idle int

+ Ksm Ksm

+ Kversion string

+ LoadAvg []string

+ Memory Memory

+ Name string

+ PVEVersion string

+ RootFS RootFS

+ Swap Memory

+ Uptime uint64

+ Wait float64

+ func (n *Node) Appliances(ctx context.Context) (appliances Appliances, err error)

+ func (n *Node) Container(ctx context.Context, vmid int) (*Container, error)

+ func (n *Node) Containers(ctx context.Context) (c Containers, err error)

+ func (n *Node) DeleteCustomCertificate(ctx context.Context) error

+ func (n *Node) DownloadAppliance(ctx context.Context, template, storage string) (ret string, err error)

+ func (n *Node) FirewallGetRules(ctx context.Context) (rules []*FirewallRule, err error)

+ func (n *Node) FirewallOptionGet(ctx context.Context) (firewallOption *FirewallNodeOption, err error)

+ func (n *Node) FirewallOptionSet(ctx context.Context, firewallOption *FirewallNodeOption) error

+ func (n *Node) FirewallRulesCreate(ctx context.Context, rule *FirewallRule) error

+ func (n *Node) FirewallRulesDelete(ctx context.Context, rulePos int) error

+ func (n *Node) FirewallRulesUpdate(ctx context.Context, rule *FirewallRule) error

+ func (n *Node) GetCustomCertificates(ctx context.Context) (certs *NodeCertificates, err error)

+ func (n *Node) IPAM(ctx context.Context) (ipam []*IPAM, err error)

+ func (n *Node) Network(ctx context.Context, iface string) (network *NodeNetwork, err error)

+ func (n *Node) NetworkReload(ctx context.Context) (*Task, error)

+ func (n *Node) Networks(ctx context.Context, ifaceType ...string) (networks NodeNetworks, err error)

+ func (n *Node) NewContainer(ctx context.Context, vmid int, options ...ContainerOption) (*Task, error)

+ func (n *Node) NewNetwork(ctx context.Context, network *NodeNetwork) (task *Task, err error)

+ func (n *Node) NewVirtualMachine(ctx context.Context, vmid int, options ...VirtualMachineOption) (*Task, error)

+ func (n *Node) Storage(ctx context.Context, name string) (storage *Storage, err error)

+ func (n *Node) StorageBackup(ctx context.Context) (*Storage, error)

+ func (n *Node) StorageDownloadURL(ctx context.Context, StorageDownloadURLOptions *StorageDownloadURLOptions) (ret string, err error)

+ func (n *Node) StorageISO(ctx context.Context) (*Storage, error)

+ func (n *Node) StorageImages(ctx context.Context) (*Storage, error)

+ func (n *Node) StorageRootDir(ctx context.Context) (*Storage, error)

+ func (n *Node) StorageVZTmpl(ctx context.Context) (*Storage, error)

+ func (n *Node) Storages(ctx context.Context) (storages Storages, err error)

+ func (n *Node) TermProxy(ctx context.Context) (term *Term, err error)

+ func (n *Node) TermWebSocket(term *Term) (chan []byte, chan []byte, chan error, func() error, error)

+ func (n *Node) UploadCustomCertificate(ctx context.Context, cert *CustomCertificate) error

+ func (n *Node) VNCWebSocket(vnc *VNC) (chan []byte, chan []byte, chan error, func() error, error)

+ func (n *Node) Version(ctx context.Context) (version *Version, err error)

+ func (n *Node) VirtualMachine(ctx context.Context, vmid int) (*VirtualMachine, error)

+ func (n *Node) VirtualMachines(ctx context.Context) (vms VirtualMachines, err error)

+ func (n *Node) VzTmpl(ctx context.Context, template, storage string) (*VzTmpl, error)

+ func (n *Node) VzTmpls(ctx context.Context, storage string) (templates VzTmpls, err error)

+ func (n *Node) Vzdump(ctx context.Context, params *VirtualMachineBackupOptions) (task *Task, err error)

+ func (n *Node) VzdumpExtractConfig(ctx context.Context, volume string) (*VzdumpConfig, error)

+ type NodeCertificate struct

+ Filename string

+ Fingerprint string

+ Issuer string

+ NotAfter string

+ NotBefore string

+ Pem string

+ PublicKeyBits int

+ PublicKeyType string

+ San []string

+ Subject string

+ type NodeCertificates []*NodeCertificate

+ type NodeNetwork struct

+ Active StringOrInt

+ Address string

+ Address6 string

+ Autostart int

+ BondMode string

+ BondPrimary string

+ BondXmit string

+ BondXmitHashPolicy string

+ BridgeFd string

+ BridgePorts string

+ BridgeStp string

+ BridgeVLANAware int

+ CIDR string

+ CIDR6 string

+ Comments string

+ Comments6 string

+ Gateway string

+ Gateway6 string

+ Iface string

+ MTU string

+ Method string

+ Method6 string

+ Netmask string

+ Netmask6 string

+ Node string

+ NodeAPI *Node

+ OVSBonds string

+ OVSBridge string

+ OVSOptions string

+ OVSPorts string

+ OVSTags string

+ Priority int

+ Slaves string

+ Type string

+ VLANID string

+ VLANRawDevice string

+ func (nw *NodeNetwork) Delete(ctx context.Context) (task *Task, err error)

+ func (nw *NodeNetwork) Update(ctx context.Context) error

+ type NodeNetworks []*NodeNetwork

+ type NodeStatus struct

+ CPU float64

+ Disk uint64

+ ID string

+ IP string

+ Level string

+ Local int

+ MaxCPU int

+ MaxDisk uint64

+ MaxMem uint64

+ Mem uint64

+ Name string

+ Node string

+ NodeID int

+ Online int

+ SSLFingerprint string

+ Status string

+ Type string

+ Uptime uint64

+ type NodeStatuses []*NodeStatus

+ type Option func(*Client)

+ func WithAPIToken(tokenID, secret string) Option

+ func WithClient(client *http.Client) Option

+ func WithCredentials(credentials *Credentials) Option

+ func WithHTTPClient(client *http.Client) Option

+ func WithLogger(logger LeveledLoggerInterface) Option

+ func WithLogins(username, password string) Option

+ func WithSession(ticket, CSRFPreventionToken string) Option

+ func WithUserAgent(ua string) Option

+ type PendingConfigItem struct

+ Delete *int

+ Key string

+ Pending interface{}

+ Value interface{}

+ type PendingConfiguration []PendingConfigItem

+ type Permission map[string]IntOrBool

+ type Permissions map[string]Permission

+ type PermissionsOptions struct

+ Path string

+ UserID string

+ type Pool struct

+ Comment string

+ Members []ClusterResource

+ PoolID string

+ func (p *Pool) Delete(ctx context.Context) error

+ func (p *Pool) Update(ctx context.Context, opt *PoolUpdateOption) error

+ type PoolUpdateOption struct

+ Comment string

+ Delete bool

+ Storage string

+ VirtualMachines string

+ type Pools []*Pool

+ type RRDData struct

+ CPU float64

+ Disk int

+ DiskRead float64

+ DiskWrite float64

+ MaxCPU int

+ MaxDisk uint64

+ MaxMem uint64

+ Mem float64

+ NetIn float64

+ NetOut float64

+ Time uint64

+ type Role struct

+ Privs string

+ RoleID string

+ Special IntOrBool

+ func (r *Role) Delete(ctx context.Context) error

+ func (r *Role) Update(ctx context.Context) error

+ type Roles []*Role

+ type RootFS struct

+ Avail uint64

+ Free uint64

+ Total uint64

+ Used uint64

+ type SDNZone struct

+ DHCP string

+ DNS string

+ DNSZone string

+ IPAM string

+ MTU int

+ Name string

+ Nodes []string

+ Pending bool

+ ReverseDNS string

+ State string

+ Type string

+ type SDNZoneOptions struct

+ AdvertiseSubnets bool

+ Bridge string

+ BridgeDisableMACLearning bool

+ Controller string

+ DHCP string

+ DNS string

+ DNSZone string

+ DPID int

+ DisableARPNDSuppression bool

+ ExitNodes string

+ ExitNodesLocalRouting bool

+ ExitNodesPrimary string

+ Fabric string

+ IPAM string

+ MAC string

+ MTU int

+ Name string

+ Nodes string

+ Peers string

+ RTImport string

+ ReverseDNS string

+ Tag uint

+ Type string

+ VLANProtocol string

+ VRFVXLAN int

+ VXLANPort uint16

+ type Separator = string

+ type Session struct

+ CSRFPreventionToken string

+ Cap map[string]map[string]int

+ ClusterName string

+ Ticket string

+ Username string

+ type Snapshot struct

+ Description string

+ Name string

+ Parent string

+ Snapstate string

+ Snaptime int64

+ Vmstate int

+ type Storage struct

+ Active int

+ Avail uint64

+ Content string

+ Enabled int

+ Name string

+ Node string

+ Shared int

+ Storage string

+ Total uint64

+ Type string

+ Used uint64

+ UsedFraction float64

+ func (s *Storage) Backup(ctx context.Context, name string) (backup *Backup, err error)

+ func (s *Storage) DeleteContent(ctx context.Context, content string) (*Task, error)

+ func (s *Storage) DownloadURL(ctx context.Context, content, filename, url string) (*Task, error)

+ func (s *Storage) DownloadURLWithHash(ctx context.Context, content, filename, url string, ...) (*Task, error)

+ func (s *Storage) GetContent(ctx context.Context) (content []*StorageContent, err error)

+ func (s *Storage) ISO(ctx context.Context, name string) (iso *ISO, err error)

+ func (s *Storage) Upload(content, file string) (*Task, error)

+ func (s *Storage) UploadWithHash(content, file string, storageFilename *string, ...) (*Task, error)

+ func (s *Storage) UploadWithName(content, file string, storageFilename string) (*Task, error)

+ func (s *Storage) VzTmpl(ctx context.Context, name string) (vztmpl *VzTmpl, err error)

+ type StorageContent struct

+ Ctime uint64

+ Encryption string

+ Format string

+ Notes string

+ Parent string

+ Protection bool

+ Size uint64

+ Used uint64

+ VMID uint64

+ Verification string

+ Volid string

+ type StorageDownloadURLOptions struct

+ Checksum string

+ ChecksumAlgorithm string

+ Compression string

+ Content string

+ Filename string

+ Node string

+ Storage string

+ URL string

+ VerifyCertificates IntOrBool

+ type Storages []*Storage

+ type StringOrFloat64 float64

+ func (d *StringOrFloat64) UnmarshalJSON(b []byte) error

+ type StringOrInt int

+ func (d *StringOrInt) UnmarshalJSON(b []byte) error

+ type StringOrUint64 uint64

+ func (d *StringOrUint64) UnmarshalJSON(b []byte) error

+ type TFA struct

+ Realm string

+ Types []string

+ User string

+ type Task struct

+ Duration time.Duration

+ EndTime time.Time

+ ExitStatus string

+ ID string

+ IsCompleted bool

+ IsFailed bool

+ IsRunning bool

+ IsSuccessful bool

+ Node string

+ PID uint64

+ PStart uint64

+ Saved string

+ StartTime time.Time

+ Status string

+ Type string

+ UPID UPID

+ User string

+ func NewTask(upid UPID, client *Client) *Task

+ func (t *Task) Log(ctx context.Context, start, limit int) (l Log, err error)

+ func (t *Task) Ping(ctx context.Context) error

+ func (t *Task) Stop(ctx context.Context) error

+ func (t *Task) UnmarshalJSON(b []byte) error

+ func (t *Task) Wait(ctx context.Context, interval, max time.Duration) error

+ func (t *Task) WaitFor(ctx context.Context, seconds int) error

+ func (t *Task) WaitForCompleteStatus(ctx context.Context, timesNum int, steps ...int) (status bool, completed bool, err error)

+ func (t *Task) Watch(ctx context.Context, start int) (chan string, error)

+ type Tasks []*Task

+ type Term struct

+ Port StringOrInt

+ Ticket string

+ UPID string

+ User string

+ type Time struct

+ Localtime uint64

+ Time uint64

+ Timezone string

+ type Timeframe string

+ type Token struct

+ Comment string

+ Expire int

+ Privsep IntOrBool

+ TokenID string

+ type Tokens []*Token

+ type UPID string

+ type User struct

+ Comment string

+ Email string

+ Enable IntOrBool

+ Expire int

+ Firstname string

+ Groups []string

+ Keys string

+ Lastname string

+ RealmType string

+ TFALockedUntil string

+ TOTPLocked IntOrBool

+ Tokens map[string]Token

+ UserID string

+ func (u *User) APIToken(ctx context.Context, tokenid string) (token Token, err error)

+ func (u *User) Delete(ctx context.Context) error

+ func (u *User) DeleteAPIToken(ctx context.Context, tokenid string) error

+ func (u *User) GetAPITokens(ctx context.Context) (tokens Tokens, err error)

+ func (u *User) GetTFA(ctx context.Context) (tfa TFA, err error)

+ func (u *User) NewAPIToken(ctx context.Context, token Token) (newtoken NewAPIToken, err error)

+ func (u *User) UnlockTFA(ctx context.Context) error

+ func (u *User) Update(ctx context.Context) error

+ func (u *User) UpdateAPIToken(ctx context.Context, tokenid string) (token Token, err error)

+ type Users []*User

+ type VNC struct

+ Cert string

+ Password string

+ Port StringOrInt

+ Ticket string

+ UPID string

+ User string

+ type VNCConfig struct

+ GeneratePassword bool

+ Websocket bool

+ type VNCProxyOptions struct

+ Height int

+ Websocket string

+ Width int

+ type VNet struct

+ Name string

+ Tag uint16

+ Type string

+ VlanAware int

+ Zone string

+ type VNetOptions struct

+ Alias string

+ IsolatePorts bool

+ Name string

+ Tag uint32

+ Type string

+ VlanAware bool

+ Zone string

+ type VNetSubnet struct

+ CIDR string

+ DhcpRange []NetRange

+ Gateway string

+ ID string

+ Netmask string

+ Network string

+ SNAT int

+ Type string

+ VNet string

+ Zone string

+ type Version struct

+ Release string

+ RepoID string

+ Version string

+ type VirtualMachine struct

+ Agent IntOrBool

+ CPU float64

+ CPUs int

+ Disk uint64

+ DiskRead uint64

+ DiskWrite uint64

+ HA HA

+ Lock string

+ MaxDisk uint64

+ MaxMem uint64

+ Mem uint64

+ Name string

+ NetIn uint64

+ Netout uint64

+ Node string

+ PID StringOrUint64

+ QMPStatus string

+ RunningMachine string

+ RunningQemu string

+ Status string

+ Tags string

+ Template IsTemplate

+ Uptime uint64

+ VMID StringOrUint64

+ VirtualMachineConfig *VirtualMachineConfig

+ func (v *VirtualMachine) AddTag(ctx context.Context, value string) (*Task, error)

+ func (v *VirtualMachine) AgentExec(ctx context.Context, command []string, inputData string) (pid int, err error)

+ func (v *VirtualMachine) AgentExecStatus(ctx context.Context, pid int) (status *AgentExecStatus, err error)

+ func (v *VirtualMachine) AgentGetNetworkIFaces(ctx context.Context) (iFaces []*AgentNetworkIface, err error)

+ func (v *VirtualMachine) AgentOsInfo(ctx context.Context) (info *AgentOsInfo, err error)

+ func (v *VirtualMachine) AgentSetUserPassword(ctx context.Context, password string, username string) error

+ func (v *VirtualMachine) Clone(ctx context.Context, params *VirtualMachineCloneOptions) (newid int, task *Task, err error)

+ func (v *VirtualMachine) CloudInit(ctx context.Context, ...) error

+ func (v *VirtualMachine) Config(ctx context.Context, options ...VirtualMachineOption) (*Task, error)

+ func (v *VirtualMachine) ConvertToTemplate(ctx context.Context) (task *Task, err error)

+ func (v *VirtualMachine) Delete(ctx context.Context) (task *Task, err error)

+ func (v *VirtualMachine) DeleteFirewallIPSet(ctx context.Context, name string, force bool) error

+ func (v *VirtualMachine) DeleteFirewallIPSetEntry(ctx context.Context, name string, cidr string, digest string) error

+ func (v *VirtualMachine) FirewallGetRules(ctx context.Context) (rules []*FirewallRule, err error)

+ func (v *VirtualMachine) FirewallOptionGet(ctx context.Context) (firewallOption *FirewallVirtualMachineOption, err error)

+ func (v *VirtualMachine) FirewallOptionSet(ctx context.Context, firewallOption *FirewallVirtualMachineOption) error

+ func (v *VirtualMachine) FirewallRulesCreate(ctx context.Context, rule *FirewallRule) error

+ func (v *VirtualMachine) FirewallRulesDelete(ctx context.Context, rulePos int) error

+ func (v *VirtualMachine) FirewallRulesUpdate(ctx context.Context, rule *FirewallRule) error

+ func (v *VirtualMachine) GetFirewallIPSet(ctx context.Context) (ipsets []*FirewallIPSet, err error)

+ func (v *VirtualMachine) GetFirewallIPSetEntries(ctx context.Context, name string) (entries []*FirewallIPSetEntry, err error)

+ func (v *VirtualMachine) GetFirewallIPSetEntry(ctx context.Context, name string, cidr string) (entry *FirewallIPSetEntry, err error)

+ func (v *VirtualMachine) HasTag(value string) bool

+ func (v *VirtualMachine) Hibernate(ctx context.Context) (task *Task, err error)

+ func (v *VirtualMachine) IsHibernated() bool

+ func (v *VirtualMachine) IsPaused() bool

+ func (v *VirtualMachine) IsRunning() bool

+ func (v *VirtualMachine) IsStopped() bool

+ func (v *VirtualMachine) Migrate(ctx context.Context, params *VirtualMachineMigrateOptions) (task *Task, err error)

+ func (v *VirtualMachine) MoveDisk(ctx context.Context, disk string, params *VirtualMachineMoveDiskOptions) (task *Task, err error)

+ func (v *VirtualMachine) NewFirewallIPSet(ctx context.Context, ipset FirewallIPSetCreationOption) error

+ func (v *VirtualMachine) NewFirewallIPSetEntry(ctx context.Context, name string, entry FirewallIPSetEntryCreationOption) error

+ func (v *VirtualMachine) NewSnapshot(ctx context.Context, name string) (task *Task, err error)

+ func (v *VirtualMachine) NewSnapshotWithOption(ctx context.Context, name string, option string) (task *Task, err error)

+ func (v *VirtualMachine) Pause(ctx context.Context) (task *Task, err error)

+ func (v *VirtualMachine) Pending(ctx context.Context) (pending *PendingConfiguration, err error)

+ func (v *VirtualMachine) Ping(ctx context.Context) error

+ func (v *VirtualMachine) RRDData(ctx context.Context, timeframe Timeframe, ...) (rrddata []*RRDData, err error)

+ func (v *VirtualMachine) Reboot(ctx context.Context) (task *Task, err error)

+ func (v *VirtualMachine) RemoveTag(ctx context.Context, value string) (*Task, error)

+ func (v *VirtualMachine) Reset(ctx context.Context) (task *Task, err error)

+ func (v *VirtualMachine) ResizeDisk(ctx context.Context, disk, size string) (*Task, error)

+ func (v *VirtualMachine) Resume(ctx context.Context) (task *Task, err error)

+ func (v *VirtualMachine) Shutdown(ctx context.Context) (task *Task, err error)

+ func (v *VirtualMachine) SnapshotRollback(ctx context.Context, name string) (task *Task, err error)

+ func (v *VirtualMachine) Snapshots(ctx context.Context) (snapshots []*Snapshot, err error)

+ func (v *VirtualMachine) SplitTags()

+ func (v *VirtualMachine) Start(ctx context.Context) (task *Task, err error)

+ func (v *VirtualMachine) Stop(ctx context.Context) (task *Task, err error)

+ func (v *VirtualMachine) TermProxy(ctx context.Context) (term *Term, err error)

+ func (v *VirtualMachine) TermWebSocket(term *Term) (chan []byte, chan []byte, chan error, func() error, error)

+ func (v *VirtualMachine) UnlinkDisk(ctx context.Context, diskID string, force bool) (task *Task, err error)

+ func (v *VirtualMachine) UnmountCloudInitISO(ctx context.Context, device string) error

+ func (v *VirtualMachine) UpdateFirewallIPSetEntry(ctx context.Context, name string, cidr string, ...) error

+ func (v *VirtualMachine) VNCProxy(ctx context.Context, config *VNCConfig) (vnc *VNC, err error)

+ func (v *VirtualMachine) VNCWebSocket(vnc *VNC) (chan []byte, chan []byte, chan error, func() error, error)

+ func (v *VirtualMachine) WaitForAgent(ctx context.Context, seconds int) error

+ func (v *VirtualMachine) WaitForAgentExecExit(ctx context.Context, pid, seconds int) (*AgentExecStatus, error)

+ type VirtualMachineBackupCompress = string

+ type VirtualMachineBackupMode = string

+ type VirtualMachineBackupNotificationPolicy = string

+ type VirtualMachineBackupOptions struct

+ All bool

+ BwLimit uint

+ Compress VirtualMachineBackupCompress

+ DumpDir string

+ Exclude string

+ ExcludePath []string

+ IoNice uint

+ LockWait uint

+ MailTo string

+ Mode VirtualMachineBackupMode

+ Node string

+ NotesTemplate string

+ NotificationPolicy VirtualMachineBackupNotificationPolicy

+ NotificationTarget string

+ Performance string

+ Pigz int

+ Pool string

+ Protected string

+ PruneBackups string

+ Quiet bool

+ Remove bool

+ Script string

+ StdExcludes bool

+ StdOut bool

+ Stop bool

+ StopWait uint

+ Storage string

+ TmpDir string

+ VMID uint64

+ Zstd uint

+ type VirtualMachineCloneOptions struct

+ BWLimit uint64

+ Description string

+ Format string

+ Full uint8

+ Name string

+ NewID int

+ Pool string

+ SnapName string

+ Storage string

+ Target string

+ type VirtualMachineConfig struct

+ Acpi int

+ Affinity string

+ Agent string

+ Args string

+ Audio0 string

+ Autostart int

+ Balloon int

+ Bios string

+ Boot string

+ CICustom string

+ CIPassword string

+ CIType string

+ CIUpgrade int

+ CIUser string

+ CPU string

+ CPULimit StringOrFloat64

+ CPUUnits int

+ Cores int

+ Description string

+ Digest string

+ EFIDisk0 string

+ Hookscript string

+ HostPCI0 string

+ HostPCI1 string

+ HostPCI2 string

+ HostPCI3 string

+ HostPCI4 string

+ HostPCI5 string

+ HostPCI6 string

+ HostPCI7 string

+ HostPCI8 string

+ HostPCI9 string

+ HostPCIs map[string]string

+ Hotplug string

+ Hugepages string

+ IDE0 string

+ IDE1 string

+ IDE2 string

+ IDE3 string

+ IDEs map[string]string

+ IPConfig0 string

+ IPConfig1 string

+ IPConfig2 string

+ IPConfig3 string

+ IPConfig4 string

+ IPConfig5 string

+ IPConfig6 string

+ IPConfig7 string

+ IPConfig8 string

+ IPConfig9 string

+ IPConfigs map[string]string

+ KVM int

+ Lock string

+ Machine string

+ Memory StringOrInt

+ Meta string

+ Name string

+ Nameserver string

+ Net0 string

+ Net1 string

+ Net2 string

+ Net3 string

+ Net4 string

+ Net5 string

+ Net6 string

+ Net7 string

+ Net8 string

+ Net9 string

+ Nets map[string]string

+ Numa int

+ Numa0 string

+ Numa1 string

+ Numa2 string

+ Numa3 string

+ Numa4 string

+ Numa5 string

+ Numa6 string

+ Numa7 string

+ Numa8 string

+ Numa9 string

+ Numas map[string]string

+ OSType string

+ OnBoot int

+ Parallel0 string

+ Parallel1 string

+ Parallel2 string

+ Parallels map[string]string

+ Protection int

+ Rng0 string

+ SATA0 string

+ SATA1 string

+ SATA2 string

+ SATA3 string

+ SATA4 string

+ SATA5 string

+ SATAs map[string]string

+ SCSI0 string

+ SCSI1 string

+ SCSI10 string

+ SCSI11 string

+ SCSI12 string

+ SCSI13 string

+ SCSI14 string

+ SCSI15 string

+ SCSI16 string

+ SCSI17 string

+ SCSI18 string

+ SCSI19 string

+ SCSI2 string

+ SCSI20 string

+ SCSI21 string

+ SCSI22 string

+ SCSI23 string

+ SCSI24 string

+ SCSI25 string

+ SCSI26 string

+ SCSI27 string

+ SCSI28 string

+ SCSI29 string

+ SCSI3 string

+ SCSI30 string

+ SCSI4 string

+ SCSI5 string

+ SCSI6 string

+ SCSI7 string

+ SCSI8 string

+ SCSI9 string

+ SCSIHW string

+ SCSIs map[string]string

+ SMBios1 string

+ SSHKeys string

+ Searchdomain string

+ Serial0 string

+ Serial1 string

+ Serial2 string

+ Serial3 string

+ Serials map[string]string

+ Sockets int

+ TPMState0 string

+ Tablet int

+ Tags string

+ TagsSlice []string

+ Template int

+ USB0 string

+ USB1 string

+ USB10 string

+ USB11 string

+ USB12 string

+ USB13 string

+ USB14 string

+ USB2 string

+ USB3 string

+ USB4 string

+ USB5 string

+ USB6 string

+ USB7 string

+ USB8 string

+ USB9 string

+ USBs map[string]string

+ Unused0 string

+ Unused1 string

+ Unused2 string

+ Unused3 string

+ Unused4 string

+ Unused5 string

+ Unused6 string

+ Unused7 string

+ Unused8 string

+ Unused9 string

+ Unuseds map[string]string

+ VGA string

+ VMGenID string

+ Vcpus int

+ VirtIO0 string

+ VirtIO1 string

+ VirtIO10 string

+ VirtIO11 string

+ VirtIO12 string

+ VirtIO13 string

+ VirtIO14 string

+ VirtIO15 string

+ VirtIO2 string

+ VirtIO3 string

+ VirtIO4 string

+ VirtIO5 string

+ VirtIO6 string

+ VirtIO7 string

+ VirtIO8 string

+ VirtIO9 string

+ VirtIOs map[string]string

+ func (vmc *VirtualMachineConfig) MergeDisks() map[string]string

+ func (vmc *VirtualMachineConfig) MergeHostPCIs() map[string]string

+ func (vmc *VirtualMachineConfig) MergeIDEs() map[string]string

+ func (vmc *VirtualMachineConfig) MergeIPConfigs() map[string]string

+ func (vmc *VirtualMachineConfig) MergeNets() map[string]string

+ func (vmc *VirtualMachineConfig) MergeNumas() map[string]string

+ func (vmc *VirtualMachineConfig) MergeParallels() map[string]string

+ func (vmc *VirtualMachineConfig) MergeSATAs() map[string]string

+ func (vmc *VirtualMachineConfig) MergeSCSIs() map[string]string

+ func (vmc *VirtualMachineConfig) MergeSerials() map[string]string

+ func (vmc *VirtualMachineConfig) MergeUSBs() map[string]string

+ func (vmc *VirtualMachineConfig) MergeUnuseds() map[string]string

+ func (vmc *VirtualMachineConfig) MergeVirtIOs() map[string]string

+ type VirtualMachineMigrateOptions struct

+ BWLimit uint64

+ Force IntOrBool

+ MigrationNetwork string

+ MigrationType string

+ Online IntOrBool

+ Target string

+ TargetStorage string

+ WithLocalDisks IntOrBool

+ type VirtualMachineMoveDiskOptions struct

+ BWLimit uint64

+ Delete uint8

+ Digest string

+ Disk string

+ Format string

+ Storage string

+ TargetDigest string

+ TargetDisk string

+ TargetVMID int

+ type VirtualMachineOption struct

+ Name string

+ Value interface{}

+ type VirtualMachineOptions []*VirtualMachineOption

+ type VirtualMachines []*VirtualMachine

+ type Volume interface

+ Delete func() error

+ type VzTmpl struct

+ func (v *VzTmpl) Delete(ctx context.Context) (*Task, error)

+ type VzTmpls []*VzTmpl

+ type VzdumpConfig struct

+ Boot string

+ CiPassword string

+ CiUser string

+ Cores uint64

+ HostPCI0 string

+ HostPCI1 string

+ HostPCI2 string

+ HostPCI3 string

+ HostPCI4 string

+ HostPCI5 string

+ HostPCI6 string

+ HostPCI7 string

+ HostPCI8 string

+ HostPCI9 string

+ IDE0 string

+ IDE1 string

+ IDE2 string

+ IDE3 string

+ IPConfig0 string

+ IPConfig1 string

+ IPConfig2 string

+ IPConfig3 string

+ IPConfig4 string

+ IPConfig5 string

+ IPConfig6 string

+ IPConfig7 string

+ IPConfig8 string

+ IPConfig9 string

+ Memory uint64

+ Meta string

+ Net0 string

+ Net1 string

+ Net2 string

+ Net3 string

+ Net4 string

+ Net5 string

+ Net6 string

+ Net7 string

+ Net8 string

+ Net9 string

+ Numa string

+ Numa0 string

+ Numa1 string

+ Numa2 string

+ Numa3 string

+ Numa4 string

+ Numa5 string

+ Numa6 string

+ Numa7 string

+ Numa8 string

+ Numa9 string

+ OsType string

+ Parallel0 string

+ Parallel1 string

+ Parallel2 string

+ SATA0 string

+ SATA1 string

+ SATA2 string

+ SATA3 string

+ SATA4 string

+ SATA5 string

+ SCSI0 string

+ SCSI1 string

+ SCSI10 string

+ SCSI11 string

+ SCSI12 string

+ SCSI13 string

+ SCSI14 string

+ SCSI15 string

+ SCSI16 string

+ SCSI17 string

+ SCSI18 string

+ SCSI19 string

+ SCSI2 string

+ SCSI20 string

+ SCSI21 string

+ SCSI22 string

+ SCSI23 string

+ SCSI24 string

+ SCSI25 string

+ SCSI26 string

+ SCSI27 string

+ SCSI28 string

+ SCSI29 string

+ SCSI3 string

+ SCSI30 string

+ SCSI4 string

+ SCSI5 string

+ SCSI6 string

+ SCSI7 string

+ SCSI8 string

+ SCSI9 string

+ SSHKeys string

+ Scsihw string

+ Serial0 string

+ Serial1 string

+ Serial2 string

+ Serial3 string

+ Sockets uint64

+ USB0 string

+ USB1 string

+ USB10 string

+ USB11 string

+ USB12 string

+ USB13 string

+ USB14 string

+ USB2 string

+ USB3 string

+ USB4 string

+ USB5 string

+ USB6 string

+ USB7 string

+ USB8 string

+ USB9 string

+ Unused0 string

+ Unused1 string

+ Unused2 string

+ Unused3 string

+ Unused4 string

+ Unused5 string

+ Unused6 string

+ Unused7 string

+ Unused8 string

+ Unused9 string

+ VirtIO0 string

+ VirtIO1 string

+ VirtIO10 string

+ VirtIO11 string

+ VirtIO12 string

+ VirtIO13 string

+ VirtIO14 string

+ VirtIO15 string

+ VirtIO2 string

+ VirtIO3 string

+ VirtIO4 string

+ VirtIO5 string

+ VirtIO6 string

+ VirtIO7 string

+ VirtIO8 string

+ VirtIO9 string

+ VmgenID string

v0.2.3-fr

Aug 20, 2025