Options available for command group ``proxmox-datacenter-manager-client``:

``--color`` ``no|always|auto   (default=auto)``
  Control terminal color output.

``--output-format`` ``text|json|json-pretty``
  Output format.

``--fingerprint`` ``<string>``
  Certificate fingerprint to expect.

``--host`` ``<string>``
  Server to connect to, or `user@realm@host` triple.

``--password-command`` ``<string>``
  Command to run to get the password.

``--password-file`` ``<string>``
  File to read the password from.

``--port`` ``<integer> (0 - 65535)   (default=8443)``
  Port to connect.

``--user`` ``<string>``
  User ID

----

``proxmox-datacenter-manager-client acl delete <path> <role> --auth-id <string> [OPTIONS]``

Delete an ACL entry.

``<path>`` : ``<string>``
  Access control path.

``<role>`` : ``<role>``
  Enum representing roles via their [PRIVILEGES] combination.

  Since privileges are implemented as bitflags, each unique combination of
  privileges maps to a single, unique `u64` value that is used in this enum
  definition.

``--auth-id`` ``<string>``
  Authentication ID

Optional parameters:

``--digest`` ``<string>``
  Prevent changes if current configuration file has different SHA256 digest.
  This can be used to prevent concurrent modifications.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client acl list [OPTIONS]``

List all users or show a single user's information.

Optional parameters:

``--exact`` ``<boolean>   (default=false)``
  If set, returns only ACL for the exact path.
``--path`` ``<string>``
  Access control path.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client acl update <path> <role> --auth-id <string> [OPTIONS]``

Add or update an ACL entry.

``<path>`` : ``<string>``
  Access control path.

``<role>`` : ``<role>``
  Enum representing roles via their [PRIVILEGES] combination.

  Since privileges are implemented as bitflags, each unique combination of
  privileges maps to a single, unique `u64` value that is used in this enum
  definition.

``--auth-id`` ``<string>``
  Authentication ID

Optional parameters:

``--digest`` ``<string>``
  Prevent changes if current configuration file has different SHA256 digest.
  This can be used to prevent concurrent modifications.
``--propagate`` ``<boolean>   (default=true)``
  Allow to propagate (inherit) permissions.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client help [{<command>}] [OPTIONS]``

Get help about specified command (or sub-command).

``<command>`` : ``<string>``
  Command. This may be a list in order to specify nested sub-commands. Can be
  specified more than once.

Optional parameters:

``--verbose`` ``<boolean>``
  Verbose help.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client login``

Log into a server.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client metric-collection status``

Show metric collection status.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client metric-collection trigger [OPTIONS]``

Trigger metric collection. If a remote is passed, only this remote will be collected, otherwise
all.

Optional parameters:

``--remote`` ``<string>``
  Remote ID.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client pbs datastore list <remote>``

List all the remotes this instance is managing.

``<remote>`` : ``<string>``
  Remote ID.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client pbs datastore rrddata <remote> <datastore> <mode> <timeframe>``

Return a PBS datastore's metric data.

``<remote>`` : ``<string>``
  Remote ID.

``<datastore>`` : ``<string>``
  Datastore name.

``<mode>`` : ``MAX|AVERAGE``
  RRD consolidation mode

``<timeframe>`` : ``hour|day|week|month|year|decade``
  RRD time frame

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client pbs node rrddata <remote> <mode> <timeframe>``

Return a PBS node's metric data.

``<remote>`` : ``<string>``
  Remote ID.

``<mode>`` : ``MAX|AVERAGE``
  RRD consolidation mode

``<timeframe>`` : ``hour|day|week|month|year|decade``
  RRD time frame

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client pbs snapshot list <remote> <datastore> [OPTIONS]``

List all the remotes this instance is managing.

``<remote>`` : ``<string>``
  Remote ID.

``<datastore>`` : ``<string>``
  Datastore name.

Optional parameters:

``--ns`` ``<string>``
  Namespace.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client pbs task list <remote>``

List the tasks of a cluster.

``<remote>`` : ``<string>``
  Remote ID.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client pbs task status <remote> <upid>``

Query the status of a task.

