proxmox

package
v0.1.0 Latest Latest
Warning

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

Go to latest
Published: Jun 3, 2026 License: GPL-3.0 Imports: 20 Imported by: 0

Documentation

Overview

Package proxmox implements the Proxmox VE protocol plugin: a deep node → guests/storage tree, VM/LXC/node detail views, live metrics, noVNC and xterm consoles, snapshots, backups, and lifecycle actions — all over the PVE REST API (with the console websocket bridged through the gateway transport).

Index

Constants

View Source
const CredentialProxmoxToken plugin.CredentialKind = "proxmox_api_token"

CredentialProxmoxToken is the plugin-owned reusable credential kind: a Proxmox API token (identity is the token id `user@realm!name`, secret is the value).

Variables

This section is empty.

Functions

func Routes

func Routes() []plugin.Route

Types

type Plugin

type Plugin struct{}

func New

func New() *Plugin

func (*Plugin) Connect

func (p *Plugin) Connect(ctx context.Context, cfg plugin.ConnectConfig) (plugin.Session, error)

func (*Plugin) Manifest

func (p *Plugin) Manifest() plugin.Manifest

func (*Plugin) Routes

func (p *Plugin) Routes() []plugin.Route

type Session

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

Session holds the per-connection Proxmox VE client. REST traffic flows through the go-proxmox client (wired to cfg.Net via a custom http.Client); the console websocket is dialed separately so it shares the same transport.

func Unwrap

func Unwrap(sess plugin.Session) (*Session, error)

Unwrap recovers the concrete Proxmox session from a (possibly wrapped) plugin session, mirroring the helper the other plugins expose for their route code.

func (*Session) Close

func (s *Session) Close() error

func (*Session) HealthCheck

func (s *Session) HealthCheck(ctx context.Context) error

func (*Session) OpenChannel

func (s *Session) OpenChannel(ctx context.Context, req plugin.ChannelRequest) (plugin.Channel, error)

Jump to

Keyboard shortcuts

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