Release Announcement: NSO 6.6 is here!
Check out the release highlights to see what's new
NSO DevCenterTry NSO

README v1.13.20 2025-04-07

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 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. VNF Instance
   10.1. Perform actions for VNF Instance
   10.2. Use rpc-request-config to configure VNF Instance requests' behaviour
11. Perform actions for NS Instance
12. Details on setting "action" payload
13. Perform VNF Op action
14. Perform NS Op action
15. Disable/Enable entities from model to be synced with API
    15.1 More details on "sync" settings usage
16. Perform VNF Fault Management actions
17. Subscription
    17.1. Use rpc-request-config to configure Subscription requests' behaviour
    17.2. Manage Subscription settings
18. VNF Performance Management
    18.1 VNF PM Subscription
         18.1.1 Perform actions for VNF PM Subscription
    18.2. VNF PM Job
          18.2.1. Perform actions for VNF PM Job
    18.3. VNF PM Threshold
          18.3.1. Perform actions for VNF PM Threshold
19. VNF Indicator
    19.1 VNF Indicator
         19.1.1. Perform actions for VNF Indicator
    19.2 VNF Indicator Subscription
         19.2.1. Perform actions for VNF Indicator Subscription

1. General

This document describes the etsi-sol003 NED.

The etsi-sol003 NED is built to interact with ETSI GS NFV-SOL 003 RESTful api/devices.

If you suspect a bug in the NED, please see chapter 8.

Additional README files bundled with this NED package

Common NED Features

Verified target systems

1.1 Extract the NED package

