Summary
Run Action
Description
Run an action in NSO (Network Services Orchestrator).
Route
POST /nso_manager/runAction/:adapterId
Roles
admin
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| adapterId |
string |
yes |
The host that the action should be executed against. |
| path |
string |
yes |
The XPath to your package's action. |
| params |
object |
yes |
Values needed to execute the action. Supported parameters are defined within the NSO action and/or RPC action. |
| variables |
string |
yes |
Values to be used in variable definition. |
Copied to Clipboard
{
"path": "/itential_commands/admin_down_interfaces",
"params": {
"params": {
"ned_id": "cisco-ios-cli-6.74",
"commands": "hostname test"
}
},
"variables": "action-type pyaction"
}
Copied to Clipboard
{
"type": "object",
"properties": {
"path": {
"title": "path",
"type": "string",
"examples": [
"/itential_commands/native2Pronghorn",
"/itential_commands/admin_down_interfaces"
]
},
"params": {
"$ref": "inputParams",
"examples": [
{
"params": {
"ned_id": "cisco-ios-cli-6.74",
"commands": "hostname test"
}
},
{
"params": {
"device": "ios.0",
"interfaces": "[\"GigabitEthernet{0}\",\"\"Ethernet{0/0/0}\"]"
}
}
]
},
"variables": {
"type": "string",
"examples": [
"action-type pyaction"
]
}
},
"required": [
"path",
"params",
"variables"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| response |
object |
An object with information on the requested action and the action's response. |
Copied to Clipboard
{
"jsonrpc": "2.0",
"result": [
{
"name": "response",
"value": "{ \"config\":{ \"_attr\":{ \"type\":\"keyword\", \"ns\":\"http://tail-f.com/ns/config/1.0\", \"prefix\":\"ncs\", \"condition\":\"must\", \"severity\":\"error\"}, \"ncs:devices\":{ \"_attr\":{ \"type\":\"keyword\", \"ns\":\"http://tail-f.com/ns/ncs\", \"prefix\":\"ncs\", \"condition\":\"must\", \"severity\":\"error\"}, \"device\":{ \"_attr\":{ \"type\":\"list\", \"ns\":\"http://tail-f.com/ns/ncs\", \"prefix\":\"ncs\", \"condition\":\"must\", \"severity\":\"error\"}, \"_keys\": [\"name\"], \"_children\":[{ \"name\":{ \"_attr\":{ \"type\":\"leaf\", \"ns\":\"http://tail-f.com/ns/ncs\", \"prefix\":\"ncs\", \"condition\":\"must\", \"severity\":\"error\"}, \"_value\":\"TEMP_DEVICE\"}, \"config\":{ \"_attr\":{ \"type\":\"keyword\", \"ns\":\"http://tail-f.com/ns/ncs\", \"prefix\":\"ncs\", \"condition\":\"must\", \"severity\":\"error\"}, \"ios:hostname\":{ \"_attr\":{ \"type\":\"leaf\", \"ns\":\"urn:ios\", \"prefix\":\"ios\", \"condition\":\"must\", \"severity\":\"error\"}, \"_value\":\"test\"}}}]}}}}"
}
],
"id": 1
}
Copied to Clipboard
{
"$ref": "instanceData",
"examples": [
{
"jsonrpc": "2.0",
"result": [
{
"name": "response",
"value": "{ \"config\":{ \"_attr\":{ \"type\":\"keyword\", \"ns\":\"http://tail-f.com/ns/config/1.0\", \"prefix\":\"ncs\", \"condition\":\"must\", \"severity\":\"error\"}, \"ncs:devices\":{ \"_attr\":{ \"type\":\"keyword\", \"ns\":\"http://tail-f.com/ns/ncs\", \"prefix\":\"ncs\", \"condition\":\"must\", \"severity\":\"error\"}, \"device\":{ \"_attr\":{ \"type\":\"list\", \"ns\":\"http://tail-f.com/ns/ncs\", \"prefix\":\"ncs\", \"condition\":\"must\", \"severity\":\"error\"}, \"_keys\": [\"name\"], \"_children\":[{ \"name\":{ \"_attr\":{ \"type\":\"leaf\", \"ns\":\"http://tail-f.com/ns/ncs\", \"prefix\":\"ncs\", \"condition\":\"must\", \"severity\":\"error\"}, \"_value\":\"TEMP_DEVICE\"}, \"config\":{ \"_attr\":{ \"type\":\"keyword\", \"ns\":\"http://tail-f.com/ns/ncs\", \"prefix\":\"ncs\", \"condition\":\"must\", \"severity\":\"error\"}, \"ios:hostname\":{ \"_attr\":{ \"type\":\"leaf\", \"ns\":\"urn:ios\", \"prefix\":\"ios\", \"condition\":\"must\", \"severity\":\"error\"}, \"_value\":\"test\"}}}]}}}}"
}
],
"id": 1
}
]
}
