Summary
Run a script in Automation Gateway
Description
This method will run a script in Automation Gateway
Route
No Northbound API Available
Roles
admin
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| scriptName |
string |
yes |
the name of the script to run |
| hosts |
array |
no |
an array of hosts to run the script on |
| args |
object |
yes |
an object containing the arguments to pass into the script |
| template |
string |
no |
the textfsm string used by the module |
Copied to Clipboard
{
"scriptName": "env_example.pl",
"args": {
"argument_list": [
"first_arg",
"second_arg"
]
},
"hosts": [
"xr9kv-atl",
"xr9kv-atl",
"xr9kv-atl",
"xr9kv-atl",
"xr9kv-atl"
],
"template": "template"
}
Copied to Clipboard
{
"type": "object",
"properties": {
"scriptName": {
"type": "string",
"examples": [
"env_example.pl"
]
},
"hosts": {
"type": "array",
"items": {
"type": "string",
"title": "host",
"$ref": "deviceData#/definitions/deviceName"
}
},
"args": {
"type": "object",
"properties": {},
"examples": [
{
"argument_list": [
"first_arg",
"second_arg"
]
}
]
},
"template": {
"type": "string",
"examples": [
"template"
]
}
},
"required": [
"scriptName",
"args"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
object |
the status of running the script on each host |
Copied to Clipboard
{
"response": false
}
Copied to Clipboard
{
"type": "object",
"properties": {
"response": {
"type": "boolean"
}
}
}
