Cisco Prime Nerk 43 User Guide

							  
9-3
Cisco Prime Network 4.3.2 User Guide
Chapter 9      Manage Device Configurations and Software Images
  Managing Device Software Images
Use the following icons to toggle between different views in the Top Families, Configuration Sync 
Status, and Configuration Changes in the Last Week dashlets.
Managing Device Software Images
The CCM Image Management feature provides tools for performing rapid, reliable software upgrades 
and automates the steps associated with upgrade planning and monitoring. Device software images are 
stored in the CCM image repository, to which you can add new images by importing them from 
Cisco.com, from existing devices, from a local file system, or from an external image repository. The 
images are stored in binary format in the repository, which is in the Prime Network database. Before an 
image is distributed, CCM performs an upgrade analysis to ensure that the network element is 
compatible with the image; after an image is distributed, it takes a minimum of 30 minutes for the image 
to activate. For Cisco IOS XR devices, you can add individual packages, deactivate packages, test 
changes before committing them, commit changes, and roll packages back to stored rollback points. 
CCM saves messages that can be used for debugging in 
NETWORKHOME/XMP_Platform/logs/NEIM.log.
NoteKeep these notes in mind when using Image Management:
Devices must be in the Device Reachable communication state and the Operational investigation 
state. See Checking the Device State, page 11-19 for an explanation of how to check state 
information.
CCM does not support special characters for any of the editable fields in the client, including filters.
Before activating images on multiple devices, install the image on a single device and verify that it 
operates correctly.
Configuration 
Changes in the 
Last WeekNumber of device configuration changes detected for each day of the current week. 
This dashlet is empty when configuration change notification is not enabled 
(controlled by the “Enable/Disable Event-Triggered Config Archive” setting on the 
Configuration Management Settings page).
Most Recent 
Configuration 
ChangesLast five device configuration changes made to devices in the network. This dashlet 
is empty if configuration change notification is not enabled. It is controlled by the 
“Enable/Disable Event Triggered Config Archive” setting on the Configuration 
Management Settings page (see Setting Up Configuration Management, page 3-5). If 
a device does not support Commit IDs and Diffs, the client displays N/A. Dashlet Provides information about:
Icon Description
Displays the details in the form of a pie or bar chart. If you hover your mouse cursor over 
a section in the pie chart, a tooltip displays the information associated with that section.
Displays the details in a tabular form. 
						

							  
9-4
Cisco Prime Network 4.3.2 User Guide
EDCS-1524415
Chapter 9      Manage Device Configurations and Software Images
  Managing Device Software Images
NoteIf Prime Network is down then debug message is sent to user and no debug message is sent to user when 
Prime Network is up
The following topics explain how to work with software images and packages:
Adding New Images to the Repository, page 9-4
Creating an Image Baseline for New Devices, page 9-6
Distributing Images and Making Sure They Will Work, page 9-8
File System Clean Up, page 9-13
Activating Cisco IOS Software Images, page 9-14
Performing Cisco IOS XR Software Package Operations, page 9-18
Cleaning Up the Repository, page 9-25
Adding New Images to the Repository
When images are copied to the repository, they are placed in the storing directory specified on the Image 
Management Settings page. Images are copied from the storing directory into the repository. Before 
copying an image, CCM verifies whether the new image is different from the existing image in the 
repository. If they are the same, CCM does not add it to the repository. By default, the storing directory 
is NETWORKHOME/NCCMComponents/NEIM/images. 
NoteBefore importing images, make sure internet connectivity is available to the remote server; otherwise, 
the imported images will not be populated with RAM, boot ROM, and feature set information.
When you download an image from Cisco.com, CCM creates a job for the download. The job 
information is saved, along with other job information, in the database.
Figure 9-2 illustrates the process of importing images into the Prime Network database. 
						

							  
9-5
Cisco Prime Network 4.3.2 User Guide
Chapter 9      Manage Device Configurations and Software Images
  Managing Device Software Images
