cisco software manager user guide€¦ · ciscosoftwaremanageruserguide americasheadquarters...

Cisco Software Manager User GuideAmericas HeadquartersCisco Systems, Inc.170 West Tasman DriveSan Jose, CA 95134-1706USAhttp://www.cisco.comTel: 408 526-4000

800 553-NETS (6387)Fax: 408 527-0883

Text Part Number: OL-29903-02

C H A P T E R 1Cisco Software Manager User Guide

This document describes how to install and use the Cisco Software Manager (CSM) application that helpsmanage the process of software maintenance upgrades (SMUs) and service packs (SPs) on devices that runthe Cisco IOS XR Software.

Information in this guide is relevant only until CSM Release 3.0. For later releases, refer to the InstallationGuide for Cisco Software Manager Server.

Service packs are available only for Cisco ASR 9000 devices, Release 4.3.2 or later versions.Note

• Introduction, on page 1• Changes to this Document, on page 2• Installing CSM, on page 2• CSM Icons and Monitor Pane, on page 7• Pre-Requisite for SMU Recommendation, on page 8• Setting Up CSM, on page 8• Using CSM, on page 9• Retrieve and View SMUs or SPs Information, on page 10• Execute SMU or SP Tasks, on page 12• Create a Watch List, on page 13• Obtain SMUs or SPs Recommendations, on page 13• Obtain an Optimized SMU List, on page 21• Uninstalling CSM, on page 21

IntroductionCisco Software Manager (CSM) is a management application for software maintenance upgrades (SMUs),and service packs (SPs). It provides recommendations to users that reduce their effort in manually searching,identifying, and analyzing SMUs and SPs that are required for a device. A SMU is a fix for a bug. An SP isa collection of SMUs bundled in one file.

To provide the recommendations, CSM must be connected through the Internet to the cisco.com domain.CSM is designed to connect multiple devices and provides SMUs and SPs management for multiple CiscoIOS XR platforms and releases.

Cisco Software Manager User Guide1OL-29903-02

https://www.cisco.com/c/en/us/td/docs/routers/asr9000/software/smu/b-csm-install-guide.html

https://www.cisco.com/c/en/us/td/docs/routers/asr9000/software/smu/b-csm-install-guide.html

CSM is a standalone Java application that can be installed on Windows, Mac OS, or UNIX. CSM supportsCisco Carrier Routing System and Cisco ASR 9000 Series Aggregation Services Routers.

Changes to this DocumentTable-1 lists the technical changes made to this document since it was first printed.

Table 1: Changes to This Document

Change SummaryDateRevision

Republished with documentation updates for CSMversion 2.0:

• Support for service packs was introduced.• Watch List tab was introduced.• Proxy settings in Set Up dialog box wasintroduced.

• Download SMUs or SPs option was introduced.• Transfer files option was introduced.

March 2014OL-29903-02

Initial release.May 2013OL-29903-01

Installing CSMThis section explains system software requirements, pre-requisites, and software installation procedures onWindows, Mac OS, and UNIX for CSM.

To download CSM, click CSM.

System Software RequirementsThis table lists system software requirements for installing CSM:

Table 2: System Software Requirements

NotesRequirementsArea

Use the latest patch or Service Pack releasedby the OS vendor. Check with the vendor forthe latest patch or Service Pack.

• Windows

• Mac OS

• UNIX

Operating System

To download JRE, click here.• JRE 1.6• JRE 1.7

Java Runtime Environment

Cisco Software Manager User GuideOL-29903-022

Cisco Software Manager User GuideChanges to this Document

http://software.cisco.com/download/release.html?mdfid=282414851&flowid=2137&softwareid=284777134&release=1.0&relind=AVAILABLE&rellifecycle=&reltype=latest

http://www.oracle.com/technetwork/java/javase/downloads/index.html

Pre-RequisitesThe installation script (SetupCSM.cmd for Windows or SetupCSM.sh for UNIX and Mac OS) requires JREto be in the search path. If JRE is not present in the search path, users can invoke the installer using the directpath. For installation steps, see Installing CSM on Windows, on page 4, Installing CSM on Mac OS, onpage 5, or Installing CSM on UNIX, on page 6.

This section lists steps that must be executed to include JRE in the search path on the Windows system:

Procedure

