adapter-automation_gateway

On this page:

runCollectionRole

Summary

Run a role from a collection in Automation Gateway

Description

This method will run a role from a collection in Automation Gateway

Route

No Northbound API Available

Roles

admin

Parameters

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

Return

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