Add ssh_pre_flight_args to the docs

This commit is contained in:
Victor Zhestkov 2022-03-04 09:47:26 +03:00 committed by Megan Wilhite
parent 5c958f6893
commit 8239097291

View file

@ -66,6 +66,9 @@ The information which can be stored in a roster ``target`` is the following:
# does not exist, unless --pre-flight is passed to salt-ssh
# command or ssh_run_pre_flight is set to true in the config
# Added in 3001 Release.
ssh_pre_flight_args: # The list of arguments to pass to the script
# running on the minion with ssh_pre_flight.
# Can be specified as single string.
set_path: # Set the path environment variable, to ensure the expected python
# binary is in the salt-ssh path, when running the command.
# Example: '$PATH:/usr/local/bin/'. Added in 3001 Release.
@ -88,6 +91,15 @@ you want to intentionally run the script again you have a couple of options:
* Set ssh_run_pre_flight to True in the config
* Run salt-ssh with the --pre-flight arg.
.. _ssh_pre_flight_args:
ssh_pre_flight_args
-------------------
Additional arguments to the script running on the minion with `ssh_pre_flight` can be passed
with specifying a list of arguments or a single string. In case of using single string
distinct arguments will be passed to the script by splitting this string with the spaces.
.. _roster_defaults:
Target Defaults