Alias reference

The 347 built-in aliases, read from the catalog in the code this site was built from. How to use them is on the Aliases page; cv4pve-cli alias list -v prints the names, descriptions and API calls in the terminal, together with your own aliases.

• Arguments are given in order after the alias name. or --guest marks the aliases that take --guest <id|name> in place of the node, the type and the VM ID.
• --yes under the name marks the aliases that run only with --yes.
• API call is what the alias runs, as you would write it after cv4pve-cli api.

get

Reads a list or a status, plus top.

Alias	Arguments	Description	API call
top		Show all cluster resources (quick overview)	get /cluster/resources

Alias	Arguments	Description	API call
get ceph flags		List global Ceph flags (noout, norebalance, ...)	get /cluster/ceph/flags
get ceph status		Cluster-wide Ceph status	get /cluster/ceph/status
get cluster backup volumes	<id>	List volumes included in a specific backup job	get /cluster/backup/{id}/included_volumes
get cluster backup-jobs		List all scheduled backup jobs	get /cluster/backup
get cluster corosync nodes		List the nodes in the corosync configuration	get /cluster/config/nodes
get cluster firewall		List cluster-wide firewall rules	get /cluster/firewall/rules
get cluster firewall aliases		List the cluster firewall aliases (named addresses)	get /cluster/firewall/aliases
get cluster firewall groups		List the firewall security groups	get /cluster/firewall/groups
get cluster firewall ipsets		List the cluster firewall IPSets	get /cluster/firewall/ipset
get cluster firewall options		Show cluster firewall options	get /cluster/firewall/options
get cluster ha		Show HA manager status	get /cluster/ha/status/current
get cluster ha groups		List all HA groups	get /cluster/ha/groups
get cluster ha manager-status		Show full HA manager status including LRM	get /cluster/ha/status/manager_status
get cluster ha resources		List all HA resources	get /cluster/ha/resources
get cluster log		Show recent cluster-wide logs	get /cluster/log
get cluster mappings pci		List all PCI hardware mappings	get /cluster/mapping/pci
get cluster mappings usb		List all USB hardware mappings	get /cluster/mapping/usb
get cluster metrics-servers		List all configured metric server targets	get /cluster/metrics/server
get cluster nextid		Get the next free VM/CT ID in the cluster	get /cluster/nextid
get cluster not-backed-up		List all guests not covered by any backup job	get /cluster/backup-info/not-backed-up
get cluster notification-endpoints		List all configured notification endpoints	get /cluster/notifications/endpoints
get cluster notification-matchers		List all notification matchers	get /cluster/notifications/matchers
get cluster notification-targets		List all available notification targets	get /cluster/notifications/targets
get cluster options		Show cluster-wide options	get /cluster/options
get cluster qdevice		Show the status of the corosync QDevice	get /cluster/config/qdevice
get cluster replications	<node>	List the replication jobs of a node	get /nodes/{node}/replication
get cluster replications all		List all replication jobs (cluster-wide)	get /cluster/replication
get cluster schedule-analyze	<schedule>	Show when a schedule expression will trigger next	get /cluster/jobs/schedule-analyze --schedule {schedule}
get cluster sdn controllers		List all SDN controllers	get /cluster/sdn/controllers
get cluster sdn vnets		List all SDN virtual networks	get /cluster/sdn/vnets
get cluster sdn zones		List all SDN zones	get /cluster/sdn/zones
get cluster status		Show health and quorum status of the cluster	get /cluster/status
get cluster tasks		Show all active tasks in the cluster	get /cluster/tasks
get ct firewall	<node> <vmid> or --guest	List firewall rules for a container	get /nodes/{node}/lxc/{vmid}/firewall/rules
get ct firewall log	<node> <vmid> or --guest	Show the firewall log of a container	get /nodes/{node}/lxc/{vmid}/firewall/log
get ct firewall options	<node> <vmid> or --guest	Show firewall options for a container	get /nodes/{node}/lxc/{vmid}/firewall/options
get ct interfaces	<node> <vmid> or --guest	Show runtime network interfaces of a running container (via guest agent)	get /nodes/{node}/lxc/{vmid}/interfaces
get ct pending	<node> <vmid> or --guest	Show CT configuration including pending (unapplied) changes	get /nodes/{node}/lxc/{vmid}/pending
get ct rrddata	<node> <vmid> <hour|day|week|month|year> or --guest	Show performance history of a container (RRD)	get /nodes/{node}/lxc/{vmid}/rrddata --timeframe {hour|day|week|month|year}
get ct snapshots	<node> <vmid> or --guest	List container snapshots	get /nodes/{node}/lxc/{vmid}/snapshot
get ct status	<node> <vmid> or --guest	Show container runtime status	get /nodes/{node}/lxc/{vmid}/status/current
get ct templates	<node> <storage>	List CT templates on storage	get /nodes/{node}/storage/{storage}/content --content vztmpl
get guest backup config	<node> <volume>	Extract VM/CT configuration from a vzdump backup archive	get /nodes/{node}/vzdump/extractconfig --volume {volume}
get guest backups	<node> <storage> <vmid>	List all backups for a guest on a storage	get /nodes/{node}/storage/{storage}/content --content backup --vmid {vmid}
get guest feature	<node> <vmtype> <vmid> <feature> or --guest	Check if a feature is available for a guest (VM or CT)	get /nodes/{node}/{vmtype}/{vmid}/feature --feature {feature}
get guest firewall	<node> <vmtype> <vmid> or --guest	List firewall rules for a guest (VM or CT)	get /nodes/{node}/{vmtype}/{vmid}/firewall/rules
get guest firewall log	<node> <vmtype> <vmid> or --guest	Show the firewall log of a guest (VM or CT)	get /nodes/{node}/{vmtype}/{vmid}/firewall/log
get guest firewall options	<node> <vmtype> <vmid> or --guest	Show firewall options for a guest (VM or CT)	get /nodes/{node}/{vmtype}/{vmid}/firewall/options
get guest pending	<node> <vmtype> <vmid> or --guest	Show guest configuration including pending (unapplied) changes	get /nodes/{node}/{vmtype}/{vmid}/pending
get guest rrddata	<node> <vmtype> <vmid> <hour|day|week|month|year> or --guest	Show performance history of a guest (RRD, VM or CT)	get /nodes/{node}/{vmtype}/{vmid}/rrddata --timeframe {hour|day|week|month|year}
get guest snapshots	<node> <vmtype> <vmid> or --guest	List snapshots for a guest (VM or CT)	get /nodes/{node}/{vmtype}/{vmid}/snapshot
get guest status	<node> <vmtype> <vmid> or --guest	Show guest runtime status (VM or CT)	get /nodes/{node}/{vmtype}/{vmid}/status/current
get guests		List all VMs and containers (cluster-wide)	get /cluster/resources --type vm
get node apt changelog	<node> <package>	Show changelog of a package available on a node	get /nodes/{node}/apt/changelog --name {package}
get node apt repos	<node>	Show APT repository configuration on a node	get /nodes/{node}/apt/repositories
get node backup defaults	<node>	Show the currently configured vzdump default settings	get /nodes/{node}/vzdump/defaults
get node backups	<node> <storage>	List backup files on a storage	get /nodes/{node}/storage/{storage}/content --content backup
get node ceph config	<node>	Show the Ceph configuration file	get /nodes/{node}/ceph/cfg/raw
get node ceph fs	<node>	List CephFS filesystems on a node	get /nodes/{node}/ceph/fs
get node ceph mgrs	<node>	List Ceph managers on a node	get /nodes/{node}/ceph/mgr
get node ceph mons	<node>	List Ceph monitors on a node	get /nodes/{node}/ceph/mon
get node ceph osds	<node>	List Ceph OSDs (tree) on a node	get /nodes/{node}/ceph/osd
get node ceph pools	<node>	List Ceph pools on a node	get /nodes/{node}/ceph/pool
get node ceph status	<node>	Ceph status as seen from a specific node	get /nodes/{node}/ceph/status
get node certificates	<node>	List certificates on a node	get /nodes/{node}/certificates/info
get node config	<node>	Show node configuration (NTP, DNS, notify, etc.)	get /nodes/{node}/config
get node cpu-models	<node>	List available CPU models on a node	get /nodes/{node}/capabilities/qemu/cpu
get node disk lvm	<node>	List LVM volume groups	get /nodes/{node}/disks/lvm
get node disk smart	<node> <disk>	Show S.M.A.R.T. status for a disk	get /nodes/{node}/disks/smart --disk {disk}
get node disk zfs	<node>	List ZFS pools on a node	get /nodes/{node}/disks/zfs
get node disks	<node>	List physical disks on a node	get /nodes/{node}/disks/list
get node dns	<node>	Show DNS settings for a node	get /nodes/{node}/dns
get node firewall	<node>	List firewall rules for a node	get /nodes/{node}/firewall/rules
get node firewall log	<node>	Show firewall log for a node	get /nodes/{node}/firewall/log
get node firewall options	<node>	Show firewall options for a node	get /nodes/{node}/firewall/options
get node hardware pci	<node>	List local PCI devices on a node	get /nodes/{node}/hardware/pci
get node hardware usb	<node>	List local USB devices on a node	get /nodes/{node}/hardware/usb
get node hosts	<node>	Show /etc/hosts content of a node	get /nodes/{node}/hosts
get node iso	<node> <storage>	List ISO images on storage	get /nodes/{node}/storage/{storage}/content --content iso
get node journal	<node>	Read the systemd journal of a node	get /nodes/{node}/journal
get node machine-types	<node>	List available QEMU machine types on a node	get /nodes/{node}/capabilities/qemu/machines
get node netstat	<node>	Show network statistics for a node	get /nodes/{node}/netstat
get node network	<node>	List network interfaces on a node	get /nodes/{node}/network
get node packages	<node>	List available package updates on a node	get /nodes/{node}/apt/update
get node prune-info	<node> <storage>	Preview which backups would be removed by a prune operation	get /nodes/{node}/storage/{storage}/prunebackups
get node replication log	<node> <id>	Show log of a replication job on a specific node	get /nodes/{node}/replication/{id}/log
get node replication status	<node> <id>	Show status of a replication job on a specific node	get /nodes/{node}/replication/{id}/status
get node report	<node>	Generate a full diagnostic report for a node	get /nodes/{node}/report
get node rrddata	<node> <hour|day|week|month|year>	Show node performance data (RRD)	get /nodes/{node}/rrddata --timeframe {hour|day|week|month|year}
get node scan cifs	<node> <server>	Scan a remote host for CIFS/SMB shares accessible from a node	get /nodes/{node}/scan/cifs --server {server}
get node scan iscsi	<node> <portal>	Scan for iSCSI targets accessible from a node	get /nodes/{node}/scan/iscsi --portal {portal}
get node scan lvm	<node>	List LVM volume groups accessible from a node	get /nodes/{node}/scan/lvm
get node scan nfs	<node> <server>	Scan a remote host for NFS shares accessible from a node	get /nodes/{node}/scan/nfs --server {server}
get node scan pbs	<node> <server> <username>	Scan a Proxmox Backup Server accessible from a node (also needs --password)	get /nodes/{node}/scan/pbs --server {server} --username {username}
get node scan zfs	<node>	Scan for ZFS pools accessible from a node	get /nodes/{node}/scan/zfs
get node services	<node>	List all services on a node	get /nodes/{node}/services
get node storage rrddata	<node> <storage> <hour|day|week|month|year>	Show storage usage history (RRD)	get /nodes/{node}/storage/{storage}/rrddata --timeframe {hour|day|week|month|year}
get node storages	<node>	List storages available on a node	get /nodes/{node}/storage
get node subscription	<node>	Show subscription status of a node	get /nodes/{node}/subscription
get node syslog	<node>	Read the system log (syslog) of a node	get /nodes/{node}/syslog
get node tasks	<node>	List recent tasks on node	get /nodes/{node}/tasks
get node time	<node>	Show current time and timezone of a node	get /nodes/{node}/time
get node version	<node>	Show PVE version installed on a node	get /nodes/{node}/version
get node versions	<node>	Show the versions of the Proxmox VE packages (like pveversion -v)	get /nodes/{node}/apt/versions
get nodes		List all nodes	get /nodes
get pools		List all resource pools	get /pools
get resources		List all cluster resources	get /cluster/resources
get security acls		List all access control rules	get /access/acl
get security domains		List all authentication domains/realms	get /access/domains
get security groups		List all user groups	get /access/groups
get security privileges		List all available privileges in the system	get /access/permissions
get security roles		List all defined roles and their privileges	get /access/roles
get security tfa		List TFA configurations for all users	get /access/tfa
get security tokens	<userid>	List all API tokens for a user	get /access/users/{userid}/token
get security user tfa	<userid>	List TFA entries for a specific user	get /access/tfa/{userid}
get security users		List all users and their status	get /access/users
get storages		List all storages (cluster-wide)	get /cluster/resources --type storage
get storages config		List all configured storages (cluster-wide config)	get /storage
get version		Show API version	get /version
get vm agent exec-status	<node> <vmid> <pid> or --guest	Get the result/status of a command executed via guest agent	get /nodes/{node}/qemu/{vmid}/agent/exec-status --pid {pid}
get vm agent fsinfo	<node> <vmid> or --guest	Show filesystem info of the guest via QEMU guest agent	get /nodes/{node}/qemu/{vmid}/agent/get-fsinfo
get vm agent hostname	<node> <vmid> or --guest	Show hostname of the guest OS via QEMU guest agent	get /nodes/{node}/qemu/{vmid}/agent/get-host-name
get vm agent info	<node> <vmid> or --guest	Show guest OS info via QEMU guest agent	get /nodes/{node}/qemu/{vmid}/agent/info
get vm agent memory	<node> <vmid> or --guest	Show memory blocks info of the guest via QEMU guest agent	get /nodes/{node}/qemu/{vmid}/agent/get-memory-blocks
get vm agent network	<node> <vmid> or --guest	Show guest network interfaces via QEMU guest agent	get /nodes/{node}/qemu/{vmid}/agent/network-get-interfaces
get vm agent osinfo	<node> <vmid> or --guest	Show guest OS information via QEMU guest agent	get /nodes/{node}/qemu/{vmid}/agent/get-osinfo
get vm agent time	<node> <vmid> or --guest	Show system time of the guest via QEMU guest agent	get /nodes/{node}/qemu/{vmid}/agent/get-time
get vm agent timezone	<node> <vmid> or --guest	Show timezone of the guest OS via QEMU guest agent	get /nodes/{node}/qemu/{vmid}/agent/get-timezone
get vm agent users	<node> <vmid> or --guest	List users logged into the guest via QEMU guest agent	get /nodes/{node}/qemu/{vmid}/agent/get-users
get vm agent vcpus	<node> <vmid> or --guest	Show virtual CPU info of the guest via QEMU guest agent	get /nodes/{node}/qemu/{vmid}/agent/get-vcpus
get vm cloudinit	<node> <vmid> <user|network|meta> or --guest	Dump the cloud-init configuration for a VM (user/network/meta)	get /nodes/{node}/qemu/{vmid}/cloudinit/dump --type {user|network|meta}
get vm firewall	<node> <vmid> or --guest	List firewall rules for a VM	get /nodes/{node}/qemu/{vmid}/firewall/rules
get vm firewall log	<node> <vmid> or --guest	Show the firewall log of a VM	get /nodes/{node}/qemu/{vmid}/firewall/log
get vm firewall options	<node> <vmid> or --guest	Show firewall options for a VM	get /nodes/{node}/qemu/{vmid}/firewall/options
get vm migrate-check	<node> <vmid> or --guest	Check whether a VM can migrate: local disks and resources, allowed nodes	get /nodes/{node}/qemu/{vmid}/migrate
get vm pending	<node> <vmid> or --guest	Show VM configuration including pending (unapplied) changes	get /nodes/{node}/qemu/{vmid}/pending
get vm rrddata	<node> <vmid> <hour|day|week|month|year> or --guest	Show performance history of a VM (RRD)	get /nodes/{node}/qemu/{vmid}/rrddata --timeframe {hour|day|week|month|year}
get vm snapshots	<node> <vmid> or --guest	List VM snapshots	get /nodes/{node}/qemu/{vmid}/snapshot
get vm status	<node> <vmid> or --guest	Show VM runtime status	get /nodes/{node}/qemu/{vmid}/status/current
get vms		List all VMs and containers (cluster-wide), same as get guests	get /cluster/resources --type vm

