Cisco Software Manager User Guide: Americas Headquarters
Cisco Software Manager User Guide: Americas Headquarters
Americas Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
http://www.cisco.com
Tel: 408 526-4000
800 553-NETS (6387)
Fax: 408 527-0883
Note The Service Packs are available only for Cisco ASR 9000 device, release 4.3.2 or later versions.
• Introduction, page 2
• Changes to this Document, page 2
• Installing the Cisco Software Manager, page 2
• Icons and Names, page 5
• Pre-Requisite for SMU Recommendation, page 6
• Using the Cisco Software Manager, page 6
• Set Up the Cisco Software Manager, page 7
• Retrieve SMUs or SPs Information from Cisco.com, page 8
• View SMU or SP Details, page 8
• Select SMUs or SPs, page 9
• Execute SMU or SP Tasks, page 9
• Create a Watch List, page 10
• Obtain SMUs or SPs Recommendations, page 10
• Monitor Pane, page 16
• Obtain an Optimized SMU List, page 19
• Uninstalling the Cisco Software Manager, page 20
Introduction
The Cisco Software Manager (CSM) provides SMUs and SPs recommendations to users and reduces their
effort in manually searching, identifying, and analyzing SMUs and SPs that are needed for a device. To provide
the recommendations, CSM must be connected through the Internet to the cisco.com domain. The CSM can
connect to multiple devices and provide SMUs and SPs management for multiple Cisco IOS XR platforms
and releases.
Note The Service Packs are available only for Cisco ASR 9000 device, release 4.3.2 or later versions.
The Cisco Software Manager (CSM) is a standalone Java application that can be installed on Windows, MAC,
and UNIX. The CSM supports Cisco CRS and Cisco ASR 9000 devices.
Computer Requirements
The following section lists the computer requirements:
• Apple Mac OS X
Procedure
Step 1 From cisco.com, download the current version of the installation file CSM-<version>.zip.
Step 2 Unzip the installation file, (CSM-<version>.zip).
Step 3 Double-click the file, SetupCSM.cmd.
What to Do Next
Users updating from CSM-1.0 version have to manually copy device profiles stored at the location
\Users\<username>\csm\versions\1.0\LoginInformation.xml file to CSM-2.0 location
\Users\<username>\csm\versions\2.0, so that CSM-2.0 can access device profiles.
Step 1 From cisco.com, download the current version of the installation file CSM-<version>.zip.
Step 2 Double-click the CSM-<version>.zip file, to unzip it.
The CSM-<version>.0 folder is created.
Step 3 Open a terminal window and change to the directory where you extracted the zip file.
Example:
cd /Users/<username>/Desktop/CSM-2.0.
Step 4 Execute these commands on the terminal window to run the installation script:
• chmod 777 SetupCSM.sh
• ./SetupCSM.sh
Cisco Software Manager begins to install. A shortcut that launches CSM software is created on the desktop.
Note The SetupCSM.sh script assumes JRE to be in the search path. If that is not the case, you can invoke
java (JVM) directly using the full path: /usr/bin/java -jar installer.jar.
Step 5 Double-click the CSM icon on the desktop to launch the CSM application.
What to Do Next
Users updating from CSM-1.0 version have to manually copy device profiles stored at the location (base
directory)/csm/versions/1.0/LoginInformation.xml file to CSM-2.0 location (base directory)/csm/versions/2.0,
so that CSM-2.0 can access device profiles. A base directory is the directory where the user has installed the
CSM.
Step 1 From cisco.com, download the current version of the installation file CSM-<version>.zip.
Step 2 Open a terminal window and execute these commands:
a) Create a new folder.
Example:
mkdir newfolder
b) Unzip the file, CSM-2.0.zip, at the newly created folder.
Example:
unzip CSM-2.0.zip
c) Change to the directory to where you extracted the zip file.
d) Run the installation script:
• chmod 777 SetupCSM.sh
• ./SetupCSM.sh
Note If CSM is installed in a location other than /users/<username>, that specific directory location should
be used while executing above commands.
What to Do Next
Users updating from CSM-1.0 version have to manually copy device profiles stored at the location (base
directory)/csm/versions/1.0/LoginInformation.xml file to CSM-2.0 location (base directory)/csm/versions/2.0,
so that CSM-2.0 can access device profiles. A base directory is the directory where the user has installed the
CSM.
Icons Names
Set Up
Task
Refresh
Import
Note See Execute SMU or SP Tasks, on page 9 to download SMU or SP, transfer files,
create TAR file, view/extract TAR file, and to export SMU or SP information.
3 Obtain SMUs or SPs Recommendations. See Obtain SMUs or SPs Recommendations, on page 10.
• Identify Superseded SMUs and SPs. See Identify Superseded SMUs and SPs, on page 17.
• Create and Assign Custom Suggested File. See Create and Assign Custom Suggested File, on page
18.
• Generate the Conformance report. See Generate the Conformance Report, on page 18.
Note See Create a Watch List to create a watch list and Execute SMU or SP Tasks, on page
9 to download SMU or SP, transfer files, create TAR file, view/extract TAR file, and
to export SMU or SP information.
4 Obtain an Optimized SMU List. See Obtain an Optimized SMU List, on page 19.
Step 1 Launch the CSM software and click the Set Up icon on the main tool bar.
Step 2 Define the following attributes in the Set Up dialog box:
• Repository Directory—Specify the location on the system where the SMUs or SP can be stored. This
is useful first to determine whether the SMU or SP is present at that location or not, and accordingly the
software displays an appropriate graphical icon next to the SMU or SP entry. A tar file can be created
only if the SMUs or SPs are present in this location.
• Polling Interval—Specify how often the CSM software must query cisco.com to retrieve SMU or SP
information. Before the query, the software first polls all the connected devices for an up-to-date package
information.
• Email Notification Settings—Specify the email account where the email notification has to be sent when
new SMUs or SPs are discovered. The Test Email Account Settings can be used to verify if the email
delivery is operational.
• Proxy Settings—Specify the HTTP Proxy and HTTPS Proxy from Proxy tab. The HTTP and HTTPS
Proxy are needed only if CSM requires such settings to connect to the Internet.
Procedure
Step 3 In the SMUs tab or Service Packs tab, click the Filter (Optimal) button and choose an appropriate filter
option:
• Select the Optimal filter option to view only optimal SMUs or SPs. This option excludes all superseded
SMUs or SPs that are not a pre-requisite for other SMUs or SPs.
• Select the ALL filter option to view all SMUs or SPs.
After the download is complete, the SMU or SP tar file is untarred and placed in the repository directory. The
tar file contains the SMU or SP and readme file. To view the readme file, right-click on the SMU or SP entry
and click .txt menu option. The SMUs or SPs list will refresh and indicate that the SMU or SP is now locatable
by displaying the green check icon.
Transfer Files—Allows users to transfer selected SMUs or SPs to a remote TFTP or FTP server:
1 In the SMUs tab or Service Packs tab, select the SMUs or SPs.
2 Click Tasks icon and select Transfer Files.
3 Click Selected SMUs or Selected Service Packs, and then click Next. An error message is displayed if
selected SMUs or SPs are not found in the repository directory.
4 Click Select Files Manually to add files other than SMUs or SPs.
5 Select a transfer method, TFTP or FTP and specify connection parameters. Click Transfer.
Create TAR File—The TAR file contains the SMUs or SPs that can be installed on the device:
1 Manually download the SMUs or SPs from cisco.com at your local system in the repository directory.
2 The SMUs and SPs that are stored in the repository directory are indicated by a green check icon in the
ST (status) column.
3 In the SMUs tab or Service Packs tab, select the SMUs or SPs with the green check icon.
4 Click the Task icon and select Create TAR File. The software alerts the user in case of any missing
prerequisites.
View/Extract TAR File—Users can view the contents of a TAR file and selectively extract the desired SMUs
or SPs. Click the Task icon and select View/Extract TAR File to perform this action.
Export SMU or SP Information—Export SMU or SP details of the selected SMUs or SPs or those SMUs
or SPs that are not installed on the device to an HTML file, thus:
1 Click the Task icon and select Export SMU Information or Export Service Pack Information.
2 Select the export option. The SMU or SP information is saved in the HTML file.
The SMU or SP details are sorted by the posted date. Any annotation entered will be present in the
Comments column of the HTML file.
Procedure
Step 2 Click the Platforms and Releases button and select the desired platform and the release version. Since the
watch list items are tied to a platform and release, the user needs to select the desired platform and release.
Step 3 In the Watch List tab, enter the SMU ID or DDTS and click Add. An alert notification is displayed when
the SMU entered in the watch list for is available during the next query to cisco.com. To delete a watch item,
select the entry and click Delete icon on top right corner.
The CSM software processes the information that is provided using one of the sources above and displays
the SMUs or SPs recommendations in the Software Monitor pane. For Monitor pane details, see Monitor
Pane, on page 16.
Procedure
Import File
The CLI Source tab is used to provide the “show install active summary” information for only one device. To
provide package and SMU or SPs information of multiple devices at the same time, an external file that
contains these details can be imported to the CSM software. To import an external text file, do the following:
Procedure
Step 3 Click each device in the Network Elements pane to view the results in the Monitor Pane, on page 16.
Connected Device
To provide package information through a connected device to the software, connectivity must be established
between the device and the computer that hosts the software. Before connecting the device to the software,
users must:
1 Verify device requirements. See Device Requirements, on page 12.
2 Verify mandatory configuration on the device for the required connection type. See Supported Connection
Types, on page 12.
3 Create Login profiles. See Creating Login Profiles, on page 13.
Once the above listed conditions are met, the users can login to the device. See Login to Device, on page 13.
When the software is successfully connected to the device, it retrieves the package information and adds the
connected device into the Network Elements tree pane. Devices with the same platform and release are grouped
under the same sub-tree (for example, ASR9K-PX-4.2.3). Click each device in the Network Elements pane
to view their results in the Monitor pane. The Package table will be updated based on the selection made. For
Monitor pane details, see Monitor Pane, on page 16.
A connected device displayed in the Network Elements pane can have two colors—orange or blue. Orange
indicates failure in establishing connection between the software and the device during the next polling. Blue
indicates successful connection between the software and the device.
Note If the device is in the discovering state for a long time, the user must remove the device using the Remove
Network Element icon and ensure xml agent tty is configured on the device and then login to the device
again.
Note Install crypto key on the router when the sshv1 or sshv2 connection is used.
Device Requirements
The following section lists the requirements for Cisco CRS and Cisco ASR 9000 routers to establish connectivity
with the CSM software:
• Install manageability PIE:
• (Cisco ASR9K) asr9k-mgbl-p.pie must be loaded
• (Cisco ASR9K) asr9k-k9sec-p.pie must be loaded for SSHv1 and SSHv2
• (Cisco CRS) hfr-mgbl-px.pie must be loaded
• (Cisco CRS) hfr-k9sec-px.pie must be loaded for SSHv1 and SSHv2
• Enable the XML agent— xml agent tty must be configured on the device.
Procedure
Login to Device
To login to the device, do the following
Procedure
The attributes in the Login screen vary depending on the choice of Connection Category (IP or Scripted).
Direct Login
When IP is chosen as the Connection Category, the following attributes are displayed on the Login screen:
• Device User Name—Enter the device user name
• Device Password—Enter the device password
• Connection Type—Choose Telnet, SSHv1, or SSHv2
• Device IP/Name—Enter the device management IP address.
Scripted Login
When Scripted is chosen as the Connection Category, the following attributes are displayed on the Login
screen:
• Scripted User Name—Enter the intermediate server username
• Scripted Password—Enter the intermediate server password
• Device User Name—Enter the device user name
• Device Password—Enter the device password
• Connection Type—Choose Telnet, SSHv1, or SSHv2
• Node Name/Port—Enter the intermediate server name or IP. Choose "..." to add additional script
information. Enter the port number if the server does not use the default Tenet/SSH port number. For
more information, see Login Script Steps, on page 14 .
• Device Description—Enter the device description.
• The “Wait For” data fields contain prompted string returned by the intermediate server.
• When CSM sees the “Wait For” string, it responds by sending the data defined in the “Send” data field.
• Scripted Username and Scripted Password are the intermediate server authentication that can be selected
from the drop down. During the actual login, these credentials must be entered by the user in the login
screen.
• The appearance of the Login prompt (login:) may vary depending on the system (Windows, MAC, or
UNIX) where the CSM software was installed.
Telnet —>Telnet scripted login indicates that the connectivity type between the computer that hosts the
software and the intermediate server is Telnet and the connectivity type between the intermediate server
and the device is Telnet.
Telnet —>SSH scripted login indicates that the connectivity type between the computer that hosts the software
and the intermediate server is Telnet and the connectivity type between the intermediate server and the device
is SSH.
SSH—>Telnet scripted login indicates that the connectivity type between the computer that hosts the software
and the intermediate server is SSH and the connectivity type between the intermediate server and the device
is Telnet.
SSH —>SSH scripted login indicates that the connectivity type between the computer that hosts the software
and the intermediate server is SSH and the connectivity type between the intermediate server and the device
is SSH.
Monitor Pane
The Monitor pane contains three tabs:
• SMUs—Displays SMU information retrieved from cisco.com for a specific platform and release in the
SMU table. SMUs that are already installed on the device are highlighted in green. SMUs that are not
applicable to the device are highlighted in gray. For example, a SMU may require the mpls pie which
is not installed on the device. By default, the software uses the Optimal filter option to display SMU
entries in the SMU table. However, the user may select the All filter option to display all SMUs.
• Service Packs—Displays available service pack information for a specific platform and release in the
SP table. The Service Packs tab is applicable only for Cisco ASR 9000 device, release 4.3.2 and later
versions. The latest service pack is displayed at the top of the table. The existing service packs that are
superseded by the latest service pack have a strike-through font.
• Watch List—Displays SMUs that are being tracked for specific platform and release. The Watch List
allows the user to keep track of the new SMUs that might be released for a specific platform and release.
The details of the new SMUs is provided by the Cisco escalation team to the customer/user along with
customer ETA. The Customer ETA date is for reference and should not be considered as the actual
delivery date. To create a watch list, see Create a Watch List.
Package Table—Displays the packages, SMUs and SPs that are currently present on the device in the bottom
window of SMUs tab and Service Packs tab. The packages, SMUs and SPs can have Active, Active Committed,
Inactive, and Inactive Committed state. The Package table displays packages, SMUs and SPs depending on
their state in Active, Active Committed, Inactive, and Inactive Committed tabs.
This table describes the package states:
State Description
Active Packages that are not persistent across system reloads. To be persistent
the user needs to execute the install committed command on the
packages.
Active Committed Active packages that are persistent across system reloads.
Inactive Packages that are committed and persistent across system reloads; but,
deactivated currently.
State Description
Inactive Committed Packages that are neither active nor committed.
The SMU, SP and the Package tables have the quick search filter. The filter accepts a string pattern and filters
the display list accordingly. The filter can be used to look up for a specific DDTS, SMUs or SPs within a
specific functional area, for example, BGP. Turn off the filter if you suspect the SMU and SP list should have
more entries. Click the cross icon in the filter to turn off the filter.
The Monitor pane automatically refreshes at every polling interval configured in the Setup dialog box. Also,
users can manually refresh by clicking the Refresh icon to retrieve the updated SMU and SP information
from cisco.com. A manual refresh does not poll the latest package information from the device. To manually
poll the device, use the Refresh icon on the Network Elements pane.
After obtaining the SMU and SP recommendation from cisco.com, users can perform the following tasks:
• Identify Superseded SMUs and SPs, on page 17
• Download SMU or SP
• Transfer Files
• Create TAR File
• View/Extract TAR File
• Export SMU or SP Information
Note See Execute SMU or SP Tasks, on page 9 to download SMU or SP, transfer files,
create TAR file, view/extract TAR file, and to export SMU or SP information.
Procedure
• Assign File to Suggest— Browse for an external text file that contains the required SMUs. The SMU
details are displayed in the Assign File to Suggest dialog box. The assignment is saved and assigned to
this particular platform and release.
Step 5 Click the Suggest button and choose Enable Suggest. A green tick mark is displayed against Suggest.
The Monitor pane is refreshed and the new list of suggested SMUs is displayed in the top window (SMU
table) and the bottom window (Package table) is refreshed accordingly.
Note By default, the Suggest button displays a red cross which indicates it is not enabled.
Procedure
The SMU or SP recommendation is displayed on the Monitor pane within SMUs tabs and Service Packs tabs.
Step 3 Select the SMUs or SPs and click Conformance Report at the bottom right corner. The SMU or SP
conformance report for the selected SMUs or SP is displayed.
The user can choose to copy the report to the system clipboard or save the report as a text file. The results in
the report are tab delimited and can be pasted onto Microsoft Excel spreadsheet or other applications.
Note If there are multiple devices under the same platform and release sub-tree (on the Network Elements
pane), the users can choose to run the Conformance report against the current device or selected
devices.
Procedure