Guest

Cisco ASR 9000 Series Aggregation Services Routers

Cisco Software Manager User Guide

  • Viewing Options

  • PDF (1.7 MB)
  • Feedback
Cisco Software Manager User Guide

Contents

Cisco Software Manager User Guide

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


Note


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

Introduction

Cisco 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 is a 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 Cisco IOS XR platforms and releases.

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

Changes to this Document

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

Table 1 Changes to This Document
Revision Date Change Summary

OL-29903-02

March 2014

Republished with documentation updates for CSM version 2.0:
  • Support for service packs was introduced.
  • Watch List tab was introduced.
  • Proxy settings in Set Up dialog box was introduced.
  • Download SMUs or SPs option was introduced.
  • Transfer files option was introduced.

OL-29903-01

May 2013

Initial release.

Installing CSM

This section explains system software requirements, pre-requisites, and software installation procedures on Windows, Mac OS, and UNIX for CSM.

To download CSM, click CSM.

System Software Requirements

This table lists system software requirements for installing CSM:

Table 2 System Software Requirements
Area Requirements Notes
Operating System
  • Windows
  • Mac OS
  • UNIX

Use the latest patch or Service Pack released by the OS vendor. Check with the vendor for the latest patch or Service Pack.

Java Runtime Environment
  • JRE 1.6
  • JRE 1.7

To download JRE, click here.

Pre-Requisites

The installation script (SetupCSM.cmd for Windows or SetupCSM.sh for UNIX and Mac OS) requires JRE to be in the search path. If JRE is not present in the search path, users can invoke the installer using the direct path. For installation steps, see Installing CSM on Windows, Installing CSM on Mac OS, or Installing CSM on UNIX.

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