show

Reads the details of one object.

Alias	Arguments	Description	API call
show cluster backup-job	<id>	Show details of a specific backup job	get /cluster/backup/{id}
show cluster firewall ipset	<name>	List the addresses of a cluster firewall IPSet	get /cluster/firewall/ipset/{name}
show cluster firewall-rule	<pos>	Show details of a specific cluster firewall rule	get /cluster/firewall/rules/{pos}
show cluster ha group	<group>	Show configuration of a specific HA group	get /cluster/ha/groups/{group}
show cluster ha resource	<sid>	Show configuration of a specific HA resource	get /cluster/ha/resources/{sid}
show cluster mapping pci	<id>	Show a specific PCI hardware mapping	get /cluster/mapping/pci/{id}
show cluster mapping usb	<id>	Show a specific USB hardware mapping	get /cluster/mapping/usb/{id}
show cluster metrics-server	<id>	Show configuration of a specific metric server	get /cluster/metrics/server/{id}
show cluster replication	<node> <id>	Show status of a specific replication job	get /nodes/{node}/replication/{id}
show cluster sdn vnet	<vnet>	Show configuration of a specific SDN vnet	get /cluster/sdn/vnets/{vnet}
show cluster sdn zone	<zone>	Show configuration of a specific SDN zone	get /cluster/sdn/zones/{zone}
show ct	<node> <vmid> or --guest	Show container config	get /nodes/{node}/lxc/{vmid}/config
show ct firewall-rule	<node> <vmid> <pos> or --guest	Show details of a specific CT firewall rule	get /nodes/{node}/lxc/{vmid}/firewall/rules/{pos}
show ct snapshot	<node> <vmid> <snapname> or --guest	Show configuration of a specific container snapshot	get /nodes/{node}/lxc/{vmid}/snapshot/{snapname}/config
show guest	<node> <vmtype> <vmid> or --guest	Show guest config (VM or CT)	get /nodes/{node}/{vmtype}/{vmid}/config
show guest backup	<node> <storage> <volume>	Show details of a specific backup file	get /nodes/{node}/storage/{storage}/content/{volume}
show guest firewall-rule	<node> <vmtype> <vmid> <pos> or --guest	Show details of a specific guest firewall rule	get /nodes/{node}/{vmtype}/{vmid}/firewall/rules/{pos}
show guest snapshot	<node> <vmtype> <vmid> <snapname> or --guest	Show configuration of a specific guest snapshot	get /nodes/{node}/{vmtype}/{vmid}/snapshot/{snapname}/config
show node	<node>	Show node status	get /nodes/{node}/status
show node disk zfs	<node> <name>	Show detailed status of a ZFS pool	get /nodes/{node}/disks/zfs/{name}
show node firewall-rule	<node> <pos>	Show details of a specific node firewall rule	get /nodes/{node}/firewall/rules/{pos}
show node service	<node> <service>	Show the state of a service on a node	get /nodes/{node}/services/{service}/state
show node storage	<node> <storage>	Show configuration of a specific storage on a node	get /nodes/{node}/storage/{storage}
show node task	<node> <upid>	Show log of a specific task	get /nodes/{node}/tasks/{upid}/log
show node task status	<node> <upid>	Show status of a specific task on a node	get /nodes/{node}/tasks/{upid}/status
show pool	<poolid>	Show details of a specific pool	get /pools/{poolid}
show security domain	<realm>	Show configuration of an authentication domain	get /access/domains/{realm}
show security group	<groupid>	Show details of a group	get /access/groups/{groupid}
show security role	<roleid>	Show privileges assigned to a specific role	get /access/roles/{roleid}
show security token	<userid> <tokenid>	Show details of a specific API token	get /access/users/{userid}/token/{tokenid}
show security user	<userid>	Show details of a specific user	get /access/users/{userid}
show storage	<node> <storage>	Show storage status/usage	get /nodes/{node}/storage/{storage}/status
show storage config	<storage>	Show configuration of a specific storage	get /storage/{storage}
show vm	<node> <vmid> or --guest	Show VM config	get /nodes/{node}/qemu/{vmid}/config
show vm firewall-rule	<node> <vmid> <pos> or --guest	Show details of a specific VM firewall rule	get /nodes/{node}/qemu/{vmid}/firewall/rules/{pos}
show vm snapshot	<node> <vmid> <snapname> or --guest	Show configuration of a specific VM snapshot	get /nodes/{node}/qemu/{vmid}/snapshot/{snapname}/config

