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 live-status actions
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
1. General
This document describes the ericsson-minilink6352 NED.
Additional README files bundled with this NED package
+---------------------------+------------------------------------------------------------------------------+
| Name | Info |
+---------------------------+------------------------------------------------------------------------------+
| README-ned-settings.md | Information about all run time settings supported by this NED. |
+---------------------------+------------------------------------------------------------------------------+
+---------------------------+-----------------+--------+---------------------------------------------------+
| Model | Version | OS | Info |
+---------------------------+-----------------+--------+---------------------------------------------------+
| MINI-LINK 6352/2 80/21H | | | |
+---------------------------+-----------------+--------+---------------------------------------------------+
1.1 Extract the NED package
It is assumed the NED package ncs-<NSO version>-ericsson-minilink6352-<NED version>.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
Extract the NED package and verify its signature:
> cd /tmp/ned-package-store
> chmod u+x ncs-6.0-ericsson-minilink6352-1.0.1.signed.bin
> ./ncs-6.0-ericsson-minilink6352-1.0.1.signed.bin
In case the signature can not be verified (for instance if no internet connection),
do as below instead:
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:
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.
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.
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
4.1 Current Yang schema structure of the model adopted:
$ ncs_cli -u admin -C
admin@ncs# config
Entering configuration mode terminal
admin@ncs(config)# devices device <deviceNAme> config
admin@ncs(config-config)# common services service http service-enable enabled port 80
admin@ncs(config-config)# common services service https service-enable enabled port 443
admin@ncs(config-config)# common services service snmp service-enable enabled port 161
admin@ncs(config-config)# common services service xrpc service-enable enabled port 8080
Check configured candidate cdb content:
admin@ncs(config-config)# show full-configuration common services service
devices device <deviceNAme>
config
common services service http service-enable enabled port 8080
common services service https service-enable enabled port 8443
common services service snmp service-enable enabled port 160
common services service xrpc service-enable enabled port 8888
!
!
Commit DRY to display the diffs from the CDB candidate state
admin@ncs(config-config)# commit dry-run
admin@ncs(config-config)# commit dry-run
cli {
local-node {
data devices {
device <deviceNAme> {
config {
common {
services {
service {
http {
- service-enable disabled;
+ service-enable enabled;
- port 80;
+ port 8080;
}
https {
- service-enable disabled;
+ service-enable enabled;
- port 443;
+ port 8443;
}
snmp {
- service-enable disabled;
+ service-enable enabled;
- port 161;
+ port 160;
}
xrpc {
- service-enable disabled;
+ service-enable enabled;
- port 8080;
+ port 8888;
}
}
}
}
}
}
}
}
}
Commit native to display device CLI native syntax of the command that will be issued
admin@ncs(config-config)# commit dry-run outformat native
native {
device {
name <deviceName>
data common services service http service-enable enabled port 8080
common services service https service-enable enabled port 8443
common services service snmp service-enable enabled port 160
common services service xrpc service-enable enabled port 8888
}
}
4.3.3 Configuring /common/system
Configure params:
$ ncs_cli -u admin -C
admin@ncs# config
Entering configuration mode terminal
admin@ncs(config)# devices device <deviceNAme> config
admin@ncs(config-config)# common system contact <WORD1 WORD2 WORD3>
admin@ncs(config-config)# common system name <NAME>
admin@ncs(config-config)# common system location <WORD1 WORD2 WORD3>
Check configured candidate cdb content:
admin@ncs(config-config)# show full-configuration common system
devices device <deviceNAme>
config
common system contact Contact Name
common system name System Name
common system location System Location
!
!
Commit DRY to display the diffs from the CDB candidate state
admin@ncs(config-config)# commit dry-run
cli {
local-node {
data devices {
device <deviceNAme> {
config {
common {
system {
- contact " old name";
+ contact "Contact Name";
- name old_system_name;
+ name "System Name";
- location "location name";
+ location "System Location";
}
}
}
}
}
}
}
Commit native to display device CLI native syntax of the command that will be issued
admin@ncs(config-config)# commit dry-run outformat native
native {
device {
name <deviceNAme>
data common system contact Contact Name
common system name System Name
common system location System Location
}
}
4.3.4 Configuring /common/snmp/in-use
Configure params:
admin@ncs(config-config)# show full-configuration common snmp
devices device <deviceNAme>
config
data common snmp in-use enabled
!
!
Commit DRY to display the diffs from the CDB candidate state
Commit native to display device CLI native syntax of the command that will be issued
admin@ncs(config-config)# commit dry-run outformat native
native {
device {
name <deviceNAme>
data common snmp in-use enabled
}
}
4.3.5 Configuring /common/time
Configure params:
$ ncs_cli -u admin -C
admin@ncs# config
Entering configuration mode terminal
admin@ncs(config)# devices device <deviceNAme> config
admin@ncs(config-config)# common time clock 13:10:45 May 23 2024
admin@ncs(config-config)# common time time-zone AMERICA
admin@ncs(config-config)# common time server 1.123.12.12
admin@ncs(config-config)# common time server-ipv6 ::
admin@ncs(config-config)# common time ntp enabled
admin@ncs(config-config)# common time ntp-authentication disabled
Check configured candidate cdb content:
admin@ncs(config-config)# show full-configuration common time
devices device <deviceNAme>
config
common time clock 13:10:45 May 24 2024
common time time-zone AMERICA
common time server 1.234.56.78
common time server-ipv6 ::
common time ntp enabled
common time ntp-authentication disabled
!
!
Commit DRY to display the diffs from the CDB candidate state
admin@ncs(config-config)# commit dry-run
cli {
local-node {
data devices {
device <deviceNAme> {
config {
common {
time {
- clock "13:10:45 May 23 2024";
+ clock "13:10:45 May 24 2024";
- time-zone AMERICA;
+ time-zone AMERICA_DENVER;
- server 1.234.56.78;
+ server 1.2.3.4;
- ntp enabled;
+ ntp disabled;
- ntp-authentication disabled;
+ ntp-authentication enabled;
}
}
}
}
}
}
}
Commit native to display device CLI native syntax of the command that will be issued
admin@ncs(config-config)# commit dry-run outformat native
native {
device {
name <deviceNAme>
data common time clock 13:10:45 May 24 2024
common time time-zone AMERICA
common time server 1.234.56.78
common time ntp enabled
common time ntp-authentication disabled
}
}
$ ncs_cli -u admin -C
admin@ncs# config
Entering configuration mode terminal
admin@ncs(config)# devices device <deviceNAme> config
admin@ncs(config-config)# cos dot1p priority-map-profile 1 priority-map 0 class 1
admin@ncs(config-config)# cos dot1p priority-map-profile 1 priority-map 1 class 0
...
admin@ncs(config-config)# show full cos dot1p priority-map-profile 1
devices device <deviceNAme>
config
cos dot1p priority-map-profile 1 priority-map 0 class 1
cos dot1p priority-map-profile 1 priority-map 1 class 0
cos dot1p priority-map-profile 1 priority-map 2 class 2
cos dot1p priority-map-profile 1 priority-map 3 class 3
cos dot1p priority-map-profile 1 priority-map 4 class 4
cos dot1p priority-map-profile 1 priority-map 5 class 5
cos dot1p priority-map-profile 1 priority-map 6 class 6
cos dot1p priority-map-profile 1 priority-map 7 class 7
!
!
Commit DRY to display the diffs from the CDB candidate state
admin@ncs(config-config)# commit dry-run
cli {
local-node {
data devices {
device <deviceNAme> {
config {
cos {
dot1p {
priority-map-profile 1 {
priority-map 0 {
- class 1;
+ class 0;
}
priority-map 1 {
- class 0;
+ class 1;
}
}
}
}
}
}
}
}
}
Commit native to display device CLI native syntax of the command that will be issued
admin@ncs(config-config)# commit dry-run outformat native
native {
device {
name <deviceNAme>
data cos dot1p priority-map-profile 1 priority-map 0 class 0
cos dot1p priority-map-profile 1 priority-map 1 class 1
}
}
admin@ncs(config-config)# show full ip interface 1
devices device <deviceNAme>
config
ip interface 1
address 192.168.0.1
address-ipv6 ::
mask 255.255.255.255
mtu 1500
type numbered
exit
!
!
Commit DRY to display the diffs from the CDB candidate state
Commit native to display device CLI native syntax of the command that will be issued
admin@ncs(config-config)# commit dry-run outformat native
native {
device {
name <deviceNAme>
data ip interface 1
address 192.168.0.1
mask 255.255.255.255
exit
}
}
4.6.2 Configuring /ip/route
Ip route list has three keys:
admin@ncs(config-config)# ip route ?
This line doesn't have a valid range expression
Possible completions:
A.B.C.D Destination IP address
admin@ncs(config-config)# ip route 1.2.3.4 ?
Possible completions:
A.B.C.D Destination network prefix mask
admin@ncs(config-config)# ip route 1.2.3.4 255.255.255.0 ?
Possible completions:
A.B.C.D Gateway address
admin@ncs(config-config)# ip route 1.2.3.4 255.255.255.0 1.2.3.0
admin@ncs(config-route-1.2.3.4/255.255.255.0/1.2.3.0)# ?
Possible completions:
metric <0 - 4294967295>;; Route metric Interface cost; The lower the metric, the more desirable the route
preference <0 - 255>;; The lower the preference, the more desirable the route
---
Commit native to display device CLI native syntax of the command that will be issued
admin@ncs(config-route-1.2.3.4/255.255.255.0/1.2.3.0)# commit dry-run outformat native
native {
device {
name <deviceNAme>
data ip route 1.2.3.4 255.255.255.0 1.2.3.0
metric 1234
preference 123
exit
}
}
4.7. Configuring /slot
admin@ncs(config-config)# slot 1 ?
Possible completions:
ct Carrier Termination configuration
lan Configure LAN port properties
rlt Radio Link Terminal configuration
wan Configure WAN port and radio
<cr>
Lan list has two keys, slot and port: [slot='x'][port='y']
admin@ncs(config-wan-1/5)# show full | display xpath
/devices/device[name='']/config/ericsson-minilink6352:slot[slot-number='1']/wan[slot='1'][port='5']/admin-status is
/devices/device[name='']/config/ericsson-minilink6352:slot[slot-number='1']/wan[slot='1'][port='5']/cos/priority-map-profile/priority-map-profile test
Configure params:
admin@ncs(config-config)# show full slot 1 wan 1 1
devices device <deviceNAme>
config
slot 1
wan 1 5
admin-status is
cos priority-map-profile priority-map-profile test
exit
exit
!
!
Commit native to display device CLI native syntax of the command that will be issued
admin@ncs(config-config)# commit dry-run outformat native
native {
device {
name <deviceNAme>
data slot 1
wan 1 5
admin-status is
cos priority-map-profile priority-map-profile test
exit
exit
}
}
4.7.3 Configuring /switch
4.7.3 Configuring /switch/vlan
Configure params:
admin@ncs(config-config)# switch vlan 1234 name TEST_VLAN mac-learn enabled capability none
admin@ncs(config-config)# show full switch vlan 1234
devices device <deviceNAme>
config
switch
vlan 1234
name TEST_VLAN
mac-learn enabled
capability none
exit
exit
!
!
Commit DRY to display the diffs from the CDB candidate state
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.
- SSH/TELNET 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':
Reproduce the found issue using ncs_cli or your NSO service.
Write down each necessary step in a reproduction report.
In addition to this, it helps if you can show how it should work
by manually logging into the device using SSH/TELNET and type
the relevant commands showing a successful operation.
Gather the reproduction report and a copy of the raw trace file
containing data recorded when the issue happened.
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:
Set the config on the real device including all existing dependent config
and run sync-from to show it in the trace.
Run sync-from # devices device dev-1 sync-from
Attach the raw trace to the ticket
List the config you want implemented in the same syntax as shown on the device
SSH/TELNET 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 as long as we can connect to the NED via SSH/TELNET.
9. How to rebuild a NED
To rebuild the NED do as follows:
> cd $NED_ROOT_DIR/src
> make clean all
When the NED has been successfully rebuilt, it is necessary to reload the package into NSO.
admin@ncs# packages reload
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:
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 <tab>
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.
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:
[<device name>;<user>;<password>;<opaque>;<ssh server name>;<ssh server instruction>;<ssh server prompt>;]
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:
# [<device name>;<user>;<password>;<opaque>;<ssh server name>;<ssh server instruction>;<ssh server prompt>;]
# 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)
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 <name> default-map mfa executable <path to the executable>
admin@ncs(config)# devices authgroups group <name> default-map mfa opaque <some opaque data>
admin@ncs(config)# commit
Try connecting to the device.
10.1 Trouble shooting
In case of connection problems the following steps can help for debugging:
