Pdm¶
proxmox pdm --help¶
Input:
Output:
Usage: proxmox pdm [OPTIONS] COMMAND [ARGS]...
Proxmox Datacenter Manager (PDM) commands.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ subscriptions Show fleet-wide subscription status. │
│ tui Launch the PDM Textual TUI. │
│ remote Manage PDM remotes. │
│ pve PDM operations on registered PVE remotes. │
│ pbs PDM operations on registered PBS remotes. │
│ resources Global cross-remote resources. │
│ metrics Metric collection. │
│ access Users, ACL, TFA. │
│ views Custom cross-remote dashboards. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.727
proxmox pdm access --help¶
Input:
Output:
Usage: proxmox pdm access [OPTIONS] COMMAND [ARGS]...
Users, ACL, TFA.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ user User accounts. │
│ acl Access control entries. │
│ tfa Two-factor auth. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.723
proxmox pdm access acl --help¶
Input:
Output:
Usage: proxmox pdm access acl [OPTIONS] COMMAND [ARGS]...
Access control entries.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ list List ACL entries. │
│ update Add or update an ACL entry. │
│ delete Remove an ACL entry. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.726
proxmox pdm access acl delete --help¶
Input:
Output:
Usage: proxmox pdm access acl delete [OPTIONS]
Remove an ACL entry.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --path TEXT [required] │
│ * --roles TEXT [required] │
│ --users TEXT │
│ --groups TEXT │
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.750
proxmox pdm access acl list --help¶
Input:
Output:
Usage: proxmox pdm access acl list [OPTIONS]
List ACL entries.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.731
proxmox pdm access acl update --help¶
Input:
Output:
Usage: proxmox pdm access acl update [OPTIONS]
Add or update an ACL entry.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --path TEXT [required] │
│ * --roles TEXT [required] │
│ --users TEXT │
│ --groups TEXT │
│ --propagate --no-propagate │
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.747
proxmox pdm access tfa --help¶
Input:
Output:
Usage: proxmox pdm access tfa [OPTIONS] COMMAND [ARGS]...
Two-factor auth.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ list List TFA factors for a user. │
│ add Add a TFA factor to a user. │
│ delete Remove a TFA factor. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.728
proxmox pdm access tfa add --help¶
Input:
Output:
Usage: proxmox pdm access tfa add [OPTIONS] USERID
Add a TFA factor to a user.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * userid TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --type TEXT totp, webauthn, recovery, … [required] │
│ --description TEXT │
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.724
proxmox pdm access tfa delete --help¶
Input:
Output:
Usage: proxmox pdm access tfa delete [OPTIONS] USERID TFA_ID
Remove a TFA factor.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * userid TEXT [required] │
│ * tfa_id TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.727
proxmox pdm access tfa list --help¶
Input:
Output:
Usage: proxmox pdm access tfa list [OPTIONS] USERID
List TFA factors for a user.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * userid TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.712
proxmox pdm access user --help¶
Input:
Output:
Usage: proxmox pdm access user [OPTIONS] COMMAND [ARGS]...
User accounts.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ list List PDM users. │
│ create Create a PDM user. │
│ update Update a PDM user. │
│ delete Delete a PDM user. │
│ passwd Change the password of a PDM user. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.720
proxmox pdm access user create --help¶
Input:
Output:
Usage: proxmox pdm access user create [OPTIONS] USERID
Create a PDM user.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * userid TEXT user@realm [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --comment TEXT │
│ --email TEXT │
│ --enable --disable │
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.731
proxmox pdm access user delete --help¶
Input:
Output:
Usage: proxmox pdm access user delete [OPTIONS] USERID
Delete a PDM user.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * userid TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.726
proxmox pdm access user list --help¶
Input:
Output:
Usage: proxmox pdm access user list [OPTIONS]
List PDM users.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.730
proxmox pdm access user passwd --help¶
Input:
Output:
Usage: proxmox pdm access user passwd [OPTIONS] USERID
Change the password of a PDM user.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * userid TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --password TEXT [required] │
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.752
proxmox pdm access user update --help¶
Input:
Output:
Usage: proxmox pdm access user update [OPTIONS] USERID
Update a PDM user.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * userid TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --comment TEXT │
│ --email TEXT │
│ --enable --disable │
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.742
proxmox pdm metrics --help¶
Input:
Output:
Usage: proxmox pdm metrics [OPTIONS] COMMAND [ARGS]...
Metric collection.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ status Show metric collection status. │
│ trigger Manually trigger metric collection. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.728
proxmox pdm metrics status --help¶
Input:
Output:
Usage: proxmox pdm metrics status [OPTIONS]
Show metric collection status.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.721
proxmox pdm metrics trigger --help¶
Input:
Output:
Usage: proxmox pdm metrics trigger [OPTIONS]
Manually trigger metric collection.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.720
proxmox pdm pbs --help¶
Input:
Output:
Usage: proxmox pdm pbs [OPTIONS] COMMAND [ARGS]...
PDM operations on registered PBS remotes.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ datastore PBS datastores. │
│ snapshot PBS snapshots. │
│ node PBS node operations. │
│ tasks PBS tasks. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.745
proxmox pdm pbs datastore --help¶
Input:
Output:
Usage: proxmox pdm pbs datastore [OPTIONS] COMMAND [ARGS]...
PBS datastores.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ list List PBS datastores on a remote. │
│ rrddata Fetch RRD samples for a PBS datastore. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.714
proxmox pdm pbs datastore list --help¶
Input:
Output:
Usage: proxmox pdm pbs datastore list [OPTIONS] REMOTE
List PBS datastores on a remote.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * remote TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.724
proxmox pdm pbs datastore rrddata --help¶
Input:
Output:
Usage: proxmox pdm pbs datastore rrddata [OPTIONS] REMOTE STORE
Fetch RRD samples for a PBS datastore.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * remote TEXT [required] │
│ * store TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --timeframe TEXT [default: hour] │
│ --cf TEXT │
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.727
proxmox pdm pbs node --help¶
Input:
Output:
Usage: proxmox pdm pbs node [OPTIONS] COMMAND [ARGS]...
PBS node operations.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ rrddata Fetch RRD samples for the PBS node. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.722
proxmox pdm pbs node rrddata --help¶
Input:
Output:
Usage: proxmox pdm pbs node rrddata [OPTIONS] REMOTE
Fetch RRD samples for the PBS node.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * remote TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --timeframe TEXT [default: hour] │
│ --cf TEXT │
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.720
proxmox pdm pbs snapshot --help¶
Input:
Output:
Usage: proxmox pdm pbs snapshot [OPTIONS] COMMAND [ARGS]...
PBS snapshots.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ list List snapshots in a PBS datastore. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.723
proxmox pdm pbs snapshot list --help¶
Input:
Output:
Usage: proxmox pdm pbs snapshot list [OPTIONS] REMOTE STORE
List snapshots in a PBS datastore.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * remote TEXT [required] │
│ * store TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --namespace,--ns TEXT │
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.723
proxmox pdm pbs tasks --help¶
Input:
Output:
Usage: proxmox pdm pbs tasks [OPTIONS] COMMAND [ARGS]...
PBS tasks.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ list List tasks on a PBS remote. │
│ status Show the status of a PBS task. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.781
proxmox pdm pbs tasks list --help¶
Input:
Output:
Usage: proxmox pdm pbs tasks list [OPTIONS] REMOTE
List tasks on a PBS remote.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * remote TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.753
proxmox pdm pbs tasks status --help¶
Input:
Output:
Usage: proxmox pdm pbs tasks status [OPTIONS] REMOTE UPID
Show the status of a PBS task.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * remote TEXT [required] │
│ * upid TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.744
proxmox pdm pve --help¶
Input:
Output:
Usage: proxmox pdm pve [OPTIONS] COMMAND [ARGS]...
PDM operations on registered PVE remotes.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ resources Query resources on a PVE remote. │
│ tasks List tasks on a PVE remote. │
│ qemu QEMU VMs on a PVE remote. │
│ lxc LXC containers on a PVE remote. │
│ node PVE nodes on a remote. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.715
proxmox pdm pve lxc --help¶
Input:
Output:
Usage: proxmox pdm pve lxc [OPTIONS] COMMAND [ARGS]...
LXC containers on a PVE remote.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ list List guests on the remote. │
│ config Show a guest configuration. │
│ start Start the guest. │
│ stop Force-stop the guest. │
│ shutdown Gracefully shut down the guest. │
│ migrate Migrate the guest within the same cluster. │
│ remote-migrate Migrate the guest to another registered PDM cluster. │
│ rrddata Fetch RRD samples for the guest. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.718
proxmox pdm pve lxc config --help¶
Input:
Output:
Usage: proxmox pdm pve lxc config [OPTIONS] REMOTE VMID
Show a guest configuration.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * remote TEXT [required] │
│ * vmid INTEGER [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.729
proxmox pdm pve lxc list --help¶
Input:
Output:
Usage: proxmox pdm pve lxc list [OPTIONS] REMOTE
List guests on the remote.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * remote TEXT Remote id. [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.725
proxmox pdm pve lxc migrate --help¶
Input:
Output:
Usage: proxmox pdm pve lxc migrate [OPTIONS] REMOTE VMID
Migrate the guest within the same cluster.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * remote TEXT [required] │
│ * vmid INTEGER [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --target TEXT Target node name. [required] │
│ --online │
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.742
proxmox pdm pve lxc remote-migrate --help¶
Input:
Output:
Usage: proxmox pdm pve lxc remote-migrate [OPTIONS] REMOTE VMID
Migrate the guest to another registered PDM cluster.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * remote TEXT [required] │
│ * vmid INTEGER [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --target-remote TEXT [required] │
│ --target-vmid INTEGER │
│ --target-node TEXT │
│ --online │
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.733
proxmox pdm pve lxc rrddata --help¶
Input:
Output:
Usage: proxmox pdm pve lxc rrddata [OPTIONS] REMOTE VMID
Fetch RRD samples for the guest.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * remote TEXT [required] │
│ * vmid INTEGER [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --timeframe TEXT [default: hour] │
│ --cf TEXT │
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.720
proxmox pdm pve lxc shutdown --help¶
Input:
Output:
Usage: proxmox pdm pve lxc shutdown [OPTIONS] REMOTE VMID
Gracefully shut down the guest.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * remote TEXT [required] │
│ * vmid INTEGER [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.739
proxmox pdm pve lxc start --help¶
Input:
Output:
Usage: proxmox pdm pve lxc start [OPTIONS] REMOTE VMID
Start the guest.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * remote TEXT [required] │
│ * vmid INTEGER [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.742
proxmox pdm pve lxc stop --help¶
Input:
Output:
Usage: proxmox pdm pve lxc stop [OPTIONS] REMOTE VMID
Force-stop the guest.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * remote TEXT [required] │
│ * vmid INTEGER [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.733
proxmox pdm pve node --help¶
Input:
Output:
Usage: proxmox pdm pve node [OPTIONS] COMMAND [ARGS]...
PVE nodes on a remote.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ list List PVE nodes on a remote. │
│ rrddata Fetch RRD samples for a node. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.718
proxmox pdm pve node list --help¶
Input:
Output:
Usage: proxmox pdm pve node list [OPTIONS] REMOTE
List PVE nodes on a remote.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * remote TEXT Remote id. [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.740
proxmox pdm pve node rrddata --help¶
Input:
Output:
Usage: proxmox pdm pve node rrddata [OPTIONS] REMOTE NODE
Fetch RRD samples for a node.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * remote TEXT [required] │
│ * node TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --timeframe TEXT [default: hour] │
│ --cf TEXT │
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.728
proxmox pdm pve qemu --help¶
Input:
Output:
Usage: proxmox pdm pve qemu [OPTIONS] COMMAND [ARGS]...
QEMU VMs on a PVE remote.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ list List guests on the remote. │
│ config Show a guest configuration. │
│ start Start the guest. │
│ stop Force-stop the guest. │
│ shutdown Gracefully shut down the guest. │
│ migrate Migrate the guest within the same cluster. │
│ remote-migrate Migrate the guest to another registered PDM cluster. │
│ rrddata Fetch RRD samples for the guest. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.743
proxmox pdm pve qemu config --help¶
Input:
Output:
Usage: proxmox pdm pve qemu config [OPTIONS] REMOTE VMID
Show a guest configuration.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * remote TEXT [required] │
│ * vmid INTEGER [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.718
proxmox pdm pve qemu list --help¶
Input:
Output:
Usage: proxmox pdm pve qemu list [OPTIONS] REMOTE
List guests on the remote.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * remote TEXT Remote id. [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.733
proxmox pdm pve qemu migrate --help¶
Input:
Output:
Usage: proxmox pdm pve qemu migrate [OPTIONS] REMOTE VMID
Migrate the guest within the same cluster.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * remote TEXT [required] │
│ * vmid INTEGER [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --target TEXT Target node name. [required] │
│ --online │
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.718
proxmox pdm pve qemu remote-migrate --help¶
Input:
Output:
Usage: proxmox pdm pve qemu remote-migrate [OPTIONS] REMOTE VMID
Migrate the guest to another registered PDM cluster.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * remote TEXT [required] │
│ * vmid INTEGER [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --target-remote TEXT [required] │
│ --target-vmid INTEGER │
│ --target-node TEXT │
│ --online │
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.722
proxmox pdm pve qemu rrddata --help¶
Input:
Output:
Usage: proxmox pdm pve qemu rrddata [OPTIONS] REMOTE VMID
Fetch RRD samples for the guest.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * remote TEXT [required] │
│ * vmid INTEGER [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --timeframe TEXT [default: hour] │
│ --cf TEXT │
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.721
proxmox pdm pve qemu shutdown --help¶
Input:
Output:
Usage: proxmox pdm pve qemu shutdown [OPTIONS] REMOTE VMID
Gracefully shut down the guest.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * remote TEXT [required] │
│ * vmid INTEGER [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.717
proxmox pdm pve qemu start --help¶
Input:
Output:
Usage: proxmox pdm pve qemu start [OPTIONS] REMOTE VMID
Start the guest.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * remote TEXT [required] │
│ * vmid INTEGER [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.725
proxmox pdm pve qemu stop --help¶
Input:
Output:
Usage: proxmox pdm pve qemu stop [OPTIONS] REMOTE VMID
Force-stop the guest.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * remote TEXT [required] │
│ * vmid INTEGER [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.722
proxmox pdm pve resources --help¶
Input:
Output:
Usage: proxmox pdm pve resources [OPTIONS] REMOTE
Query resources on a PVE remote.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * remote TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --type TEXT │
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.726
proxmox pdm pve tasks --help¶
Input:
Output:
Usage: proxmox pdm pve tasks [OPTIONS] REMOTE
List tasks on a PVE remote.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * remote TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.727
proxmox pdm remote --help¶
Input:
Output:
Usage: proxmox pdm remote [OPTIONS] COMMAND [ARGS]...
Manage PDM remotes.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ list List registered PDM remotes. │
│ version Query the version of a registered remote. │
│ add Register a new PVE or PBS remote with PDM. │
│ update Update a registered remote. │
│ remove Unregister a remote. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.717
proxmox pdm remote add --help¶
Input:
Output:
Usage: proxmox pdm remote add [OPTIONS] ID
Register a new PVE or PBS remote with PDM.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * id TEXT Remote id. [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --type -t TEXT Remote type (pve or pbs). [required] │
│ --authid TEXT │
│ --token TEXT │
│ --fingerprint TEXT │
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.728
proxmox pdm remote list --help¶
Input:
Output:
Usage: proxmox pdm remote list [OPTIONS]
List registered PDM remotes.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.732
proxmox pdm remote remove --help¶
Input:
Output:
Usage: proxmox pdm remote remove [OPTIONS] REMOTE
Unregister a remote.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * remote TEXT Remote id. [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.737
proxmox pdm remote update --help¶
Input:
Output:
Usage: proxmox pdm remote update [OPTIONS] REMOTE
Update a registered remote.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * remote TEXT Remote id. [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --token TEXT │
│ --fingerprint TEXT │
│ --authid TEXT │
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.724
proxmox pdm remote version --help¶
Input:
Output:
Usage: proxmox pdm remote version [OPTIONS] REMOTE
Query the version of a registered remote.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * remote TEXT Remote id. [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.720
proxmox pdm resources --help¶
Input:
Output:
Usage: proxmox pdm resources [OPTIONS] COMMAND [ARGS]...
Global cross-remote resources.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ list List global resources across every remote. │
│ status Show per-remote connectivity status. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.734
proxmox pdm resources list --help¶
Input:
Output:
Usage: proxmox pdm resources list [OPTIONS]
List global resources across every remote.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --type TEXT │
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.739
proxmox pdm resources status --help¶
Input:
Output:
Usage: proxmox pdm resources status [OPTIONS]
Show per-remote connectivity status.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.716
proxmox pdm subscriptions --help¶
Input:
Output:
Usage: proxmox pdm subscriptions [OPTIONS]
Show fleet-wide subscription status.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.720
proxmox pdm tui --help¶
Input:
Output:
Usage: proxmox pdm tui [OPTIONS] [MODE]
Launch the PDM Textual TUI.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ mode [MODE] Optional mode. Use 'mock' to run against the in-memory │
│ mock backend. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.731
proxmox pdm views --help¶
Input:
Output:
Usage: proxmox pdm views [OPTIONS] COMMAND [ARGS]...
Custom cross-remote dashboards.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ list List custom views. │
│ get Show a custom view. │
│ create Create a custom view. │
│ update Update a custom view. │
│ delete Delete a custom view. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.730
proxmox pdm views create --help¶
Input:
Output:
Usage: proxmox pdm views create [OPTIONS] ID
Create a custom view.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * id TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --name TEXT │
│ --comment TEXT │
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.718
proxmox pdm views delete --help¶
Input:
Output:
Usage: proxmox pdm views delete [OPTIONS] VIEW_ID
Delete a custom view.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * view_id TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.714
proxmox pdm views get --help¶
Input:
Output:
Usage: proxmox pdm views get [OPTIONS] VIEW_ID
Show a custom view.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * view_id TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.730
proxmox pdm views list --help¶
Input:
Output:
Usage: proxmox pdm views list [OPTIONS]
List custom views.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.724
proxmox pdm views update --help¶
Input:
Output:
Usage: proxmox pdm views update [OPTIONS] VIEW_ID
Update a custom view.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * view_id TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --name TEXT │
│ --comment TEXT │
│ --output -o TEXT │
│ --json │
│ --yaml │
│ --markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.725