The sys module provides information about the available functions on the minion
Return the argument specification of functions in Salt execution modules.
CLI Example:
salt '*' sys.argspec pkg.install
salt '*' sys.argspec sys
salt '*' sys.argspec
Return the docstrings for all modules. Optionally, specify a module or a function to narrow the selection.
The strings are aggregated into a single document on the master for easy reading.
Multiple modules/functions can be specified.
CLI Example:
salt '*' sys.doc
salt '*' sys.doc sys
salt '*' sys.doc sys.doc
salt '*' sys.doc network.traceroute user.info
List the functions for all modules. Optionally, specify a module or modules from which to list.
CLI Example:
salt '*' sys.list_functions
salt '*' sys.list_functions sys
salt '*' sys.list_functions sys user
List the modules loaded on the minion
CLI Example:
salt '*' sys.list_modules
New in version 2014.7.0.
List the functions for all returner modules. Optionally, specify a returner module or modules from which to list.
CLI Example:
salt '*' sys.list_returner_functions
salt '*' sys.list_returner_functions mysql
salt '*' sys.list_returner_functions mysql etcd
New in version 2014.7.0.
List the runners loaded on the minion
CLI Example:
salt '*' sys.list_returners
New in version 2014.7.0.
List the functions for all runner modules. Optionally, specify a runner module or modules from which to list.
CLI Example:
salt '*' sys.list_runner_functions
salt '*' sys.list_runner_functions state
salt '*' sys.list_runner_functions state virt
New in version 2014.7.0.
List the runners loaded on the minion
CLI Example:
salt '*' sys.list_runners
New in version 2014.7.0.
List the functions for all state modules. Optionally, specify a state module or modules from which to list.
CLI Example:
salt '*' sys.list_state_functions
salt '*' sys.list_state_functions file
salt '*' sys.list_state_functions pkg user
New in version 2014.7.0.
List the modules loaded on the minion
CLI Example:
salt '*' sys.list_state_modules
Tell the minion to reload the execution modules
CLI Example:
salt '*' sys.reload_modules
New in version 2014.7.0.
Return the docstrings for all returners. Optionally, specify a returner or a function to narrow the selection.
The strings are aggregated into a single document on the master for easy reading.
Multiple returners/functions can be specified.
CLI Example:
salt '*' sys.returner_doc
salt '*' sys.returner_doc sqlite3
salt '*' sys.returner_doc sqlite3.get_fun
salt '*' sys.returner_doc sqlite3.get_fun etcd.get_fun
New in version 2014.7.0.
Return the docstrings for all runners. Optionally, specify a runner or a function to narrow the selection.
The strings are aggregated into a single document on the master for easy reading.
Multiple runners/functions can be specified.
CLI Example:
salt '*' sys.runner_doc
salt '*' sys.runner_doc cache
salt '*' sys.runner_doc cache.grains
salt '*' sys.runner_doc cache.grains mine.get
New in version 2014.7.0.
Return the docstrings for all states. Optionally, specify a state or a function to narrow the selection.
The strings are aggregated into a single document on the master for easy reading.
Multiple states/functions can be specified.
CLI Example:
salt '*' sys.state_doc
salt '*' sys.state_doc service
salt '*' sys.state_doc service.running
salt '*' sys.state_doc service.running ipables.append
Docs for previous releases are available on salt.rtfd.org.
Latest Salt release: 2014.7.1
22.16.203. salt.modules.sysbench
22.16.205. salt.modules.system
Upcoming SaltStack events, webinars and local meet ups and user groups.