tyler
/
proxmox-backup
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs/administration-guide.rst: add small section to explain output-format

This commit is contained in:
Dietmar Maurer 2020-02-28 12:25:09 +01:00
parent f40cf85212
commit 53ea655669
1 changed files with 31 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docs/administration-guide.rst
View File

@ -198,7 +198,7 @@ variable.
Environment Variables
~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~
``PBS_REPOSITORY``
The default backup repository.
@ -215,6 +215,36 @@ Environment Variables
certificate (only used if the system CA certificates cannot
validate the certificate).
Output Format
~~~~~~~~~~~~~
Most commands support the ``--output-format`` parameter, which can be
set to 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).
Please use the following environment variables to 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, but
not meant to be parsed by automation tools. Please use the ``json``
format for such purpose because it is machine readable.
.. _creating-backups:
Creating Backups