Figure 9-2 Import Image Operations
To import images into the CCM image repository:
Step 1Choose Images > Repository. 
Step 2Choose the appropriate method:
GATEWAY
File
System
UNIT Staging
Directory
Import image from Cisco.com
TFTP
Directory External
IPv4/IPv6
Repository
Device
Cisco.com
DATABASE
Storing
Directory
Import image from file system (the only operation that uses the gateway Storing Directory)
Import image from External IPv4/IPv6 repository
Import image from device (the only image import operation that uses the gateway Storing Directory and unit TFTP directory)361758
To import from: Choose: Notes
Cisco.com web sitefrom Cisco.comMake sure the Cisco.com credentials are set on the 
Image Management Settings page. You must enter 
a device type, software version, and feature set. 
						

							  
9-6
Cisco Prime Network 4.3.2 User Guide
EDCS-1524415
Chapter 9      Manage Device Configurations and Software Images
  Managing Device Software Images
Step 3Select the images and import them. CCM redirects you to the Jobs page, where you can monitor the 
status of the import job.
Step 4Choose Images > Repository again to refresh the list of images.
If a field displays NA, the image attributes were not available from the image header. (If pre-existing 
filters are still in use, you may need to click Clear Filter.) We recommend that you manually enter the 
information to ensure the accuracy of the upgrade analysis.
After an image is successfully imported, CCM removes any images from the unit TFTP directory, the 
gateway Staging Directory, and the gateway Storing Directory (for import from Cisco.com only).  If you 
import images from a file system, you must manually delete those files from the gateway Storing 
Directory.
You can also add informational text to the Comments field. To distribute the images, see Distributing 
Images and Making Sure They Will Work, page 9-8.
Creating an Image Baseline for New Devices
Use this method to create an image baseline—that is, directly copy images from existing devices to the 
image repository. This is useful when you add devices from a new device series or family. 
For information on devices that support Image Baseline, see the Cisco Prime Network 4.3.2 Supported 
VNEs - Addendum.
See Figure 9-2 which illustrates how images are imported from devices into the database.
NoteYou cannot import tar files from IOS XR devices.
To import images from devices into the CCM image repository:
Step 1Choose Images > Repository. 
Step 2From the Import drop-down list, choose From Devices. The Devices dialog box displays information 
about the device. For long texts in the Element Type, Software Version, and Running Image fields, 
hover the cursor over the hyperlink to display the entire contents.Another IPv4 or IPv6 
gateway serverfrom External 
RepositoryCCM will display available images, their size, and 
whether they already exist in the repository. CCM 
displays all images or packages (bin, pie, smu, and 
so on) from the directory specified in the Image 
Management Settings page, and also from its sub 
directory in order to support tar files.
If you create tar files manually, ensure that you 
follow the file naming convention as the tar files in 
the Cisco.com web site so that the correct family 
name is displayed in the Images Repository page 
(Images > Repository). A file system on the 
local gateway serverfrom File System To import from: Choose: Notes 
						

							  
9-7
Cisco Prime Network 4.3.2 User Guide
Chapter 9      Manage Device Configurations and Software Images
  Managing Device Software Images
