Summary
Run a module in Automation Gateway
Description
This method will run a module in Automation Gateway
Route
No Northbound API Available
Roles
admin
Parameters
DetailsExampleSchema
| Name | Type | Required | Description |
|---|---|---|---|
| moduleName | string | yes | Name of the Ansible module. Itential's Automation Gateway supports network modules listed at https://docs.ansible.com/ansible/latest/modules/list_of_network_modules.html. |
| hosts | array | no | An array of device names. The Ansible module will be executed against each device passed in the hosts array. |
| groups | array | no | An array of group names. The Ansible module will be executed against each device group passed in the groups array. |
| args | object | yes | An object holding arguments for the module. Object will have a property for each of the module's parameters. The property's key must match the parameter name. |
| template | string | no | The TexFSM template that will parse the module's returned data. |
Return
DetailsExampleSchema
| Name | Type | Description |
|---|---|---|
| result | object | the status of running the module on each host |