salt/doc/ref/cli/salt-call.rst
Pedro Algarvio 6c819439b5 Add a few more nice to have hooks
Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>
2023-02-07 07:10:13 +00:00

2.9 KiB

salt-call

Synopsis

salt-call [options]

Description

The salt-call command is used to run module functions locally on a minion instead of executing them from the master. Salt-call is used to run a Standalone Minion <tutorial-standalone-minion>, and was originally created for troubleshooting <troubleshooting-minion-salt-call>.

The Salt Master is contacted to retrieve state files and other resources during execution unless the --local option is specified.

Note

salt-call commands execute from the current user's shell context, while salt commands execute from the system's default context.

Options

salt-call

--hard-crash

Raise any original exception rather than exiting gracefully Default: False

-g, --grains

Return the information generated by the Salt grains

-m MODULE_DIRS, --module-dirs=MODULE_DIRS

Specify an additional directory to pull modules from. Multiple directories can be provided by passing -m /--module-dirs multiple times.

-d, --doc, --documentation

Return the documentation for the specified module or for all modules if none are specified

--master=MASTER

Specify the master to use. The minion must be authenticated with the master. If this option is omitted, the master options from the minion config will be used. If multi masters are set up the first listed master that responds will be used.

--return RETURNER

Set salt-call to pass the return data to one or many returner interfaces. To use many returner interfaces specify a comma delimited list of returners.

--local

Run salt-call locally, as if there was no master running.

--file-root=FILE_ROOT

Set this directory as the base file root.

--pillar-root=PILLAR_ROOT

Set this directory as the base pillar root.

--retcode-passthrough

Exit with the salt call retcode and not the salt binary retcode

--no-return-event

Do not send the return event back to master.

--metadata

Print out the execution metadata as well as the return. This will print out the outputter data, the return code, etc.

--id=ID

Specify the minion id to use. If this option is omitted, the id option from the minion config will be used.

--skip-grains

Do not load grains.

--refresh-grains-cache

Force a refresh of the grains cache

See also

salt(1) salt-master(1) salt-minion(1)