Step 3To import images from devices of a specific group, click Select Groups. Click the hyperlinked device 
group name to view the list of devices that belong to the group. See Setting Up CCM Device Groups, 
page 3-17 for more information on user-defined device grouping.
Step 4Select the required device group in the Device Groups page and click OK.
The devices that belong to the selected device group are highlighted in the Devices page. You can also 
import all the devices existing in a group. To do so:
–Select a device group and click Import from Group.
–Enter the scheduling information as explained after Step 5 and click Import from Group.
Step 5In the Devices page, click Import. A scheduler popup window appears.
NoteYou might be prompted to enter your device access credentials. This option is enabled if, from 
the Administration client, Global Settings > Security Settings > User Account Settings > 
Execution of Configuration Operations, you checked the option Ask for user credentials 
when running configuration operations. This is an enhanced security measure to restrict 
access to devices.
Step 6Enter the scheduling information. By default, jobs are scheduled to run as soon as possible.
NoteThe time you specify here to schedule the import job is the gateway time.
Step 7If you do not want to use the default transfer protocol, select a different protocol:
TFTP (unsecured)
SFTP/SCP (secured)
FTP (unsecured)
For information on the default transfer protocol that each device use, see the Cisco Prime Network 4.3.2 
Supported VNEs - Addendum and the Cisco Prime Network 4.3 Supported Cisco VNEs. For its Supported 
Protocols see the Support for Change and Configuration Management in 4.3.2 tables.
Step 8If you have selected two or more devices, click one of the following to specify the operation mode:
Parallel Order—Imports images from all devices at the same time.
Sequential Order—Allows you to specify the order of the devices to import the images from. You 
can do so by moving the devices up and down in the Device Order box.
NoteThe Device Order box is only available for sequences containing less than 300 devices. CCM 
sequences the devices based on the order used when the devices were selected.
Step 9Enter the e-mail ID(s) to which to send a notification after the import job is complete. For two or more 
users, enter a comma-separated list of e-mail IDs. A notification e-mail is sent based on the e-mail option 
specified in the Image Management Settings page.
NoteBefore you enter the e-mail ID(s), ensure that you have set up the SMTP host and SMTP port in 
the Image Management Settings page (see Setting Up Image Management, page 3-13). The 
configured e-mail ID(s) will be displayed by default and can be modified if required.
Step 10Click Import. CCM redirects you to the Jobs page, where you can monitor the status of the import job. 
						

							  
9-8
Cisco Prime Network 4.3.2 User Guide
EDCS-1524415
Chapter 9      Manage Device Configurations and Software Images
  Managing Device Software Images
NoteIf you import all devices from a device group and, after creating the job, there is a change in the 
group, CCM updates the job accordingly such that all the devices available in the group at the 
time of the job execution are considered.
Step 11Choose Images > Repository again to refresh the list of images. If any of the image information could 
not be retrieved, the field will display NA. (If pre-existing filters are still in use, you may need to click 
Clear Filter.) We recommend that you manually enter the information to ensure the accuracy of the 
upgrade analysis.
Step 12Delete files from the storing directory (if applicable) to free space for future imports. 
After the import, you can also add informational text to the Comments field. Normally at this point you 
will distribute the images; see Distributing Images and Making Sure They Will Work, page 9-8.
Distributing Images and Making Sure They Will Work
CCM can copy an image to a network element without activating it. This lets you perform these tasks 
before activating the image:
Find out if there is insufficient memory, clear the disk space for distributing the image or package
Do an upgrade analysis to check the suitability of the device for the chosen image 
If appropriate, the images can be activated as part of the distribution job, and the following tasks can also 
be performed:
Commit Cisco IOS XR (so that changes are saved across device reloads).
Perform a warm upgrade, where one Cisco IOS image can read in and decompress another 
Cisco IOS image and transfer control to this new image (thus reducing the downtime of a device 
during planned software upgrades and downgrades). 
Perform an in-service software upgrade (ISSU) for Cisco ASR 903 devices to update the router 
software with minimal service interruption. CCM performs a single command upgrade that installs 
a complete set of sub-packages using one command. The device must be configured in SSO 
redundancy mode. Before you perform an ISSU, you must verify if sufficient memory is available 
in standby boot flash. 
NoteCisco ASR 903 devices must be booted in sub-package mode only through boot flash and 
not through any sub-directories of boot flash before using CCM to perform an ISSU. For 
more information, see the Cisco ASR 903 Series Router Chassis Configuration Guide.
In the Activation Scheduler page, check the Boot in Subpackage mode radio button to boot the 
Cisco ASR 903 devices.
Perform an in-service software upgrade (ISSU) for Cisco 9000 series devices and CRS devices to 
update the router software with minimal service interruption. The option to perform ISSU is 
supported only for SMU packages.
For information on devices that support ISSU, see the Cisco Prime Network 4.3.2 Supported VNEs 
- Addendum. For its Supported Protocols see the Support for Change and Configuration 
Management in 4.3.2 tables. 
						

							  
9-9
Cisco Prime Network 4.3.2 User Guide
Chapter 9      Manage Device Configurations and Software Images
  Managing Device Software Images