Step 1 Users onWindows 7 system, openControl Panel>System and Security>System>Advanced System Settingsand users on Windows XP, open Control Panel>System>Advanced System Settings.

Step 2 In the System Properties window, click Environment Variables.Step 3 In the System Variables section, select Path and click Edit.Step 4 Append C:\Program Files\java\jre6\bin to the Variable Value field.Step 5 Click OK.

JRE is included in the search path.

Software Installation ProceduresThis section explains CSM installation procedures on Windows, Mac OS and UNIX.

This flow chart shows installing CSM procedure:


Cisco Software Manager User GuidePre-Requisites

Figure 1: Installing CSM Flowchart

Installing CSM on Windows

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).


Cisco Software Manager User GuideInstalling CSM on Windows

http://software.cisco.com/download/release.html?mdfid=282414851&softwareid=284777134&release=2.0&relind=AVAILABLE&rellifecycle=&reltype=latest

Step 3 Double-click the file, SetupCSM.cmd.

CSM begins to install.

A shortcut that launches CSM is created on the desktop.

If the JRE is not made available in the search path, users must include it in the search path:double-click SetupCSM.cmd, or execute the “<JREDir>\bin\java" -jar installer.jar command at thecommand prompt. The execution of the "<JREDir>\bin\java" -jar installer.jar command should bedone in the directory where the user has unzipped the installation file content. The user needs toopen a DOS window and change over to that directory. JREDir is the location at which JRE ispresent; forWindows 7 this is C:\Program Files (x86)\java\jre6 and forWindows XP it is C:\ProgramFiles\java\jre6.

Note

Step 4 Double-click the CSM icon on the desktop to launch CSM.

What to do next

When upgrading the application from CSM-1.0 version, users need to manually copy LoginInformation.xmlfile which has device profiles, stored at the location \Users\<username>\csm\versions\1.0 to the correspondinglocation for CSM-2.0 version \Users\<username>\csm\versions\2.0, CSM-2.0 to access device profiles.

Installing CSM on Mac OS

Procedure

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.

A CSM-<version number> 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 at the terminal window to run the installation script:

• chmod 777 SetupCSM.sh

• ./SetupCSM.sh

CSM begins to install. A shortcut that launches CSM is created on the desktop.

If the JRE is not made available in the search path, users must invoke java (JVM) directly using thefull path: /usr/bin/java -jar installer.jar to include the JRE in the search path.

Note

Step 5 Double-click CSM icon on the desktop to launch the CSM application.


Cisco Software Manager User GuideInstalling CSM on Mac OS


What to do next

When upgrading the application from CSM-1.0 version, users need to manually copy LoginInformation.xmlfile which has device profiles, stored at the location (base directory)/csm/versions/1.0 to the correspondinglocation for CSM-2.0 version (base directory)/csm/versions/2.0, CSM-2.0 to access device profiles. A basedirectory is the directory where the user has installed CSM.

Installing CSM on UNIX

Procedure

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-<version>.zip. , at the newly created folder.

Example:

unzip CSM-2.0.zip

c) Change to the directory to the location where you have extracted the zip file.d) Run the installation script:

• chmod 777 SetupCSM.sh• ./SetupCSM.sh

CSM begins to install.

If the JRE is not made available in the search path, users must invoke java (JVM) directly using thefull path: /usr/bin/java -jar installer.jar to include the JRE in the search path.

Note

Step 3 To launch CSM, execute one of these commands:

• /users/<username>/csm/bin/CSM2.0.cmd

• /users/<username>/CSM2.0

If CSM is installed in a location other than /users/<username>, use that specific directory locationwhile executing above commands.

Note

What to do next

When upgrading the application from CSM-1.0 version, users need to manually copy LoginInformation.xmlfile which has device profiles, stored at the location (base directory)/csm/versions/1.0 to the correspondinglocation for CSM-2.0 version (base directory)/csm/versions/2.0, CSM-2.0 to access device profiles. A basedirectory is the directory where the user has installed CSM.


Cisco Software Manager User GuideInstalling CSM on UNIX


CSM Icons and Monitor PaneThis section lists icons seen in CSM and describes the monitor pane tabs.

Icons and Their NamesThis table lists CSM icons and their names:

Table 3: Icons and Names

NamesIcons

Set Up

