Synopsis

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

--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

--color no|always|auto   (default=auto)

Control terminal color output.

--output-format text|json|json-pretty

Output format.

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 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 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>

Add a new remote.

<id><string>

Remote ID.

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 update <id> [OPTIONS]

Update a remote.

<id><string>

Remote ID.

Optional parameters:

--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.

--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>

Add a new remote.

<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 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

Description

This tool implements a datacenter manager client, i.e. it can connect to any datacenter manager with the same major version and issue management commands, query status and control remotes and their resources.