Cisco Prime Nerk 43 User Guide

							  
9-23
Cisco Prime Network 4.3.2 User Guide
Chapter 9      Manage Device Configurations and Software Images
  Managing Device Software Images
Step 4Check the Sync Satellite(s) check box, if you wish to upgrade and synchronize the satellites. The Sync 
Satellite(s) check box is available only for Cisco ASR 9000 devices having satellites.
NoteSynchronization of satellites is done, only if the operation selected is activation or deactivation. 
Otherwise, synchronization will not happen even if this check box is selected.
Step 5Click Finished to schedule the activation and/or synchronization.
Committing Cisco IOS XR Packages Across Device Reloads
Committing a Cisco IOS XR package makes the device package configurations persist across device 
reloads. The commit operation also creates a rollback point on the device. See Rolling Back 
Cisco IOS XR Packages, page 9-24, for more information on rollback points.
NoteWe recommend that you do not commit package changes until the device runs with its configuration for 
a period of time, until you are sure the change is appropriate. In that way, the change is not yet persisted 
across device reloads.
Before You Begin
Verify that the package to be committed is operating properly (for example, by doing a show status 
command).
Make sure you have the permissions to perform the commit operation. You will not be allowed to 
schedule a commit job, if you do not have permissions.
To commit a package after it has been activated, deactivated, or rolled back:
Step 1Choose Images > Commit. 
Step 2Choose the network elements with the packages you want to commit. 
Step 3Click one of the following (in the table header) to specify the commit mode:
Commit in Parallel—Commits all changes at the same time. 
Commit Sequentially—Allows you to define the order in which the changes are committed.
Step 4Enter the scheduling information.
NoteThe time you specify here to schedule the commit job is the gateway time.
Step 5Enter the e-mail ID(s) to which to send a notification e-mail after the scheduled commit 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.
Step 6Click Commit. By default, jobs are scheduled to run as soon as possible. 
						

							  
9-24
Cisco Prime Network 4.3.2 User Guide
EDCS-1524415
Chapter 9      Manage Device Configurations and Software Images
  Managing Device Software Images
Rolling Back Cisco IOS XR Packages 
Rolling back a Cisco IOS XR package reverts the device packages to a previous installation 
state—specifically, to a package installation rollback point. If a package has been removed from a 
device, all rollback points associated with the package are also removed and it is no longer possible to 
roll back to that point. 
Before You Begin
Read Managing Device Software Images, page 9-3, for information about managing rollback points 
on Cisco IOS XR devices.
Make sure you have the permissions to perform the rollback operation. You will not be allowed to 
schedule a rollback job, if you do not have permissions.
To roll back a Cisco IOS XR package:
Step 1Choose Images > Rollback. CCM displays all Cisco IOS XR devices. You can filter the results by using 
the Quick Filter option.
Step 2Choose the network elements. CCM populates the rollback points for the selected device package.
Step 3Choose a rollback ID from the Rollback ID drop-down list. The Rollback Point Details field lists the 
packages that were active when that ID was created. 
Step 4To view all of the packages associated with the rollback point, place the mouse cursor on the Rollback 
Point Details field; see Figure 9-4 for an example. To view the time stamp associated with the selected 
rollback, see the value displayed in the Time Stamp field. 
NoteThe date and time stamps are displayed according to the local time zone settings of the client.
Figure 9-4 Packages Rollback Page with Rollback Point Details
Step 5
Click OK to close the popup window.
NoteIf a package has been deleted from the repository, the rollback points of the package are still 
displayed in CCM. If you choose a rollback point for a deleted package, the rollback will fail. 
The job results popup provides information explaining why it failed.
Step 6(Optional) Click Compatibility Check in the table header to run a test of the rollback procedure on 
the device. This will not change the real device configuration. (This is similar to using the Test Only 
option in the activation process.) 
						

							  
9-25
Cisco Prime Network 4.3.2 User Guide
Chapter 9      Manage Device Configurations and Software Images
  Managing Device Software Images
Step 7Click Rollback or Rollback and Commit.
NoteWe recommend that you do not commit package changes until the device runs with its 
configuration for a period of time, until you are sure the change is appropriate. In that way, the 
change is not yet persisted across device reloads. See Committing Cisco IOS XR Packages 
Across Device Reloads, page 9-23.
Step 8Enter the scheduling information.
NoteThe time you specify here to schedule the rollback job is the gateway time.
Step 9Enter the e-mail ID(s) to which to send a notification after the scheduled rollback 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 Rollback.
Cleaning Up the Repository
The repository is purged according to the settings described in Setting Up Image Management, 
page 3-13. When files are removed from the repository, this does not affect files that are installed on the 
device. However, deleting a package could cause a rollback point to become unexecutable. If a package 
or version of a package that is associated with a specific rollback point is removed, it will no longer be 
possible to roll back to that point. See Rolling Back Cisco IOS XR Packages, page 9-24.
To delete images from the CCM image repository:
Step 1Choose Images > Repository.
Step 2Select the image you want to delete and click the Delete button (with red X) in the table header.
Step 3To collectively delete all images in the repository, click the Delete All button in the table header. You 
will see a prompt asking you to confirm whether or not to proceed with the operation. 
Step 4Click OK to confirm and image(s) available in the repository will be deleted. 
						

							  
9-26
Cisco Prime Network 4.3.2 User Guide
EDCS-1524415
Chapter 9      Manage Device Configurations and Software Images
  Managing Device Configurations