Task

Refresh

Import

Add Network Elements

Remove Network Elements

Monitor PaneThe Monitor pane contains three tabs:

• SMUs—Displays SMU information retrieved from cisco.com for a specific platform and release in theSMU table. SMUs that are already installed on the device are highlighted in green. SMUs that are notapplicable to the device are highlighted in gray. For example, a SMU may require the mpls pie, whichmay not be installed on the device. By default, CSM uses the Optimal filter option to display SMU entriesin 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 theSP table. The Service Packs tab is applicable only for Cisco ASR 9000 device, Release 4.3.2 and laterversions. The latest service pack is displayed at the top of the table. The existing service packs that aresuperseded by the latest service pack are displayed using a strike-through font.

• Watch List—Displays SMUs that are being tracked for a specific platform and release. The watch listallows the user to keep track of new SMUs that are released for a specific platform and release. Thedetails of the new SMUs are provided by the Cisco escalation team to the customer or user along withthe customer expected time of arrival (ETA). The Customer ETA date is a reference date and should notbe considered as the actual delivery date. To create a watch list, see Create a Watch List, on page 13.

Package Table—Displays the packages, SMUs and SPs that are currently present on the device in the bottomwindow 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 ontheir state in Active, Active Committed, Inactive, and Inactive Committed tabs.


Cisco Software Manager User GuideCSM Icons and Monitor Pane

This table describes the package states:

Table 4: Package States

DescriptionState

Packages that are not persistent across system reloads. To be persistentthe user needs to execute the install committed command on thepackages.

Active

Active packages that are persistent across system reloads.Active Committed

Packages that are committed and persistent across system reloads; but,deactivated currently.

Inactive

Packages that are neither active nor committed.Inactive Committed

The SMU, SP, and Package tables have a quick search filter. The filter accepts a string pattern and filters thedisplay list accordingly. The filter can be used to look for specific DDTS, SMUs or SPs within a specificfunctional area; for example, BGP. Turn off the filter if you suspect the SMU and SP list should have moreentries. 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. Users,too can manually refresh by clicking the Refresh icon to retrieve the updated SMU and SP information fromcisco.com. A manual refresh does not poll the latest package information from the device. To manually pollthe device, use the Refresh icon on the Network Elements pane.

Pre-Requisite for SMU RecommendationTo keep Cisco IOS XR software up-to-date CSM recommends SMUs and SPs. To enable CSM to provideSMU recommendations for Cisco Carrier Routing System and Cisco ASR 9000 Series Aggregation ServicesRouters, Release 4.2.x, 4.3.0 and 4.3.1, it is mandatory to install the SMU CSCug82278 on the device beforeany SMU installation.

Setting Up CSMAfter installing CSM, users must first set it up. Setting up involves specifying:

• the location on the system where SMUs are stored.

• the periodicity at which CSM queries cisco.com, to retrieve SMU information.

• the email account where email notifications are sent, when new SMUs are discovered.

• the proxy settings that enable CSM to connect to the Internet, when the system is behind a firewall.

Procedure

1. Launch CSM and click the Set Up icon on the main tool bar.

2. Define these attributes in the Set Up dialog box:


Cisco Software Manager User GuidePre-Requisite for SMU Recommendation

Repository Directory—Specify the location on the system where SMUs and SPs are stored. This isused to determine whether a particular SMU or SP is present at that location, or not. Depending on

•

whether a SMU or SP is present or not, CSM displays an appropriate graphical icon next to the SMUor SP entry. A tar file can be created only if SMUs or SPs are present in this location.

• Polling Interval—Specify how often CSMmust query cisco.com to retrieve SMU or SP information.Before querying, CSM first polls all connected devices for up-to-date package information.

• Email Notification Settings—Specify the email account where email notifications are sent when newSMUs or SPs are discovered. Use the Test Email Account Settings option to verify that the emaildelivery system is operational.

• Proxy Settings—Specify the HTTP Proxy and HTTPS Proxy from Proxy tab. The HTTP and HTTPSProxy are required only if your system is behind a firewall; CSM requires such settings to connectto the Internet.

Using CSMAfter setting up CSM, users can perform these tasks:

1. Retrieve and View SMUs or SP Information from cisco.com. See Retrieve SMUs or SPs Information, onpage 11.