do

Runs an action.

Alias	Arguments	Description	API call
do apply cluster sdn --yes		Apply the pending SDN changes and reload the network on every node	set /cluster/sdn
do backup guest	<node> <vmid> <storage>	Start a backup job immediately for a VM or CT	create /nodes/{node}/vzdump --vmid {vmid} --storage {storage}
do clone ct	<node> <vmid> <newid> <name> or --guest	Clone a container	create /nodes/{node}/lxc/{vmid}/clone --newid {newid} --hostname {name}
do clone vm	<node> <vmid> <newid> <name> or --guest	Clone a VM	create /nodes/{node}/qemu/{vmid}/clone --newid {newid} --name {name}
do download storage	<node> <storage> <url> <filename> <iso|vztmpl>	Download an ISO, template or image from a URL to a storage	create /nodes/{node}/storage/{storage}/download-url --url {url} --filename {filename} --content {iso|vztmpl}
do exec vm agent	<node> <vmid> <command> or --guest	Execute a command inside the VM via QEMU guest agent	create /nodes/{node}/qemu/{vmid}/agent/exec --command {command}
do migrate cluster ha resource	<sid> <node>	Request online migration of a HA resource to another node	create /cluster/ha/resources/{sid}/migrate --node {node}
do migrate ct	<node> <vmid> <target_node> or --guest	Migrate a container to another node	create /nodes/{node}/lxc/{vmid}/migrate --target {target_node}
do migrate guest	<node> <vmtype> <vmid> <target_node> or --guest	Migrate a guest to another node (VM or CT)	create /nodes/{node}/{vmtype}/{vmid}/migrate --target {target_node}
do migrate vm	<node> <vmid> <target_node> or --guest	Live migrate a VM to another node	create /nodes/{node}/qemu/{vmid}/migrate --target {target_node}
do migrateall node --yes	<node> <target_node>	Migrate all guests from a node to other nodes	create /nodes/{node}/migrateall --target {target_node}
do monitor vm	<node> <vmid> <command> or --guest	Execute a QEMU monitor (HMP) command on a VM	create /nodes/{node}/qemu/{vmid}/monitor --command {command}
do move ct disk	<node> <vmid> <disk> <storage> or --guest	Move a CT volume to a different storage	create /nodes/{node}/lxc/{vmid}/move_volume --volume {disk} --storage {storage}
do move vm disk	<node> <vmid> <disk> <storage> or --guest	Move a VM disk to a different storage	create /nodes/{node}/qemu/{vmid}/move_disk --disk {disk} --storage {storage}
do prune node backups --yes	<node> <storage>	Prune old backups on a storage according to retention settings	delete /nodes/{node}/storage/{storage}/prunebackups
do reboot ct --yes	<node> <vmid> or --guest	Reboot a container	create /nodes/{node}/lxc/{vmid}/status/reboot
do reboot guest --yes	<node> <vmtype> <vmid> or --guest	Reboot a guest (VM or CT)	create /nodes/{node}/{vmtype}/{vmid}/status/reboot
do reboot node --yes	<node>	Reboot a node	create /nodes/{node}/status --command reboot
do reboot vm --yes	<node> <vmid> or --guest	Reboot a VM	create /nodes/{node}/qemu/{vmid}/status/reboot
do reload node service	<node> <service>	Reload a service on a node (restart if it cannot reload)	create /nodes/{node}/services/{service}/reload
do relocate cluster ha resource	<sid> <node>	Relocate a HA resource to another node (stop and restart)	create /cluster/ha/resources/{sid}/relocate --node {node}
do renew node certificate	<node>	Renew the ACME certificate of a node	set /nodes/{node}/certificates/acme/certificate
do reset vm --yes	<node> <vmid> or --guest	Reset a VM	create /nodes/{node}/qemu/{vmid}/status/reset
do resize ct disk	<node> <vmid> <disk> <size> or --guest	Expand a CT disk	set /nodes/{node}/lxc/{vmid}/resize --disk {disk} --size {size}
do resize guest disk	<node> <vmtype> <vmid> <disk> <size> or --guest	Expand a guest disk (VM or CT)	set /nodes/{node}/{vmtype}/{vmid}/resize --disk {disk} --size {size}
do resize vm disk	<node> <vmid> <disk> <size> or --guest	Expand a VM disk	set /nodes/{node}/qemu/{vmid}/resize --disk {disk} --size {size}
do restart node service	<node> <service>	Restart a service on a node	create /nodes/{node}/services/{service}/restart
do restore ct --yes	<node> <vmid> <volume>	Restore a container from a vzdump backup archive (creates/overwrites the target vmid)	create /nodes/{node}/lxc --vmid {vmid} --ostemplate {volume} --restore 1
do restore vm --yes	<node> <vmid> <volume>	Restore a VM from a vzdump backup archive (creates/overwrites the target vmid)	create /nodes/{node}/qemu --vmid {vmid} --archive {volume}
do resume ct	<node> <vmid> or --guest	Resume a suspended container	create /nodes/{node}/lxc/{vmid}/status/resume
do resume guest	<node> <vmtype> <vmid> or --guest	Resume a suspended guest (VM or CT)	create /nodes/{node}/{vmtype}/{vmid}/status/resume
do resume vm	<node> <vmid> or --guest	Resume a suspended VM	create /nodes/{node}/qemu/{vmid}/status/resume
do rollback ct --yes	<node> <vmid> <snapname> or --guest	Rollback container state to a specific snapshot	create /nodes/{node}/lxc/{vmid}/snapshot/{snapname}/rollback
do rollback guest --yes	<node> <vmtype> <vmid> <snapname> or --guest	Rollback guest state to a specific snapshot (VM or CT)	create /nodes/{node}/{vmtype}/{vmid}/snapshot/{snapname}/rollback
do rollback vm --yes	<node> <vmid> <snapname> or --guest	Rollback VM state to a specific snapshot	create /nodes/{node}/qemu/{vmid}/snapshot/{snapname}/rollback
do shutdown ct --yes	<node> <vmid> or --guest	Shutdown a container	create /nodes/{node}/lxc/{vmid}/status/shutdown
do shutdown guest --yes	<node> <vmtype> <vmid> or --guest	Shutdown a guest (VM or CT)	create /nodes/{node}/{vmtype}/{vmid}/status/shutdown
do shutdown node --yes	<node>	Shutdown a node	create /nodes/{node}/status --command shutdown
do shutdown vm --yes	<node> <vmid> or --guest	Shutdown a VM	create /nodes/{node}/qemu/{vmid}/status/shutdown
do start ct	<node> <vmid> or --guest	Start a container	create /nodes/{node}/lxc/{vmid}/status/start
do start guest	<node> <vmtype> <vmid> or --guest	Start a guest (VM or CT)	create /nodes/{node}/{vmtype}/{vmid}/status/start
do start node service	<node> <service>	Start a service on a node	create /nodes/{node}/services/{service}/start
do start vm	<node> <vmid> or --guest	Start a VM	create /nodes/{node}/qemu/{vmid}/status/start
do startall node	<node>	Start all VMs and containers on a node (onboot=1 by default)	create /nodes/{node}/startall
do stop ct --yes	<node> <vmid> or --guest	Stop a container	create /nodes/{node}/lxc/{vmid}/status/stop
do stop guest --yes	<node> <vmtype> <vmid> or --guest	Stop a guest (VM or CT)	create /nodes/{node}/{vmtype}/{vmid}/status/stop
do stop node service	<node> <service>	Stop a service on a node	create /nodes/{node}/services/{service}/stop
do stop node task --yes	<node> <upid>	Stop/Kill a running task	delete /nodes/{node}/tasks/{upid}
do stop vm --yes	<node> <vmid> or --guest	Stop a VM	create /nodes/{node}/qemu/{vmid}/status/stop
do stopall node --yes	<node>	Stop all VMs and containers on a node	create /nodes/{node}/stopall
do suspend vm	<node> <vmid> or --guest	Suspend a VM	create /nodes/{node}/qemu/{vmid}/status/suspend
do suspendall node --yes	<node>	Suspend all guests on a node	create /nodes/{node}/suspendall
do sync cluster replication	<node> <id>	Force an immediate replication sync	create /nodes/{node}/replication/{id}/schedule_now
do sync security domain	<realm>	Sync users/groups from an external authentication domain	create /access/domains/{realm}/sync
do test cluster notification	<name>	Send a test notification to a specific target	create /cluster/notifications/targets/{name}/test
do update node packages	<node>	Trigger an apt update (refresh package cache) on a node	create /nodes/{node}/apt/update
do vm agent fsfreeze --yes	<node> <vmid> or --guest	Freeze the guest filesystems (thaw them with do vm agent fsthaw)	create /nodes/{node}/qemu/{vmid}/agent/fsfreeze-freeze
do vm agent fsfreeze-status	<node> <vmid> or --guest	Show whether the guest filesystems are frozen	create /nodes/{node}/qemu/{vmid}/agent/fsfreeze-status
do vm agent fsthaw	<node> <vmid> or --guest	Thaw the guest filesystems	create /nodes/{node}/qemu/{vmid}/agent/fsfreeze-thaw
do vm agent fstrim	<node> <vmid> or --guest	Run fstrim inside the guest via QEMU guest agent	create /nodes/{node}/qemu/{vmid}/agent/fstrim
do vm agent ping	<node> <vmid> or --guest	Ping the QEMU guest agent to verify it is running	create /nodes/{node}/qemu/{vmid}/agent/ping
do wakeup node	<node>	Send Wake-on-LAN magic packet to a node	create /nodes/{node}/wakeonlan