Managing Device Configurations
The CCM Configuration Management feature enables you to control and track changes that are made to 
a device configuration. It uses a change management feature to detect ongoing changes to devices in two 
ways:
When doing periodic archiving of device configurations. If CCM detects a change in a configuration 
file, it will get the new version of the file from the device and copy it to the archive.
When a configuration change notification is received from a device. This is called event-triggered 
archiving. You can configure CCM to copy a new version of a configuration file to the archive 
whenever a change is detected, or to queue the changes and then copy the files to the archive 
according to a schedule.
By default, neither of these methods are enabled. You can configure them from the Configuration 
Management Settings page (see Setting Up Configuration Management, page 3-5).
Change Logs provide information on the changes made to devices in the network, sorted by their time 
stamp. The Configuration Management Settings page controls how long these logs are saved. CCM saves 
messages that can be used for debugging in NETWORKHOME/XMP_Platform/logs/ConfigArchive.log.
NoteKeep these notes in mind when using Configuration 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.
Cisco IOS devices using SNMPv3 must be configured with write permission for the 
CISCO-CONFIG-COPY-MIB MIB group.
The following topics explain how to work with device configurations:
What is In the Configuration Archive?, page 9-26
Protecting and Labeling Important Configurations in the Archive, page 9-28
Editing an Archive Configuration, page 9-28
Finding Out What is Different Between Configurations, page 9-29
Copying a Configuration File to a Central Server, page 9-30
Are Running and Startup Configs Mismatched? (Cisco IOS and Cisco Nexus), page 9-31
Copying the Device Files to the Archive (Backups), page 9-32
Fixing a Live Device Configuration (Restore), page 9-36
Cleaning Up the Archive, page 9-39
Finding Out What Changed on Live Devices, page 9-39
What is In the Configuration Archive?
Choose Configurations > Archives to view the contents of the archive. The configuration archive 
maintains copies of device configuration files, storing them in the database. Configuration files are 
stored in readable format, as received from the device. You can edit existing archive files and save for  
						

							  
9-27
Cisco Prime Network 4.3.2 User Guide
Chapter 9      Manage Device Configurations and Software Images
  Managing Device Configurations
deployment at a later time. The edited archive files are available in the Edited Archive tab. The total 
number of archives available in the database is also displayed in the header. The configuration, after 
deployment, can also be restored to the original state. Users can only see devices that are in their device 
scope. For enhanced security, you might be prompted to enter your device access credentials when you 
try viewing device details or when you try performing configuration changes on devices. 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. 
The Archived Configurations page displays the following information about each configuration file.
.Table 9-2 Configuration Information Displayed on Archived Configurations Page
Field Description
Device Name Name of device. Click the icon next to the device name to open a popup that 
displays device properties. Additional information is listed depending on the 
device type:
Current active packages on the device—For Cisco IOS XR devices
Active kickstart images—For Cisco Nexus OS devices
Priority list—For Cisco StarOS devices. The priority list displays various 
combinations of a configuration file and an image file in priority order for 
the device.
Version An internally-used number. A version will not have an associated configuration 
file under the following circumstances:
The associated configuration file was deleted from the archive.
The associated configuration file has not yet been copied to the archive. 
(CCM supports queuing change notifications and copying the configuration 
files to the archive at a later time. See Setting Up Configuration 
Management, page 3-5.)
Click a version number hyperlink to launch the Device Configuration Viewer, 
from which you can view the contents of a configuration file.
Type Type of configuration for each device. 
For information on the devices that support the different configuration type, see 
the Cisco Prime Network 4.3.2 Supported VNEs - Addendum.
Vendor Specifies the device vendor: Cisco or non-Cisco device.
Date  Changed Date and time of last change, displayed according to the local time zone settings 
of the client.
For Cisco CPT, Cisco StarOS, and Cisco ME 4600 series OLT devices, this field 
displays N/A.
Label User-assigned archive labels.
Running Image The software image currently running on the device.  
						

							  
9-28
Cisco Prime Network 4.3.2 User Guide
EDCS-1524415
Chapter 9      Manage Device Configurations and Software Images
  Managing Device Configurations