``<remote>`` : ``<string>``
  Remote ID.

``<upid>`` : ``<string>``
  The task UPID, optionally with the remote name prefix

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client pve lxc config <remote> <vmid> [OPTIONS]``

Query the configuration of a container.

``<remote>`` : ``<string>``
  Remote ID.

``<vmid>`` : ``<integer> (1 - N)``
  A guest ID

Optional parameters:

``--node`` ``<string>``
  Node name (or 'localhost')
``--snapshot`` ``<string>``
  The name of the snapshot
``--state`` ``pending|active   (default=pending)``
  Guest configuration access.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client pve lxc list <remote> [OPTIONS]``

List the LXC containers of a cluster.

``<remote>`` : ``<string>``
  Remote ID.

Optional parameters:

``--node`` ``<string>``
  Node name (or 'localhost')

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client pve lxc migrate <remote> <vmid> <target> [OPTIONS]``

Migrate a container to a different node in the same cluster.

``<remote>`` : ``<string>``
  Remote ID.

``<vmid>`` : ``<integer> (1 - N)``
  A guest ID

``<target>`` : ``<string>``
  Remote ID.

Optional parameters:

``--bwlimit`` ``<integer> (0 - N)``
  Override I/O bandwidth limit (in KiB/s).
``--map-storage`` ``FROM:TO,...``
  Mapping of source storages to ones on the target cluster. Can be specified
  more than once.
``--node`` ``<string>``
  Node name (or 'localhost')
``--online`` ``<boolean>``
  Perform an online migration if the vm is running.
``--restart`` ``<boolean>   (default=false)``
  Perform a restart-migration.
``--timeout`` ``<integer> (0 - N)``
  Add a shutdown timeout for the restart-migration.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client pve lxc remote-migrate <remote> <vmid> <target> --map-bridge FROM:TO,... --map-storage FROM:TO,... [OPTIONS]``

Migrate a container to a different cluster.

``<remote>`` : ``<string>``
  Remote ID.

``<vmid>`` : ``<integer> (1 - N)``
  A guest ID

``<target>`` : ``<string>``
  Remote ID.

``--map-bridge`` ``FROM:TO,...``
  Mapping of source network bridges to ones on the target cluster. Can be
  specified more than once.

``--map-storage`` ``FROM:TO,...``
  Mapping of source storages to ones on the target cluster. Can be specified
  more than once.

Optional parameters:

``--bwlimit`` ``<integer> (0 - N)``
  Override I/O bandwidth limit (in KiB/s).
``--delete`` ``<boolean>``
  Delete the original VM and related data after successful migration.
``--node`` ``<string>``
  Node name (or 'localhost')
``--online`` ``<boolean>``
  Perform an online migration if the vm is running.
``--restart`` ``<boolean>   (default=false)``
  Perform a restart-migration.
``--target-vmid`` ``<integer> (1 - N)``
  A guest ID
``--timeout`` ``<integer> (0 - N)``
  Add a shutdown timeout for the restart-migration.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client pve lxc rrddata <remote> <vmid> <mode> <timeframe>``

Return a CT's metric data.

``<remote>`` : ``<string>``
  Remote ID.

``<vmid>`` : ``<integer> (1 - N)``
  A guest ID

``<mode>`` : ``MAX|AVERAGE``
  RRD consolidation mode

``<timeframe>`` : ``hour|day|week|month|year|decade``
  RRD time frame

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client pve lxc shutdown <remote> <vmid> [OPTIONS]``

Shutdown a container.

``<remote>`` : ``<string>``
  Remote ID.

``<vmid>`` : ``<integer> (1 - N)``
  A guest ID

Optional parameters:

``--node`` ``<string>``
  Node name (or 'localhost')

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client pve lxc snapshot create <remote> <vmid> <snapname> [OPTIONS]``

Create a snapshot of an LXC guest.

``<remote>`` : ``<string>``
  Remote ID.

``<vmid>`` : ``<integer> (1 - N)``
  A guest ID

``<snapname>`` : ``<string>``
  The name of the snapshot

Optional parameters:

``--description`` ``<string>``
  A textual description or comment.
