# README v1.0.32 2026-02-13 ## Table of contents *** ``` 1. General 1.1 Extract the NED package 1.2 Install the NED package 1.2.1 Local install 1.2.2 System install 1.3 Configure the NED in NSO 2. Optional debug and trace setup 3. Dependencies 4. Sample device configuration 5. Built in RPC actions 5.1. rpc add-filter-path 5.2. rpc clean-package 5.3. rpc clear-cached-capabilities 5.4. rpc clear-filter-paths 5.5. rpc compare-config 5.6. rpc compare-loaded-schema 5.7. rpc compile-modules 5.8. rpc export-package 5.9. rpc get-modules 5.10. rpc import-filter-paths 5.11. rpc list-filter-paths 5.12. rpc list-module-sets 5.13. rpc list-modules 5.14. rpc list-profiles 5.15. rpc patch-modules 5.16. rpc rebuild-package 5.17. rpc remove-filter-path 5.18. rpc show-default-local-dir 5.19. rpc show-loaded-schema 5.20. rpc verify-get-config 5.21. rpc xpath-trace-analyzer 6. Built in live-status show 7. Limitations 8. How to report NED issues and feature requests 9. How to rebuild a NED 10. Configure the NED to use ssh multi factor authentication 11. Run Arbitrary Commands on Device 12. Display Dry-Run Commit Output in Nokia MD-CLI Format ``` ## 1. General *** This document describes the nokia-sros\_nc NED. IMPORTANT: This NED is delivered without any of the device YANG models bundled to the NED package. It is required to download the YANG files separately and rebuild the NED package before the NED is fully operational. See the README-rebuild.md for further information. In summary, the below steps are needed to have a fully functioning NED: ``` 1. Compile the empty package and load it into NSO 2a. Connect to device and fetch yang modules (if yang available on device or in git repository) 2b. Copy vendor yang directly into src/yang (if yang is available elsewhere) 3. Verify yang, potentially fixing any issues 4. Re-Compile package (i.e. in NSO), and do packages reload ``` Additional README files bundled with this NED package ``` +---------------------------+------------------------------------------------------------------------------+ | Name | Info | +---------------------------+------------------------------------------------------------------------------+ | README-ned-settings.md | Information about all run time settings supported by this NED. | | | | | README-rebuild.md | Detailed instructions on how to download the device YANG models and | | | rebuilding the NED with them. | +---------------------------+------------------------------------------------------------------------------+ ``` Common NED Features ``` +---------------------------+-----------+------------------------------------------------------------------+ | Feature | Supported | Info | +---------------------------+-----------+------------------------------------------------------------------+ | netsim | yes | | | | | | | check-sync | yes | See the README-ned-settings.md, 'transaction trans-id-method' | | | | for details. | | | | | | partial-sync-from | yes | | | | | | | live-status actions | yes | Can run CLI commands through 'exec any', see README.md | | | | | | live-status show | yes | All models are by default mounted under live-status | | | | | | load-native-config | no | Since config can be loaded in xml format in NSO, this can be | | | | used instead. | +---------------------------+-----------+------------------------------------------------------------------+ ``` Verified target systems ``` +---------------------------+-----------------+--------+---------------------------------------------------+ | Model | Version | OS | Info | +---------------------------+-----------------+--------+---------------------------------------------------+ | 7950 | 22 | SROS | | | | | | | | 7950 | 23 | SROS | | +---------------------------+-----------------+--------+---------------------------------------------------+ ``` Verified YANG model bundles ``` +---------------------------+-----------------+------------------------------------------------------------+ | Bundle | Version | Info | +---------------------------+-----------------+------------------------------------------------------------+ | SROS Combined | rel22 | | | | | | | SROS Combined | rel23 | | | | | | | OpenConfig | 0.10.0 | | +---------------------------+-----------------+------------------------------------------------------------+ ``` ### 1.1 Extract the NED package *** It is assumed the NED package `ncs--nokia-sros_nc-.signed.bin` has already been downloaded from software.cisco.com. In this instruction the following example settings will be used: * NSO version: 6.0 * NED version: 1.0.1 * NED package downloaded to: /tmp/ned-package-store 1. Extract the NED package and verify its signature: ``` > cd /tmp/ned-package-store > chmod u+x ncs-6.0-nokia-sros_nc-1.0.1.signed.bin > ./ncs-6.0-nokia-sros_nc-1.0.1.signed.bin ``` 2. In case the signature can not be verified (for instance if no internet connection), do as below instead: ``` > ./ncs-6.0-nokia-sros_nc-1.0.1.signed.bin --skip-verification ``` 3. The result of the extraction shall be a tar.gz file with the same name as the .bin file: ``` > ls *.tar.gz ncs-6.0-nokia-sros_nc-1.0.1.tar.gz ``` ### 1.2 Install the NED package *** There are two alternative ways to install this NED package. Which one to use depends on how NSO itself is setup. In the instructions below the following example settings will be used: * NSO version: 6.0 * NED version: 1.0.1 * NED download directory: /tmp/ned-package-store * NSO run time directory: \~/nso-lab-rundir A prerequisite is to set the environment variable NSO\_RUNDIR to point at the NSO run time directory: ``` > export NSO_RUNDIR=~/nso-lab-rundir ``` **IMPORTANT**: This NED is delivered as an “empty” package, i.e without any device YANG models bundled. It must be rebuilt with the device YANG models to become operational. The procedure to rebuild the empty NED (described in the README-rebuild.md) shall typically be done in a lab environment. For this step a “local install” of the NED shall be used. It is not suitable to use “system install” here since it is intended for production systems only. Once this NED has been rebuilt with the device YANG and exported to one or many separate tar.gz customized NED packages, a “system installation” can be used on them. #### 1.2.1 Local install *** This section describes how to install a NED package on a locally installed NSO (see "NSO Local Install" in the NSO Installation guide). It is assumed the NED package has been been unpacked to a tar.gz file as described in 1.1. 1. Untar the tar.gz file. This creates a new sub-directory named: `nokia-sros_nc-.`: ``` > tar xfz ncs-6.0-nokia-sros_nc-1.0.1.tar.gz > ls -d */ nokia-sros_nc-gen-1.0 ``` 2. Install the NED into NSO, using the ncs-setup tool: ``` > ncs-setup --package nokia-sros_nc-gen-1.0 --dest $NSO_RUNDIR ``` 3. Open a NSO CLI session and load the new NED package like below: ``` > ncs_cli -C -u admin admin@ncs# packages reload reload-result { package nokia-sros_nc-gen-1.0 result true } ``` Alternatively the tar.gz file can be installed directly into NSO. Then skip steps 1 and 2 and do like below instead: ``` > ncs-setup --package ncs-6.0-nokia-sros_nc-1.0.1.tar.gz --dest $NSO_RUNDIR > ncs_cli -C -u admin admin@ncs# packages reload reload-result { package nokia-sros_nc-gen-1.0 result true } ``` Set the environment variable NED\_ROOT\_DIR to point at the NSO NED package: ``` > export NED_ROOT_DIR=$NSO_RUNDIR/packages/nokia-sros_nc-gen-1.0 ``` #### 1.2.2 System install *** This section describes how to install a NED package on a system installed NSO (see "NSO System Install" in the NSO Installation Guide). It is assumed the NED package has been been unpacked to a tar.gz file as described in 1.1. 1. Do a NSO backup before installing the new NED package: ``` > $NCS_DIR/bin/ncs-backup ``` 2. Start a NSO CLI session and fetch the NED package: ``` > ncs_cli -C -u admin admin@ncs# software packages fetch package-from-file \ /tmp/ned-package-store/ncs-6.0-nokia-sros_nc-1.0.tar.gz admin@ncs# software packages list package { name ncs-6.0-nokia-sros_nc-1.0.tar.gz installable } ``` 3. Install the NED package (add the argument replace-existing if a previous version has been loaded): ``` admin@ncs# software packages install nokia-sros_nc-1.0 admin@ncs# software packages list package { name ncs-6.0-nokia-sros_nc-1.0.tar.gz installed } ``` 4. Load the NED package ``` admin@ncs# packages reload admin@ncs# software packages list package { name ncs-6.0-nokia-sros_nc-gen-1.0 loaded } ``` ### 1.3 Configure the NED in NSO *** This section describes the steps for configuring a device instance using the newly installed NED package. * Start a NSO CLI session: ``` > ncs_cli -C -u admin ``` * Enter configuration mode: ``` admin@ncs# configure Entering configuration mode terminal admin@ncs(config)# ``` * Configure a new authentication group (my-group) to be used for this device: ``` admin@ncs(config)# devices authgroup group my-group default-map remote-name \ remote-password ``` * Configure a new device instance (example: dev-1): ``` admin@ncs(config)# devices device dev-1 address admin@ncs(config)# devices device dev-1 port admin@ncs(config)# devices device dev-1 device-type generic ned-id nokia-sros_nc-gen-1.0 admin@ncs(config)# devices device dev-1 state admin-state unlocked admin@ncs(config)# devices device dev-1 authgroup my-group ``` **IMPORTANT**: The *device-type* shall always be set to *generic* when configuring a device instance to use a 3PY NED. A common mistake is configuring it as *netconf*, which will cause NSO to use its internal netconf client instead. * Finally commit the configuration ``` admin@ncs(config)# commit ``` * Verify configuration, using a sync-from. ``` admin@ncs(config)# devices device dev-1 sync-from result true ``` If the sync-from was not successful, check the NED configuration again. ## 2. Optional debug and trace setup *** It is often desirable to see details from when and how the NED interacts with the device(Example: troubleshooting) This can be achieved by configuring NSO to generate a trace file for the NED. A trace file contains information about all interactions with the device. Messages sent and received as well as debug printouts, depending on the log level configured. NSO creates one separate trace file for each device instance with tracing enabled. Stored in the following location: `$NSO_RUNDIR/logs/ned-nokia-sros_nc-gen-1.0-.trace` Do as follows to enable tracing in one specific device instance in NSO: 1. Start a NSO CLI session: ``` > ncs_cli -C -u admin ``` 2. Enter configuration mode: ``` admin@ncs# configure Entering configuration mode terminal admin@ncs(config)# ``` 3. Enable trace raw: ``` admin@ncs(config)# devices device dev-1 trace raw admin@ncs(config)# commit ``` Alternatively, tracing can be enabled globally affecting all configured device instances: ``` admin@ncs(config)# devices global-settings trace raw admin@ncs(config)# commit ``` 4. Configure the log level for printouts to the trace file: ``` admin@ncs(config)# devices device dev-1 ned-settings nokia-sros_nc logger \ level [debug | verbose | info | error] admin@ncs(config)# commit ``` Alternatively the log level can be set globally affecting all configured device instances using this NED package. ``` admin@ncs(config)# devices device global-settings ned-settings nokia-sros_nc logger \ level [debug | verbose | info | error] admin@ncs(config)# commit ``` The log level 'info' is used by default and the 'debug' level is the most verbose. **IMPORTANT**: Tracing shall be used with caution. This feature does increase the number of IPC messages sent between the NED and NSO. In some cases this can affect the performance in NSO. Hence, tracing should normally be disabled in production systems. An alternative method for generating printouts from the NED is to enable the Java logging mechanism. This makes the NED print log messages to common NSO Java log file. `$NSO_RUNDIR/logs/ncs-java-vm.log` Do as follows to enable Java logging in the NED 1. Start a NSO CLI session: ``` > ncs_cli -C -u admin ``` 2. Enter configuration mode: ``` admin@ncs# configure Entering configuration mode terminal admin@ncs(config)# ``` 3. Enable Java logging with level all from the NED package: ``` admin@ncs(config)# java-vm java-logging logger com.tailf.packages.ned.sros \ level level-all admin@ncs(config)# commit ``` 4. Configure the NED to log to the Java logger ``` admin@ncs(config)# devices device dev-1 ned-settings nokia-sros_nc logger java true admin@ncs(config)# commit ``` Alternatively Java logging can be enabled globally affecting all configured device instances using this NED package. ``` admin@ncs(config)# devices global-settings ned-settings nokia-sros_nc logger java true admin@ncs(config)# commit ``` **IMPORTANT**: Java logging does not use any IPC messages sent to NSO. Consequently, NSO performance is not affected. However, all log printouts from all log enabled devices are saved in one single file. This means that the usability is limited. Typically single device use cases etc. **SSHJ DEBUG LOGGING** For issues related to the ssh connection it is often useful to enable full logging in the SSHJ ssh client. This will make SSHJ print additional log entries in `$NSO_RUNDIR/logs/ncs-java-vm.log`: ``` admin@ncs(config)# java-vm java-logging logger net.schmizz.sshj level level-all admin@ncs(config)# commit ``` ## 3. Dependencies *** This NED has the following host environment dependencies: * Java 1.8 (NSO version < 6.2) * Java 17 (NSO version >= 6.2) * Gnu Sed Dependencies for NED recompile: * Apache Ant * Bash * Gnu Sort * Gnu awk * Grep * Python3 (with packages: re, sys, getopt, subprocess, argparse, os, glob) ## 4. Sample device configuration *** ``` devices authgroups group nokia-auth-group default-map remote-name default-map remote-password ! devices device dev-1 address
port authgroup nokia-auth-group device-type generic ned-id nokia-sros_nc-gen-1.0 trace raw ! Set get-config-no-filter true if openconfig models are being used ned-settings nokia-sros_nc transaction get-config-no-filter true ned-settings nokia-sros_nc transaction exclude-namespaces urn:ietf:params:xml:ns:yang:ietf-interfaces ned-settings nokia-sros_nc live-status filter-invalid-values true state admin-state unlocked ! ``` ## 5. Built in RPC actions *** ### 5.1. rpc add-filter-path *** ``` Add a path to be filtered, possibly removing paths being made redundant. Input arguments: Either of: - include OR: - exclude - force - path ``` ### 5.2. rpc clean-package *** ``` Cleans the NED package from all downloaded third party YANG files. Input arguments: - verbose Print the full clean output also for successful executions (otherwise only printed on errors). ``` ### 5.3. rpc clear-cached-capabilities *** ``` Clear all cached capabilities (module-set-id/content-id/yang-library/netconf-state). No input arguments ``` ### 5.4. rpc clear-filter-paths *** ``` Clear all filter-paths, except content from ned-setting 'filter-paths-file'. No input arguments ``` ### 5.5. rpc compare-config *** ``` Do a NED-internal compare-config, with data either from device or file, optionally disabling filtering. Input arguments: - config-file Optional file to load config from instead of fetching from device (NOTE, should be content of rpc-reply, i.e. config wrapped in data-tag). - strict Match defaults strict, according to capabilities. - unfiltered Don't apply filter-paths. - outformat (default tree) tree - Standard NSO diff tree. compact - Compact diff showing key-paths. xml - Show diff as netconf edit-config XML. ``` ### 5.6. rpc compare-loaded-schema *** ``` Compare the currently loaded schema with the newly downloaded YANG modules. This tool generates a report indicating whether the schemas are compatible within the scope of the current device configuration stored in the CDB. Input arguments: - details Display detailed results of the schema comparison, including all detected differences and their compatibility status. - skip-yang-pre-processing Skip applying the same pre-processor fixes and build filters to newly downloaded YANG files as were applied to the loaded schema before comparison. If set, it will likely generate a significant number of false positives in the comparison results. - outformat (default structured) Select the format of the generated report. structured - structured. text - text. ``` ### 5.7. rpc compile-modules *** ``` Compile YANG modules, showing all non-fatal warnings found. Input arguments: - local-dir Path to the directory where the YANG files are found (defaults to src/yang in package). - no-deviations Set to disable deviations. - ignore-errors Ignore errors while compiling, i.e. which would normally cause compilation to abort. ``` ### 5.8. rpc export-package *** ``` Export the customized and rebuilt NED. The exported archive file can then be used to install the NED package in other NSO instances. The name of the file will have the following format ncs----customized.tgz. Input arguments: - destination (default /tmp) Set destination directory for the exported archive file. - suffix (default -customized) Configure a customized suffix to the name of the archive file. ``` ### 5.9. rpc get-modules *** ``` Fetch the YANG modules from the device. Input arguments: - module-include-regex Regular expression matching all YANG models to be included in the download. Example: 'openconfig-.*'. - module-exclude-regex Regular expression matching all YANG models to be excluded from the download. Example: 'tailf-.*'. - namespace-include-regex Regular expression matching all namespaces to be included in the download. Example: 'tailf-.*'. - namespace-exclude-regex Regular expression matching all namespaces to be excluded from the download. Example: 'tailf-.*'. - module-set Only include modules from the given yang-library module-set (if device supports yang-library 1.1). - only-present - only-oper-filter - profile (default sros-combined-from-device) Use a download profile to match a predefined subset of matching YANG files. - local-dir Path to the directory where the YANG files are to be copied (defaults to src/yang in package). - ignore-errors Ignore errors during download. For example missing files of failed revision checks. Either of: - remote device The device itself. OR: - remote dir A directory on the local host holding all YANG files. For instance a local clone of a git repository. OR: - remote archive A path to a zip/tgz archive file containing the YANG files. OR: - remote git repository The URL to the git repository. Example: https://github.com/YangModels/yang.git. - remote git dir Path to a sub directory inside the git repo where the YANG files can be found. Example: vendor/cisco/nx/10.1-2. - remote git checkout Optionally, a name of a branch/tag in the git repo where the YANG files can be found. Example: master. - remote git include-dir Optional extra include paths to be used when searching for YANG files. Each include path is relative to the git root directory. ``` ### 5.10. rpc import-filter-paths *** ``` Import filter-paths from file, will be merged with currently loaded. Input arguments: - filter-file File containing filter-paths, one on each line: . ``` ### 5.11. rpc list-filter-paths *** ``` List currently loaded/generated filter-paths. Input arguments: - deviation-module Generate a module which deviates all excluded paths as 'not-supported'. - save-to-file Save result to given file. For deviation module, optionally just give name of module to generate in src/yang. ``` ### 5.12. rpc list-module-sets *** ``` List the yang-library module-sets advertised by the device, if device supports it. No input arguments ``` ### 5.13. rpc list-modules *** ``` List the YANG modules advertised by the device. Including revision tag. Input arguments: - module-include-regex Regular expression matching all YANG models to be included in the download. Example: 'openconfig-.*'. - module-exclude-regex Regular expression matching all YANG models to be excluded from the download. Example: 'tailf-.*'. - namespace-include-regex Regular expression matching all namespaces to be included in the download. Example: 'tailf-.*'. - namespace-exclude-regex Regular expression matching all namespaces to be excluded from the download. Example: 'tailf-.*'. - module-set Only include modules from the given yang-library module-set (if device supports yang-library 1.1). - only-present - only-oper-filter - profile (default sros-combined-from-device) Use a download profile to match a predefined subset of matching YANG files. ``` ### 5.14. rpc list-profiles *** ``` List all predefined download profiles bundled with the NED. Including a short description of each. No input arguments ``` ### 5.15. rpc patch-modules *** ``` Patch YANG modules, to remove non-fatal warnings found. Input arguments: - local-dir Path to the directory where the YANG files are found (defaults to src/yang in package). - no-deviations Set to disable deviations. - output-dir Path to the directory where the patched YANG files are written (defaults to src/yang in package), existing files will be renamed to .yang.orig. ``` ### 5.16. rpc rebuild-package *** ``` Rebuild the NED package directly from within NSO. This invokes the gnu make internally. Input arguments: - verbose Print the full build output also for successful builds (otherwise only printed on errors). - build-namespace-classes Generate Python and Java namespace classes for each YANG file. - use-module-as-prefix Instructs the NSO YANG compiler to use the YANG module name as the prefix instead of the prefix declared in the YANG file. By default, the declared prefix is used. Enabling this option changes how schema nodes are referenced in NSO, including through the Maagic and Maapi APIs. Use this option with caution, as it may cause unexpected side effects. The primary use case is migrating from an older NED schema that used module names as prefixes. Note that the NED setting transaction/accept-module-as-prefix must also be enabled in the rebuilt NED to make it function properly. - profile Apply a certain build profile. - filter scope dir Directory containing one or many xml file representing the wanted scope. - filter trim-schema method (default patch) Select method to be used for trimming. deviate - Trim by creating a YANG deviation file containing all selected nodes. patch - Trim by patching the YANG models and remove all selected nodes from them before they are being compiled. Either of: - filter trim-schema nodes List of nodes to trim. Use one of the pre-defined top node names. Alternatively, specify a custom xpath to trim (prefix is mandatory on each element in the path). OR: - filter trim-schema all-unused Trim all currently unused nodes in the schema. This means all config nodes that are currently not populated in CDB. OR: - filter trim-schema all-with-status Trim all nodes in the schema annotated with matching 'status' statements. deprecated - Means node is still supported, but usage no longer recommended. obsolete - Means node is not supported anymore, and should not be used. OR: - filter trim-schema nodes-from-file (default /tmp/nedcom-trim-schema-nodes.txt) Specify a path to a custom file to be used for trimming nodes. The file shall contain schema paths, including relevant prefixes to all nodes to be trimmed. One schema path per line. OR: - filter trim-schema custom-deviation-file Specify a path to a custom YANG deviation file to be used for trimming the schema. The file shall comply to the standard for deviation files and contain paths to all nodes to be trimmed from the schema. OR: - filter auto-config dir Directory containing the files used for auto-config filtering. The following files must be present: before.xml and after.xml. - filter auto-config file (default /tmp/nedcom-auto-deviations.yang) Name of auto generated deviation file. - ned-id major Set a custom major number in the generated ned-id. - ned-id minor Set a custom minor number in the generated ned-id. - ned-id suffix Set a custom suffix in the generated ned-id. - include-netsim Do compile the YANG models for netsim as well, when rebuilding the NED package. - additional-build-args Additional arguments to pass to build(make) commands. ``` ### 5.17. rpc remove-filter-path *** ``` Remove a path from filter-paths. Input arguments: Either of: - include OR: - exclude - path ``` ### 5.18. rpc show-default-local-dir *** ``` Show the path to the default directory where the YANG files are to be copied. I.e /src/yang. No input arguments ``` ### 5.19. rpc show-loaded-schema *** ``` Display the schema currently built into the NED package. Each node will by default be listed with a schema path. Input arguments: - scope (default all) Select the scope for the nodes that will be listed. all - Display all nodes in the schema. This is the default. used - Display only the config nodes in use, i.e currently populated in CDB. unused - Display only the config nodes that are not in use. rpcs - Display the rpc nodes defined in the schema. - with-status Only select nodes annotated with matching 'status' statements. deprecated - Means node is still supported, but usage no longer recommended. obsolete - Means node is not supported anymore, and should not be used. - count Count the nodes and return the sum instead of the full list of nodes. - details Display schema details like must/when expression, leafrefs and leafref targets. - root-paths Specify root paths for which nodes shall be listed or counted. Only nodes with a schema path starting any of the specified roots will then be processed. - config (default true) Set to false to display non config nodes in the schema. Note: scope will in this case be 'all'. - output file - developer generate-schypp-pragmas pragma (default remove) Set pragma type. remove - remove. replace - replace. - developer generate-schypp-pragmas statement Set the yang statement for the pragma. must - must. when - when. unique - unique. type - type. - developer generate-schypp-pragmas pattern Configure the pattern to search for matching statements. Use ".*" to match any string. - developer generate-schypp-pragmas replace-with For replace pragmas, set replacement for statements matching the pattern. - developer generate-schypp-pragmas add-comment Prepend extra comment containing info about the statement. ``` ### 5.20. rpc verify-get-config *** ``` Verify XML contents of config, either from device or file, to validate data and look for unmodeled structures (the yang-modules are compiled on the fly making this a convenient way to verify yang-updates). Input arguments: Either of: - local-dir Path to the directory where the YANG files are found (defaults to src/yang in package). - no-deviations Set to disable deviations. - patch Auto-patch yang when possible (e.g. missing leafref targets will expand referrer type). - config-file Optional file to load config from instead of fetching from device (NOTE, should be content of rpc-reply, i.e. config wrapped in data-tag). OR: - no-compile - verbose Show verbose output, like 'sync-from verbose'. ``` ### 5.21. rpc xpath-trace-analyzer *** ``` A tool for analyzing NSO XPath traces, designed to identify inefficient or problematic XPath expressions in third-party YANG files that may negatively impact NSO performance. Input arguments: - file (default logs/xpath.trace) Path to the NSO xpath trace file to use. The xpath trace file used by the current NSO will be used by default. - number-of-entries (default 10) Set the number of entries to display in the generated top list. ``` ## 6. Built in live-status show *** The nokia-sroc\_nc NED has full support for fetching operational data via the NSO live-status API. ## 7. Limitations *** The SROS device must be properly configured in model driven mode and with netconf enabled for this NED to function properly. Any other mode such as 'mixed mode' makes SROS limited and will prevent the NED from using certain features. For instance the fast transaction id calculation nethod which has been customized for SROS. Some issues has been observed when running towards SROS devices. These are briefly described here, please note that these are only what have been observed in specific use-cases, it might be related to device/SROS model/version, and also to specific configuration used in these use-cases. Hence, these issues might not be relevant for your use-case, and of course, there might be other issues which have not been observed. As has been observed with many vendors yang-models, SROS seems to contain some leafrefs that are not enforced in the device, which might lead to NSO reporting "illegal reference" when doing sync-from. See file src/customize-schema.schypp for these, i.e. paths which have an 'inline\_type' operation in this file. Also see the README-rebuild.md for more info on mitigating "illegal reference". In some older versions of SROS, support for yang-library version 1.1 is announced, however, the implementation has bugs in it (this relates at least to SROS versions <= 20.10 which announce yang-library 1.1 support). In this case the NED needs to be configured to make it look like the device actually implements yang-library 1.0. This can be done by setting the below ned-settings: ``` ned-settings nokia-sros_nc connection capabilities use-yang-library false ned-settings nokia-sros_nc connection capabilities regex-exclude .*yang-library:1.1.* ned-settings nokia-sros_nc connection capabilities inject urn:ietf:params:netconf:capability:yang-library:1.0revision=2019-01-04&module-set-id=20.10.R4 ``` NOTE: The "fake" module-set-id used here is not relevant, it can be anything Another issue which has been observed is that while the device announces support for the yang-module ietf-interfaces, it can not be used for example inside the filter of a get-config request. Hence this module needs to be filtered out, which is done with the below ned-setting: ``` ned-settings nokia-sros_nc transaction exclude-namespaces urn:ietf:params:xml:ns:yang:ietf-interfaces ``` At least SROS version 22 has problems with properly returning valid data from the openconfig data tree when the NED is doing a get-config request. The device seems to have problems with the default filter used by the NED. If the NED is built with openconfig, this filter will contain namespaces of the openconfig models. This will result in the device returning an error instead of the valid config. This issue can be solved by configuring the following NED setting: ``` ned-settings nokia-sros_nc transaction get-config-no-filter true ``` All current versions of SROS have a special non rfc compliant behaviour for settings related to the configuration groups 'bof' and 'li'. These configuration trees are regarded as separate datastores by SROS. This means SROS does not allow editing standard config together with 'bof' or 'li' settings in the same transaction. Furthermore editing 'bof' and 'li' settings does require Nokia specific non rfc compliant extensions to the netconf messages. Do as follows to enable support for managing 'bof' settings in the NED: 1. Make sure the Nokia 'bof' models are included when rebuilding the NED. For example, use the profile 'sros-combined-with-bof-from-device' when downloading the models. 2. Configure the following NED setting: ``` ned-settings nokia-sros_nc transaction bof-settings enable true; ``` 3. Set the following NED setting to *true* for devices running SROS version 23 or newer. Default is *false*. ``` ned-setinngs nokia-sros_nc transaction bof-settings use-config-region-ns true ``` The NED does currently not support managing 'li' settings. This is something that can be added upon request. ## 8. How to report NED issues and feature requests *** **Issues like bugs and errors shall always be reported to the Cisco NSO NED team through the Cisco Support channel:** * * The following information is required for the Cisco NSO NED team to be able to investigate an issue: ``` - A detailed recipe with steps to reproduce the issue. - A raw trace file generated when the issue is reproduced. - Access to a device where the issue can be reproduced by the Cisco NSO NED team. This typically means both read and write permissions are required. Pseudo access via tools like Webex, Zoom etc is not acceptable. However, it is ok with device access through VPNs, jump servers etc though. ``` Do as follows to gather the necessary information needed for your device, here named 'dev-1': 1. Enable full debug logging in the NED ``` ncs_cli -C -u admin admin@ncs# configure admin@ncs(config)# devices device dev-1 ned-settings nokia-sros_nc logging level debug admin@ncs(config)# commit ``` 2. Configure the NSO to generate a raw trace file from the NED ``` admin@ncs(config)# devices device dev-1 trace raw admin@ncs(config)# commit ``` 3. If the NED already had trace enabled, clear it in order to submit only relevant information Do as follows for NSO 6.4 or newer: ``` admin@ncs(config)# devices device dev-1 clear-trace ``` Do as follows for older NSO versions: ``` admin@ncs(config)# devices clear-trace ``` 4. Run a compare-config to populate the trace with initial device config ``` admin@ncs(config)# devices device dev-1 compare-config ``` 5. Reproduce the found issue using ncs\_cli or your NSO service. Write down each necessary step in a reproduction report. 6. Gather the reproduction report and a copy of the raw trace file containing data recorded when the issue happened. 7. Contact the Cisco support and request to open a case. Provide the gathered files together with access details for a device that can be used by the Cisco NSO NED when investigating the issue. **Requests for new features and extensions of the NED are handled by the Cisco NSO NED team when applicable. Such requests shall also go through the Cisco support channel.** The following information is required for feature requests and extensions: 1. A detailed use case description, with details like: * Data of interest * The kind of operations to be used on the data. Like: 'read', 'create', 'update', 'delete' and the order of the operation * Device APIs involved in the operations (For example: REST URLs and payloads) * Device documentation describing the operations involved 2. Run sync-from # devices device dev-1 sync-from (if relevant) 3. Attach the raw trace to the ticket (if relevant) 4. Access to a device that can be used by the Cisco NSO NED team for testing and verification of the new feature. This usually means that both read and write permissions are required. Pseudo access via tools like Webex, Zoom etc is not acceptable. However, it is ok with access through VPNs, jump servers etc. ## 9. How to rebuild a NED *** Check the README-rebuild.md file, chapter 1.3, for more information. ## 10. Configure the NED to use ssh multi factor authentication *** This NED supports multi factor authentication (MFA) using the ssh authentication method 'keyboard-interactive'. Some additional steps are required to enable the MFA support: 1. Verify that your NSO version supports MFA. This is configurable as additional settings in the authentication group used by the device instance. Enter a NSO CLI and enter the following and do tab completion: ``` > ncs_cli -C -u admin admin@ncs# show running-config devices authgroups group default default-map Possible completions: action-name The action to call when a notification is received. callback-node Invoke a standalone action to retrieve login credentials for managed devices on the 'callback-node' instance. mfa Settings for handling multi-factor authentication towards the device public-key Use public-key authentication remote-name Specify device user name remote-password Specify the remote password remote-secondary-password Second password for configuration same-pass Use the local NCS password as the remote password same-secondary-password Use the local NCS password as the remote secondary password same-user Use the local NCS user name as the remote user name ``` If 'mfa' is displayed in the output like above, NSO has MFA support enabled. In case MFA is not supported it is necessary to upgrade NSO before proceeding. 2. Implement the authenticator executable. The MFA feature relies on an external executable to take care of the client part of the multi factor authentication. The NED will automatically call this executable for each challenge presented by the ssh server and expects to get a proper response in return. The executable can be a simple shell script or a program implemented in any programming language. The required behaviour is like this: * read one line from stdin The line passed from the NED will be a semi colon separated string containing the following info: ``` [;;;;;;;] ``` The elements for device name, user, password and opaque corresponds to what has been configured in NSO. The ssh server name, instruction and prompt are given by the ssh server during the authentication step. Each individual element in the semi colon separated list is Base64 encoded. * Extract the challenge based on the contents above. * Print a response matching the challenge to stdout and exit with code 0 * In case a matching response can not be given do exit with code 2 Below is a simple example of an MFA authenticator implemented in Python3: ``` #!/usr/bin/env python3 import sys import base64 # This is an example on how to implement an external multi factor authentication handler # that will be called by the NED upon a ssh 'keyboard-interactive' authentication # The handler is reading a line from stdin with the following expected format: # [;;;;;;;] # All elements are base64 encoded. def decode(arg): return str(base64.b64decode(arg))[2:-1] if __name__ == '__main__': query_challenges = { "admin@localhost's password: ":'admin', 'Enter SMS passcode:':'secretSMScode', 'Press secret key: ':'2' } # read line from stdin and trim brackets line = sys.stdin.readline().strip()[1:-1] args = line.split(';') prompt = decode(args[6]) if prompt in query_challenges.keys(): print(query_challenges[prompt]) exit(0) else: exit(2) ``` 3. Configure the authentication group used by the device instance to enable MFA. There are two configurables available: * executable The path to the external multi factor authentication executable (mandatory). * opaque Opaque data that will passed as a cookie element to the executable (optional). ``` > ncs_cli -C -u admin admin@ncs# config Entering configuration mode terminal admin@ncs(config)# devices authgroups group default-map mfa executable admin@ncs(config)# devices authgroups group default-map mfa opaque admin@ncs(config)# commit ``` 4. Try connecting to the device. ### 10.1 Trouble shooting *** In case of connection problems the following steps can help for debugging: Enable the NED trace in debug level: ``` > devices device dev-1 trace raw > devices device dev-1 ned-settings nokia-sros_nc logger level debug > commit ``` Try connect again Inspect the generated trace file. Verify that the ssh client is using the external authenticator executable: ``` using ssh external mfa executable: ``` Verify that the executable is called with the challenges presented by the ssh server: ``` calling external mfa executable with ssh server given name: '', instruction: '', prompt '' ``` Check for any errors reported by the NED when calling the executable ``` ERROR: external mfa executable failed <....> ``` ## 11. Run Arbitrary Commands on Device *** Some commands that are available to a user logged in to an interactive CLI session on the device might not be available through NETCONF. For situations like this the NED provides the feature to run arbitrary commands on the device. The NED feature to execute commands is connected in NSO to a live-status action called 'exec any'. The NED does by default use the 'md-cli-raw-command' feature to tunnel commands to the device. This feature is supported by all newer versions of Nokia SROS. It is also possible to configure the NED to use an interactive SSH login to the device. This extra SSH session is then handled internally in the NED. This option works also with older versions of SROS. There are some ned-settings to control the behaviour of this feature, see the section 'ned-settings nokia-sros\_nc live-status exec-any-mode and cli' in README-ned-settings.md for details on this. ``` admin@ncs# devices device dev-1 live-status exec any admin display-config ``` Note that when using ncs\_cli, the command-line given might need to be quoted if it contains characters that are interpreted by the ncs\_cli itself. ## 12. Display Dry-Run Commit Output in Nokia MD-CLI Format *** When you run `commit dry-run outformat native` in NSO, this NED will, by default, return a NETCONF XML representation of the configuration that would be applied to the device. You can configure the NED to also generate the same configuration in Nokia MD-CLI format (as a best-effort conversion). This feature is intended to make the configuration output more human-readable, which can be useful for auditing and reviewing changes. Important: The MD-CLI format is only shown during dry-run operations. When you perform an actual commit, only the NETCONF XML is sent to the device. To enable MD-CLI dry-run output, configure the following NED setting: ``` admin@ncs# devices device dev-1 ned-settings nokia-sros_nc transaction dry-run-output-format netconf-and-md-cli admin@ncs# commit ``` Example output: ``` admin@ncs# devices device dev-1 config configure port 1/1/1 description EXAMPLE admin@ncs# commit dry-run outformat native native { device { name dev-1 data #118 ## #404 test-then-set rollback-on-error 1/1/1 EXAMPLE ## Corresponding operations in MD-CLI format: /configure port 1/1/1 description EXAMPLE } } ```