Summary
Run an Action
Description
Run an action in NSO (Network Services Orchestrator).The possiable actions are the ones in itential_tools
Route
No Northbound API Available
Roles
admin
Parameters
Details Example Schema
Name
Type
Required
Description
params
object
yes
Values needed to execute the action. Supported parameters are defined within the NSO action and/or RPC action.
Copied to Clipboard
{
"params": {
"path": "/itential_commands/admin_down_interfaces",
"params": {
"params": {
"deviceName": "ios.0",
"prefixes": "ncs"
},
"path": "/itential_commands/getNamespaces"
}
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"params": {
"type": "object",
"properties": {
"path": {
"type": "string",
"title": "Action Path",
"examples": [
"/itential_commands/native2Pronghorn",
"/itential_commands/get_config",
"/itential_commands/getNamespaces",
"/itential_commands/admin_down_device",
"/itential_commands/admin_down_interfaces",
"/itential_commands/admin_up_interfaces",
"/itential_commands/set_config",
"/itential_commands/verify_config",
"/itential_commands/stage_device",
"/itential_commands/set_config_transactions"
]
},
"params": {
"description": "every itential_tools action reqires different input params to others",
"schema": {
"$ref": "inputParams"
},
"examples": [
{
"params": {
"device": "fortios.0",
"format": "NATIVE"
},
"path": "/itential_commands/get_config"
},
{
"params": {
"ned_id": "cisco-ios-cli-6.74",
"commands": "hostname test"
},
"path": "/itential_commands/native2Pronghorn"
},
{
"params": {
"deviceName": "ios.0",
"prefixes": "ncs"
},
"path": "/itential_commands/getNamespaces"
},
{
"params": {
"device": "ios.test.1"
},
"path": "/itential_commands/admin_down_device"
},
{
"params": {
"device": "nx.0",
"interfaces": "[\"Ethernet{1/1}\", \"\"port-channel{100}\"]"
},
"path": "/itential_commands/admin_down_interfaces"
},
{
"params": {
"device": "ios.0",
"interfaces": "[\"Ethernet{1/1}\"]"
},
"path": "/itential_commands/admin_up_interfaces"
},
{
"params": {
"device": "ios.0",
"config": "hostname test",
"deviceType": "cisco-ios-cli-6.74",
"dryRun": "cli"
},
"path": "/itential_commands/set_config"
},
{
"params": {
"ned_id": "cisco-ios-cli-6.74",
"commands": "hostname test"
},
"path": "/itential_commands/verify_config"
},
{
"params": {
"device_name": "alu-sr.0",
"ned_id": "alu-sr-cli-8.21",
"commands": "hostname test"
},
"path": "/itential_commands/stage_device"
},
{
"params": {
"device": "ios.0",
"deviceType": "cisco-ios-cli-6.74",
"transactions": {
"id": 1,
"new": "hostname test",
"old": "",
"parents": ""
}
},
"path": "/itential_commands/set_config_transactions"
}
]
}
},
"required": [
"path",
"params"
]
}
},
"required": [
"params"
],
"additionalProperties": false
}
Return
Details Example Schema
Name
Type
Description
response
object
Run action information.
Copied to Clipboard
{
"instance_data": {
"mpvg": "in officia id sunt ea",
"jFcd": "nostrud dolore dolore",
"GyA": "laboris qui in esse",
"TEsSeayqtut": "enim quis sit",
"jIPXL": "laborum ipsum eu"
}
}