``--node`` ``<string>``
  Node name (or 'localhost')

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client pve lxc snapshot delete <remote> <vmid> <snapname> [OPTIONS]``

Delete a snapshot of an LXC guest.

``<remote>`` : ``<string>``
  Remote ID.

``<vmid>`` : ``<integer> (1 - N)``
  A guest ID

``<snapname>`` : ``<string>``
  The name of the snapshot

Optional parameters:

``--node`` ``<string>``
  Node name (or 'localhost')

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client pve lxc snapshot list <remote> <vmid> [OPTIONS]``

List the snapshots of an LXC guest.

``<remote>`` : ``<string>``
  Remote ID.

``<vmid>`` : ``<integer> (1 - N)``
  A guest ID

Optional parameters:

``--node`` ``<string>``
  Node name (or 'localhost')

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client pve lxc snapshot rollback <remote> <vmid> <snapname> [OPTIONS]``

Roll back an LXC guest to a snapshot (destructive: reverts disk and config to it).

``<remote>`` : ``<string>``
  Remote ID.

``<vmid>`` : ``<integer> (1 - N)``
  A guest ID

``<snapname>`` : ``<string>``
  The name of the snapshot

Optional parameters:

``--node`` ``<string>``
  Node name (or 'localhost')
``--start`` ``<boolean>``
  Start the container after a successful rollback.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client pve lxc snapshot update-description <remote> <vmid> <snapname> [OPTIONS]``

Update an LXC snapshot's description.

``<remote>`` : ``<string>``
  Remote ID.

``<vmid>`` : ``<integer> (1 - N)``
  A guest ID

``<snapname>`` : ``<string>``
  The name of the snapshot

Optional parameters:

``--description`` ``<string>``
  The new description; pass an empty string to clear.
``--node`` ``<string>``
  Node name (or 'localhost')

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client pve lxc start <remote> <vmid> [OPTIONS]``

Start a container.

``<remote>`` : ``<string>``
  Remote ID.

``<vmid>`` : ``<integer> (1 - N)``
  A guest ID

Optional parameters:

``--node`` ``<string>``
  Node name (or 'localhost')

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client pve lxc stop <remote> <vmid> [OPTIONS]``

Stop a container abruptly.

``<remote>`` : ``<string>``
  Remote ID.

``<vmid>`` : ``<integer> (1 - N)``
  A guest ID

Optional parameters:

``--node`` ``<string>``
  Node name (or 'localhost')

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client pve node list <remote>``

List all the nodes of a pve cluster.

``<remote>`` : ``<string>``
  Remote ID.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client pve node rrddata <remote> <node> <mode> <timeframe>``

Return a PVE node's metric data.

``<remote>`` : ``<string>``
  Remote ID.

``<node>`` : ``<string>``
  Node name (or 'localhost')

``<mode>`` : ``MAX|AVERAGE``
  RRD consolidation mode

``<timeframe>`` : ``hour|day|week|month|year|decade``
  RRD time frame

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client pve qemu config <remote> <vmid> [OPTIONS]``

Query the configuration of a VM.

``<remote>`` : ``<string>``
  Remote ID.

``<vmid>`` : ``<integer> (1 - N)``
  A guest ID

Optional parameters:

``--node`` ``<string>``
  Node name (or 'localhost')
``--snapshot`` ``<string>``
  The name of the snapshot
``--state`` ``pending|active   (default=pending)``
  Guest configuration access.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client pve qemu list <remote> [OPTIONS]``

List the QEMU VMs of a cluster.

``<remote>`` : ``<string>``
  Remote ID.

Optional parameters:

``--node`` ``<string>``
  Node name (or 'localhost')

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client pve qemu migrate <remote> <vmid> <target> [OPTIONS]``

Migrate a VM to a different node of the same cluster.

``<remote>`` : ``<string>``
  Remote ID.

``<vmid>`` : ``<integer> (1 - N)``
  A guest ID

``<target>`` : ``<string>``
  Remote ID.

Optional parameters:

``--bwlimit`` ``<integer> (0 - N)``
  Override I/O bandwidth limit (in KiB/s).
``--force`` ``<boolean>``
  Perform an online migration if the vm is running.
