Cisco UCS B-Series CLI Firmware Management Guide, Release 2.1
Managing the Capability Catalog in Cisco UCS Manager
Downloads: This chapterpdf (PDF - 1.33MB) The complete bookPDF (PDF - 2.89MB) | The complete bookePub (ePub - 282.0KB) | Feedback

Managing the Capability Catalog in Cisco UCS Manager

Managing the Capability Catalog in Cisco UCS Manager

This chapter includes the following sections:

Capability Catalog

The Capability Catalog is a set of tunable parameters, strings, and rules. Cisco UCS uses the catalog to update the display and configurability of components such as newly qualified DIMMs and disk drives for servers.

The catalog is divided by hardware components, such as the chassis, CPU, local disk, and I/O module. You can use the catalog to view the list of providers available for that component. There is one provider per hardware component. Each provider is identified by the vendor, model (PID), and revision. For each provider, you can also view details of the equipment manufacturer and the form factor.

For information about which hardware components are dependent upon a particular catalog release, see the component support tables in the Service Notes for the B- Series servers. For information about which components are introduced in a specific release, see the Cisco UCS Release Notes.

Contents of the Capability Catalog

The contents of the Capability Catalog include the following:

Implementation-Specific Tunable Parameters
  • Power and thermal constraints
  • Slot ranges and numbering
  • Adapter capacities
Hardware-Specific Rules
  • Firmware compatibility for components such as the BIOS, CIMC, RAID controller, and adapters
  • Diagnostics
  • Hardware-specific reboot
User Display Strings
  • Part numbers, such as the CPN, PID/VID
  • Component descriptions
  • Physical layout/dimensions
  • OEM information

Updates to the Capability Catalog

Capability Catalog updates are included in each Cisco UCS Infrastructure Software Bundle. Unless otherwise instructed by Cisco TAC, you only need to activate the Capability Catalog update after you've downloaded, updated, and activated a Cisco UCS Infrastructure Software Bundle.

As soon as you activate a Capability Catalog update, Cisco UCS immediately updates to the new baseline catalog. You do not have to perform any further tasks. Updates to the Capability Catalog do not require you to reboot or reinstall any component in a Cisco UCS domain.

Each Cisco UCS Infrastructure Software Bundle contains a baseline catalog. In rare circumstances, Cisco releases an update to the Capability Catalog between Cisco UCS releases and makes it available on the same site where you download firmware images.


Note


The Capability Catalog version is determined by the version of Cisco UCS that you are using. For example, Cisco UCS 2.0 releases work with any 2.0 release of the Capability Catalog, but not with 1.0 releases of the Capability Catalog. For information about Capability Catalog releases supported by specific Cisco UCS releases, see the Release Notes for Cisco UCS Software accessible through the Cisco UCS B-Series Servers Documentation Roadmap available at the following URL: http:/​/​www.cisco.com/​go/​unifiedcomputing/​b-series-doc.


Activating a Capability Catalog Update

