salt.output.highstate¶

Outputter for displaying results of state runs¶

The return data from the Highstate command is a standard data structure which is parsed by the highstate outputter to deliver a clean and readable set of information about the HighState run on minions.

Two configurations can be set to modify the highstate outputter. These values can be set in the master config to change the output of the salt command or set in the minion config to change the output of the salt-call command.

state_verbose:

By default state_verbose is set to True, setting this to False will instruct the highstate outputter to omit displaying anything in green, this means that nothing with a result of True and no changes will not be printed

state_output:

The highstate outputter has five output modes, full, terse, mixed, changes and filter.

• The default is set to full, which will display many lines of detailed information for each executed chunk.
• If terse is used, then the output is greatly simplified and shown in only one line.
• If mixed is used, then terse output will be used unless a state failed, in which case full output will be used.
• If changes is used, then terse output will be used if there was no error and no changes, otherwise full output will be used.
• If filter is used, then either or both of two different filters can be used: exclude or terse. These can be set as such from the command line, or in the Salt config as state_output_exclude or state_output_terse, respectively. The values to exclude must be a comma-separated list of True, False and/or None. Because of parsing nuances, if only one of these is used, it must still contain a comma. For instance: exclude=True,.

state_tabular:

If state_output uses the terse output, set this to True for an aligned output format. If you wish to use a custom format, this can be set to a string.

Example output:

myminion:
----------
          ID: test.ping
    Function: module.run
      Result: True
     Comment: Module function test.ping executed
     Changes:
              ----------
              ret:
                  True

Summary
------------
Succeeded: 1
Failed:    0
------------
Total:     0

salt.output.highstate.output(data)¶

The HighState Outputter is only meant to be used with the state.highstate function, or a function that returns highstate return data.