``--map-storage`` ``FROM:TO,...``
  Mapping of source storages to ones on the target cluster. Can be specified
  more than once.
``--migration-network`` ``<string>``
  CIDR of the (sub) network that is used for migration.
``--migration-type`` ``secure|insecure``
  Migration traffic is encrypted using an SSH tunnel by default. On secure,
  completely private networks this can be disabled to increase performance.
``--node`` ``<string>``
  Node name (or 'localhost')
``--online`` ``<boolean>``
  Perform an online migration if the vm is running.
``--with-local-disks`` ``<boolean>``
  Enable live storage migration for local disks.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client pve qemu remote-migrate <remote> <vmid> <target> --map-bridge FROM:TO,... --map-storage FROM:TO,... [OPTIONS]``

Migrate a VM to a different cluster.

``<remote>`` : ``<string>``
  Remote ID.

``<vmid>`` : ``<integer> (1 - N)``
  A guest ID

``<target>`` : ``<string>``
  Remote ID.

``--map-bridge`` ``FROM:TO,...``
  Mapping of source network bridges to ones on the target cluster. Can be
  specified more than once.

``--map-storage`` ``FROM:TO,...``
  Mapping of source storages to ones on the target cluster. Can be specified
  more than once.

Optional parameters:

``--bwlimit`` ``<integer> (0 - N)``
  Override I/O bandwidth limit (in KiB/s).
``--delete`` ``<boolean>``
  Delete the original VM and related data after successful migration.
``--node`` ``<string>``
  Node name (or 'localhost')
``--online`` ``<boolean>``
  Perform an online migration if the vm is running.
``--target-vmid`` ``<integer> (1 - N)``
  A guest ID

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client pve qemu rrddata <remote> <vmid> <mode> <timeframe>``

Return a VM's metric data.

``<remote>`` : ``<string>``
  Remote ID.

``<vmid>`` : ``<integer> (1 - N)``
  A guest ID

``<mode>`` : ``MAX|AVERAGE``
  RRD consolidation mode

``<timeframe>`` : ``hour|day|week|month|year|decade``
  RRD time frame

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client pve qemu shutdown <remote> <vmid> [OPTIONS]``

Shutdown a VM.

``<remote>`` : ``<string>``
  Remote ID.

``<vmid>`` : ``<integer> (1 - N)``
  A guest ID

Optional parameters:

``--node`` ``<string>``
  Node name (or 'localhost')

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client pve qemu snapshot create <remote> <vmid> <snapname> [OPTIONS]``

Create a snapshot of a QEMU guest.

``<remote>`` : ``<string>``
  Remote ID.

``<vmid>`` : ``<integer> (1 - N)``
  A guest ID

``<snapname>`` : ``<string>``
  The name of the snapshot

Optional parameters:

``--description`` ``<string>``
  A textual description or comment.
``--node`` ``<string>``
  Node name (or 'localhost')
``--vmstate`` ``<boolean>``
  Include the VM's RAM state.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client pve qemu snapshot delete <remote> <vmid> <snapname> [OPTIONS]``

Delete a snapshot of a QEMU guest.

``<remote>`` : ``<string>``
  Remote ID.

``<vmid>`` : ``<integer> (1 - N)``
  A guest ID

``<snapname>`` : ``<string>``
  The name of the snapshot

Optional parameters:

``--node`` ``<string>``
  Node name (or 'localhost')

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client pve qemu snapshot list <remote> <vmid> [OPTIONS]``

List the snapshots of a QEMU guest.

``<remote>`` : ``<string>``
  Remote ID.

``<vmid>`` : ``<integer> (1 - N)``
  A guest ID

Optional parameters:

``--node`` ``<string>``
  Node name (or 'localhost')

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client pve qemu snapshot rollback <remote> <vmid> <snapname> [OPTIONS]``

Roll back a QEMU guest to a snapshot (destructive: reverts disk and config to it).

``<remote>`` : ``<string>``
  Remote ID.

``<vmid>`` : ``<integer> (1 - N)``
  A guest ID

``<snapname>`` : ``<string>``
  The name of the snapshot