CCM uses the image staging location and transport protocol (TFTP, by default) specified on the Image 
Management Settings page. CCM displays the available upgradeable modules and the storage partitions 
(if any) on the network element for the image distribution, from which you can choose the storage 
location you want to use.
The final step is to schedule the distribution job to occur either as soon as possible or at a future date 
(the default is as soon as possible). 
What is Upgrade Analysis?
An upgrade analysis checks the attributes of the selected image, checks certain device features, and 
generates a separate report for each device. It is required before any image can be distributed. However, 
even if the upgrade analysis reports errors, CCM will allow you to proceed with the distribution (because 
an error can be a simple matter of an unpopulated field).
CCM gathers this information from two sources:
The Image Management repository, which contains information about minimum RAM, minimum 
Flash, and so on, in the image header.
The Prime Network inventory, which contains information about the active images on the device, as 
well as Flash memory, modules, and processor details.
An upgrade analysis verifies that the device contains sufficient RAM or storage, the image is compatible 
with the device family, and the software version is compatible with the image version running on the 
device.
Ta b l e 9 - 1 denotes the symbols used on the Distribution page.
Distribute Images to Devices
The following procedure explains how to perform an image distribution. You can also use this procedure 
to perform an upgrade analysis and then exit the procedure before performing the distribution.
Table 9-1 Status Icons
SymbolDescription
In Device Status Column In Distribution Upgrade Analysis 
Column or Activation Analysis 
Results
Device is available for upgrade analysis and 
distribution. Device passed without warnings.
Device is not available for upgrade analysis or 
distribution. Most likely the device is in the 
Maintenance investigation state or the Unreachable 
communication state. Click the device hyperlink and 
open the device properties popup to see details about the 
device. Device passed with warnings. 
Click the icon to get more 
information.
n/a Device did not pass analysis. 
Click the icon to get more 
information. 
						

							  
9-10
Cisco Prime Network 4.3.2 User Guide
EDCS-1524415
Chapter 9      Manage Device Configurations and Software Images
  Managing Device Software Images
Before You Begin
If you are doing a Cisco IOS XR version upgrade (which upgrades the core package), see Managing 
Device Software Images, page 9-3 for information about other packages that you should upgrade at 
the same time.
Make sure you have the permissions to perform the distribute operation. You will not be allowed to 
schedule a distribution job, if you do not have permissions.
Figure 9-3 illustrates the process of distributing images to devices.
Figure 9-3 Image Distribution Operations
To distribute images and use upgrade analysis:
Step 1Choose Images > Distribute.
Step 2Choose the device type (IOS or IOS XR) and selection method (by image or package, or by device). It 
is often easier to start with devices due to the sometimes cryptic nature of software image names. In this 
example we start with devices.
NoteCCM does not support tar file operations on IOS devices. Tar file operations are supported only 
on Cisco Catalyst and IOS XR devices.
a.To choose devices of a specific device group, click Select Groups in the table header. Click the 
hyperlinked device group name to view the list of devices that belong to the group.
b.Select the required device group in the Device Groups page and click OK. 
c.Choose one or more devices and click Next.
Step 3CCM displays all images or packages which are valid for the selected devices from the internal image 
repository (for example, kickstart images for Cisco Nexus 5000 or Cisco Nexus 7000, and boot configs 
for Cisco ASR 5000). You can also choose From External Repository from the drop-down list (in the 
table header) to display the images or packages from the external image repository.
GATEWAY
UNIT FTP Staging
Directory
Distribute image from repository
TFTP
DirectoryDevice
DATABASE
Distribute image from external repository361757
External
Repository 
						

							  
9-11
Cisco Prime Network 4.3.2 User Guide
Chapter 9      Manage Device Configurations and Software Images
  Managing Device Software Images
