README-ned-settings

NED settings details


This NED is equipped with a number of runtime configuration options "NED settings" allowing for customization by the end user. All options are configurable using the NSO API for NED settings. Most NED settings can be configured globally, per device profile or per device instance in the following locations:

global /ncs:devices/global-settings/ned-settings/arista-dcs/ profile /ncs:devices/ncs:profiles/profile:/ned-settings/arista-dcs/ device /ncs:/device/devices/device:/ned-settings/arista-dcs/

Profiles setting overrides global-settings and device settings override profile settings, hence the narrowest scope of the setting is used by the device.

If user changes a ned-setting, then user must reconnect to the device, i.e. disconnect and connect in order for the new setting to take effect.

From the NSO CLI the device instance NED settings for this NED are available under:

# config
# devices device dev-1 ned-settings arista-dcs

Press TAB to see all the NED settings.

Table of contents


1. ned-settings arista-dcs
2. proxy
3. connection
4. logger
5. live-status
6. developer
   6.1. simulate-show
7. read
   7.1. show-running-all-match-pattern
8. write
   8.1. inject-command

1. ned-settings arista-dcs


arista-dcs ned-settings.

2. ned-settings arista-dcs proxy


Configure NED to access device via a proxy.

3. ned-settings arista-dcs connection


Configure settings specific to the connection between NED and device.

4. ned-settings arista-dcs logger


Settings for controlling logs generated.

5. ned-settings arista-dcs live-status


Configure NED settings related to live-status.

6. ned-settings arista-dcs developer


Contains settings used for debugging (intended for NED developers).

6.1. ned-settings arista-dcs developer simulate-show


Used with live-status to inject simulated output for a show command.

7. ned-settings arista-dcs read


Settings used when reading from device.

7.1. ned-settings arista-dcs read show-running-all-match-pattern


The list of the patterns included in the "show running-config all" command, for example:

devices device arista ned-settings arista-dcs read show-running-all-match-pattern "^logging trap" devices device arista ned-settings arista-dcs read show-running-all-match-pattern "^aaa authorization config-commands"

8. ned-settings arista-dcs write


Settings used when writing to device.

8.1. ned-settings arista-dcs write inject-command


  • write inject-command

The arista-dcs write inject-command ned-setting can be used to inject command line(s) in a transaction. This can be needed, for example, when deleting crypto config which requires a clear command to be run before delete.

The ned-settings is configured with:

id User defined name for this ned-setting used to identify the list entry

config-line The config line(s) where command should be injected (DOTALL regexp)

command The command (or config) to inject after|before config-line. Prefix with 'do ' if you want to run exec command in config mode. Prefix with 'exec ' if you want to run exec command in exec mode.

'where', eight values are supported: before-each inject command before each matching before-first inject command before first matching after-each inject command after each matching after-last inject command after last matching before-topmode inject command before regex topmode after-topmode inject command after regex topmode first inject command first if regex matches or is unset last inject command last if regex matches or is unset

An example (of a previously hard coded inject case):

devices global-settings ned-settings arista-dcs write inject-command C1 config-line "no crypto ikev2 keyring \S+" command "do clear crypto session" before-first devices global-settings ned-settings arista-dcs write inject-command C2 config-line "no crypto ikev2 keyring \S+" command "do clear crypto ikev2 sa fast" before-first

The above inject command configs will cause a delete of ikev2 keyring to look like this:

do clear crypto session do clear crypto ikev2 sa fast no crypto ikev2 keyring XXX

$i (where i is value from 1 to 9) can also be used to inject matches values from the config line. For example:

devices global-settings ned-settings arista-dcs write inject-command C2 config-line "no interface Tunnel(\d+)" command "do clear dmvpn session interface Tunnel $1 static" before-first

with a deletion of interface Tunnel100 results in:

!do clear dmvpn session interface Tunnel 100 static no interface Tunnel100

Hence, $1 is replaced with the first group value from the config line, which is (\d+).

Last updated

Was this helpful?