Procedure
     Command or ActionPurpose
    Step 1 UCS-A# scope system  

    Enters system mode.

     
    Step 2 UCS-A /system # scope capability  

    Enters system capability mode.

     
    Step 3 UCS-A /system/capability # activate firmware firmware-version  

    Activates the specified Capability Catalog version.

     
    Step 4 UCS-A /system/capability # commit-buffer  

    Commits the transaction to the system configuration.

     

    The following example activates a Capability Catalog update and commits the transaction:

    UCS-A# scope system
    UCS-A /system # scope capability
    UCS-A /system/capability # activate firmware 1.0(3)
    UCS-A /system/capability* # commit-buffer
    UCS-A /system/capability # 

    Verifying that the Capability Catalog is Current

    Procedure
       Command or ActionPurpose
      Step 1 UCS-A# scope system  

      Enters system mode.

       
      Step 2 UCS-A /system # scope capability  

      Enters system capability mode.

       
      Step 3 UCS-A /system/capability # show version  

      Displays the current Capability Catalog version.

       
      Step 4On Cisco.com, determine the most recent release of the Capability Catalog available. 

      For more information about the location of Capability Catalog updates, see Obtaining Capability Catalog Updates from Cisco.

       
      Step 5If a more recent version of the Capability Catalog is available on Cisco.com, update the Capability Catalog with that version.   
      The following example displays the current Capability Catalog version:
      UCS-A# scope system
      UCS-A /system # scope capability
      UCS-A /system/capability # show version
      Catalog:
          Running-Vers: 1.0(8.35)
          Activate-Status: Ready
      UCS-A /system/capability #
      

      Restarting a Capability Catalog Update

      You can restart a failed Capability Catalog file update, modifying the update parameters if necessary.

      Procedure
         Command or ActionPurpose
        Step 1UCS-A# scope system  

        Enters system command mode.

         
        Step 2UCS-A /system # scope capability  

        Enters capability command mode.

         
        Step 3UCS-A /system/capability # show cat-updater filename  

        (Optional) Displays the update history for Capability Catalog file update operations.

         
        Step 4UCS-A /system/capability # scope cat-updater filename  

        Enters the command mode for the Capability Catalog file update operation.

         
        Step 5UCS-A /system/capability/cat-updater # set userid username  

        (Optional) Specifies the username for the remote server.

         
        Step 6UCS-A /system/capability/cat-updater # set password password  

        (Optional) Specifies the password for the remote server username.

        If no password is configured, you are prompted for a password when you start the update.

         
        Step 7UCS-A /system/capability/cat-updater # set protocol {ftp | scp | sftp | tftp}  

        (Optional) Specifies the file transfer protocol for the remote server.

        Note   

        TFTP has a file size limitation of 32 MB. Because catalog images can be much larger than that, we recommend that you do not use TFTP for catalog image downloads.

         
        Step 8UCS-A /system/capability/cat-updater # set server {hostname | ip-address}  

        (Optional) Specifies the hostname or IP address of the remote server.

         
        Step 9UCS-A /system/capability/cat-updater # set path pathname/filename  

        (Optional) Specifies the path and file name of the Capability Catalog file on the remote server.

         
        Step 10UCS-A /system/capability/cat-updater # restart  

        Restarts the Capability Catalog file update operation.

         

        The following example changes the server IP address and restarts the Capability Catalog file update operation:

        UCS-A# scope system
        UCS-A /system # scope capability
        UCS-A /system/capability # show cat-updater 
        
        Catalog Updater:
            File Name Protocol Server          Userid          Status
            --------- -------- --------------- --------------- ------
            ucs-catalog.1.0.0.4.bin
                      Scp      192.0.2.111     user1           Failed
        
        UCS-A /system/capability # scope cat-updater ucs-catalog.1.0.0.4.bin 
        UCS-A /system/capability/cat-updater # set server 192.0.2.112
        UCS-A /system/capability/cat-updater # restart
        UCS-A /system/capability/cat-updater # 
        

        Viewing a Capability Catalog Provider

        Procedure
           Command or ActionPurpose
          Step 1UCS-A# scope system  

          Enters system command mode.

           
          Step 2UCS-A /system # scope capability  

          Enters capability command mode.

           
          Step 3UCS-A /system/capability # show {chassis | cpu | disk | fan | fru | iom | memory | psu | server} [vendor model revision] [detail | expand]  

          Displays vendor, model, and revision information for all components in the specified component category.

          To view manufacturing and form factor details for a specific component, specify the vendor , model , and revision with the expand keyword. If any of these fields contains spaces, you must enclose the field with quotation marks.

           


          Note


          If the server contains one or more SATA devices, such as a hard disk drive or solid state drive, the show disk command displays ATA in the Vendor field. Use the expand keyword to display additional vendor information.


          The following example lists the installed fans and displays detailed information from the Capability Catalog about a specific fan:

          UCS-A# scope system
          UCS-A /system # scope capability
          UCS-A /system/capability # show fan
          
          Fan Module:
              Vendor                   Model                    Revision
              ------------------------ ------------------------ --------
              Cisco Systems, Inc.      N10-FAN1                 0
              Cisco Systems, Inc.      N10-FAN2                 0
              Cisco Systems, Inc.      N20-FAN5                 0
          
          UCS-A /system/capability # show fan "Cisco Systems, Inc." N10-FAN1 0 expand
          
          Fan Module:
              Vendor: Cisco Systems, Inc.
              Model: N10-FAN1
              Revision: 0
          
              Equipment Manufacturing:
                  Name: Fan Module for UCS 6140 Fabric Interconnect
                  PID: N10-FAN1
                  VID: NA
                  Caption: Fan Module for UCS 6140 Fabric Interconnect
                  Part Number: N10-FAN1
                  SKU: N10-FAN1
                  CLEI:
                  Equipment Type:
          
              Form Factor:
                  Depth (C): 6.700000
                  Height (C): 1.600000
                  Width (C): 4.900000
                  Weight (C): 1.500000
          
          UCS-A /system/capability # 
          

          Downloading Individual Capability Catalog Updates

          Obtaining Capability Catalog Updates from Cisco

          Procedure
            Step 1   In a web browser, navigate to Cisco.com.
            Step 2   Under Support, click All Downloads.
            Step 3   In the center pane, click Unified Computing and Servers.
            Step 4   If prompted, enter your Cisco.com username and password to log in.
            Step 5   In the right pane, click Cisco UCS Infrastructure and UCS Manager Software > Unified Computing System (UCS) Manager Capability Catalog.
            Step 6   Click the link for the latest release of the Capability Catalog.
            Step 7   Click one of the following buttons and follow the instructions provided:
            • Download Now—Allows you to download the catalog update immediately
            • Add to Cart—Adds the catalog update to your cart to be downloaded at a later time
            Step 8   Follow the prompts to complete your download of the catalog update.

            What to Do Next

            Update the Capability Catalog.

            Updating the Capability Catalog from a Remote Location

            You cannot perform a partial update to the Capability Catalog. When you update the Capability Catalog, all components included in the catalog image are updated.

            Procedure
               Command or ActionPurpose
              Step 1UCS-A# scope system  

              Enters system command mode.

               
              Step 2UCS-A /system # scope capability  

              Enters capability command mode.

               
              Step 3UCS-A /system/capability # update catalog URL  

              Imports and applies the specified Capability Catalog file. Specify the URL for the operation using one of the following syntax:

              • ftp:// username@hostname / path
              • scp:// username@hostname / path
              • sftp:// username@hostname / path
              • tftp:// hostname : port-num / path

              When a username is specified, you are prompted for a password.

               
              Step 4UCS-A /system/capability # show version  

              (Optional) Displays the catalog update version.

               
              Step 5UCS-A /system/capability # show cat-updater filename  

              (Optional) Displays the update history for a Capability Catalog file, if specified, or for all Capability Catalog file update operations.

               

              Cisco UCS Manager downloads the image and updates the Capability Catalog. You do not need to reboot any hardware components.

              The following example uses SCP to import a Capability Catalog file:

              UCS-A# scope system
              UCS-A /system # scope capability
              UCS-A /system/capability # update catalog scp://user1@192.0.2.111/catalogs/ucs-catalog.1.0.0.4.bin
              Password: 
              UCS-A /system/capability # show version
              Catalog:
                  Update Version: 1.0(0.4)
              
              UCS-A /system/capability # show cat-updater 
              
              Catalog Updater:
                  File Name Protocol Server          Userid          Status
                  --------- -------- --------------- --------------- ------
                  ucs-catalog.1.0.0.4.bin
                            Scp      192.0.2.111     user1           Success
              
              UCS-A /system/capability #