It is assumed the NED package ncs-<NSO version>-etsi-sol003-<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

  1. Extract the NED package and verify its signature:

  2. In case the signature can not be verified (for instance if no internet connection), do as below instead:

  3. The result of the extraction shall be a tar.gz file with the same name as the .bin file:

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:

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: etsi-sol003-<NED major digit>.<NED minor digit>:

  2. Install the NED into NSO, using the ncs-setup tool:

  3. 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:

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:

  2. Start a NSO CLI session and fetch the NED package:

  3. Install the NED package (add the argument replace-existing if a previous version has been loaded):

  4. Load the NED package

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:

  • Enter configuration mode:

  • Configure a new authentication group (my-group) to be used for this device:

  • Configure a new device instance (example: dev-1):

  • Set the device address:

  • Set the required API addresses configurables (if resource's API path is not set, the default address will be used):

  • Set the required configurables:

  • Config API authentication (see options in the mode bellow):

  • Config API OAUTH2 (token) authentication (see options in the mode bellow):

    If token caching is set to true, the token is taken from CDB (or retrieved and saved to CDB if none there), otherwise (cache=false or API request get 401 response status code) the token is retrieved from device on every request.

    For "refresh_token" use:

  • Set read-timeout (7 minutes, just to be sure all data is retrieved from API):

  • Optional configurations

    Set the optional API endpoints configurables:

    Set RPC actions device-specific path middle-prefix (base-url + middle-prefix + endpoint: "/vnflcm/v1" + "/ext" + "/vnf_instances/{vnfInstanceId}/:action"):

    <action=[change_vnfpkg|operations|monitoring/migrate]>

    Configure the additional timeout in seconds for EDIT operations (0 - no additional EDIT timeout; default 720s (12 minutes)):

    Configure {tenantId} when making API calls (endpoints prefixed with "tenant-" will be used):

  • Check that real device is up/alive on connect:

  • Set device model:

    <model=[default-sol3|netcracker|esc|cbam]:default-sol3>

  • Finally commit the configuration

  • Verify configuration, using a sync-from.

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-etsi-sol003-gen-1.0-<device name>.trace

Do as follows to enable tracing in one specific device instance in NSO:

  1. Start a NSO CLI session:

  2. Enter configuration mode:

  3. Enable trace raw:

    Alternatively, tracing can be enabled globally affecting all configured device instances:

  4. Configure the log level for printouts to the trace file:

    Alternatively the log level can be set globally affecting all configured device instances using this NED package.

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:

  2. Enter configuration mode:

  3. Enable Java logging with level all from the NED package:

  4. 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:

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

NONE

5. Built in live-status actions

NONE

6. Built in live-status show

NONE

7. Limitations

NONE

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:

Do as follows to gather the necessary information needed for your device, here named 'dev-1':

  1. Enable full debug logging in the NED

  2. Configure the NSO to generate a raw trace file from the NED

  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:

    Do as follows for older NSO versions:

  4. Run a compare-config to populate the trace with initial device 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

To rebuild the NED do as follows:

When the NED has been successfully rebuilt, it is necessary to reload the package into NSO.

10. VNF Instance

10.1. Perform actions for VNF Instance

Enter device mode:

Perform actions (<action=[instantiate|terminate|operate|heal|vertical-scale|scale|scale-to-level|change-flavour|change-ext-conn|change-pkg|operation|update-software-version|retrieve-physical-host|retrieve-vnfc-resource|retrieve-scale-status|retrieve-instance-data]>):

To reset action's payload to default:

Alternative method to perform <action=[retrieve-physical-host|retrieve-vnfc-resource|retrieve-scale-status|retrieve-instance-data]> (only by <vnf-instance-id>):

Alternative method to perform <action=[operation|migrate]>:

Enable/Disable Instance instantiation after creation:

Enable/Disable Instance termination before deletion:

10.2. Use rpc-request-config to configure VNF Instance requests' behaviour

Enter instance mode:

UPDATE[PATCH] request:

<config=[metadata|extensions|vim-connection-info|configurable-properties]>

  • <add|remove> <config>:

  • <add|remove> only specific configs; overwrites the settings set per config (useful when only some data are required to be sent):

  • clean only for specific configs; the settings set per config will be the ones to be considered:

INSTANTIATE action:

<config=[vim-connection-info]>

  • <add|remove> <config>:

Configure rpc-action payload:

11. Perform actions for NS Instance

Enter device mode:

Perform actions (<action=[instantiate|terminate|heal]>):

To reset action's payload to default:

Enable/Disable Instance instantiation after creation:

Enable/Disable Instance termination before deletion:

12. Details on setting "action" payload

If a node of rpc-request-payload <action> has "param" node as a child then it's a key-value list, which is transformed into a JSON object {key: value, ...} right before sending action to the API. Just set the param "key", "value" and "type". The type of param (can be: integer, boolean, string; default: string) is considered when generating request JSON. The same behaviour is present for containers that has <format=[json|key-value]> leaf and "key-value" is selected (these containers are used to set "unknown" structured configs; eg: vnf-instance extensions).

13. Perform VNF Op action

<action=[retry|fail|rollback|cancel|retrieve*]>

Enter device mode:

  • Method 1. Perform <action> RPC:

  • Method 2 (exclude * actions). Retrieve all operations:

    Perform operation <action> action:

14. Perform NS Op action

<action=[retry]>

Enter device mode:

  • Method 1. Perform <action> RPC:

  • Method 2. Retrieve all operations:

    Perform operation ``` action:

15. Disable/Enable entities from model to be synced with API

<model=[vnf-instance|ns-instance|vnf-package|ns-package|vnf-op|ns-op|vnf-subscription|ns-subscription|vnf-fm-alarm|vnf-fm-subscription|vim]>

By default all models are disabled for "sync".

Enter device mode:

  • disable:

    or

    or

  • enable:

  • enable for all models:

  • enable only for specific models; overwrites the settings set per model (useful when only some data are required to be synced); if a model "is-syncable" is set to "false" (default value), it will be excluded from this check list:

  • clean only for specific models; the settings set per model will be the ones to be considered on sync:

  • filter <api-action=[GET|GREATE|UPDATE|DELETE]:[ GET ]> to apply "model sync" settings for (for any other <api-action> the "model sync" settings will be ignored):

  • filter <ned-action=[CONFIG|RPC-ACTION]:[ CONFIG ]> to apply "model sync" settings for (for any other ` the "model sync" settings will be ignored):

*** IMPORTANT ***

For new devices use:

and (not mandatory):

and add new syncable models as you get access to theirs API resource.

  • disable sync of DISABLED entities:

  • disable API DELETE action:

  • exclude VIMs with specific IDs from "sync-from":

  • add VIMs with specific IDs to be synced without other API addons (just raw data from main API resource):

  • ignore VIMs' faulty API addons during sync (sync only valid ones):

15.1 More details on "sync" settings usage

Use "filter/api-actions" to set API actions to apply "model sync" settings for: [ GET ] (default value) and all "sync" settings will be applied for GET action.

Use no ned-settings etsi-sol003 connection api sync filter api-actions to fallback to it's default value, [ GET ]. You will still be able to perform other actions too, [ CREATE UPDATE DELETE ], on all syncable YANG models (models set in "only", or with "is-syncable=true" if "only" is empty) that have connections with API.

