Nodes

Subsections of Nodes

List cluster nodes

Options

optiondescriptionAllowed values
filter-nameapply a regex filter on nodes namesstring
output-formatone of table, json or yaml. Default to tablestring

Examples

  • List all cluster nodes
proxcli nodes list

Nodes Networks

Subsections of Nodes Networks

List nodes networks

Options

optiondescriptionAllowed values
proxmox-nodescoma separated list of proxmox nodes from which we want to grab networksstring
output-formatformat to display networks list (json, yaml or table)string

Examples

  • Show networks from a selected list of nodes
proxcli nodes nodes networks list --proxmox-nodes "pve1,pve2"

Cluster storages

Subsections of Cluster storages

List cluster storages

Options

optiondescriptionAllowed values

Examples

  • List cluster storages
proxcli cluster storages list

Upload disk image or iso file to cluster storage

Options

optiondescriptionAllowed values
filethe path to the local filename to be uploadstring
storagethe configured storage name in proxmox nodestring
proxmox-nodeproxmox node namestring
contentthe file content type (iso or images)string

Examples

  • upload iso file to cluster storage

Nodes storages content

Subsections of Nodes storages content

List nodes storages content

Options

optiondescriptionAllowed values
storagethe node storage name (local-lvm, isos, …)string
proxmox-nodeproxmox node namestring
output-formatoutput format can be one of table, json, yaml (default to table)string
content-typefilter by content column (iso, tzst, raw, qcow2 ….)string
content-formatfilter by content format. Can be one of iso,images,backup,vztmplstring
filter-orphanedcan be YES (orphaned content), NO (no orphaned content), N/A (not applicable to orphaned content). This is a coma separated list. Default to YES,NO,N/Astring

Examples

  • List specific node storage content
proxcli nodes storages content list --node pve1 --storage local-lvm
  • List storage content filtered by images content-type in raw format
proxcli nodes storages content list --node pve1 --storage b4papp --content-type raw --content-format images 

List nodes storages content

Options

optiondescriptionAllowed values
storagethe node storage name (local-lvm, isos, …)string
proxmox-nodeproxmox node namestring
output-formatoutput format can be one of table, json, yaml (default to table)string
content-typefilter by content column (iso, tzst, raw, qcow2 ….)string
content-formatfilter by content format. Can be one of iso,images,backup,vztmplstring
filter-orphanedcan be YES (orphaned content), NO (no orphaned content), N/A (not applicable to orphaned content). This is a coma separated list. Default to YES,NO,N/Astring

Examples

  • List specific node storage content
proxcli nodes storages content list --node pve1 --storage local-lvm
  • List storage content filtered by images content-type in raw format
proxcli nodes storages content list --node pve1 --storage b4papp --content-type raw --content-format images 

Show cluster nodes tasks

Options

optiondescriptionAllowed values
proxmox-nodescoma separated list of proxmox nodes from which we want to grab tasksstring

Examples

  • Show tasks on a list of proxmox nodes
proxcli nodes tasks --proxmox-nodes "pve1,pve2"