1. ========
  2. ``salt``
  3. ========
  4. Synopsis
  5. ========
  6. salt '*' [ options ] sys.doc
  7. salt -E '.*' [ options ] sys.doc cmd
  8. salt -G 'os:Arch.*' [ options ] test.ping
  9. salt -C 'G@os:Arch.* and webserv* or G@kernel:FreeBSD' [ options ] test.ping
  10. Description
  11. ===========
  12. Salt allows for commands to be executed across a swath of remote systems in
  13. parallel. This means that remote systems can be both controlled and queried
  14. with ease.
  15. Options
  16. =======
  17. .. program:: salt
  18. .. include:: _includes/common-options.rst
  19. .. include:: _includes/timeout-option.rst
  20. .. |timeout| replace:: 5
  21. .. option:: -s, --static
  22. By default as of version 0.9.8 the salt command returns data to the
  23. console as it is received from minions, but previous releases would return
  24. data only after all data was received. To only return the data with a hard
  25. timeout and after all minions have returned then use the static option.
  26. .. option:: --async
  27. Instead of waiting for the job to run on minions only print the jod id of
  28. the started execution and complete.
  29. .. option:: --state-output=STATE_OUTPUT
  30. Override the configured state_output value for minion output. Default:
  31. full
  32. .. versionadded: 0.17
  33. .. option:: --subset=SUBSET
  34. Execute the routine on a random subset of the targeted minions. The
  35. minions will be verified that they have the named function before
  36. executing.
  37. .. option:: -v VERBOSE, --verbose
  38. Turn on verbosity for the salt call, this will cause the salt command to
  39. print out extra data like the job id.
  40. .. option:: -b BATCH, --batch-size=BATCH
  41. Instead of executing on all targeted minions at once, execute on a
  42. progressive set of minions. This option takes an argument in the form of
  43. an explicit number of minions to execute at once, or a percentage of
  44. minions to execute on.
  45. .. option:: -a EAUTH, --auth=EAUTH
  46. Pass in an external authentication medium to validate against. The
  47. credentials will be prompted for. Can be used with the -T option.
  48. .. option:: -T, --make-token
  49. Used in conjunction with the -a option. This creates a token that allows
  50. for the authenticated user to send commands without needing to
  51. re-authenticate.
  52. .. option:: --return=RETURNER
  53. Chose an alternative returner to call on the minion, if an alternative
  54. returner is used then the return will not come back to the command line
  55. but will be sent to the specified return system.
  56. .. option:: -d, --doc, --documentation
  57. Return the documentation for the module functions available on the minions
  58. .. option:: --args-separator=ARGS_SEPARATOR
  59. Set the special argument used as a delimiter between command arguments of
  60. compound commands. This is useful when one wants to pass commas as
  61. arguments to some of the commands in a compound command.
  62. .. include:: _includes/logging-options.rst
  63. .. |logfile| replace:: /var/log/salt/master
  64. .. |loglevel| replace:: ``warning``
  65. .. include:: _includes/target-selection.rst
  66. .. include:: _includes/extended-target-selection.rst
  67. .. include:: _includes/output-options.rst
  68. See also
  69. ========
  70. :manpage:`salt(7)`
  71. :manpage:`salt-master(1)`
  72. :manpage:`salt-minion(1)`