1SALT-CALL(1) Salt SALT-CALL(1)
2
6 salt-call - salt-call Documentation
7
9 salt-call [options]
10
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 The Salt Master is contacted to retrieve state files and other re‐
17 sources during execution unless the --local option is specified.
18 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
24 --version
25 Print the version of Salt that is running.
26 --versions-report
28 Show program's dependencies and version number, and then exit
29 -h, --help
31 Show the help message and exit
32 -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 --hard-crash
39 Raise any original exception rather than exiting gracefully De‐
40 fault: False
41 -g, --grains
43 Return the information generated by the Salt grains
44 -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 -d, --doc, --documentation
51 Return the documentation for the specified module or for all
52 modules if none are specified
53 --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 --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 --local
66 Run salt-call locally, as if there was no master running.
67 --file-root=FILE_ROOT
69 Set this directory as the base file root.
70 --pillar-root=PILLAR_ROOT
72 Set this directory as the base pillar root.
73 --retcode-passthrough
75 Exit with the salt call retcode and not the salt binary retcode
76 --no-return-event
78 Do not send the return event back to master.
79 --metadata
81 Print out the execution metadata as well as the return. This
82 will print out the outputter data, the return code, etc.
83 --id=ID
85 Specify the minion id to use. If this option is omitted, the id
86 option from the minion config will be used.
87 --skip-grains
89 Do not load grains.
90 --refresh-grains-cache
92 Force a refresh of the grains cache
93 Logging Options
95 Logging options which override any settings defined on the configura‐
96 tion files.
97 -l LOG_LEVEL, --log-level=LOG_LEVEL
99 Console logging log level. One of all, garbage, trace, debug,
100 info, warning, error, quiet. Default: warning.
101 --log-file=LOG_FILE
103 Log file path. Default: /var/log/salt/minion.
104 --log-file-level=LOG_LEVEL_LOGFILE
106 Logfile logging log level. One of all, garbage, trace, debug,
107 info, warning, error, quiet. Default: warning.
108 Output Options
110 --out Pass in an alternative outputter to display the return of data.
111 This outputter can be any of the available outputters:
112 highstate, json, key, overstatestage, pprint, raw, txt, yaml,
113 and many others.
114 Some outputters are formatted only for data returned from spe‐
116 cific functions. If an outputter is used that does not support
117 the data passed into it, then Salt will fall back on the pprint
118 outputter and display the return data using the Python pprint
119 standard library module.
120 --out-indent OUTPUT_INDENT, --output-indent OUTPUT_INDENT
122 Print the output indented by the provided value in spaces. Nega‐
123 tive values disable indentation. Only applicable in outputters
124 that support indentation.
125 --out-file=OUTPUT_FILE, --output-file=OUTPUT_FILE
127 Write the output to the specified file.
128 --out-file-append, --output-file-append
130 Append the output to the specified file.
131 --no-color
133 Disable all colored output
134 --force-color
136 Force colored output
137 NOTE:
139 When using colored output the color codes are as follows:
140 green denotes success, red denotes failure, blue denotes
142 changes and success and yellow denotes a expected future
143 change in configuration.
144 --state-output=STATE_OUTPUT, --state_output=STATE_OUTPUT
146 Override the configured state_output value for minion output.
147 One of 'full', 'terse', 'mixed', 'changes' or 'filter'. Default:
148 'none'.
149 --state-verbose=STATE_VERBOSE, --state_verbose=STATE_VERBOSE
151 Override the configured state_verbose value for minion output.
152 Set to True or False. Default: none.
153
155 salt(1) salt-master(1) salt-minion(1)
156
158 Thomas S. Hatch <thatch45@gmail.com> and many others, please see the
159 Authors file
160
162 2023
1633006.4 Generated on October 16, 2023 at 05:24:47 PM UTC. SALT-CALL(1)