create

Creates.

Alias	Arguments	Description	API call
create cluster backup-job	<vmid> <storage> <schedule>	Create a new scheduled backup job	create /cluster/backup --vmid {vmid} --storage {storage} --schedule {schedule}
create cluster firewall alias	<name> <cidr>	Create a cluster firewall alias for an address or network	create /cluster/firewall/aliases --name {name} --cidr {cidr}
create cluster firewall ipset	<name>	Create a cluster firewall IPSet	create /cluster/firewall/ipset --name {name}
create cluster firewall ipset-entry	<name> <cidr>	Add an address or network to a cluster firewall IPSet	create /cluster/firewall/ipset/{name} --cidr {cidr}
create cluster firewall-rule		Add a new firewall rule to the cluster (also needs --action and --type)	create /cluster/firewall/rules
create cluster ha group	<group> <nodes>	Create a new HA group	create /cluster/ha/groups --group {group} --nodes {nodes}
create cluster ha resource	<sid> <group>	Add a VM or CT to HA management	create /cluster/ha/resources --sid {sid} --group {group}
create cluster mapping pci	<id>	Create a new PCI hardware mapping (also needs --map)	create /cluster/mapping/pci --id {id}
create cluster mapping usb	<id>	Create a new USB hardware mapping (also needs --map)	create /cluster/mapping/usb --id {id}
create cluster metrics-server	<id> <influxdb|graphite> <server>	Add a new metric server target (InfluxDB/Graphite) (also needs --port)	create /cluster/metrics/server/{id} --type {influxdb|graphite} --server {server}
create cluster replication job	<id> <target>	Create a new replication job (cluster-level)	create /cluster/replication --id {id} --target {target} --type local
create ct firewall-rule	<node> <vmid> or --guest	Add a new firewall rule to a container (also needs --action and --type)	create /nodes/{node}/lxc/{vmid}/firewall/rules
create ct snapshot	<node> <vmid> <snapname> <descr> or --guest	Create a new snapshot for a container	create /nodes/{node}/lxc/{vmid}/snapshot --snapname {snapname} --description {descr}
create ct template --yes	<node> <vmid> or --guest	Convert the container into a template	create /nodes/{node}/lxc/{vmid}/template
create guest firewall-rule	<node> <vmtype> <vmid> or --guest	Add a new firewall rule to a guest (VM or CT) (also needs --action and --type)	create /nodes/{node}/{vmtype}/{vmid}/firewall/rules
create guest snapshot	<node> <vmtype> <vmid> <snapname> <descr> or --guest	Create a new snapshot for a guest (VM or CT)	create /nodes/{node}/{vmtype}/{vmid}/snapshot --snapname {snapname} --description {descr}
create guest template --yes	<node> <vmtype> <vmid> or --guest	Convert a guest into a template (VM or CT)	create /nodes/{node}/{vmtype}/{vmid}/template
create node firewall-rule	<node>	Add a new firewall rule to a node (also needs --action and --type)	create /nodes/{node}/firewall/rules
create pool	<poolid> <comment>	Create a new resource pool	create /pools --poolid {poolid} --comment {comment}
create security domain	<realm> <pam|pve|ldap|ad|openid>	Create a new authentication domain (LDAP, AD, OpenID, …)	create /access/domains --realm {realm} --type {pam|pve|ldap|ad|openid}
create security group	<groupid>	Create a new user group	create /access/groups --groupid {groupid}
create security role	<roleid> <privileges>	Create a new custom role with specific privileges	create /access/roles --roleid {roleid} --privs {privileges}
create security tfa	<userid> <totp|webauthn|u2f|recovery>	Add a TFA entry (TOTP, WebAuthn, recovery keys) for a user	create /access/tfa/{userid} --type {totp|webauthn|u2f|recovery}
create security token	<userid> <tokenid> <0|1>	Generate a new API token for a user	create /access/users/{userid}/token/{tokenid} --privsep {0|1}
create security user	<userid> <password>	Create a new user account	create /access/users --userid {userid} --password {password}
create storage	<storage> <dir|nfs|cifs|lvm|zfspool|rbd|cephfs|pbs>	Add a new storage definition to the cluster	create /storage --storage {storage} --type {dir|nfs|cifs|lvm|zfspool|rbd|cephfs|pbs}
create vm firewall-rule	<node> <vmid> or --guest	Add a new firewall rule to a VM (also needs --action and --type)	create /nodes/{node}/qemu/{vmid}/firewall/rules
create vm snapshot	<node> <vmid> <snapname> <descr> or --guest	Create a new snapshot for a VM	create /nodes/{node}/qemu/{vmid}/snapshot --snapname {snapname} --description {descr}
create vm template --yes	<node> <vmid> or --guest	Convert the VM into a read-only template	create /nodes/{node}/qemu/{vmid}/template

