Skip to content

proxmox

Proxmox

Proxmox VM and container status. By default, are sorted by node and for each node VMs and Containers are sorted by id.

PARAMETER DESCRIPTION
host

Proxmox host IP

TYPE: str DEFAULT: 'localhost'

user

Proxmox user (<user>@<realm>)

TYPE: str DEFAULT: 'root@pam'

token_name

Proxmox token name

TYPE: str

token_secret

Proxmox token secret

TYPE: str

verify_ssl

Whether to check SSL certificate validity

TYPE: bool DEFAULT: True

**kwargs

TYPE: Any DEFAULT: {}

Available columns

Source and attribute meaning: PVE Docs: Nodes Attributes with * are not part of the official API or its behavior is slightly different. Note: According to Proxmox API documentation, some optional attributes are not always present and might not be included in the table below. Open a new issue if you find an attribute you need is missing or add it yourself and submit a new pull request.

Attribute node vm lxc Notes
combined_name* Node and VM/Container names in a single column like in web UI.
cpu
cpus ✅* * same as maxcpu
maxcpu ✅* ✅* * same as cpus
disk
diskpct* disk/maxdisk
diskread
diskwrite
id
vmid ✅* * For nodes is equal to -1 and hidden, is used only for sorting.
level
maxdisk
maxmem
maxswap
mem
mempct* mem/maxmem
memhost
name
node ✅* ✅* * For VMs and Containers is arbitrarily copied from parent node.
netin
netout
pid
pressurecpufull
pressurecpusome
pressureiofull
pressureiosome
pressurememoryfull
pressurememorysome
ssl_fingerprint
status
swap
swappct ✅* swap/maxswap
type
uptime