2. Execute SMU or SP tasks. See Execute SMU or SP Tasks, on page 12

3. Create a Watch List. See Create a Watch List, on page 13

4. Obtain SMUs or SPs Recommendations. See Obtain SMUs or SPs Recommendations, on page 13. Afterobtaining SMU and SP recommendations from cisco.com, users can perform these tasks:

• Identify Superseded SMUs and SPs. See Identify Superseded SMUs and SPs, on page 19

• Create and Assign Custom Suggested File. See Create and Assign Custom Suggested File, on page19

• Generate Conformance report. See Generate the Conformance Report, on page 20

5. Obtain an Optimized SMU List. See Obtain an Optimized SMU List, on page 21.

This flowchart shows how to use CSM:


Cisco Software Manager User GuideUsing CSM

Figure 2: Using CSM Flowchart

Retrieve and View SMUs or SPs InformationBased on the selected platform and release version, CSM retrieves relevant SMUs from cisco.com. The usercan view, at the SMU tab the list of SMUs retrieved. Similarly, CSM retrieves relevant SPs from cisco.comand the user can view, at the Service Packs tab the list of SPs retrieved.


Cisco Software Manager User GuideRetrieve and View SMUs or SPs Information

Retrieve SMUs or SPs InformationThis is the procedure to retrieve SMUs and SPs information from cisco.com:

Procedure

Step 1 Launch CSM.Step 2 Click Open Tab and select Platform and Releases.

Platform and Releases tab appears in Monitor Pane.

Step 3 From Select a platform and release drop-down, select the desired platform and release version. SMUs andSPs details retrieved from cisco.com are displayed at their respective tabs.

• Service Packs are available only for Cisco ASR 9000 device, Release 4.3.2, or later versions.• If CSM fails to retrieve information, a highlight message in red is displayed. You must closethe Platforms and Releases tab and reopen the tab to reconnect to cisco.com. Click Open Taband select Platforms and Releases to reopen the tab.

Note

Step 4 In the SMUs tab or Service Packs tab, click the Filter (Optimal) button and choose an appropriate filter:

• Select the Optimal filter option to view only optimal SMUs or SPs. This option excludes all supersededSMUs or SPs that are not a pre-requisite for other SMUs or SPs.

• Select the ALL filter option to view all SMUs or SPs.

By default, the Optimal filter option is enabled.

View SMU or SP DetailsTo view details of a specific SMU or SP, click that SMU or SP row. A balloon tool tip that contains the SMUor SP information (pre-requisites, superseded, and superseded-by information) is displayed. To view informationof other related SMUs or SPs (pre-requisites, supersedes, and so on), click the SMU or SP hyperlink. Use theblue arrow icons to navigate through different SMU or SP details. To copy SMU or SP information, clickCopy to Clipboard icon (blue icon). You can annotate a SMU or SP by entering the information in theannotation field at the bottom of the tool tip.

To view SMU or SP DDTS information:

1. Click the DDTS hyperlink. The default browser is launched.

2. Enter the Cisco Authentication login details. The DDTS information from the Software Bug Toolkit website is displayed.

Select SMUs or SPsUse the check box on the table header to select or de-select all SMUs or SPs at a time. If all SMUs or SPslisted in the SMU or SP table are not selected, the check box is displayed as a clear rectangle. The check box


Cisco Software Manager User GuideRetrieve SMUs or SPs Information

is displayed as a filled rectangle if any SMU or SP is selected. If all SMUs or SPs are selected, the check boxdisplays a check mark.

Execute SMU or SP TasksActions that users can perform after retrieving SMUs or SPs from cisco.com are:

Download SMUs or SPs—Allows users to download SMUs or SPs from cisco.com. If a SMU or SP is missingfrom the repository directory, an orange exclamation icon appears.

To download SMUs or SPs, do the following:

1. In the SMUs tab or Service Packs tab, select the SMUs or SPs.

2. Click Tasks icon and select Download Selected SMUs or Download Selected Service Packs. If theselected SMUs or SPs exist in the repository directory, then user may choose to overwrite or skip existingSMUs or SPs.

3. Enter Cisco username and password, and then click Ok.

4. Accept the End User License Agreement and click Ok.