set

Changes a configuration.

Alias	Arguments	Description	API call
set cluster backup-job	<id>	Update an existing backup job	set /cluster/backup/{id}
set cluster firewall options		Update cluster firewall options	set /cluster/firewall/options
set cluster firewall-rule	<pos>	Update a specific cluster firewall rule	set /cluster/firewall/rules/{pos}
set cluster ha group	<group>	Update a HA group configuration	set /cluster/ha/groups/{group}
set cluster ha resource	<sid>	Update a HA resource configuration	set /cluster/ha/resources/{sid}
set cluster mapping pci	<id>	Update a PCI hardware mapping	set /cluster/mapping/pci/{id}
set cluster mapping usb	<id>	Update a USB hardware mapping (also needs --map)	set /cluster/mapping/usb/{id}
set cluster metrics-server	<id>	Update a metric server configuration (also needs --port and --server)	set /cluster/metrics/server/{id}
set cluster options		Update cluster-wide options	set /cluster/options
set cluster replication job	<id>	Update a cluster replication job	set /cluster/replication/{id}
set ct config	<node> <vmid> or --guest	Update CT configuration (RAM, Cores, etc.)	set /nodes/{node}/lxc/{vmid}/config
set ct firewall	<node> <vmid> or --guest	Enable/Disable container firewall	set /nodes/{node}/lxc/{vmid}/firewall/options
set ct firewall options	<node> <vmid> or --guest	Update firewall options for a container	set /nodes/{node}/lxc/{vmid}/firewall/options
set ct firewall-rule	<node> <vmid> <pos> or --guest	Update a CT firewall rule	set /nodes/{node}/lxc/{vmid}/firewall/rules/{pos}
set ct snapshot	<node> <vmid> <snapname> <description> or --guest	Update CT snapshot description	set /nodes/{node}/lxc/{vmid}/snapshot/{snapname}/config --description {description}
set ct tags	<node> <vmid> <tags> or --guest	Set or overwrite tags for a container	set /nodes/{node}/lxc/{vmid}/config --tags {tags}
set guest config	<node> <vmtype> <vmid> or --guest	Update guest configuration (VM or CT)	set /nodes/{node}/{vmtype}/{vmid}/config
set guest firewall	<node> <vmtype> <vmid> or --guest	Enable/Disable guest firewall (VM or CT)	set /nodes/{node}/{vmtype}/{vmid}/firewall/options
set guest firewall options	<node> <vmtype> <vmid> or --guest	Update firewall options for a guest (VM or CT)	set /nodes/{node}/{vmtype}/{vmid}/firewall/options
set guest firewall-rule	<node> <vmtype> <vmid> <pos> or --guest	Update a guest firewall rule (VM or CT)	set /nodes/{node}/{vmtype}/{vmid}/firewall/rules/{pos}
set guest snapshot	<node> <vmtype> <vmid> <snapname> <description> or --guest	Update guest snapshot description	set /nodes/{node}/{vmtype}/{vmid}/snapshot/{snapname}/config --description {description}
set guest tags	<node> <vmtype> <vmid> <tags> or --guest	Set or overwrite tags for a guest (VM or CT)	set /nodes/{node}/{vmtype}/{vmid}/config --tags {tags}
set node config	<node>	Update node configuration options	set /nodes/{node}/config
set node dns	<node> <domain> <dns1>	Set DNS servers for a node	set /nodes/{node}/dns --search {domain} --dns1 {dns1}
set node firewall	<node>	Enable/Disable node firewall	set /nodes/{node}/firewall/options
set node firewall options	<node>	Update firewall options for a node	set /nodes/{node}/firewall/options
set node firewall-rule	<node> <pos>	Update a specific node firewall rule	set /nodes/{node}/firewall/rules/{pos}
set node hosts	<node> <data>	Write /etc/hosts content of a node	create /nodes/{node}/hosts --data {data}
set node time	<node> <timezone>	Set the timezone of a node	set /nodes/{node}/time --timezone {timezone}
set pool	<poolid>	Update pool configuration	set /pools/{poolid}
set security acl	<path> <role> <userid>	Update permissions for a path/user/group	set /access/acl --path {path} --roles {role} --users {userid}
set security domain	<realm>	Update an authentication domain	set /access/domains/{realm}
set security group	<groupid>	Update a user group	set /access/groups/{groupid}
set security password	<userid> <password>	Change the password of a user	set /access/password --userid {userid} --password {password}
set security role	<roleid> <privileges>	Update privileges for an existing custom role	set /access/roles/{roleid} --privs {privileges}
set security user	<userid>	Update user account settings	set /access/users/{userid}
set storage config	<storage>	Update an existing storage configuration	set /storage/{storage}
set vm config	<node> <vmid> or --guest	Update VM configuration (RAM, Cores, etc.)	set /nodes/{node}/qemu/{vmid}/config
set vm firewall	<node> <vmid> or --guest	Enable/Disable VM firewall	set /nodes/{node}/qemu/{vmid}/firewall/options
set vm firewall options	<node> <vmid> or --guest	Update firewall options for a VM	set /nodes/{node}/qemu/{vmid}/firewall/options
set vm firewall-rule	<node> <vmid> <pos> or --guest	Update a VM firewall rule	set /nodes/{node}/qemu/{vmid}/firewall/rules/{pos}
set vm snapshot	<node> <vmid> <snapname> <description> or --guest	Update VM snapshot description	set /nodes/{node}/qemu/{vmid}/snapshot/{snapname}/config --description {description}
set vm tags	<node> <vmid> <tags> or --guest	Set or overwrite tags for a VM	set /nodes/{node}/qemu/{vmid}/config --tags {tags}

