How do I install adaptor artifacts that are not supported in the Artifacts view?

Purpose

Perform this procedure to install or upgrade adaptor artifacts to enable MDM NE discovery and management. While many NSP artifacts can be installed using the Artifacts view in the NSP GUI, some must be installed by script using this procedure. See the artifact documentation provided with the adaptor artifacts for information about which installation method is required.

Before you begin

If you require custom or reference adaptors for your network, contact Nokia.

The following must be true before you attempt to perform the procedure:

  • The NSP system includes MDM and is operational.

  • The NSP clusters, MDM servers, mdm-tomcat service, and file service are initialized and operational.

Note: In this procedure, release-ID in a file path has the following format:

R.r.p-rel.version

where

R.r.p is the NSP release, in the form MAJOR.minor.patch

version is a numeric value

Steps
CAUTION 

CAUTION

Deployment Failure

You may need to uninstall one or more existing adaptors before you install a new adaptor, or the adaptor installation fails.

Before you install an adaptor, ensure that you read the adaptor artifact documentation to determine whether any existing adaptors conflict with the new adaptor and must be removed before the new adaptor installation. If no conflicts are mentioned in the artifact documentation, you can proceed with the installation without uninstalling any artifacts.

 
1 

Obtain the adaptor suite and associated artifact documentation from the Nokia NSP software delivery site, in the NSP/<release>/Adaptors folder.

2 

Check the artifact documentation to see if any adaptors need to be removed before proceeding with the installation.

See How do I uninstall MDM adaptor artifacts? to uninstall an adaptor if needed, then proceed to the next step.

3 

Log in as the root or NSP admin user on the NSP deployer host in the standalone or primary NSP cluster.

Note: In a DR deployment, you perform the installation or upgrade only on the primary NSP cluster, which then replicates the adaptor configuration to the standby cluster.

4 

Transfer the adaptor suite zip file to an empty temporary directory.

5 

Open a console window.

6 

Enter the following:

# cd /opt/nsp/NSP-CN-DEP-release-ID/NSP-CN-release-ID/tools/mdm/bin ↵

7 

Enter the following to verify that the RESTCONF token for the NSP cluster is valid:

# ./adaptor-suite.bash --list ↵

Enter the NSP admin user credentials when prompted.

Messages like the following are displayed if the token is valid.

Using log file: log_file

INFO: timestamp -> Listing MDM adaptors suites ...

INFO: timestamp -> Token requested...

INFO: timestamp -> Token acquired

INFO: timestamp -> Listing adaptor suites...

Installed adaptor suites:

list_of_adaptors

INFO: timestamp -> Done.

8 

Enter the following:

Note: Multiple files and wildcards are supported. For example, sros* specifies all adaptor suites whose filenames begin with sros.

# ./adaptor-suite.bash --install filespec_1 filespec_2 . . . filespec_n ↵

where

filespec_1 to filespec_n are one or more adaptor zip file specifications; each must include the absolute file path

Enter the NSP admin user credentials when prompted.

9 

Enter the credentials.

The adaptors are transferred to each MDM instance.

Note: It may take 30 minutes or more for all adaptors to load.

After the adaptors load, you can use Device Discovery to discover compatible devices.

10 

If the NSP system is a DR deployment, verify that the primary and standby file-service-app pods are communicating.

  1. Log in as the root or NSP admin user on the NSP cluster host in the standby NSP cluster.

  2. Enter the following:

    # kubectl exec -n $(kubectl get pods -A | awk '/nsp-file-service-app/ {print $1;exit}') -it nsp-file-service-app-0 -- ls /opt/nsp/containers/nspvolume/fileservice/nokia/nsp/mdm/features/suite/ ↵

    Messages like the following are displayed, and the MDM adaptor zip files are listed.

    Defaulting container name to nsp-file-service-app

    Use 'kubectl describe pod/nsp-file-service-app-0 -n default' to see all of the containers in this pod.

    If the adaptor zip files are listed, the primary and standby pods are communicating; the adaptors are installed on the standby cluster upon DR activation of the standby cluster.

11 

Close the open console windows.

End of steps