proxmox-backup-debug¶
Synopsis¶
Common Options¶
Most commands that produce output support the --output-format
parameter. This accepts the following values:
text
:Text format (default). Structured data is rendered as a table.
json
:JSON (single line).
json-pretty
:JSON (multiple lines, nicely formatted).
Also, the following environment variables can modify output behavior:
PROXMOX_OUTPUT_FORMAT
Defines the default output format.
PROXMOX_OUTPUT_NO_BORDER
If set (to any value), do not render table borders.
PROXMOX_OUTPUT_NO_HEADER
If set (to any value), do not render table headers.
Note
The text
format is designed to be human readable, and
not meant to be parsed by automation tools. Please use the json
format if you need to process the output.
Description¶
Implements debugging functionality to inspect Proxmox Backup datastore files, verify the integrity of chunks.
The 'diff' subcommand allows comparing .pxar archives for two arbitrary snapshots. A list of added/modified/deleted files will be displayed.
Also contains an 'api' subcommand where arbitrary api paths can be called (get/create/set/delete) as well as display their parameters (usage) and their child-links (ls).
By default, it connects to the proxmox-backup-proxy on localhost via https, but by setting the environment variable PROXMOX_DEBUG_API_CODE to 1 the tool directly calls the corresponding code.
Warning
Using PROXMOX_DEBUG_API_CODE can be dangerous and is only intended for debugging purposes. It is not intended for use on a production system.
Copyright and Disclaimer¶
Copyright (C) 2019-2022, 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/