After the download is complete, the SMU or SP tar file is decompressed and placed in the repository directory.The tar file contains the SMU or SP and a readme file. To view the readme file, right-click on the SMU orSP entry and click .txt menu option. The SMUs or SPs list will refresh and indicate that the SMU or SP isnow 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 ifthe 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 would contain 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.The SMUs and SPs that are stored in the repository directory are indicated by a green check icon in theST (status) column.

2. In the SMUs tab or Service Packs tab, select the SMUs or SPs with the green check icon.

3. Click theTask icon and selectCreate TAR File. CSM alerts the user in case of any missing prerequisites.

View/Extract TAR File—Allows viewing of the contents of a TAR file and selectively extracts desiredSMUs or SPs. Click the Task icon and select View/Extract TAR File to perform this action.

Export SMU or SP Information—Allows the export of SMU or SP details of selected SMUs or SPs, orthose SMUs or SPs that are not installed on the device to an HTML file. To export SMU or SP details, do thefollowing:

1. Click the Task icon and select Export SMU Information or Export Service Pack Information.


Cisco Software Manager User GuideExecute SMU or SP Tasks

http://software.cisco.com/download/navigator.html

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 theComments column of the HTML file.

Create a Watch ListUsers can keep track of new SMUs that are released for a specific platform and release by means of a watchlist. A watch list contains SMUs that are tracked along with their expected time of arrival (ETA). The ETAdate is a reference date and should not be considered as the actual delivery date.

To create a watch list, do the following:

Procedure

Step 1 Launch CSM.Step 2 Click Open Tab and select Platform and Releases.

Platform and Releases tab appears in the Monitor Pane.

Step 3 From Select a platform and release drop-down, select the desired platform and release version.

Because the watch list items are tied to a platform and release, the user needs to select the desired platformand release.

Step 4 In the Watch List tab, enter the SMU ID or DDTS and click Add. An alert notification is displayed whenthe SMU entered in the watch list is available when CSM queries cisco.com to retrieve SMU informationduring the next polling interval. To delete a watch item, select the entry and click Delete icon on top rightcorner.

Obtain SMUs or SPs RecommendationsThe Cisco IOS XR software is constantly updated with software feature enhancements and bugs resolvedfrom earlier versions. To keep the Cisco IOSXR software up-to-date, CSM recommends software maintenanceupgrades (SMUs) and service packs (SPs).

To obtain SMU or SP recommendations for a specific platform and release, users must provide device packageinformation to CSM for that particular platform and release, using one of the following three sources:

• CLI Output , on page 14

• Import File, on page 14

• Connected Device, on page 14

CSMprocesses the information that is provided and displays the SMUs or SPs recommendations in theMonitorpane. For Monitor pane details, see Monitor Pane, on page 7.


Cisco Software Manager User GuideCreate a Watch List

CLI OutputTo provide the CLI output of the show install active summary command to CSM, use the CLI Source tab.

Procedure

Step 1 Launch CSM.Step 2 Click the Open Tab button on the main tool bar and select CLI Source. The CLI Source tab is displayed.Step 3 Enter the device name and copy-paste the complete show install active summary CLI output.Step 4 ClickNext. TheMonitor Pane is displayed. The name at theMonitor pane indicates the input source, platform,

and release number.

Whenever CSM discovers new SMUs or SPs from cisco.com, an alert message is displayed.

Import FileThe CLI Source tab is used to provide the show install active summary command output of only one device.To provide package and SMUs or SPs information of multiple devices at the same time, an external text filethat contains these details can be imported to CSM. To import an external text file, do the following:

Procedure

Step 1 Click the Import icon on the main tool bar.Step 2 Browse to select the external file and click Import. The external text file must be in the expected format as

outlined in the Import dialog box.

After the external text file is imported, names of the devices whose package information is present in theexternal file display as gray icons in the Network Elements pane.

Step 3 Click each device in the Network Elements pane to view the results in the Monitor Pane.

Connected DeviceTo provide package information through a connected device to CSM, connectivity must be established betweenthe device and the computer that hosts CSM. Before connecting, users must:

1. Verify device requirements. See Device Requirements, on page 15.

2. Verify mandatory configuration on the device for the required connection type. See Supported ConnectionTypes, on page 15.

3. Create Login profiles. See Creating Login Profiles, on page 16.