NoteCCM allows image distribution from external repository only through FTP. Make sure you 
have configured the required credentials for accessing the external image repository in the 
Image Management Settings page.
If you selected Cisco OLT devices, a list of filenames appear. The image files that do not have filename 
extensions belong to ONUs and image files that have filename extensions are that of an OLT device. For 
Cisco OLT devices, after you select the required images, the job scheduling page appears. 
If you selected Tar file(s) for IOS XR devices, you cannot select any other non-tar file(s), and vice versa.
If you selected an Nexus devices (except for Nx9K), you can select a corresponding compatible image 
in the Select Compatible Image page, for a selected system image or a kickstart image. 
NoteSelect Compatible Image is only optional. If a compatible image is selected for a System or 
Kickstart image you can perform both the Distribution and Activation of an image, otherwise 
you can perform only distribution of an image.
Choose an image and click Next. 
Step 4(Applicable only when distributing Cisco ONU images) After you select the required images, you must 
configure the image properties for a selected ONU image. From the Select ONU Image Properties pane, 
click Configure ONU Images. 
When you perform a bulk activation for ONUs, the selected image will be applied to the ONU, the details 
of which matches with the information that you entered in this window. 
Enter the following details:
Click Next. You will be redirected to the Schedule Distribution page.
Step 5In the Select Storage page, choose a storage location by device or for all devices. This specifies where 
on the network element the image or package will be copied when it is distributed. 
Field Description
Image Name The name of the image selected.
ONU Profile ID From the drop-down list, select an image profile 
to which this image must be distributed. 
Software Version The software version of ONU as available in the 
device. 
Hardware  Version The hardware version of ONU as available in the 
device. 
Description A brief description. 
						

							  
9-12
Cisco Prime Network 4.3.2 User Guide
EDCS-1524415
Chapter 9      Manage Device Configurations and Software Images
  Managing Device Software Images
Step 6(Not applicable to Cisco OLT devices) Perform an upgrade analysis to check whether the network 
element has sufficient space for the image or package by clicking Upgrade Analysis. After a few 
moments, CCM displays the results of the analysis in the Upgrade Analysis column. Click the symbol 
next to the icon to see the Upgrade Analysis report.
If an error is reported, you will see a prompt asking you to confirm whether or not to proceed with the 
operation.
Step 7(Not applicable to Cisco OLT devices) If you do not want to distribute any images or packages (for 
example, if you only wanted to perform a manual upgrade analysis), click Cancel. Otherwise, proceed 
to Step 8.
Step 8Click Next to open the Schedule Distribution page in the wizard, and complete the schedule information.
NoteYou can proceed with scheduling the distribution only if upgrade analysis is completed for all 
the devices (spanning across multiple pages) in the Select Storage page. SymbolDescription
In Device Status ColumnIn Distribution Upgrade Analysis Column or 
Activation Analysis Results
Device is available for upgrade 
analysis and distribution. Device passed without warnings.
Device is not available for upgrade 
analysis or distribution. Most likely 
the device is in the Maintenance 
investigation state or the 
Unreachable communication state. 
Click the device hyperlink and open 
the device properties popup to see 
details about the device. Device passed with warnings. Click the icon to 
get more information.
n/a Device did not pass analysis. Click the icon to 
get more information.
Field Description
Schedule 
DistributionWhen the distribution job should run.
NoteThe time you specify here to schedule the distribution job is the gateway 
time.
File Transport 
ProtocolOverrides the default transfer protocol (as configured on the Image Management 
Settings page).
Clear Flash (Optional) In case of insufficient memory, use the Clear Flash option (under 
Flash Properties). This deletes any one file (other than the running image) and 
recovers the disk space occupied by the file. This procedure is repeated until 
adequate space is available in the selected flash.
E-mail Id(s) E-mail ID(s) to which to send a notification after the scheduled distribution job 
is complete. For two or more users, enter a comma-separated list of e-mail IDs. 
A notification e-mail is sent based on the e-mail option specified in the Image 
Management Settings page.