Device customization

The NSO adapter supports two customization properties that allow you to override or extend its default behavior for specific NED device types: liveStatusProps and overrideConfig. Both are configured in the adapter’s service config in Platform.

When to use these properties

The adapter has built-in default behavior for a set of supported NED types. Use liveStatusProps when:

• A device type requires a non-standard action path or command structure for live status calls
• You need to support a device type not covered by the adapter’s defaults
• You want to override the default behavior for a supported device type

Use overrideConfig when:

• A device type requires non-default flags, cleaners, or configuration paths for get/set config operations
• You need to change how the adapter constructs JSON-RPC calls for a specific NED

Configure customizations

liveStatusProps

The liveStatusProps property customizes how the adapter constructs JSON-RPC calls for live status commands — typically show commands sent to devices through NSO.

Top-level properties

Action properties

Examples

Custom command prefix

Use commandPrefix to remap the built-in show command to a custom prefix for a specific NED type. In this example, a show version live status call becomes fake_command version in the JSON-RPC call to NSO:

1
"liveStatusProps": [
2
  {
3
    "nedType": "cisco-iosxr-cli-7.36",
4
    "actions": [
5
      {
6
        "commandPrefix": "fake_command",
7
        "actionPath": "live-status/cisco-ios-xr-stats:exec/cisco-ios-xr-stats:show"
8
      }
9
    ]
10
  }
11
]

The resulting JSON-RPC call:

actionPath: "live-status/cisco-ios-xr-stats:exec/cisco-ios-xr-stats:show"
command: "fake_command version"

Custom command parameters

Use commandParams when the live status action requires a specific parameter structure. Use "${command}" to insert the command value at the correct position:

1
"liveStatusProps": [
2
  {
3
    "nedType": "ericsson-sgsnmme",
4
    "actions": [
5
      {
6
        "actionPath": "live-status/ericssonsgsnmme-stats:EXEC/nonconfig-actions",
7
        "commandParams": {
8
          "action": {
9
            "action-payload": "${command}"
10
          }
11
        }
12
      }
13
    ]
14
  }
15
]

For a show version command, the resulting JSON-RPC call:

actionPath: "live-status/ericssonsgsnmme-stats:EXEC/nonconfig-actions"
command: {
  "action": {
    "action-payload": "show version"
  }
}

Array command type

Use commandParamType: "array" when the live status action expects the command as an array rather than a string:

1
"liveStatusProps": [
2
  {
3
    "nedType": "junos",
4
    "actions": [
5
      {
6
        "actionPath": "live-status/junoscli:exec/any",
7
        "commandParams": {
8
          "commands": "${command}"
9
        },
10
        "commandParamType": "array"
11
      }
12
    ]
13
  }
14
]

For a show version command, the resulting JSON-RPC call:

actionPath: "live-status/junoscli:exec/any"
command: {
  "commands": ["show version"]
}

overrideConfig

The overrideConfig property overrides the adapter’s default device settings for get/set config operations on a per-NED basis.

Top-level properties

Action properties

Example

Only include the properties you want to override for the given NED type:

1
"overrideConfig": [
2
  {
3
    "nedType": "cisco-ios-xr",
4
    "actions": {
5
      "nedFlag": "MAAPI_CONFIG_C",
6
      "cleaner": "IOSXRCleaner",
7
      "nedStr": "cisco-ios-xr",
8
      "deviceType": "cli",
9
      "nativeCmd": "",
10
      "interfacePath": "interface",
11
      "deviceActionPath": "live-status/cisco-ios-xr-stats:exec/ci",
12
      "cmdArgName": "args",
13
      "cmdArg": "running-config",
14
      "cmdNS": "cisco-ios-xr-stats",
15
      "supportNativeConfig": true,
16
      "deleteKeyword": "no"
17
    }
18
  }
19
]

Related reading

• Itential Tools actions
• Configure the NSO adapter