Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: document missing action args #584

Merged
merged 1 commit into from
Oct 3, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions docs/actions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,9 @@ Run an Ansible playbook.
* - json_mode
- Boolean, sends the playbook events data to the stdout as json strings as they are processed by ansible-runner
- No
* - copy_files
- Boolean, copy the local playbook file to the ansible-runner project directory, this is not needed if you are running a playbook from an ansible collection.
- No


run_module
Expand Down Expand Up @@ -96,6 +99,21 @@ Run an Ansible module
* - extra_vars
- Additional vars to be passed into the playbook as extra vars.
- No
* - json_mode
- Boolean, sends the playbook events data to the stdout as json strings as they are processed by ansible-runner
- No
* - set_facts
- Boolean, the artifacts from the module execution are inserted back into the rule set as facts
- No
* - post_events
- Boolean, the artifacts from the module execution are inserted back into the rule set as events
- No
* - ruleset
- The name of the ruleset to post the event or assert the fact to, default is current rule set.
- No
* - var_root
- If the event is a deeply nested dictionary, the var_root can specify the key name whose value should replace the matching event value. The var_root can take a dictionary to account for data when we have multiple matching events.
- No

run_job_template
****************
Expand Down Expand Up @@ -312,6 +330,9 @@ retract_fact
* - ruleset
- The name of the rule set to retract the fact, default is the current rule set name
- No
* - partial
- The fact being requested to retracted is partial and doesn't have all the keys. Default is true
- No

Example:

Expand Down