Summary
Run a module from a collection in Automation Gateway
Description
This method will run a module 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 module to run |
| moduleName | string | yes | the name of the module to run |
| hosts | array | no | an array of hosts to run the module on |
| groups | array | no | an array of group names. The Ansible collection module will be executed against each device group passed in the groups array. |
| args | object | yes | an object containing the arguments to pass into the module |
| template | string | no | the textfsm string used by the module |
Return
DetailsExampleSchema
| Name | Type | Description |
|---|---|---|
| result | object | the status of running the module on each host |