Summary
Run a nornir module in Automation Gateway
Description
This method will run a nornir module in Automation Gateway
Route
No Northbound API Available
Roles
admin
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| nornirModName |
string |
yes |
the name of the nornir module to run |
| hosts |
array |
no |
an array of hosts to run the nornir module on |
| groups |
array |
no |
an array of groups to run the nornir module on |
| args |
object |
yes |
an object containing the arguments to pass into the module |
| env |
object |
no |
an object containing the environment variables to pass into the module |
Copied to Clipboard
{
"nornirModName": "nornir_commands.py",
"args": {
"env_vars": {
"host": "test"
}
},
"hosts": [
"xr9kv-atl",
"xr9kv-atl",
"xr9kv-atl",
"xr9kv-atl",
"xr9kv-atl"
],
"groups": [
"group1",
"group1",
"group1"
]
}
Copied to Clipboard
{
"type": "object",
"properties": {
"nornirModName": {
"type": "string",
"examples": [
"nornir_commands.py"
]
},
"hosts": {
"type": "array",
"items": {
"type": "string",
"title": "host",
"$ref": "deviceData#/definitions/deviceName"
}
},
"groups": {
"type": "array",
"items": {
"type": "string",
"$ref": "deviceData#/definitions/groupName"
}
},
"args": {
"type": "object",
"properties": {},
"examples": [
{
"env_vars": {
"host": "test"
}
}
]
},
"env": {
"type": "object",
"properties": {},
"examples": [
{}
]
}
},
"required": [
"nornirModName",
"args"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
object |
the status of running the nornir module on each host |
Copied to Clipboard
{
"response": false
}
Copied to Clipboard
{
"type": "object",
"properties": {
"response": {
"type": "boolean"
}
}
}
