This document describes the cisco-aireos NED.
Additional README files bundled with this NED package
Common NED Features
Verified target systems
It is assumed the NED package ncs-<NSO version>-cisco-aireos-<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:
In case the signature can not be verified (for instance if no internet connection), do as below instead:
The result of the extraction shall be a tar.gz file with the same name as the .bin file:
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:
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.
Untar the tar.gz file. This creates a new sub-directory named: cisco-aireos-<NED major digit>.<NED minor digit>:
Install the NED into NSO, using the ncs-setup tool:
Open a NSO CLI session and load the new NED package like below:
Alternatively the tar.gz file can be installed directly into NSO. Then skip steps 1 and 2 and do like below instead:
Set the environment variable NED_ROOT_DIR to point at the NSO NED package:
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.
Do a NSO backup before installing the new NED package:
Start a NSO CLI session and fetch the NED package:
Install the NED package (add the argument replace-existing if a previous version has been loaded):
Load the NED package
This section describes the steps for configuring a device instance using the newly installed NED package.
Start a NSO CLI session:
Enter configuration mode:
Configure a new authentication group (my-group) to be used for this device:
Configure a new device instance (example: dev-1):
If the sync-from was not successful, check the NED configuration again.
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-cisco-aireos-cli-1.0-<device name>.trace
Do as follows to enable tracing in one specific device instance in NSO:
Start a NSO CLI session:
Enter configuration mode:
Enable trace raw:
Alternatively, tracing can be enabled globally affecting all configured device instances:
Configure the log level for printouts to the trace file:
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
Start a NSO CLI session:
Enter configuration mode:
Enable Java logging with level all from the NED package:
Configure the NED to log to the Java logger
Alternatively Java logging can be enabled globally affecting all configured device instances using this NED package.
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:
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
See what you are about to commit:
Commit new configuration in a transaction:
Verify that NCS is in-sync with the device:
Compare configuration between device and NCS:
Note: if no diff is shown, supported config is the same in NSO as on the device.
Note: Its not possible to rollback if we get some error, when this action is used to configure commands. Note: User must give ";" for newline.
The NED has support for a subset of aireos's native operational commands residing under device live-status. Presently, the following commands are supported:
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:
Do as follows to gather the necessary information needed for your device, here named 'dev-1':
Enable full debug logging in the NED
Configure the NSO to generate a raw trace file from the NED
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:
Do as follows for older NSO versions:
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
To rebuild the NED do as follows:
When the NED has been successfully rebuilt, it is necessary to reload the package into NSO.
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:
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:
In case of connection problems the following steps can help for debugging:
Enable the NED trace in debug level:
Try connect again
Inspect the generated trace file.
Verify that the ssh client is using the external authenticator executable:
Verify that the executable is called with the challenges presented by the ssh server:
Check for any errors reported by the NED when calling the executable
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 authenticationIf configured protocol is ssh, do fetch the host keys now:
Finally commit the configuration
Verify configuration, using a sync-from.
Python3 (with packages: re, sys, getopt, subprocess, argparse, os, glob)
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.
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.
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:
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).
Try connecting to the device.
admin@ncs(config)# devices device dev-1 ssh fetch-host-keysadmin@ncs(config)# commitadmin@ncs(config)# devices device dev-1 sync-from
result true[<device name>;<user>;<password>;<opaque>;<ssh server name>;<ssh server instruction>;<ssh server prompt>;]> 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+---------------------------+------------------------------------------------------------------------------+
| Name | Info |
+---------------------------+------------------------------------------------------------------------------+
| README-ned-settings.md | Information about all run time settings supported by this NED. |
+---------------------------+------------------------------------------------------------------------------++---------------------------+-----------+------------------------------------------------------------------+
| Feature | Supported | Info |
+---------------------------+-----------+------------------------------------------------------------------+
| netsim | yes | |
| | | |
| check-sync | yes | |
| | | |
| partial-sync-from | yes | |
| | | |
| live-status actions | yes | |
| | | |
| live-status show | yes | |
| | | |
| load-native-config | no | |
+---------------------------+-----------+------------------------------------------------------------------++---------------------------+-----------------+--------+---------------------------------------------------+
| Model | Version | OS | Info |
+---------------------------+-----------------+--------+---------------------------------------------------+
| AIR-CTVM-K9 | 7.4.x | Cisco | |
| | | Contro | |
| | | ller | |
| | | | |
| AIR-CTVM-K9 | 8.5.x | Cisco | |
| | | Contro | |
| | | ller | |
| | | | |
| AIR-CT8540-K9 | 8.10.x | Cisco | |
| | | Contro | |
| | | ller | |
| | | | |
| AIR-CT5520-K9 | 10.0.x | Cisco | |
| | | Contro | |
| | | ller | |
+---------------------------+-----------------+--------+---------------------------------------------------+> cd /tmp/ned-package-store
> chmod u+x ncs-6.0-cisco-aireos-1.0.1.signed.bin
> ./ncs-6.0-cisco-aireos-1.0.1.signed.bin> ./ncs-6.0-cisco-aireos-1.0.1.signed.bin --skip-verification> ls *.tar.gz
ncs-6.0-cisco-aireos-1.0.1.tar.gz> export NSO_RUNDIR=~/nso-lab-rundir> tar xfz ncs-6.0-cisco-aireos-1.0.1.tar.gz
> ls -d */
cisco-aireos-cli-1.0> ncs-setup --package cisco-aireos-cli-1.0 --dest $NSO_RUNDIR> ncs_cli -C -u admin
admin@ncs# packages reload
reload-result {
package cisco-aireos-cli-1.0
result true
} > ncs-setup --package ncs-6.0-cisco-aireos-1.0.1.tar.gz --dest $NSO_RUNDIR
> ncs_cli -C -u admin
admin@ncs# packages reload
reload-result {
package cisco-aireos-cli-1.0
result true
}> export NED_ROOT_DIR=$NSO_RUNDIR/packages/cisco-aireos-cli-1.0> $NCS_DIR/bin/ncs-backup> ncs_cli -C -u admin
admin@ncs# software packages fetch package-from-file \
/tmp/ned-package-store/ncs-6.0-cisco-aireos-1.0.tar.gz
admin@ncs# software packages list
package {
name ncs-6.0-cisco-aireos-1.0.tar.gz
installable
}admin@ncs# software packages install cisco-aireos-1.0
admin@ncs# software packages list
package {
name ncs-6.0-cisco-aireos-1.0.tar.gz
installed
}admin@ncs# packages reload
admin@ncs# software packages list
package {
name ncs-6.0-cisco-aireos-cli-1.0
loaded
}> ncs_cli -C -u adminadmin@ncs# configure
Entering configuration mode terminal
admin@ncs(config)#admin@ncs(config)# devices authgroup group my-group default-map remote-name <user name on device> \
remote-password <password on device>admin@ncs(config)# devices device dev-1 address <ip address to device>
admin@ncs(config)# devices device dev-1 port <port on device>
admin@ncs(config)# devices device dev-1 device-type cli ned-id cisco-aireos-cli-1.0
admin@ncs(config)# devices device dev-1 state admin-state unlocked
admin@ncs(config)# devices device dev-1 authgroup my-groupadmin@ncs(config)# devices device dev-1 protocol <ssh or telnet>> ncs_cli -C -u adminadmin@ncs# configure
Entering configuration mode terminal
admin@ncs(config)#admin@ncs(config)# devices device dev-1 trace raw
admin@ncs(config)# commitadmin@ncs(config)# devices global-settings trace raw
admin@ncs(config)# commitadmin@ncs(config)# devices device dev-1 ned-settings cisco-aireos logger \
level [debug | verbose | info | error]
admin@ncs(config)# commit> ncs_cli -C -u adminadmin@ncs# configure
Entering configuration mode terminal
admin@ncs(config)#admin@ncs(config)# java-vm java-logging logger com.tailf.packages.ned.aireos \
level level-all
admin@ncs(config)# commitadmin@ncs(config)# devices device dev-1 ned-settings cisco-aireos logger java true
admin@ncs(config)# commitadmin@ncs(config)# devices global-settings ned-settings cisco-aireos logger java true
admin@ncs(config)# commitadmin@ncs(config)# java-vm java-logging logger net.schmizz.sshj level level-all
admin@ncs(config)# commitadmin@ncs(config-config)# interface vlan test1 102
admin@ncs(config-config)# interface vlan test2 103
admin@ncs(config-config)# interface address dynamic-interface test1 192.168.101.2 255.255.255.0 192.168.101.1
admin@ncs(config-config)# interface address dynamic-interface test2 192.168.103.2 255.255.255.0 192.168.103.1
admin@ncs(config-config)# interface port test1 1
admin@ncs(config-config)# ap cert-expiry-ignore mic enable
admin@ncs(config-config)# ap cert-expiry-ignore ssc enable
admin@ncs(config-config)# ipv6 disable
admin@ncs(config-config)# location expiry calibrating-client 12
admin@ncs(config-config)# location expiry client 12
admin@ncs(config-config)# location expiry rogue-aps 60
admin@ncs(config-config)# location expiry tags 200
admin@ncs(config-config)# location plm calibrating enable multiband
admin@ncs(config-config)# rfid status enable
admin@ncs(config-config)# sessions timeout 160
admin@ncs(config-config)#admin@ncs(config-config)# commit dry-run outformat native
native {
device {
name dev-1
data interface create test1 102
interface address dynamic-interface test1 192.168.101.2 255.255.255.0 192.168.101.1
interface create test2 103
interface address dynamic-interface test2 192.168.103.2 255.255.255.0 192.168.103.1
interface port test1 1
ap cert-expiry-ignore mic enable
ap cert-expiry-ignore ssc enable
ipv6 disable
location expiry calibrating-client 12
location expiry client 12
location expiry rogue-aps 60
location expiry tags 200
location plm calibrating enable multiband
rfid status enable
sessions timeout 160
}
}# commit
Commit complete.```
# devices device dev-1 check-sync
result in-sync
``````
# devices device dev-1 compare-config
```Example-1:
----------
config
wlan create 1 test1 test1
wlan create 2 test2 test2
exit
admin@ncs# devices device aireosdev config exec "wlan create 1 test1 test1 ; wlan create 2 test2 test2"
result success
admin@ncs#
admin@ncs# devices device aireosdev config exec "wlan delete 1 ; wlan delete 2"
result success
admin@ncs# admin@ncs# devices device aireos-device live-status exec show ?
Possible completions:
any Execute any command on device
show Execute show commands
To execute a command, run it in NCS exec mode like this:
Example-1:
----------
admin@ncs# devices device aireos-device live-status exec show sysinfo
result
Manufacturer's Name.............................. Cisco Systems Inc.
Product Name..................................... Cisco Controller
Product Version.................................. 7.4.140.0
RTOS Version..................................... 7.4.140.0
Bootloader Version............................... 7.4.140.0
Emergency Image Version.......................... 7.4.140.0
....etc- Renaming AP name is not handled in NED because renaming requires device restart.
- default-group is no longer used in new AireOS release.- AP config model is changed from ned version 3.9 because ap configs uses rpl to pull and show the configs from the device in NED.
NED converts nso commands to device commands like below
admin@ncs(config-config)# ap name APNAME ssh enable
admin@ncs(config-config)# ap name APNAME primary-base primarySwitchName1 1.1.1.3
admin@ncs(config-config)# ap name APNAME secondary-base secondarySwitchName 1.1.1.4
admin@ncs(config-config)# ap name APNAME mode flexconnect
admin@ncs(config-config)# ap name APNAME enable-disable enable
admin@ncs(config-config)# ap name APNAME flexconnect vlan native 3
admin@ncs(config-config)# ap name APNAME flexconnect vlan enable
admin@ncs(config-config)# ap name APNAME group-name groupName
admin@ncs(config-config)# commit dry-run outformat native
native {
device {
name aireos-5
data ap ssh enable APNAME
ap group-name groupName APNAME
ap primary-base primarySwitchName1 APNAME 1.1.1.3
ap secondary-base secondarySwitchName APNAME 1.1.1.4
ap mode flexconnect APNAME
ap flexconnect vlan enable APNAME
ap flexconnect vlan native 3 APNAME
ap enable APNAME
}
} Regarding ap configs which needs AP reboot.
we cannot invoke rollback and compare-config immediately after committing ap configs which require reboot,
because the ap configs will take few minutes to get replicated in the show like below
Changing the AP's mode will cause the AP to reboot.
Are you sure you want to continue? (y/n) y
(Cisco Controller) config>exit
(Cisco Controller) >show ap summary
Number of APs.................................... 0
Global AP User Name.............................. Not Configured
Global AP Dot1x User Name........................ Not Configured
Global AP Dot1x EAP Method....................... EAP-FAST
And we cannot commit other ap configs in the same commit if any of the ap config requires reboot.As the ap is missing in the device it will throw a error stating the ap is invalid like below
(Cisco Controller) config>ap group-name TEST-GROUP APNAME
Cisco AP name is invalid. Some configs has dependecies with other configs. So we have handled those dependency configs through metadata and modifyLine(). Like below,
"wlan nac snmp enable 1" needs "wlan aaa-override disable 1" and "wlan nac radius disable 1"
So when we do a commit for wlan nac snmp enable 1
admin@ncs(config-config)# aireos:wlan nac snmp enable 1
admin@ncs(config-config)# commit dry-run outformat native
native {
device {
name aireos-2
data wlan aaa-override disable 1
wlan nac radius disable 1
wlan nac snmp enable 1
}
}
admin@ncs(config-config)# commit
Commit complete.
And for wlan nac radius enable 1
admin@ncs(config)# devices device aireos-2 config aireos:wlan nac radius enable 1
admin@ncs(config-config)# commit dry-run outformat native
native {
device {
name aireos-2
data wlan aaa-override enable 1
wlan nac snmp disable 1
wlan nac radius enable 1
}
}
admin@ncs(config-config)# commit
Commit complete.- 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.ncs_cli -C -u admin
admin@ncs# configure
admin@ncs(config)# devices device dev-1 ned-settings cisco-aireos logging level debug
admin@ncs(config)# commitadmin@ncs(config)# devices device dev-1 trace raw
admin@ncs(config)# commitadmin@ncs(config)# devices device dev-1 clear-traceadmin@ncs(config)# devices clear-trace> cd $NED_ROOT_DIR/src
> make clean alladmin@ncs# packages reload> 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> devices device dev-1 trace raw
> devices device dev-1 ned-settings cisco-aireos logger level debug
> commitusing ssh external mfa executable: <configured path to executable>calling external mfa executable with ssh server given name: '<name>', instruction: '<instruction>', prompt '<challenge>'ERROR: external mfa executable failed <....>admin@ncs(config)# devices device global-settings ned-settings cisco-aireos logger \
level [debug | verbose | info | error]
admin@ncs(config)# commitadmin@ncs(config)# devices device dev-1 compare-config#!/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)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/cisco-aireos/ profile /ncs:devices/ncs:profiles/profile:/ned-settings/cisco-aireos/ device /ncs:/device/devices/device:/ned-settings/cisco-aireos/
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:
This section describes how device output (warnings/errors) can be filtered.
This section describes how to remove/filter configs during sync-from.
This ned-setting is used to inject settings of some show commands into the config, when reading from device. The following show commands have some cached info
Configure NED settings related to live-status.
This ned-setting is used to set auto-ptompts to answers to device prompting questions.
This section lists the connection ned-settings used when connecting to the device:
Configure NED to access device via a proxy.
Settings for controlling logs generated.
# config
# devices device dev-1 ned-settings cisco-aireos
Press TAB to see all the NED settings.
1. ned-settings cisco-aireos
2. cisco-aireos-config-warning
3. cisco-aireos-remove-sync-from-config
4. cisco-aireos-cached-show-enable
5. live-status
5.1. auto-prompts
6. connection
7. proxy
8. logger- use-startup-commands <true|false> (default false)
This ned-setting executes 'show run-config startup-commands' in sync-from.
By default executing 'show run-config startup-commands' is disabled.
For example, to enable startup-commands:
admin@ncs(config)# devices device aireosdev ned-settings cisco-aireos use-startup-commands true
admin@ncs(config)# commit
Commit complete.
admin@ncs(config)# devices device aireosdev disconnect
admin@ncs(config)# devices device aireosdev connect
result true
info (admin) Connected to aireosdev
admin@ncs(config)# devices device aireosdev sync-from
result true
admin@ncs(config)
Note that in order for the above ned-setting to take effect, you
must disconnect and connect again, to re-read ned-settings.
- extended-parser <enum> (default auto)
Make the cisco-aireos NED handle CLI parsing (i.e. transform the running-config from the
device to the model based config tree).
disabled - Load configuration the standard way.
turbo-mode - The NED executes the whole command parsing by itself, completely bypassing
the NSO CLI parser. The configuration dump is transferred to NSO using maapi
setvalues call.
turbo-xml-mode - The NED executes the whole command parsing by itself, completely bypassing
the NSO CLI parser. The configuration dump is transferred to NSO in XML
format.
robust-mode - Makes the NED filter the configuration so that unmodeled content is removed
before being passed to the NSO CLI-engine. This protects against
configuration ending up at the wrong level when NSO CLI parser fallbacks
(which potentially can cause following config to be skipped).
auto - Uses turbo-mode when available, will use fastest availablemethod to load
data to NSO. If NSO doesn't support data-loading from CLI NED, robust-mode
is used.- cisco-aireos-config-warning <warning>
- warning <WORD>
Warning regular expression, e.g. .* does not exist.*.
After having sent a config command to the device the NED will treat
any text reply as an error and abort the transaction. The config
command that caused the failed transaction will be shown together
with the error message returned by the device. Sometimes the text
message is not an actual error. It could be a warning that should be
ignored. The NED has a static list of known warnings, presently these:
// general
"deleted auth-list entry",
"warning! system name change disrupts the existing rf grouping.",
"ssid updated successfully."
etc
If you stumble upon a warning not already in the NED, which is quite
likely due to the large number of warnings, you can configure the
NED to ignore them using this ned-setting.
The list key is a regular expression with a warning that should be
ignored.
For example, to add a new warning exception:
admin@ncs(config)# devices global-settings ned-settings
cisco-aireos cisco-aireos-config-warning "Failed in adding cpu acl rule"
admin@ncs(config)# commit
Commit complete.
admin@ncs(config)# devices device aireosdev disconnect
admin@ncs(config)# devices device aireosdev connect
result true
info (admin) Connected to aireosdev
Note that in order for the above ned-setting to take effect, you
must disconnect and connect again, to re-read ned-settings.- cisco-aireos-remove-sync-from-config <remove-config>
- remove-config <WORD>
command regular expression, e.g. "\s*rogue client alert .*".
For example:
To add a new config to remove:
admin@ncs(config)# devices device aireosdev ned-settings cisco-aireos
cisco-aireos-remove-sync-from-config "\s*rogue client alert .*"
admin@ncs(config)# commit
Commit complete.
admin@ncs(config)# devices device aireosdev disconnect
admin@ncs(config)# devices device aireosdev sync-from
result true
admin@ncs(config)#
Note that in order for the above ned-setting to take effect, you
must disconnect and connect again, to re-read ned-settings.- cisco-aireos-cached-show-enable version <true|false> (default true)
Enable caching of some output of 'show sysinfo' command (enabled by default).
For example:
show sysinfo
The injected config can be usable in service code to check
version. The values are injected under the /aireos:cached-show container.
Example of injected config:
cached-show version product-version 8.4.1.138
admin@ncs(config)# devices device aireosdev ned-settings cisco-aireos
cisco-aireos-cached-show-enable false|true(default)
admin@ncs(config)# commit
Commit complete.
admin@ncs(config)# devices device aireosdev disconnect
admin@ncs(config)# devices device aireosdev sync-from
result true
admin@ncs(config)#
Note that in order for the above ned-setting to take effect, you
must disconnect and connect again, to re-read ned-settings.- live-status time-to-live <int32> (default 50)
Define time-to-live for data fetched from the device via live-status.(default 50).- live-status auto-prompts <id> <question> <answer>
- id <WORD>
List id, any string.
- question <WORD>
Device question, regular expression.
- answer <WORD>
Answer to device question.
Generally the command output parsing halts when the NED detects
an operational or config prompt, however sometimes the command
requests additional input, answer(s) to questions.
Use "EXIT" in answer to Halt parsing and return output
Use this ned-setting to create auto-prompt question and answer, like below
devices global-settings ned-settings cisco-aireos live-status auto-prompts Q1 question "<question>" answer "<answer>"
examples:
devices global-settings ned-settings cisco-aireos live-status auto-prompts Q1 question "Would you like to save?" answer "N"
devices global-settings ned-settings cisco-aireos live-status auto-prompts Q2 question "Are you sure you would like to reset the system?" answer "y"
devices global-settings ned-settings cisco-aireos live-status auto-prompts Q3 question "System will now restart!" answer EXIT
Note that in order for the above ned-setting to take effect, you
must disconnect and connect again, to re-read ned-settings.- connection number-of-retries <uint8> (default 0)
Configure max number of retries the NED will try to connect to the device before giving up.
Default 0.
- connection time-between-retry <uint8> (default 1)
Configure the time in seconds the NED will wait between each connect retry. Default 1s.- proxy remote-connection <enum>
Connection type between proxy and device.
ssh - ssh.
telnet - telnet.
serial - serial.
- proxy remote-address <union>
Address of host behind the proxy.
- proxy remote-port <uint16>
Port of host behind the proxy.
- proxy remote-name <string>
User name on the device behind the proxy.
- proxy remote-password <string>
Password on the device behind the proxy.
- proxy proxy-prompt <string>
Prompt pattern on the proxy host.
- proxy remote-ssh-args <string>
Additional arguments used to establish proxy connection.- logger level <enum> (default info)
Set level of logging.
error - error.
info - info.
verbose - verbose.
debug - debug.
- logger java <true|false> (default false)
Toggle logs to be added to ncs-java-vm.log.