Optional parameters:

``--node`` ``<string>``
  Node name (or 'localhost')
``--start`` ``<boolean>``
  Start the guest after a successful rollback.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client pve qemu snapshot update-description <remote> <vmid> <snapname> [OPTIONS]``

Update a QEMU snapshot's description.

``<remote>`` : ``<string>``
  Remote ID.

``<vmid>`` : ``<integer> (1 - N)``
  A guest ID

``<snapname>`` : ``<string>``
  The name of the snapshot

Optional parameters:

``--description`` ``<string>``
  The new description; pass an empty string to clear.
``--node`` ``<string>``
  Node name (or 'localhost')

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client pve qemu start <remote> <vmid> [OPTIONS]``

Start a VM.

``<remote>`` : ``<string>``
  Remote ID.

``<vmid>`` : ``<integer> (1 - N)``
  A guest ID

Optional parameters:

``--node`` ``<string>``
  Node name (or 'localhost')

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client pve qemu stop <remote> <vmid> [OPTIONS]``

Stop a VM abruptly.

``<remote>`` : ``<string>``
  Remote ID.

``<vmid>`` : ``<integer> (1 - N)``
  A guest ID

Optional parameters:

``--node`` ``<string>``
  Node name (or 'localhost')

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client pve resources <remote> [<kind>]``

Query the cluster resources.

``<remote>`` : ``<string>``
  Remote ID.

``<kind>`` : ``vm|storage|node|sdn``
  Resource type.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client pve task list <remote> [OPTIONS]``

List the tasks of a cluster.

``<remote>`` : ``<string>``
  Remote ID.

Optional parameters:

``--node`` ``<string>``
  Node name (or 'localhost')

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client pve task status <remote> <upid>``

Query the status of a task.

``<remote>`` : ``<string>``
  Remote ID.

``<upid>`` : ``<string>``
  The task UPID, optionally with the remote name prefix

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client remote add <type> <id> --authid <string> --nodes <string> --token <string> [OPTIONS]``

Add a new remote.

``<type>`` : ``pve|pbs   (default=pve)``
  The type of a remote entry.

``<id>`` : ``<string>``
  Remote ID.

``--authid`` ``<string>``
  Authentication ID

``--nodes`` ``<string>``
  A list of cluster node addresses. Can be specified more than once.

``--token`` ``<string>``
  The access token's secret.

Optional parameters:

``--create-token`` ``<string>``
  If given, create this token on the remote and use it.
``--web-url`` ``<string>``
  Configuration for the Web UI URL link generation.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client remote delete <id> [OPTIONS]``

Delete a remote.

``<id>`` : ``<string>``
  Remote ID.

Optional parameters:

``--delete-token`` ``<boolean>   (default=true)``
  If set to false, token deletion on the remote is skipped.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client remote list``

List all the remotes this instance is managing.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client remote probe-certificate <id> <node>``

Re-probe a configured node's TLS certificate, ignoring the pinned fingerprint.

Useful to detect a rotated certificate. Apply the new fingerprint with
`remote set-fingerprint <id> <node> <fingerprint>`, or clear the pin by omitting it.

``<id>`` : ``<string>``
  Remote ID.

``<node>`` : ``<string>``
  Hostname of the configured node to probe.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client remote set-fingerprint <id> <node> [OPTIONS]``

Set or clear a node's stored TLS certificate fingerprint.

Omit the fingerprint to clear the pin and rely on the system trust store. Run
`remote probe-certificate` first to read the fingerprint the node currently presents.

``<id>`` : ``<string>``
  Remote ID.

``<node>`` : ``<string>``
  Hostname of the configured node whose fingerprint to set.

Optional parameters:

``--fingerprint`` ``<string>``
  X509 certificate fingerprint (sha256).

Inherited group parameters:

``--color``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client remote update <id> [OPTIONS]``

Update a remote.

``<id>`` : ``<string>``
  Remote ID.

Optional parameters:

``--authid`` ``<string>``
  Authentication ID
``--delete`` ``<string>``
  List of properties to clear, e.g. 'group' or 'web-url'. Can be specified more
  than once.
``--nodes`` ``<string>``
  A list of cluster node addresses. Can be specified more than once.
``--token`` ``<string>``
  The access token's secret.
``--web-url`` ``<string>``
  Configuration for the Web UI URL link generation.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client remote version <id>``

Show a remote's version.

``<id>`` : ``<string>``
  Remote ID.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client resources [OPTIONS]``

List all the remotes this instance is managing.

Optional parameters:

``--max-age`` ``<integer> (0 - N)``
  Maximum age of cached remote resources.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client subscriptions add-keys {<keys>} [OPTIONS]``

Add one or more subscription keys to the pool.

``<keys>`` : ``<string>``
  Subscription keys to add to the pool. Can be specified more than once.

Optional parameters:

``--digest`` ``<string>``
  Prevent changes if current configuration file has different SHA256 digest.
  This can be used to prevent concurrent modifications.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client subscriptions adopt-all [OPTIONS]``

Adopt every foreign live subscription into the pool in one transaction.

Walks all remotes the caller can audit, imports any (remote, node) with a live current key
and no pool binding. Candidates the caller has no modify privilege on, or whose key is
already bound elsewhere in the pool, are silently skipped.

Optional parameters:

``--digest`` ``<string>``
  Prevent changes if current configuration file has different SHA256 digest.
  This can be used to prevent concurrent modifications.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client subscriptions adopt-key <remote> <node> [OPTIONS]``

Adopt the live subscription on a remote node into the pool.

Brings a foreign subscription under PDM management without touching the remote: the live
current key on `remote`/`node` is imported as a pool entry bound to that node. Refuses if
the (remote, node) target already has a pool-managed binding.

``<remote>`` : ``<string>``
  Remote ID.

``<node>`` : ``<string>``
  Node name (or 'localhost')

Optional parameters:

``--digest`` ``<string>``
  Prevent changes if current configuration file has different SHA256 digest.
  This can be used to prevent concurrent modifications.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client subscriptions apply-pending [OPTIONS]``

Push all pending key assignments to remotes as a worker task.

Blocks until the worker finishes so the operator sees the exit status of the actual push
run, not just a UPID they would have to chase down by hand.

Optional parameters:

``--digest`` ``<string>``
  Prevent changes if current configuration file has different SHA256 digest.
  This can be used to prevent concurrent modifications.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client subscriptions assign-key <key> --node <string> --remote <string> [OPTIONS]``

Assign a key from the pool to a remote node.

``<key>`` : ``<string>``
  Subscription key.

``--node`` ``<string>``
  Node name (or 'localhost')

``--remote`` ``<string>``
  Remote ID.

Optional parameters:

``--digest`` ``<string>``
  Prevent changes if current configuration file has different SHA256 digest.
  This can be used to prevent concurrent modifications.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client subscriptions auto-assign [OPTIONS]``

Propose (and optionally apply) automatic key-to-node assignments.

Optional parameters:

``--apply`` ``<boolean>   (default=false)``
  Commit the proposal immediately via bulk-assign. Without this, only a preview
  is printed.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client subscriptions check <remote> <node>``

Trigger a fresh shop-side subscription check on a remote node.

Equivalent to the per-product "Check" button: re-verifies the live subscription status
against the shop. Useful for promoting a stale Invalid/Expired verdict to Active once the
underlying issue is fixed at the shop, without waiting for the next periodic check.

``<remote>`` : ``<string>``
  Remote ID.

``<node>`` : ``<string>``
  Node name (or 'localhost')

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client subscriptions clear-assignment <key> [OPTIONS]``

Clear the assignment of a key (unassign from its remote node).

``<key>`` : ``<string>``
  Subscription key.

Optional parameters:

``--digest`` ``<string>``
  Prevent changes if current configuration file has different SHA256 digest.
  This can be used to prevent concurrent modifications.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client subscriptions clear-key <remote> <node> [OPTIONS]``

Queue a Clear Key on a remote node so its subscription can be removed at next Apply Pending.

Refuses if no pool entry is bound to (remote, node): foreign live subscriptions must first
be imported via the explicit Adopt Key action, never as a side effect of queueing a clear.

