adapter-automation_gateway

On this page:

dryRunPlaybook

Summary

Dry Run a playbook in Automation Gateway with check mode

Description

This method will run a playbook in Automation Gateway with check mode i.e Dry Run

Route

No Northbound API Available

Roles

admin

Parameters

DetailsExampleSchema
Name Type Required Description
playbookName string yes the name of the playbook to run
hosts array no an array of hosts to run the playbook on
groups array no an array of group names. The Ansible playbook will be executed against each device group passed in the groups array.
args object no an object containing the arguments to pass into the playbook
template string no the textfsm string used by the playbook

Return

DetailsExampleSchema
Name Type Description
result object The status of running the playbook on each host