output-options.rst 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. Output Options
  2. --------------
  3. .. option:: --out
  4. Pass in an alternative outputter to display the return of data. This
  5. outputter can be any of the available outputters:
  6. ``highstate``, ``json``, ``key``, ``overstatestage``, ``pprint``, ``raw``, ``txt``, ``yaml``, and :ref:`many others <all-salt.output>`.
  7. Some outputters are formatted only for data returned from specific functions.
  8. If an outputter is used that does not support the data passed into it, then
  9. Salt will fall back on the ``pprint`` outputter and display the return data
  10. using the Python ``pprint`` standard library module.
  11. .. option:: --out-indent OUTPUT_INDENT, --output-indent OUTPUT_INDENT
  12. Print the output indented by the provided value in spaces. Negative values
  13. disable indentation. Only applicable in outputters that support
  14. indentation.
  15. .. option:: --out-file=OUTPUT_FILE, --output-file=OUTPUT_FILE
  16. Write the output to the specified file.
  17. .. option:: --out-file-append, --output-file-append
  18. Append the output to the specified file.
  19. .. option:: --no-color
  20. Disable all colored output
  21. .. option:: --force-color
  22. Force colored output
  23. .. note::
  24. When using colored output the color codes are as follows:
  25. ``green`` denotes success, ``red`` denotes failure, ``blue`` denotes
  26. changes and success and ``yellow`` denotes a expected future change in configuration.
  27. .. option:: --state-output=STATE_OUTPUT, --state_output=STATE_OUTPUT
  28. Override the configured state_output value for minion
  29. output. One of 'full', 'terse', 'mixed', 'changes' or
  30. 'filter'. Default: 'none'.
  31. .. option:: --state-verbose=STATE_VERBOSE, --state_verbose=STATE_VERBOSE
  32. Override the configured state_verbose value for minion
  33. output. Set to True or False. Default: none.