The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
Upgrading the Cisco Prime Network Analysis Module Software
Upgrading the NAM Software to Version 6.2—Which Procedure Do I Use?
Upgrading Using the Prime NAM CLI
Upgrading Using the Helper Utility
Prime NAM Platforms and Supported Upgrade Methods
Obtaining Documentation and Submitting a Service Request
This document provides details about upgrading an existing installation of Cisco Prime Network Analysis Module (NAM) software to version 6.2.
Ensure that you review the Cisco Prime Network Analysis Modules Compatibility Matrix and are familiar with:
Upgrading to Prime NAM 6.2 is supported from Prime NAM 5.x, 6.0, and 6.1.
If you are running NAM version 5.0, we recommend that you upgrade to 5.1.x first, and then upgrade to 6.2.
In most cases, we recommend using the NAM CLI to perform a standard upgrade. If you do not care to retain your existing data and configuration, or wish to start fresh for any other reason, use the NAM CLI to perform a reformat upgrade.
The helper utility is a small program running in a barebones software environment that facilitates upgrade or recovery operations. The helper utility is accessed by rebooting the NAM into helper mode. Upgrading via the helper utility is typically required only when you wish to perform a reformat upgrade from NAM version 5.1(2) or below, as those versions do not support a reformat upgrade via the NAM CLI. Additionally, in cases where a NAM encounters issues that render it unable to boot into the application image, the helper utility can typically be used to reimage the NAM to restore operations.
The table below summarizes your upgrade options and provides a reference to the appropriate section.
Note To utilize the Cisco Nexus 7000 Series Release 6.2(8) performance improvements for Data Center protocols (VxLAN, FabricPath, OTV, LISP, Segment ID, VNTag, and FCoE), you can upgrade the FPGA image in your Cisco Nexus 7000 Series NAM-NX1. For details on how to upgrade your FPGA image, see FPGA/EPLD Upgrade Note for Cisco Prime NAM-NX1, 6.0.
An overview of the procedure for upgrading using the NAM CLI is as follows:
1. Before starting the upgrade process, we recommend performing a complete backup of your current configuration. Use the command line interface to upload your configuration to an external server. See Backing Up Your Configuration.
2. Download the desired version of the NAM software and use the upgrade CLI command to perform the upgrade. See Upgrading Your Software.
3. After completing the upgrade process, we recommend backing up your configuration again (to a different backup file than used in Step 1). This backup will capture any configuration updates that were made automatically as part of the upgrade, and will be useful in case of a future error that requires reinstallation of the NAM software (e.g., hard disk failure). .
Starting with the NAM 6.2(1) release, the NAM application image is a signed image, meaning that the image includes a digital signature that can be used to detect whether the image has been tampered with or otherwise modified. This signature is checked during installation, and if found not to match against the image, installation aborts. Any earlier release of NAM software does not include a digital signature, and is referred to as an unsigned image.
In NAM 6.1(1) and earlier, the NAM CLI is not designed to verify signed images. Signed images will still install successfully, but the signature will not be verified. Therefore, when upgrading from these versions, the integrity of the target image should be verified using the corresponding checksum published on Cisco.com. Furthermore, the following warning messages may be displayed, and should be ignored (the "trailing garbage" is the digital signature):
gzip: stdin: decompression OK, trailing garbage ignored
tar: Error exit delayed from previous errors
Note Once a signed image has been installed on a NAM, its CLI will refuse to install an unsigned image, since the signature verification step fails when there is no signature. If installation of an older, unsigned version of the NAM software becomes necessary, use the helper utility, or the recovery procedure for that software version.
The following table summarizes the upgrade scenarios that are supported via the CLI:
We recommend that you perform a complete backup of your Prime NAM configuration to facilitate recovery in case of an unexpected error during the upgrade process.
Note Capture files and monitoring data are not backed up.
To back up your current configuration, use the following NAM CLI command:
config upload ftp://user:password@server/path backup_file_name
config upload ftp:// admin:email@example.com/archive/nam_config backup_file_name
The config upload command saves a copy of the NAM configuration to the destination you specify.
For 5.1.x and 6.0(1), there are two backup files:
For 6.0(2) and 6.1, there is only one backup file, with a.namconf.tar suffix.
The destination address must include a valid server name, and the login user must have read/write access to the specified directory.
To upgrade the application image on the Prime NAM, follow these steps:
Step 1 Download the application image for the Prime NAM at the following URL:
Look for a file named nam-app-x86_64.x-x-x.SPA.bin.gz, where x-x-x is the NAM software version and "SPA" designates a signed, production image (if installing a NAM image prior to version 6.2(1), the filename will not include "SPA"). This file will be referred to as the NAM application image.
Step 2 Store the NAM application image on an external server (e.g., the server where you archived your NAM configuration).
Step 3 Issue the appropriate command from Table 1-2 .
Perform a standard upgrade, retaining configuration and data.
upgrade2 ftp://user:pass@server/path/filename reformat
Perform a reformat upgrade, which clears existing configuration and data before applying the NAM application image.
Note By default, the CDB (network monitoring database) will be converted to the latest schema.
Step 4 Enter Yes to complete the installation.
After the installation is complete, you can log into the user interface.
The following examples illustrate the upgrade process for a NAM 2320 appliance:
Note The upgrade procedure for NAM 2304 is identical to the procedure outlined below. For other platforms like NAM-3 and NAM-NX1, we recommend that you log into the switch and connect to the NAM console (using service-module session or attach console module, respectively) before starting the upgrade. This is so you can track the progress of the upgrade.
Step 1 Connect to the CIMC CLI interface. We recommend accessing the NAM CLI via the CIMC console so that you can track the progress of the upgrade and respond to any prompts (e.g., whether to convert or delete the monitoring database); this is not possible when accessing the NAM CLI via an SSH or Telnet session through the management port.
Step 2 Press Enter if no login prompt appears.
Step 3 At the login prompt, provide the NAM CLI username and password (root/root by default).
Step 4 Issue the CLI command: upgrade <image_url>
Step 5 Enter y to confirm that you want to proceed with the upgrade. The system will reboot into helper mode, update the NAM application image, and then reboot back into the NAM application.
Step 6 After the system restarts, a message like the following may be displayed:
The database format has changed and needs to be deleted or converted. Converting the database can take up to a few hours. Deleting the database is quick, but you will lose monitoring data.
(10 seconds) Convert or Delete? [C/d]:
You may enter C to convert the CDB (network monitoring) data. If you enter c, all existing CDB data will be converted and carried over, which can take a few hours, depending on the amount of monitoring data stored. This is the default action.
You may enter d to delete the data, if you do not need to keep it. If you enter d, all existing CDB data is wiped out.
If you do not provide any input, this prompt will time out after 10 seconds, at which point the default c action will be taken.
Step 7 After the upgrade is done, the login prompt appears. Log in with your username and password.
In this example, nam-2320.cisco.com denotes a NAM-2320 appliance, and nam-2320-cimc.cisco.com is its CIMC.
If you are performing a typical upgrade of the NAM software, we suggest following the NAM CLI upgrade procedure, documented in the previous section. Typically, the helper utility is accessed directly only when there is a problem with an existing NAM installation that requires more extreme measures, such as wiping the hard disks before reinstalling the NAM software image. The helper utility is also required when downgrading from a signed image to an unsigned image; such a downgrade cannot be performed via the NAM CLI. (For additional background on signed and unsigned images, refer to the previous section.)
To access the helper utility, issue the reboot -helper command from the NAM CLI to reboot into helper mode. If the NAM CLI is inaccessible, follow the recovery procedure documented in the Installation and Configuration Guide for that platform to boot the corresponding recovery image, which contains the helper utility.
Once the helper utility menu appears, use Option 2 (Download application image and reformat HDD) to download the desired application image and write the image to the disk. If booting a recovery image in ISO format, you may instead use Option 3 (Install application image from CD and reformat HDD) to avoid downloading a separate application image.
Note If the Prime NAM application is already installed and has networking configured, these settings will be detected by the helper automatically. Otherwise, you must use Option n to configure networking before using this option.
The helper utility downloads and installs a NAM application image from a local FTP or HTTP server. For details on where to download the NAM application image and image naming conventions, refer to Upgrading the NAM Software to Version 6.2—Which Procedure Do I Use?.
The following table summarizes the upgrade scenarios that are supported via the helper utility:
The below table summarizes the upgrade options supported by the CLI and helper utility. In general, this table applies both to standard and reformat upgrades, with the exception of certain legacy versions of the NAM software that do not support reformat upgrades from the CLI (refer to Table 5 for further details on reformat upgrade support).
Table 3 lists the Prime NAM versions and platforms, and whether a reformat upgrade for that version and platform is supported from the CLI or helper utility (or both).
After completing an upgrade, clear your web browser cache to avoid issues caused by old cached versions of NAM code or data conflicting with the new NAM software. If the browser cache is not cleared, you may encounter abnormal GUI behavior.
Review the known issues listed in the Release Notes for Cisco Prime NAM 6.2, before you perform the upgrade.
GUI display filters are not carried over when upgrading to NAM 6.2. Such filters must be recreated as necessary.
For additional information about other documentation, see the Cisco Prime Network Analysis Module Documentation Overview on Cisco.com.
For information on obtaining documentation, submitting a service request, and gathering additional information, see the monthly What’s New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation, at the following URL:
Subscribe to the What’s New in Cisco Product Documentation as a Really Simple Syndication (RSS) feed and set content to be delivered directly to your desktop using a reader application. The RSS feeds are a free service and Cisco currently supports RSS Version 2.0.