After the three listed conditions are met, the users can login to the device. See Login to Device, on page 16.


Cisco Software Manager User GuideCLI Output

When CSM is successfully connected to the device, it retrieves the package information and adds the connecteddevice into the Network Elements tree pane. Devices with the same platform and release are grouped underthe same sub-tree. Click each device in the Network Elements pane to view its results in the Monitor pane.The Package table is updated based on the selection of device. For Monitor pane details, see Monitor Pane,on page 7.

A connected device can be displayed in the Network Elements pane in either of these two colors—orange orblue. Orange indicates failure in establishing connection between CSM and the device. Blue indicates successfulconnection between CSM and the device.

If the device is in the discovering state for an extended period, the user must remove the device using theRemove Network Element icon and ensure xml agent tty is configured on the device before attempting tolog into the device again.

Note

Supported Connection TypesThe following table lists the connection types that CSM supports to establish connectivity to the device andthe mandatory configuration required on the device:

Table 5: Supported Connection Types

Mandatory Router ConfigurationConnection

telnet vrf default ipv4 server max-servers 20Telnet

ssh server

hostname <hostname>

domain name <domain>

SSHv1

ssh server v2SSHv2

Install crypto key on the router when the sshv1 or sshv2 connection is used.Note

Device RequirementsThis section lists the requirements for Cisco CRS and Cisco ASR 9000 routers to establish connectivity withCSM:

• 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.


Cisco Software Manager User GuideSupported Connection Types

Creating Login ProfilesUsers can create login profiles and save the login information in an XML file. During the consecutive loginsthat follow, CSM uses the information present in this XML file and allows the user to login without the needto re-enter the login details. The XML file (LoginInformation.xml) created is stored at the application directory(...\csm\versions\<latest version number> ) and can be shared with other users.

To create a login profile, carry out this Login creation procedure:

Procedure

Step 1 Launch CSM.Step 2 Click the Add Network Elements icon on the main tool bar. The Login dialog box is displayed.Step 3 Right-click Login Information and choose either Add New Device Group or Add New Device.

Add New Device Group creates a device group to which devices can be added later and Add New Deviceadds a device.

The attributes present in the Add New Device dialog box are:

• Connection Category—Choose IP if there is direct connectivity between the computer that hosts CSMand the device; otherwise, choose Scripted.

• Connection Type —Choose any one of these connection types: Telnet/SSHv1/SSHv2

• Device IP/Name—(Only IP connection category). Enter the device management IP address or the HostName.

• NodeName/Port—(Only Scripted connection category). Enter the intermediate server name or IP address.Enter the port number if the server does not use the default Tenet/SSH port number. Click “…” to addadditional script information. For more information on entering details in this field, refer to the LoginScript Steps, on page 17.

• Device Description—Description of the device.

Login to DeviceTo login to the device, carry out this procedure.

Procedure

Step 1 Launch CSM.Step 2 Click the Add Network Elements icon on the main tool bar.Step 3 Select the device from Login Information space and enter the login credentials that are defined for the device.

See Direct Login and Scripted Login, on page 17.Step 4 Click OK.


Cisco Software Manager User GuideCreating Login Profiles

Users can log into multiple devices simultaneously if they share the same username and password.To login to multiple devices, select multiple devices by using the <Ctrl> / <Shift> key, or selectthe entire device group in Login Information space.

Note

Direct Login and Scripted Login

The connection between the computer that hosts CSM and the device can be established in two ways:

• Direct Connection or Direct Login—The computer that hosts CSM is directly connected to the device.In this case, choose IP as the Connection Category in the Login Screen.

• Indirect Connection or Scripted Login—The computer that hosts CSM is connected to the device throughan intermediate server. In this case, choose Scripted as the Connection Category in the Login screen.

The attributes in the Login screen vary according to the choice of Connection Category (IP or Scripted).

Direct Login

When IP is chosen as the Connection Category, these attributes are displayed on the Login screen:

• Device User Name—Enter device user name.

• Device Password—Enter device password.

• Connection Type—Choose Telnet, SSHv1, or SSHv2.

• Device IP/Name—Enter device management IP address.

Scripted Login

When Scripted is chosen as the Connection Category, these attributes are displayed on the Login screen:

• Scripted User Name—Enter intermediate server username.

