proxmoxAPI

package

v0.0.0-...-f6b9a2a Latest Latest Go to latest Published: Feb 10, 2026 License: AGPL-3.0 Imports: 17 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/UNHCSC/pve-koth

Links

Open Source Insights

Documentation ¶

Index ¶

type ContainerCreateOptions
- func (c *ContainerCreateOptions) GoProxmoxOptions() (opts []proxmox.ContainerOption)
type ProxmoxAPI
- func InitProxmox() (api *ProxmoxAPI, err error)
type ProxmoxAPIBulkCreateResult
type ProxmoxAPICreateResult

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type ContainerCreateOptions ¶

type ContainerCreateOptions struct {
	TemplatePath     string
	StoragePool      string
	Hostname         string
	RootPassword     string
	RootSSHPublicKey string
	StorageSizeGB    int
	MemoryMB         int
	Cores            int
	GatewayIPv4      string
	IPv4Address      string
	CIDRBlock        int
	NameServer       string
	SearchDomain     string
}

func (*ContainerCreateOptions) GoProxmoxOptions ¶

func (c *ContainerCreateOptions) GoProxmoxOptions() (opts []proxmox.ContainerOption)

type ProxmoxAPI ¶

type ProxmoxAPI struct {
	Nodes   []*proxmox.Node
	Cluster *proxmox.Cluster

	InsecureSkipVerify bool

	ConnectTimeout time.Duration
	CommandTimeout time.Duration
	// contains filtered or unexported fields
}

func InitProxmox ¶

func InitProxmox() (api *ProxmoxAPI, err error)

func (*ProxmoxAPI) BulkCTActionWithRetries ¶

func (api *ProxmoxAPI) BulkCTActionWithRetries(action func(ids []int) (err error), ids []int, numRetries int) (err error)

func (*ProxmoxAPI) BulkCreateContainers ¶

func (api *ProxmoxAPI) BulkCreateContainers(nodes []*proxmox.Node, confs []*ContainerCreateOptions) (results []*ProxmoxAPIBulkCreateResult)

func (*ProxmoxAPI) BulkCreateContainersConcurrent ¶

func (api *ProxmoxAPI) BulkCreateContainersConcurrent(nodes []*proxmox.Node, confs []*ContainerCreateOptions, numCreateRetries int) (results []*ProxmoxAPIBulkCreateResult, err error)

func (*ProxmoxAPI) BulkDelete ¶

func (api *ProxmoxAPI) BulkDelete(ids []int) (err error)

func (*ProxmoxAPI) BulkStart ¶

func (api *ProxmoxAPI) BulkStart(ids []int) (err error)

func (*ProxmoxAPI) BulkStop ¶

func (api *ProxmoxAPI) BulkStop(ids []int) (err error)

func (*ProxmoxAPI) CTActionWithRetries ¶

func (api *ProxmoxAPI) CTActionWithRetries(action func(ct *proxmox.Container) error, ct *proxmox.Container, numRetries int) (err error)

func (*ProxmoxAPI) ChangeContainerNetworking ¶

func (api *ProxmoxAPI) ChangeContainerNetworking(ct *proxmox.Container, gatewayIPv4, IPv4Address string, CIDRBlock int) (err error)

func (*ProxmoxAPI) CloneTemplate ¶

func (api *ProxmoxAPI) CloneTemplate(ct *proxmox.Container, hostname string) (newCT *proxmox.Container, err error)

func (*ProxmoxAPI) Container ¶

func (api *ProxmoxAPI) Container(ctID int) (ct *proxmox.Container, err error)

func (*ProxmoxAPI) CreateContainer ¶

func (api *ProxmoxAPI) CreateContainer(node *proxmox.Node, conf *ContainerCreateOptions) (result *ProxmoxAPICreateResult, err error)

func (*ProxmoxAPI) CreateContainerWithID ¶

func (api *ProxmoxAPI) CreateContainerWithID(node *proxmox.Node, conf *ContainerCreateOptions, ctID int) (result *ProxmoxAPICreateResult, err error)

func (*ProxmoxAPI) CreateTemplate ¶

func (api *ProxmoxAPI) CreateTemplate(ct *proxmox.Container) (err error)

func (*ProxmoxAPI) DeleteContainer ¶

func (api *ProxmoxAPI) DeleteContainer(ct *proxmox.Container) (err error)

func (*ProxmoxAPI) GetContainers ¶

func (api *ProxmoxAPI) GetContainers(ids []int) (containers []*proxmox.Container, err error)

func (*ProxmoxAPI) ListContainers ¶

func (api *ProxmoxAPI) ListContainers(node *proxmox.Node) (containers []*proxmox.Container, err error)

func (*ProxmoxAPI) NextNode ¶

func (api *ProxmoxAPI) NextNode() *proxmox.Node

func (*ProxmoxAPI) NodeByName ¶

func (api *ProxmoxAPI) NodeByName(name string) *proxmox.Node

func (*ProxmoxAPI) NodeForContainer ¶

func (api *ProxmoxAPI) NodeForContainer(ctID int) (node *proxmox.Node, err error)

func (*ProxmoxAPI) RawExecute ¶

func (api *ProxmoxAPI) RawExecute(ct *proxmox.Container, username, password, command string) (stdout string, stderr string, exitCode int, err error)

func (*ProxmoxAPI) RawExecuteWithRetries ¶

func (api *ProxmoxAPI) RawExecuteWithRetries(ct *proxmox.Container, username, password, command string, numRetries int) (stdout string, stderr string, exitCode int, err error)

func (*ProxmoxAPI) StartContainer ¶

func (api *ProxmoxAPI) StartContainer(ct *proxmox.Container) (err error)

func (*ProxmoxAPI) StopContainer ¶

func (api *ProxmoxAPI) StopContainer(ct *proxmox.Container) (err error)

type ProxmoxAPIBulkCreateResult ¶

type ProxmoxAPIBulkCreateResult struct {
	Result *ProxmoxAPICreateResult
	Error  error
}

type ProxmoxAPICreateResult ¶

type ProxmoxAPICreateResult struct {
	Container *proxmox.Container
	CTID      int
}

Source Files ¶

View all Source files

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