delete

Removes.

Alias	Arguments	Description	API call
delete cluster backup-job --yes	<id>	Remove a backup job schedule	delete /cluster/backup/{id}
delete cluster firewall alias --yes	<name>	Delete a cluster firewall alias	delete /cluster/firewall/aliases/{name}
delete cluster firewall ipset --yes	<name>	Delete a cluster firewall IPSet (it must be empty)	delete /cluster/firewall/ipset/{name}
delete cluster firewall ipset-entry --yes	<name> <cidr>	Remove an address or network from a cluster firewall IPSet	delete /cluster/firewall/ipset/{name}/{cidr}
delete cluster firewall-rule --yes	<pos>	Remove a cluster firewall rule by position	delete /cluster/firewall/rules/{pos}
delete cluster ha group --yes	<group>	Delete a HA group configuration	delete /cluster/ha/groups/{group}
delete cluster ha resource --yes	<sid>	Remove a resource from HA management	delete /cluster/ha/resources/{sid}
delete cluster mapping pci --yes	<id>	Remove a PCI hardware mapping	delete /cluster/mapping/pci/{id}
delete cluster mapping usb --yes	<id>	Remove a USB hardware mapping	delete /cluster/mapping/usb/{id}
delete cluster metrics-server --yes	<id>	Remove a metric server configuration	delete /cluster/metrics/server/{id}
delete cluster replication job --yes	<id>	Remove a cluster replication job	delete /cluster/replication/{id}
delete ct --yes	<node> <vmid> or --guest	Destroy a container (Permanent!)	delete /nodes/{node}/lxc/{vmid}
delete ct firewall-rule --yes	<node> <vmid> <pos> or --guest	Remove a firewall rule from a container	delete /nodes/{node}/lxc/{vmid}/firewall/rules/{pos}
delete ct snapshot --yes	<node> <vmid> <snapname> or --guest	Delete a specific container snapshot	delete /nodes/{node}/lxc/{vmid}/snapshot/{snapname}
delete ct tags	<node> <vmid> or --guest	Remove all tags from a container	set /nodes/{node}/lxc/{vmid}/config --delete tags
delete ct unused-disk --yes	<node> <vmid> <unusedDisk> or --guest	Remove an unattached disk from a CT	set /nodes/{node}/lxc/{vmid}/config --delete {unusedDisk}
delete guest --yes	<node> <vmtype> <vmid> or --guest	Destroy a guest VM or CT (Permanent!)	delete /nodes/{node}/{vmtype}/{vmid}
delete guest backup --yes	<node> <storage> <volume>	Permanently delete a backup file from storage	delete /nodes/{node}/storage/{storage}/content/{volume}
delete guest firewall-rule --yes	<node> <vmtype> <vmid> <pos> or --guest	Remove a firewall rule from a guest (VM or CT)	delete /nodes/{node}/{vmtype}/{vmid}/firewall/rules/{pos}
delete guest snapshot --yes	<node> <vmtype> <vmid> <snapname> or --guest	Delete a specific guest snapshot	delete /nodes/{node}/{vmtype}/{vmid}/snapshot/{snapname}
delete guest tags	<node> <vmtype> <vmid> or --guest	Remove all tags from a guest (VM or CT)	set /nodes/{node}/{vmtype}/{vmid}/config --delete tags
delete guest unused-disk --yes	<node> <vmtype> <vmid> <unusedDisk> or --guest	Remove an unattached disk from a guest (VM or CT)	set /nodes/{node}/{vmtype}/{vmid}/config --delete {unusedDisk}
delete node firewall-rule --yes	<node> <pos>	Remove a firewall rule from a node	delete /nodes/{node}/firewall/rules/{pos}
delete pool --yes	<poolid>	Remove a resource pool	delete /pools/{poolid}
delete security domain --yes	<realm>	Remove an authentication domain	delete /access/domains/{realm}
delete security group --yes	<groupid>	Remove a user group	delete /access/groups/{groupid}
delete security role --yes	<roleid>	Remove a custom role	delete /access/roles/{roleid}
delete security tfa --yes	<userid> <id>	Remove a TFA entry for a user	delete /access/tfa/{userid}/{id}
delete security token --yes	<userid> <tokenid>	Remove an API token	delete /access/users/{userid}/token/{tokenid}
delete security user --yes	<userid>	Remove a user account	delete /access/users/{userid}
delete storage config --yes	<storage>	Remove a storage definition from the cluster	delete /storage/{storage}
delete vm --yes	<node> <vmid> or --guest	Destroy a VM (Permanent!)	delete /nodes/{node}/qemu/{vmid}
delete vm firewall-rule --yes	<node> <vmid> <pos> or --guest	Remove a firewall rule from a VM	delete /nodes/{node}/qemu/{vmid}/firewall/rules/{pos}
delete vm snapshot --yes	<node> <vmid> <snapname> or --guest	Delete a specific VM snapshot	delete /nodes/{node}/qemu/{vmid}/snapshot/{snapname}
delete vm tags	<node> <vmid> or --guest	Remove all tags from a VM	set /nodes/{node}/qemu/{vmid}/config --delete tags
delete vm unused-disk --yes	<node> <vmid> <unusedDisk> or --guest	Remove an unattached disk from a VM	set /nodes/{node}/qemu/{vmid}/config --delete {unusedDisk}