NoteCCM does not support the view, compare, edit, and, edit and restore operations if the configuration file 
is in binary format.
Protecting and Labeling Important Configurations in the Archive
Assigning labels to configuration files is a clear, simple way to identify important configurations and 
convey critical information. You can manage labels by choosing Labels > Manage.
Adding a label adds it to the catalog where it is made available to all users. Add labels by clicking 
Add Row.
Deleting a label unassigns the label from configurations that are using it. Likewise, if you edit a 
label, the change is applied to all configurations using the label.
Unassigning a label does not delete the label from the catalog. 
Labels with the “do not purge” property will not be purged from the archive (the delete action is 
disabled). When calculating the total number of archives to see if the maximum has been reached 
and archives should be purged, CCM does not include configurations with this label in the total (see 
Setting Up Configuration Management, page 3-5).
Editing an Archive Configuration
You can edit an existing device archive file and save the edited file. This edited archived file is stored in 
the Prime Network database, and the edited file can be deployed at any time. This can be viewed from 
the Edited Archive tab, in the Archive page. Every time you edit and save an existing file, a new version 
is added in the database, and is also listed in the Edited Archive page. Context / Module / 
PriorityFor Cisco Nexus OS devices, this field displays the virtual device context 
(VDC) name.
For Cisco 7600 series devices, this field displays the module name.
For Cisco StarOS devices, this field displays the boot configuration files with 
their priorities.
For Cisco CPT 200 and Cisco CPT 600 devices, this field displays the operation 
mode details.
For other devices, this field displays N/A.
NoteSNMPv3 and SSHv2 are supported in the CPT 600/200 
devices. The support is limited to software version 
9.535/9.536.
Comments User-assigned free text.
Commit Id (Cisco IOS XR only) ID that identifies the last configuration change on the 
device (maximum number saved is 100).
Table 9-2 Configuration Information Displayed on Archived Configurations Page (continued)
Field Description 
						

							  
9-29
Cisco Prime Network 4.3.2 User Guide
Chapter 9      Manage Device Configurations and Software Images
  Managing Device Configurations
NoteThe option to edit existing device archive file and save the edited file is not available for non-Cisco 
devices.
Edit archive files following the procedure below:
Step 1From the Archive page, choose a configuration file, and click Edit.
Step 2Edit and save the configuration file.
An edited archive version is created. This edited version will belong to the same configuration type as 
that of the original archive file. 
The edited archive files can be restored to the devices. 
Finding Out What is Different Between Configurations
CCM allows you to compare two configuration files that are saved in the archive and display them side 
by side, highlighting configuration differences and allowing you to move between them. CCM excludes 
a small set of commands by default, such as the NTP clock rate (which constantly changes on a managed 
network element but is not considered a configuration change). You can change the excluded commands 
list as described in Setting Up Configuration Management, page 3-5. Additions, deletions, and excluded 
values are color-coded as shown in the following example. 
Figure 9-5 Compare Configurations Dialog Box
You can compare any types of configurations as long as they run on the same operating system. However, 
you cannot compare a Cisco IOS configuration with Cisco IOS XR configuration.
The following are typical scenarios for using the compare function:
Compare the latest and next-to-latest configuration to see the most recent change. 
						

							  
9-30
Cisco Prime Network 4.3.2 User Guide
EDCS-1524415
Chapter 9      Manage Device Configurations and Software Images
  Managing Device Configurations
Compare Cisco IOS running and startup configurations to see how they are out of sync.
Compare the configurations on two different devices to find out how they are different.
Compare the configurations after eliminating excluded 4.3.2 from comparison.
NoteWhen you are trying to compare an archive with an active startup, running, or admin configuration, if 
there is a change in the device configuration, CCM initiates a backup job and creates a latest version of 
the device configuration file. You can view the latest version of the configuration file in the Archived 
Configurations page.
To compare configurations:
Step 1Choose Configurations > Archives. 
Step 2Locate the archives you want to compare. You can click the Version hyperlink next to a device to open 
the Device Configuration Viewer and quickly view the contents of the configuration file.
Step 3You can choose to do the following:
Copying a Configuration File to a Central Server
You can export configurations to an FTP or SFTP server that is specified on the Configuration 
Management Settings page. They are exported as a .cfg (configuration) file.
Configuration files are saved using the following format:
deviceName-configurationType-version-configChangeTimestamp.cfg
For example, the following file would contain the 18th version of a running configuration for the device 
named 7200-5, saved on March 27, 2010 at 2:40:30 P.M:
7200-5-RUNNING_CONFIG-18-2010327144030.cfg
NoteExport of configuration files of IPv6 devices to servers running Windows OS is not supported.
Before You Begin
Make sure of the following:
Export location and required credentials, and (for e-mails) SMTP host and port are configured on 
the Configuration Management Settings page. Device Type or OS Supported Function
For Cisco IOS XR devicesCompare > To Active Running or Compare > To Active Admin
Cisco IOS deviceCompare > To Active Startup or Compare > To Active Running
Cisco StarOS deviceCompare > To Active Boot or Compare > To Active Running
All Compare > Selected Archives 
						

							  
9-31
Cisco Prime Network 4.3.2 User Guide
Chapter 9      Manage Device Configurations and Software Images
  Managing Device Configurations
