Commands
Every command accepts --help (-h, -?). cv4pve-cli --version prints the version. The aliases
are commands too: see the alias reference.
config
Section titled “config”Saved connections: see Contexts.
| Command | Arguments and options |
|---|---|
config add <name> |
--host (required, nodes comma-separated, each with an optional port), --port (default 8006), --api-token, --username, --password, --validate-certificate (default true), --timeout (seconds, default 30) |
config set <name> |
The same options as config add; only those given are changed |
config use <name> |
|
config current |
|
config list |
|
config view |
|
config verify [<name>] |
Default: the current context |
config rename <name> <new-name> |
|
config delete <name> |
Calls on any API path: see API calls.
| Command | Arguments and options |
|---|---|
api get <path> [--key value …] |
--output/-o, --verbose/-v, --all-columns/-A, --human-readable <true|false> (default true), --wait, --wait-timeout (seconds, default: until the task ends) |
api set <path> [--key value …] |
The same |
api create <path> [--key value …] |
The same |
api delete <path> [--key value …] |
The same |
api ls <path> |
|
api usage <path> [get|set|create|delete] |
--verbose/-v, --returns/-r, --output/-o |
--output: text (default), json, jsonpretty, markdown, html.
The aliases: see Aliases.
| Command | Arguments and options |
|---|---|
alias list |
--search/-s <text>, --verbose/-v, --output/-o |
alias add <name> |
--command/-c (required), --description/-d |
alias remove <name> |
Your aliases only |
Each alias accepts its arguments, --key value API parameters, --output/-o, --verbose/-v,
--all-columns/-A, --human-readable, --wait, --wait-timeout and, when the path targets a guest, --guest/-g. The aliases that change the cluster the
most need --yes/-y: see Operations that change the cluster.
Proxmox VE tasks by UPID: see Tasks.
| Command | Arguments and options |
|---|---|
task list |
--node <node> (default: the whole cluster), --output/-o |
task show <upid> |
|
task wait <upid> |
--timeout (seconds, default 300) |
task log <upid> |
--follow/-f, --limit (default 500), --interval (seconds, default 2, minimum 1) |
task stop <upid> |
--yes/-y (required to stop) |
completion
Section titled “completion”| Command | What it does |
|---|---|
completion reset |
Writes the completion scripts again: see Tab completion |
Hidden options
Section titled “Hidden options”Not listed in --help, accepted before or after any command:
| Option | What it does |
|---|---|
--debug, --log-level |
Log of the API calls: see Troubleshooting |
--dry-run |
api commands and aliases print the call and send nothing |
top is an alias of api get /cluster/resources. complete is used by the completion scripts.