• Scripted Password—Enter intermediate server password.

• Device User Name—Enter device user name.

• Device Password—Enter device password.

• Connection Type—Choose Telnet, SSHv1, or SSHv2.

• Node Name/Port—Enter intermediate server name or IP. Choose "..." to add additional script information.Enter port number if the server does not use the default Tenet/SSH port number. For more information,see Login Script Steps, on page 17 .

• Device Description—Enter device description.

Login Script Steps

You enter additional script information in the Login Script Steps dialog box, while creating a login profile orwhile logging into the device.

The steps outlined in the Login Script Steps depict the manual login sequence:


Cisco Software Manager User GuideDirect Login and Scripted Login

1. CSM initiates communication with the intermediate server and waits for a prompted string returned bythe intermediate server in the Wait For data fields.

2. When the prompted string matches with the CSM'sWait For string that is login, Password, or intermediateserver prompt, then CSM responds by sending the data defined in the Send data field.

3. You can choose Scripted Username and Scripted Password as the intermediate server authentication fromthe 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 operating system (Windows,Mac OS, or UNIX) where CSM is installed.

The following are examples of entering additional script information in the Login Script Steps dialog box.The examples are based on the connection type (Telnet, SSHv1, or SSHv2) of the connection between thecomputer that hosts CSM and the intermediate server, and the connection type between the intermediate serverand the device.

Telnet to Telnet Scripted Login Example

Telnet to Telnet scripted login indicates that the connectivity type of both the connections: the connectionbetween the computer that hosts CSM and the intermediate server and the connection between the intermediateserver and the device is Telnet.

Table 6: Telnet —>Telnet Scripted Login

Scripted UsernameSend:login:Wait For:

Scripted PasswordSend:Password:Wait For:

telnet <device host name or ipaddress>

Send:intermediate server promptWait For:

Telnet to SSH Scripted Login Example

Telnet to SSH scripted login indicates that the connectivity type of the connection between the computer thathosts CSM and the intermediate server is Telnet, and the connectivity type of the connection between theintermediate server and the device is SSH.

Table 7: Telnet —>SSH Scripted Login


ssh -l <device username> <devicepassword>


<device password>Send:password:Wait For:

SSH to Telnet Scripted Login Example

SSH to Telnet scripted login indicates that the connectivity type of the connection between the computer thathosts CSM and the intermediate server is SSH, and the connectivity type of the connection between theintermediate server and the device is Telnet.

Table 8: SSH —>Telnet Scripted Login



Cisco Software Manager User GuideLogin Script Steps

telnet <device host name or ipaddress>


SSH to SSH Scripted Login Example

SSH to scripted login indicates that the connectivity type of both the connections: the connection between thecomputer that hosts CSM and the intermediate server and the connection between the intermediate server andthe device is SSH.

Table 9: SSH —>SSH Scripted Login


ssh -l <device username> <devicepassword>


<device password>Send:password:Wait For:

Identify Superseded SMUs and SPsBased on SMUs and SPs selected in the SMU and SPs table, CSM identifies any superseded SMUs and SPson the device and applies a strikethrough font for the display of the superseded SMU or SP names in thepackage table. The superseded SMUs or SPs can be removed and deactivated after the selected SMUs or SPsare activated.When the user clicks on the superseded SMU or SP, a balloon tooltip is displayedwith informationabout the superseded SMU or SP.

In addition, if a SMU or SP is superseded by existing SMUs or SPs on the device, its name too takes on thestrikethrough font effect. To identify the SMUs or SPs that are superseded by existing SMUs or SPs on thedevice, uncheck all the SMU or SPs entries on the SMU or SP table. The quickest way to uncheck all entriesis by unchecking the check box on the table column header.

Create and Assign Custom Suggested FileA pre-certified SMU list that is used to validate all devices or routers is referred to as Custom SuggestedSMUs. CSM allows users to create a file that contains Custom Suggested SMUs. Also, the user can assignan existing file (external text file) that contains SMUs required to validate the device. The custom-suggestedfile contains only SMU names. Each line in the file contains a name.

Procedure

Step 1 Launch CSM.Step 2 Obtain SMU recommendation using any one of these sources:

• CLI Output , on page 14.• Import File, on page 14.• Connected Device, on page 14.

The SMU recommendation is displayed at the SMU tab.

