proxmox-datacenter-manager-admin(1)
| PROXMOX-DATACENTER-MANAGER-ADMIN(1) | Proxmox Datacenter Manager | PROXMOX-DATACENTER-MANAGER-ADMIN(1) |
NAME
proxmox-datacenter-manager-admin - Command line tool for managing Proxmox Datacenter Manager hosts.
SYNOPSIS
proxmox-datacenter-manager-admin acme account deactivate <name> [OPTIONS]
Deactivate an ACME account.
- <name> (<string>)
- ACME account name.
Optional parameters:
- --force <boolean> (default=true)
- Delete account data even if the server refuses to deactivate the account.
----
proxmox-datacenter-manager-admin acme account info <name> [OPTIONS]
Show ACME account information.
- <name> (<string>)
- ACME account name.
Optional parameters:
- --output-format text|json|json-pretty
- Output format.
----
proxmox-datacenter-manager-admin acme account list [OPTIONS]
List ACME accounts.
Optional parameters:
- --output-format text|json|json-pretty
- Output format.
----
proxmox-datacenter-manager-admin acme account register <name> <contact> [OPTIONS]
Register an ACME account.
- <name> (<string>)
- ACME account name.
- <contact> (<string>)
- List of email addresses.
Optional parameters:
- --directory <string>
- The ACME Directory.
----
proxmox-datacenter-manager-admin acme account update <name> [<contact>]
Update an ACME Account.
- <name> (<string>)
- ACME account name.
- <contact> (<string>)
- List of email addresses.
----
proxmox-datacenter-manager-admin acme certificate order [OPTIONS]
Order a new ACME certificate.
Optional parameters:
- --force <boolean> (default=false)
- Force renewal even if the certificate does not expire soon.
----
proxmox-datacenter-manager-admin acme certificate revoke
Revoke ACME certificate.
----
proxmox-datacenter-manager-admin acme plugin add <type> <id> --api <string> --data <string> [OPTIONS]
Add ACME plugin configuration.
- <type> (<string>)
- The ACME challenge plugin type.
- <id> (<string>)
- ACME Challenge Plugin ID.
- --api <string>
- DNS API Plugin Id.
- --data <string>
- File containing the plugin data.
Optional parameters:
- --disable <boolean> (default=false)
- Flag to disable the config.
- --validation-delay <integer> (0 - 172800) (default=30)
- Extra delay in seconds to wait before requesting validation.
Allows to cope with long TTL of DNS records.
----
proxmox-datacenter-manager-admin acme plugin config <id> [OPTIONS]
Show ACME plugin information.
- <id> (<string>)
- Plugin ID
Optional parameters:
- --output-format text|json|json-pretty
- Output format.
----
proxmox-datacenter-manager-admin acme plugin list [OPTIONS]
List ACME plugins.
Optional parameters:
- --output-format text|json|json-pretty
- Output format.
----
proxmox-datacenter-manager-admin acme plugin remove <id>
Delete an ACME plugin configuration.
- <id> (<string>)
- ACME Challenge Plugin ID.
----
proxmox-datacenter-manager-admin acme plugin set <id> [OPTIONS]
Update an ACME plugin configuration.
- <id> (<string>)
- ACME Challenge Plugin ID.
Optional parameters:
- --api <string>
- DNS API Plugin Id.
- --data <string>
- DNS plugin data (base64 encoded with padding).
- --delete disable|validation-delay
- List of properties to delete. Can be specified more than once.
- --digest <string>
- Prevent changes if current configuration file has different SHA256 digest. This can be used to prevent concurrent modifications.
- --disable <boolean> (default=false)
- Flag to disable the config.
- --validation-delay <integer> (0 - 172800) (default=30)
- Extra delay in seconds to wait before requesting validation.
Allows to cope with long TTL of DNS records.
----
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> [OPTIONS]
Remove a remote.
- <id> (<string>)
- Remote ID.
Optional parameters:
- --delete-token <boolean> (default=true)
- If set to false, token deletion on the remote is skipped.
----
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 - 2026, 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/>
Author
Proxmox Support Team
Copyright
2023 - 2026, Proxmox Server Solutions GmbH
| Wednesday, 15 July 2026 | <devbuild> |
