proxmox-datacenter-manager-admin

Synopsis

proxmox-datacenter-manager-admin 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.

---

proxmox-datacenter-manager-admin remote add --authid <string> --id <string> --nodes <string> --token <string> --type pve|pbs [OPTIONS]

Add a new remote.

--authid <string>

Authentication ID

--id <string>

Remote ID.

--nodes <string>

A list of cluster node addresses. Can be specified more than once.

--token <string>

The access token's secret.

--type pve|pbs   (default=pve)

The type of a remote entry.

Optional parameters:

--web-url <string>

Configuration for the Web UI URL link generation.

---

proxmox-datacenter-manager-admin remote list [OPTIONS]

List all the remotes this instance is managing.

Optional parameters:

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

Output format.

---

proxmox-datacenter-manager-admin remote remove <id>

Add a new remote.

<id><string>

Remote ID.

---

proxmox-datacenter-manager-admin 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.

---

proxmox-datacenter-manager-admin remote version <id>

Add a new remote.

<id><string>

Remote ID.

---

proxmox-datacenter-manager-admin report

Generate the system report.

---

proxmox-datacenter-manager-admin versions [OPTIONS]

List package versions for important Proxmox Datacenter Manager packages.

Optional parameters:

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

Output format.

--verbose <boolean>   (default=false)

Output verbose package information. It is ignored if output-format is specified.

Description

This tool exposes some of the datacenter managers administrative API on the command line.

Copyright and Disclaimer

Copyright (C) 2023 - 2025, Proxmox Server Solutions GmbH

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/