SALT-RUN(1)

πŸ’… SALT-RUN(1) β€” the salt-run page, but make it cute ✨

okay bestie, so this is salt-run from the Salt manual (section 1, obviously, we're in the big leagues). Sit down, hydrate, and let's get into it 🫢


πŸŽ€ NAME πŸŽ€

salt-run β€” salt-run Documentation

Execute a Salt runner. that's it. that's the whole vibe. ✨


🌸 SYNOPSIS 🌸

salt-run RUNNER

πŸ¦‹ DESCRIPTION πŸ¦‹

so salt-run is literally the frontend command for executing Salt Runners πŸ’œ. and what are Salt runners, you ask? they're simple modules used to execute convenience functions on the master. master-side lil helpers. no cap, that's exactly what they are, and I'm not adding anything else because that's genuinely all the manpage says πŸ™ˆ


✨ OPTIONS ✨

here we go, the whole lineup, every single one, don't skip, we don't do that here πŸ‘‘

  • --version β€” prints the version of Salt that's running, so you know exactly what you're working with πŸ’–
  • --versions-report β€” shows the program's dependencies and version number, and then it dips. exits. gone. bye πŸ‘‹
  • -h, --help β€” shows the help message and exits. the classic. iconic behaviour honestly
  • -c CONFIG_DIR, --config-dir=CONFIG_dir β€” where the Salt configuration directory lives. this directory holds the config files for the Salt master and minions. on most systems the default spot is /etc/salt πŸ—‚οΈ
  • -t TIMEOUT, --timeout=TIMEOUT β€” the timeout, in seconds, to wait for replies from the Salt minions. this number says how long the command line client will wait to query the minions and check on running jobs. default: 1 ⏳
  • --hard-crash β€” raises any original exception instead of exiting gracefully. default is False. so by default it's all chill and graceful, and with this flag it is NOT being polite about it πŸ’€
  • -d, --doc, --documentation β€” displays documentation for runners. pass a module or a runner and you'll see docs on only that module/runner πŸ“

🌈 Logging Options 🌈

logging options which override any settings defined on the configuration files. yes, they really do override, that's the whole point πŸ’…

  • -l LOG_LEVEL, --log-level=LOG_LEVEL β€” console logging log level. one of all, garbage, trace, debug, info, warning, error, quiet. default: warning πŸ“’
  • --log-file=LOG_FILE β€” log file path. default: /var/log/salt/master πŸ“
  • --log-file-level=LOG_LEVEL_LOGFILE β€” logfile logging log level. one of all, garbage, trace, debug, info, warning, error, quiet. default: warning πŸ“š

πŸ‘€ SEE ALSO πŸ‘€

go read those too, they're all part of the family 🫢


πŸ’œ AUTHOR πŸ’œ

Thomas S. Hatch <thatch45@gmail.com> and many others β€” please see the Authors file. not me giving credit where credit is due, we love to see it πŸ‘‘


2025


⭐ version 3007.8, generated on September 18, 2025 at 06:58:52 UTC. that's a wrap bestie, go run some runners, slay, and remember: the facts never changed, only the vibe πŸ’–βœ¨πŸ¦‹
πŸ“¦ where this page comes from