salt/doc/ref/cli/_includes/output-options.rst
2013-08-10 15:39:04 +01:00

41 lines
1.3 KiB
ReStructuredText

Output Options
--------------
.. option:: --out
Pass in an alternative outputter to display the return of data. This
outputter can be any of the available outputters:
grains, highstate, json, key, overstatestage, pprint, raw, txt, yaml
Some outputters are formatted only for data returned from specific
functions, for instance the grains outputter will not work for non grains
data.
If an outputter is used that does not support the data passed into it, then
Salt will fall back on the pprint outputter and display the return data
using the python pprint library.
Note: If using ``--out=json``, you will probably want ``--static`` as well.
Without the static option you will get a JSON strign for each minion. This
is due to using an iterative outputter. So if you want to feed it to a JSON
parser, use ``--static`` as well.
.. option:: --out-indent OUTPUT_INDENT, --output-indent OUTPUT_INDENT
Print the output indented by the provided value in spaces. Negative values
disables indentation. Only applicable in outputters that support
indentation.
.. option:: --out-file=OUTPUT_FILE, --output-file=OUTPUT_FILE
Write the output to the specified file.
.. option:: --no-color
Disable all colored output
.. option:: --force-color
Force colored output