1SALT-CALL(1)                         Salt                         SALT-CALL(1)
2
3
4

NAME

6       salt-call - salt-call Documentation
7

SYNOPSIS

9          salt-call [options]
10

DESCRIPTION

12       The salt-call command is used to run module functions locally on a min‐
13       ion instead of executing them from the master. Salt-call is used to run
14       a Standalone Minion, and was originally created for troubleshooting.
15
16       The  Salt  Master  is  contacted  to retrieve state files and other re‐
17       sources during execution unless the --local option is specified.
18
19       NOTE:
20          salt-call commands execute from the current  user's  shell  context,
21          while salt commands execute from the system's default context.
22

OPTIONS

24       --version
25              Print the version of Salt that is running.
26
27       --versions-report
28              Show program's dependencies and version number, and then exit
29
30       -h, --help
31              Show the help message and exit
32
33       -c CONFIG_DIR, --config-dir=CONFIG_dir
34              The location of the Salt configuration directory. This directory
35              contains the configuration files for Salt  master  and  minions.
36              The default location on most systems is /etc/salt.
37
38       --hard-crash
39              Raise  any original exception rather than exiting gracefully De‐
40              fault: False
41
42       -g, --grains
43              Return the information generated by the Salt grains
44
45       -m MODULE_DIRS, --module-dirs=MODULE_DIRS
46              Specify an additional directory to pull modules from.   Multiple
47              directories  can be provided by passing -m /--module-dirs multi‐
48              ple times.
49
50       -d, --doc, --documentation
51              Return the documentation for the specified  module  or  for  all
52              modules if none are specified
53
54       --master=MASTER
55              Specify the master to use. The minion must be authenticated with
56              the master. If this option is omitted, the master  options  from
57              the  minion config will be used. If multi masters are set up the
58              first listed master that responds will be used.
59
60       --return RETURNER
61              Set salt-call to pass the return data to one  or  many  returner
62              interfaces.  To use many returner interfaces specify a comma de‐
63              limited list of returners.
64
65       --local
66              Run salt-call locally, as if there was no master running.
67
68       --file-root=FILE_ROOT
69              Set this directory as the base file root.
70
71       --pillar-root=PILLAR_ROOT
72              Set this directory as the base pillar root.
73
74       --retcode-passthrough
75              Exit with the salt call retcode and not the salt binary retcode
76
77       --metadata
78              Print out the execution metadata as well  as  the  return.  This
79              will print out the outputter data, the return code, etc.
80
81       --id=ID
82              Specify  the minion id to use. If this option is omitted, the id
83              option from the minion config will be used.
84
85       --skip-grains
86              Do not load grains.
87
88       --refresh-grains-cache
89              Force a refresh of the grains cache
90
91   Logging Options
92       Logging options which override any settings defined on  the  configura‐
93       tion files.
94
95       -l LOG_LEVEL, --log-level=LOG_LEVEL
96              Console  logging  log  level. One of all, garbage, trace, debug,
97              info, warning, error, quiet. Default: warning.
98
99       --log-file=LOG_FILE
100              Log file path. Default: /var/log/salt/minion.
101
102       --log-file-level=LOG_LEVEL_LOGFILE
103              Logfile logging log level. One of all,  garbage,  trace,  debug,
104              info, warning, error, quiet. Default: warning.
105
106   Output Options
107       --out  Pass  in an alternative outputter to display the return of data.
108              This outputter can be any of the available outputters:
109                 highstate, json, key, overstatestage, pprint, raw, txt, yaml,
110                 and many others.
111
112              Some  outputters  are formatted only for data returned from spe‐
113              cific functions.  If an outputter is used that does not  support
114              the  data passed into it, then Salt will fall back on the pprint
115              outputter and display the return data using  the  Python  pprint
116              standard library module.
117
118       --out-indent OUTPUT_INDENT, --output-indent OUTPUT_INDENT
119              Print the output indented by the provided value in spaces. Nega‐
120              tive values disable indentation. Only applicable  in  outputters
121              that support indentation.
122
123       --out-file=OUTPUT_FILE, --output-file=OUTPUT_FILE
124              Write the output to the specified file.
125
126       --out-file-append, --output-file-append
127              Append the output to the specified file.
128
129       --no-color
130              Disable all colored output
131
132       --force-color
133              Force colored output
134
135              NOTE:
136                 When using colored output the color codes are as follows:
137
138                 green  denotes  success,  red  denotes  failure, blue denotes
139                 changes and success and  yellow  denotes  a  expected  future
140                 change in configuration.
141
142       --state-output=STATE_OUTPUT, --state_output=STATE_OUTPUT
143              Override  the  configured  state_output value for minion output.
144              One of 'full', 'terse', 'mixed', 'changes' or 'filter'. Default:
145              'none'.
146
147       --state-verbose=STATE_VERBOSE, --state_verbose=STATE_VERBOSE
148              Override  the  configured state_verbose value for minion output.
149              Set to True or False. Default: none.
150

SEE ALSO

152       salt(1) salt-master(1) salt-minion(1)
153

AUTHOR

155       Thomas S. Hatch <thatch45@gmail.com> and many others,  please  see  the
156       Authors file
157
158
159
160
1613004.2                           May 12, 2022                     SALT-CALL(1)
Impressum