Use no ned-settings etsi-sol003 connection api sync filter ned-actions and the setting will fallback to it's default value, [ CONFIG ], and only NED CONFIG actions, such as "sync-from", config "commit", will be filtered by "sync" settings, leaving RPC-ACTIONs free.

For example, if you want to filter all GET actions, including CONFIG and RPC-ACTIONs, for specific models, use:

A model with "is-syncable=false" (default value) added to "only" will be ignored. The "only" setting overwrites "model" setting (if you have any model in "only" setting, the "is-syncable=true" from model list settings are ignored, but you can exclude some particular models from "only" list by "is-syncable=false"; "only" can be used when you have a lot of syncable models in YANG and you want to sync only some of them, instead of disabling the rest ones).

To sync no models on "sync-from" use:

The logic schema for model "sync" goes like this:

Examples (will be updated for different use-cases):

  1. You have this "sync" settings:

"sync" settings are applied only for API GET actions (default value for "filter/api-actions"), including only NED CONFIG actions, such as "sync-from", config "commit" (default value for "filter/ned-actions" is [ CONFIG ]). RPC-ACTIONs are not filtered by "sync" settings (see Example 3). "sync-from" will retrieve only [ vnf-instance ] (default value for "is-syncable" is "false").

For [ CREATE UPDATE DELETE ] actions "sync" settings have no effect.

  1. You have this "sync" settings:

"sync" settings are applied only for API [ GET DELETE ] actions, including only NED CONFIG actions. "sync-from" will retrieve only [ vnf-op vnf-fm-alarm vnf-fm-subscription ] (also, the NED will accept to send DELETE requests only for these models).

For [ CREATE UPDATE ] actions "sync" settings have no effect.

  1. You have this "sync" settings:

"sync" settings are applied for any API [ GET ] action, including RPC-ACTIONs too. "sync-from" and GET RPC-ACTIONs will apply only for [ vnf-instance ].

It may feel a bit tangled, but you have a lot of sync options this way.

16. Perform VNF Fault Management actions

Enter device mode:

Perform VNF FM Alarm action (<action=[retrieve]>)

  • Method 1. Perform <action> RPC:

  • Method 2. Retrieve all alarms:

    Perform <action> action:

Perform VNF FM Subscription action (<action=[retrieve]>)

  • Method 1. Perform <action> RPC:

  • Method 2. Retrieve all subscriptions:

    Perform <action> action:

17. Subscription

17.1. Use rpc-request-config to configure Subscription requests' behaviour

<config=[authType]>

Enter <subscription=[vnf-subscription|ns-subscription|vnf-fm-subscription]> mode:

  • <enable|disable> <config> legacy-mode:

17.2. Manage Subscription settings

  • Enable/Disable Subscription Authentication fallback to default device username/password:

  • Enable/Disable Subscription request tracing, that may contain sensitive data (username/password), for debugging purposes:

18. VNF Performance Management

18.1 VNF PM Subscription

[vnf-pm-subscriptions]

18.1.1 Perform actions for VNF PM Subscription

Perform actions (<action=[retrieve]>):

Alternative method to perform <action=[retrieve]> (only by <vnf-pm-subscription-id>):

18.2. VNF PM Job

[vnf-pm-jobs]

18.2.1. Perform actions for VNF PM Job

Perform actions: <action=[retrieve]>:

<action=[report-retrieve]>:

Alternative method to perform actions: <action=[retrieve]>:

<action=[report-retrieve]>:

18.3. VNF PM Threshold

[vnf-pm-thresholds]

18.3.1. Perform actions for VNF PM Threshold

Perform actions: <action=[retrieve]>:

Alternative method to perform actions: <action=[retrieve]>:

19. VNF Indicator

19.1 VNF Indicator

[vnf-indicators]

19.1.1. Perform actions for VNF Indicator

Perform actions: <action=[retrieve]>:

Alternative method to perform actions: <action=[retrieve]>:

19.2 VNF Indicator Subscription

[vnf-ind-subscriptions]

19.2.1. Perform actions for VNF Indicator Subscription

Perform actions: <action=[retrieve]>:

Alternative method to perform actions: <action=[retrieve]>:

PreviousREADME-ned-settingsNextextreme-xos

Last updated

Was this helpful?