Procedure
    Step 1   Users on Windows 7 system, open Control Panel>System and Security>System>Advanced System Settings and 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 Procedures

    This section explains CSM installation procedures on Windows, Mac OS and UNIX.

    This flow chart shows installing CSM procedure:

    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).
      Step 3   Double-click the file, SetupCSM.cmd.

      CSM begins to install.

      A shortcut that launches CSM is created on the desktop.

      Note   

      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 the command prompt. The execution of the "<JREDir>\bin\java" -jar installer.jar command should be done in the directory where the user has unzipped the installation file content. The user needs to open a DOS window and change over to that directory. JREDir is the location at which JRE is present; for Windows 7 this is C:\Program Files (x86)\java\jre6 and for Windows XP it is C:\Program Files\java\jre6.

      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.xml file which has device profiles, stored at the location \Users\<username>\csm\versions\1.0 to the corresponding location 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.

        Note   

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

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

        What to Do Next

        When upgrading the application from CSM-1.0 version, users need to manually copy LoginInformation.xml file which has device profiles, stored at the location (base directory)/csm/versions/1.0 to the corresponding location for CSM-2.0 version (base directory)/csm/versions/2.0, CSM-2.0 to access device profiles. A base directory 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:
          1. Create a new folder.

            Example: mkdir newfolder
          2. Unzip the file, CSM-<version>.zip. , at the newly created folder.

            Example:unzip CSM-2.0.zip
          3. Change to the directory to the location where you have extracted the zip file.
          4. Run the installation script:
            • chmod 777 SetupCSM.sh
            • ./SetupCSM.sh

          CSM begins to install.

          Note   

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

          Step 3   To launch CSM, execute one of these commands:
          • /users/<username>/csm/bin/CSM2.0.cmd
          • /users/<username>/CSM2.0
          Note    If CSM is installed in a location other than /users/<username>, use that specific directory location while executing above commands.

          What to Do Next

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

          CSM Icons and Monitor Pane

          This section lists icons seen in CSM and describes the monitor pane tabs.

          Icons and Their Names

          This table lists CSM icons and their names:
          Table 3 Icons and Names
          Icons Names

          Set Up

          Task

          Refresh

          Import

          Add Network Elements

          Remove Network Elements

          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 may not be installed on the device. By default, CSM 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 are displayed using a strike-through font.
          • Watch List—Displays SMUs that are being tracked for a specific platform and release. The watch list allows the user to keep track of new SMUs that are released for a specific platform and release. The details of the new SMUs are provided by the Cisco escalation team to the customer or user along with the customer expected time of arrival (ETA). The Customer ETA date is a reference date 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:

          Table 4 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.

          Inactive Committed

          Packages that are neither active nor committed.

          The SMU, SP, and Package tables have a quick search filter. The filter accepts a string pattern and filters the display list accordingly. The filter can be used to look for 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. Users, too 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.

          Pre-Requisite for SMU Recommendation

          To keep Cisco IOS XR software up-to-date CSM recommends SMUs and SPs. To enable CSM to provide SMU recommendations for Cisco Carrier Routing System and Cisco ASR 9000 Series Aggregation Services Routers, Release 4.2.x, 4.3.0 and 4.3.1, it is mandatory to install the SMU CSCug82278 on the device before any SMU installation.

          Setting Up CSM

          After 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:
            • Repository Directory—Specify the location on the system where SMUs and SPs are stored. This is used 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 SMU or SP entry. A tar file can be created only if SMUs or SPs are present in this location.
            • Polling Interval—Specify how often CSM must 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 new SMUs or SPs are discovered. Use the Test Email Account Settings option to verify that the email delivery system is operational.
            • Proxy Settings—Specify the HTTP Proxy and HTTPS Proxy from Proxy tab. The HTTP and HTTPS Proxy are required only if your system is behind a firewall; CSM requires such settings to connect to the Internet.

          Using CSM

          After 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.
          2. Execute SMU or SP tasks. See Execute SMU or SP Tasks
          3. Create a Watch List. See Create a Watch List
          4. Obtain SMUs or SPs Recommendations. See Obtain SMUs or SPs Recommendations. After obtaining SMU and SP recommendations from cisco.com, users can perform these tasks:
          5. Obtain an Optimized SMU List. See Obtain an Optimized SMU List.

          This flowchart shows how to use CSM:

          Figure 2. Using CSM Flowchart

          Retrieve and View SMUs or SPs Information

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

          Retrieve SMUs or SPs Information

          This 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 and SPs details retrieved from cisco.com are displayed at their respective tabs.
            Note   
            • 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 close the Platforms and Releases tab and reopen the tab to reconnect to cisco.com. Click Open Tab and select Platforms and Releases to reopen the tab.
            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 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.

            By default, the Optimal filter option is enabled.


            View SMU or SP Details

            To view details of a specific SMU or SP, click that SMU or SP row. A balloon tool tip that contains the SMU or SP information (pre-requisites, superseded, and superseded-by information) is displayed. To view information of other related SMUs or SPs (pre-requisites, supersedes, and so on), click the SMU or SP hyperlink. Use the blue arrow icons to navigate through different SMU or SP details. To copy SMU or SP information, click Copy to Clipboard icon (blue icon). You can annotate a SMU or SP by entering the information in the annotation 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 web site is displayed.

            Select SMUs or SPs

            Use the check box on the table header to select or de-select all SMUs or SPs at a time. If all SMUs or SPs listed in the SMU or SP table are not selected, the check box is displayed as a clear rectangle. The check box is displayed as a filled rectangle if any SMU or SP is selected. If all SMUs or SPs are selected, the check box displays a check mark.

            Execute SMU or SP Tasks

            Actions 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 missing from 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 the selected SMUs or SPs exist in the repository directory, then user may choose to overwrite or skip existing SMUs 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 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 the 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 the ST (status) column.
            2. In the SMUs tab or Service Packs tab, select the SMUs or SPs with the green check icon.
            3. Click the Task icon and select Create 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 desired SMUs 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, or those SMUs or SPs that are not installed on the device to an HTML file. To export SMU or SP details, do the following:

            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.

            Create a Watch List

            Users can keep track of new SMUs that are released for a specific platform and release by means of a watch list. A watch list contains SMUs that are tracked along with their expected time of arrival (ETA). The ETA date 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 platform and release.

              Step 4   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 is available when CSM queries cisco.com to retrieve SMU information during the next polling interval. To delete a watch item, select the entry and click Delete icon on top right corner.

              Obtain SMUs or SPs Recommendations

              The Cisco IOS XR software is constantly updated with software feature enhancements and bugs resolved from earlier versions. To keep the Cisco IOS XR software up-to-date, CSM recommends software maintenance upgrades (SMUs) and service packs (SPs).

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

              CSM processes the information that is provided and displays the SMUs or SPs recommendations in the Monitor pane. For Monitor pane details, see Monitor Pane.

              CLI Output

              To 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   Click Next. The Monitor Pane is displayed. The name at the Monitor 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 File

                The 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 file that 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 the external 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 Device

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

                  1. Verify device requirements. See Device Requirements.
                  2. Verify mandatory configuration on the device for the required connection type. See Supported Connection Types.
                  3. Create Login profiles. See Creating Login Profiles.

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

                  When CSM 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. 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.

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


                  Note


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


                  Supported Connection Types

                  The following table lists the connection types that CSM supports to establish connectivity to the device and the mandatory configuration required on the device:

                  Table 5 Supported Connection Types
                  Connection Mandatory Router Configuration
                  Telnet telnet vrf default ipv4 server max-servers 20
                  SSHv1

                  ssh server

                  hostname <hostname>

                  domain name <domain>

                  SSHv2 ssh server v2

                  Note


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

                  Device Requirements

                  This section lists the requirements for Cisco CRS and Cisco ASR 9000 routers to establish connectivity with CSM:
                  • 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.

                  Creating Login Profiles

                  Users can create login profiles and save the login information in an XML file. During the consecutive logins that follow, CSM uses the information present in this XML file and allows the user to login without the need to 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 Device adds 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 CSM and 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 Host Name.
                    • Node Name/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 add additional script information. For more information on entering details in this field, refer to the Login Script Steps.
                    • Device Description—Description of the device.

                    Login to Device

                    To 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.
                      Step 4   Click OK.

                      Note   

                      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 select the entire device group in Login Information space.


                      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 through an 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 .
                      • 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 or while logging into the device.

                      The steps outlined in the Login Script Steps depict the manual login sequence:
                      1. CSM initiates communication with the intermediate server and waits for a prompted string returned by the intermediate server in the Wait For data fields.
                      2. When the prompted string matches with the CSM's Wait For string that is login, Password, or intermediate server 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 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 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 the computer that hosts CSM and the intermediate server, and the connection type between the intermediate server and the device.

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

                      Table 6 Telnet —>Telnet Scripted Login
                      Wait For: login: Send: Scripted Username
                      Wait For: Password: Send: Scripted Password
                      Wait For: intermediate server prompt Send: telnet <device host name or ip address>
                      Telnet to SSH Scripted Login Example
                      Telnet to SSH scripted login indicates that the connectivity type of the connection between the computer that hosts CSM and the intermediate server is Telnet, and the connectivity type of the connection between the intermediate server and the device is SSH.

                      Table 7 Telnet —>SSH Scripted Login
                      Wait For: login: Send: Scripted Username
                      Wait For: intermediate server prompt Send: ssh -l <device username> <device password>
                      Wait For: password: Send: <device password>
                      SSH to Telnet Scripted Login Example
                      SSH to Telnet scripted login indicates that the connectivity type of the connection between the computer that hosts CSM and the intermediate server is SSH, and the connectivity type of the connection between the intermediate server and the device is Telnet.

                      Table 8 SSH —>Telnet Scripted Login
                      Wait For: login: Send: Scripted Username
                      Wait For: intermediate server prompt Send: telnet <device host name or ip address>
                      SSH to SSH Scripted Login Example
                      SSH to scripted login indicates that the connectivity type of both the connections: the connection between the computer that hosts CSM and the intermediate server and the connection between the intermediate server and the device is SSH.

                      Table 9 SSH —>SSH Scripted Login
                      Wait For: login: Send: Scripted Username
                      Wait For: intermediate server prompt Send: ssh -l <device username> <device password>
                      Wait For: password: Send: <device password>

                      Identify Superseded SMUs and SPs

                      Based on SMUs and SPs selected in the SMU and SPs table, CSM identifies any superseded SMUs and SPs on the device and applies a strikethrough font for the display of the superseded SMU or SP names in the package table. The superseded SMUs or SPs can be removed and deactivated after the selected SMUs or SPs are activated. When the user clicks on the superseded SMU or SP, a balloon tooltip is displayed with information about 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 the strikethrough font effect. To identify the SMUs or SPs that are superseded by existing SMUs or SPs on the device, uncheck all the SMU or SPs entries on the SMU or SP table. The quickest way to uncheck all entries is by unchecking the check box on the table column header.

                      Create and Assign Custom Suggested File

                      A pre-certified SMU list that is used to validate all devices or routers is referred to as Custom Suggested SMUs. CSM allows users to create a file that contains Custom Suggested SMUs. Also, the user can assign an existing file (external text file) that contains SMUs required to validate the device. The custom-suggested file 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:

                        The SMU recommendation is displayed at the SMU tab.

                        Step 3   Select the required SMUs from the SMU table.
                        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 created successfully, CSM prompts the user to choose to assign this file for validating the device. Click Yes to assign or No to quit the action.
                        • 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 check 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 indicating that it is not enabled.


                        Generate the Conformance Report

                        The conformance report contains information about the selected SMUs and their install statuses on the selected devices. Similarly, the conformance report contains information about the selected SPs and their install statuses on 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:

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


                          Obtain an Optimized SMU List

                          CSM can provide an optimized SMU list by identifying missing pre-requisites and superseded SMUs. To obtain 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 of SMUs 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. The Pre-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 CSM

                            This 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 at the terminal window.
                            • UNIX—Execute the rm –R csm at the terminal window.