Step 3 Select the required SMUs from the SMU table.


Cisco Software Manager User GuideIdentify Superseded SMUs and SPs

Step 4 Click the Suggest button and choose one of these:

• Create Suggest File—The selected SMUs can be saved to an external text file. When the file is createdsuccessfully, CSM prompts the user to choose to assign this file for validating the device. Click Yes toassign or No to quit the action.

• Assign File to Suggest—Browse for an external text file that contains the required SMUs. The SMUdetails are displayed in the Assign File to Suggest dialog box. The assignment is saved and assigned tothis particular platform and release.

Step 5 Click the Suggest button and choose Enable Suggest. A green check mark is displayed against Suggest.

The Monitor pane is refreshed and the new list of suggested SMUs is displayed in the top window (SMUtable) and the bottom window (Package table) is refreshed accordingly.

By default, the Suggest button displays a red cross indicating that it is not enabled.Note

Generate the Conformance ReportThe conformance report contains information about the selected SMUs and their install statuses on the selecteddevices. Similarly, the conformance report contains information about the selected SPs and their install statuseson the selected devices. To generate the conformance report for SMUs or SPs, carry out this procedure:

Procedure

Step 1 Launch CSM.Step 2 Obtain SMU or SP recommendation using any one of these sources:

• CLI Output , on page 14.• Import File, on page 14.• Connected Device, on page 14.

The SMU or SP recommendation is displayed at 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 SPconformance 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 inthe report are tab delimited and can be pasted onto Microsoft Excel spreadsheet or other applications.

If there are multiple devices under the same platform and release sub-tree (on the Network Elementspane), the users can choose to run the conformance report against the current device or selecteddevices.

Note


Cisco Software Manager User GuideGenerate the Conformance Report

Obtain an Optimized SMU ListCSM can provide an optimized SMU list by identifying missing pre-requisites and superseded SMUs. Toobtain an optimized SMU list, carry out this procedure:

Procedure

Step 1 Launch CSM.Step 2 Click the Open Tab button on the main tool bar and select Optimize List. The Optimize List tab is displayed.Step 3 Provide the master SMU list using any one of the two options:

• Copy and paste the master SMU list and click Optimize.• Click Read from TAR to supply the SMU list using a tar file and click Optimize. The optimized list ofSMUs is obtained.

After the list is optimized, the users can perform these tasks:

• View Pre-requisite—Click the Pre-requisites button to view the pre-requisite relationships. ThePre-requisites button will be enabled only if there is any missing pre-requisite.

• Copy the list—Click the Copy button to copy the annotated list or the optimized list.

The Annotated list includes the tagging seen on the window.

The Optimized list includes all missing pre-requisites and excludes all superseded SMUs.

• Create a Suggest File—Click the Suggest button to use the optimized list for creating a Suggest file.

Uninstalling CSMThis section explains how to uninstall CSM:

• Windows—Navigate to the csm\uninstall folder and click the current version's uninstall command file(CSM<version>_uninstall.cmd).

• On Windows XP, the CSM folder is located at “C:\Documents and Settings\<username>”

• On Windows 7, the CSM folder is located at “C:\Users\<username>”

• Mac OS—Execute the /Users/<username>/csm/uninstall/CSM<version>_uninstall.sh command atthe terminal window.

• UNIX—Execute the rm –R csm at the terminal window.


Cisco Software Manager User GuideObtain an Optimized SMU List


Cisco Software Manager User GuideUninstalling CSM

THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS,INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND,EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.

THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITHTHE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY,CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.

The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB's public domain version ofthe UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.

NOTWITHSTANDING ANY OTHERWARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS" WITH ALL FAULTS.CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.

IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUTLIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERSHAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, networktopology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentionaland coincidental.

All printed copies and duplicate soft copies of this document are considered uncontrolled. See the current online version for the latest version.

Cisco has more than 200 offices worldwide. Addresses and phone numbers are listed on the Cisco website at www.cisco.com/go/offices.

Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL:https://www.cisco.com/c/en/us/about/legal/trademarks.html. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply apartnership relationship between Cisco and any other company. (1721R)

© 2013 Cisco Systems, Inc. All rights reserved.

https://www.cisco.com/c/en/us/about/legal/trademarks.html