Specified FTP or SFTP server must have sufficient free space to accommodate the exported 
configurations. Also, the destination subdirectory on the FTP or SFTP server must have the required 
permissions.
To export configuration files:
Step 1Choose Configurations > Archives and locate the archives you want to export. You can click the 
Version hyperlink next to a device to open the Device Configuration Viewer and quickly view the 
contents of the configuration file.
Step 2Click Export and set the desired schedule and enter the e-mail ID(s) to which to send a notification after 
the scheduled export 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 Configuration Management 
Settings page.
NoteThe time you specify here to schedule the export job is the gateway time.
Step 3Click Export. The export job is created and you are redirected to the Job Manager page, where you can 
monitor the status of the job. 
Are Running and Startup Configs Mismatched? (Cisco IOS and Cisco Nexus)
Cisco IOS and Cisco Nexus series devices contain a startup and running configuration file. The startup 
configuration is loaded when a device is restarted. Ongoing changes to the device are applied to the 
running configuration. As a result, unless the running configuration is saved as the startup configuration, 
upon a device restart, any changes would be lost. It is therefore important to ensure that the device startup 
and running configurations are in sync. When CCM synchronizes a file, it overwrites the startup 
configuration on the device with the configuration that is currently running on the device. 
Whenever a configuration file is retrieved from a device and copied to the archive (that is, backed up), 
CCM compares the latest version of the startup configuration with the latest version of the running 
configuration file. If there is a mismatch, CCM adds the device to the list of out-of-sync devices.
For Cisco Nexus series devices, CCM backs up the startup and running configurations for all VDCs 
configured in the device. If there is a mismatch between the startup and running configurations of a 
VDC, CCM creates an out-of-sync entry for that VDC.
NoteThe synchronize operation affects only the configurations running on the device. It does not affect any 
configuration files that are saved in the archive.
The Dashboard maintains a Configuration Sync Status pie chart that shows how many devices have 
out-of-sync startup and running configuration files. When you click the pie chart (or choose 
Configurations > Synchronize), you are directed to the Out of Sync Devices page, where CCM lists all 
of the out-of-sync devices in tabular format. The information is refreshed whenever you choose 
Configurations > Synchronize. 
						

							  
9-32
Cisco Prime Network 4.3.2 User Guide
EDCS-1524415
Chapter 9      Manage Device Configurations and Software Images
  Managing Device Configurations
Before You Begin
Make sure the specified FTP or SFTP server must have sufficient free space to accommodate the 
exported configurations. Also, the destination subdirectory on the FTP or SFTP server must have the 
required permissions.
To view differences and synchronize configurations:
Step 1Choose Configurations > Synchronize. CCM lists all out-of-sync devices, the date and time when the 
device configurations were last changed, and when the files were last archived. Figure 9-6 provides an 
example. The date and time are displayed according to the local time zone settings of the client.
Figure 9-6 Configuration Synchronization - Out of Sync Devices Page
Step 2
Click the Compare icon to launch the Compare Configuration window, which provides a side-by-side 
view of the two configurations and highlights the differences.
Step 3Choose the network elements you want to synchronize. This directs CCM to overwrite the startup 
configuration on the device with the configuration that is currently running.
Step 4Click Synchronize. The Schedule Synchronization page opens.
Step 5Set the desired schedule and enter the e-mail ID(s) to which to send a notification after the scheduled 
synchronization job is complete. For two or more users, enter a comma-separated list of e-mail IDs. The 
time you specify here to schedule the synchronization job is the gateway time.
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 restrict access 
to devices.
Step 6Click Synchronize. CCM schedules the job and redirects you to the Jobs page, where you can monitor 
the status of the job.
Copying the Device Files to the Archive (Backups)
Backing up a device configuration entails getting a copy of the configuration file from the device, and 
copying that file to the configuration archive. As part of the backup procedures, it is compared with the 
latest archived version of the same type (e.g. running with running, startup with startup). A new version 
of the file is archived only if the two files are different. If the number of archived versions exceeds the 
maximum, the oldest archive is purged (according to the values on the Configuration Management 
Settings page). Configurations marked with a “do not purge” label are not removed from the archive by 
the auto-purging procedures.