``<remote>`` : ``<string>``
  Remote ID.

``<node>`` : ``<string>``
  Node name (or 'localhost')

Optional parameters:

``--digest`` ``<string>``
  Prevent changes if current configuration file has different SHA256 digest.
  This can be used to prevent concurrent modifications.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client subscriptions clear-pending [OPTIONS]``

Clear every pending assignment in one bulk transaction.

Optional parameters:

``--digest`` ``<string>``
  Prevent changes if current configuration file has different SHA256 digest.
  This can be used to prevent concurrent modifications.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client subscriptions list-keys``

List all subscription keys in the pool.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client subscriptions remove-key <key>``

Remove a key from the pool entirely.

``<key>`` : ``<string>``
  Subscription key.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client subscriptions revert-clear <remote> <node> [OPTIONS]``

Drop a queued Clear Key on a remote node while keeping the pool binding.

``<remote>`` : ``<string>``
  Remote ID.

``<node>`` : ``<string>``
  Node name (or 'localhost')

Optional parameters:

``--digest`` ``<string>``
  Prevent changes if current configuration file has different SHA256 digest.
  This can be used to prevent concurrent modifications.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client subscriptions status [OPTIONS]``

Show the subscription status of all remotes.

Optional parameters:

``--max-age`` ``<integer> (0 - N)   (default=86400)``
  Maximum age (in seconds) of cached remote subscription state.
``--verbose`` ``<boolean>   (default=false)``
  If true, includes subscription information per node (with enough privileges)
``--view`` ``<string>``
  View name.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client user create <userid> [OPTIONS]``

List all users or show a single user's information.

``<userid>`` : ``<string>``
  User ID

Optional parameters:

``--comment`` ``<string>``
  Comment.
``--email`` ``<string>``
  E-Mail Address.
``--enable`` ``<boolean>   (default=true)``
  Enable the account (default). You can set this to '0' to disable the account.
``--expire`` ``<integer> (0 - N)   (default=0)``
  Account expiration date (seconds since epoch). '0' means no expiration date.
``--firstname`` ``<string>``
  First name.
``--lastname`` ``<string>``
  Last name.
``--password`` ``<string>``
  Password.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client user delete <userid>``

List all users or show a single user's information.

``<userid>`` : ``<string>``
  User ID

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client user list``

List all users or show a single user's information.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client user passwd <userid> [OPTIONS]``

Change a user's password. If no password is provided, it will be prompted for interactively.

``<userid>`` : ``<string>``
  User ID

Optional parameters:

``--password`` ``<string>``
  Password.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client user tfa add <type> <description> [OPTIONS]``

Add a TFA method to a user (currently only recovery keys).

``<type>`` : ``totp|u2f|webauthn|recovery|yubico``
  A TFA entry type.

``<description>`` : ``<string>``
  a description for the tfa entry

Optional parameters:

``--userid`` ``<string>``
  userid

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client user tfa delete <id> [OPTIONS]``

Delete a TFA entry by id.

``<id>`` : ``<string>``
  the tfa id to remove

Optional parameters:

``--userid`` ``<string>``
  userid

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client user tfa list [OPTIONS]``

List all the remotes this instance is managing.

Optional parameters:

``--userid`` ``<string>``
  User ID

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``

----

``proxmox-datacenter-manager-client user update <userid> [OPTIONS]``

Change user information.

``<userid>`` : ``<string>``
  User ID

Optional parameters:

``--comment`` ``<string>``
  Comment.
``--delete`` ``comment|enable|expire|firstname|lastname|email``
  Clear/reset user properties. Can be specified more than once.
``--email`` ``<string>``
  E-Mail Address.
``--enable`` ``<boolean>   (default=true)``
  Enable the account (default). You can set this to '0' to disable the account.
``--expire`` ``<integer> (0 - N)   (default=0)``
  Account expiration date (seconds since epoch). '0' means no expiration date.
``--firstname`` ``<string>``
  First name.
``--lastname`` ``<string>``
  Last name.

Inherited group parameters:

``--color``

``--fingerprint``

``--host``

``--output-format``

``--password-command``

``--password-file``

``--port``

``--user``
