Contents

Unique Device Identifier Retrieval

The Unique Device Identifier Retrieval feature provides the ability to retrieve and display the Unique Device Identifier (UDI) information from any Cisco product that has electronically stored such identity information.

History for Unique Device Identifier Retrieval Feature

Release

Modification

12.3(4)T

This feature was introduced.

12.0(27)S

This feature was integrated into Cisco IOS Release 12.0(27)S.

12.2(25)S

This feature was integrated into Cisco IOS Release 12.2(25)S.

12.2(27)SBC

This feature was integrated into Cisco IOS Release 12.2(27)SBC.

12.2(18)SXE5

This feature was integrated into Cisco IOS Release 12.2(18)SXE5.

Software images for Cisco 12000 series Internet routers have been deferred to Cisco IOS Release 12.0(27)S1.

Finding Support Information for Platforms and Cisco IOS Software Images

Use Cisco Feature Navigator to find information about platform support and Cisco IOS software image support. Access Cisco Feature Navigator at http:/​/​www.cisco.com/​go/​fn . You must have an account on Cisco.com. If you do not have an account or have forgotten your username or password, click Cancel at the login dialog box and follow the instructions that appear.

Prerequisites for Unique Device Identifier Retrieval

In order to use UDI retrieval, the Cisco product in use must be UDI-enabled. A UDI-enabled Cisco product supports five required Entity MIB objects. The five Entity MIB v2 (RFC-2737) objects are as follows:

  • entPhysicalName

  • entPhysicalDescr

  • entPhysicalModelName

  • entPhysicalHardwareRev

  • entPhysicalSerialNum

Although the showinventory command may be available, using that command on devices that are not UDI-enabled will likely produce no output.

Information About Unique Device Identifier Retrieval

Unique Device Identifier Overview

Each identifiable product is an entity, as defined by the Entity MIB (RFC-2737) and its supporting documents. Some entities, such as a chassis, will have subentities like slots. An Ethernet switch might be a member of a superentity like a stack. Most Cisco entities that are orderable products will leave the factory with an assigned UDI. The UDI information is printed on a label that is affixed to the physical hardware device, and it is also stored electronically on the device in order to facilitate remote retrieval.

A UDI consists of the following elements:

  • Product identifier (PID)

  • Version identifier (VID)

  • Serial number (SN)

The PID is the name by which the product can be ordered; it has been historically called the “Product Name” or “Part Number.” This is the identifier that one would use to order an exact replacement part.

The VID is the version of the product. Whenever a product has been revised, the VID will be incremented. The VID is incremented according to a rigorous process derived from Telcordia GR-209-CORE, an industry guideline that governs product change notices.

The SN is the vendor-unique serialization of the product. Each manufactured product will carry a unique serial number assigned at the factory, which cannot be changed in the field. This is the means by which to identify an individual, specific instance of a product.

Benefits of the Unique Device Identifier Retrieval Feature

  • Identifies individual Cisco products in your networks.

  • Reduces operating expenses for asset management through simple, cross-platform, consistent identification of Cisco products.

  • Identifies PIDs for replaceable products.

  • Facilitates discovery of products subject to recall or revision.

  • Automates Cisco product inventory (capital and asset management).

  • Provides a mechanism to determine the entitlement level of a Cisco product for repair and replacement service.

How to Retrieve the Unique Device Identifier

Retrieving the Unique Device Identifier

Perform this task to retrieve and display identification information for a Cisco product.

SUMMARY STEPS

    1.    enable

    2.    show inventory [raw] [entity


DETAILED STEPS
    Step 1   enable

    Enters privileged EXEC mode. Enter your password if prompted.



    Example:
    Router> enable
    Step 2   show inventory [raw] [entity

    Enter theshowinventory command to retrieve and display information about all of the Cisco products installed in the networking device that are assigned a PID, VID, and SN. If a Cisco entity is not assigned a PID, that entity is not retrieved or displayed.



    Example:
    Router# show inventory
NAME: “Chassis”, DESCR: “12008/GRP chassis”
PID: GSR8/40           ,  VID: V01,  SN: 63915640
NAME: “slot 0”, DESCR: “GRP”
PID: GRP-B             ,  VID: V01,  SN: CAB021300R5
NAME: “slot 1”, DESCR: “4 port ATM OC3 multimode”
PID: 4OC3/ATM-MM-SC    ,  VID: V01,  SN: CAB04036GT1
NAME: “slot 3”, DESCR: “4 port 0C3 POS multimode”
PID: LC-4OC3/POS-MM    ,  VID: V01,  SN: CAB014900GU
NAME: “slot 5”, DESCR: “1 port Gigabit Ethernet”
PID: GE-GBIC-SC-B      ,  VID: V01,  SN: CAB034251NX
NAME: “slot 7”, DESCR: “GRP”
PID: GRP-B             ,  VID: V01,  SN: CAB0428AN4O
NAME: “slot 16”, DESCR: “GSR 12008 Clock Scheduler Card”
PID: GSR8-CSC/ALRM     ,  VID: V01,  SN: CAB0429AUYH
NAME: “sfslot 1”, DESCR: “GSR 12008 Switch Fabric Card”
PID: GSR8-SFC          ,  VID: V01,  SN: CAB0428ALOS
NAME: “sfslot 2”, DESCR: “GSR 12008 Switch Fabric Card”
PID: GSR8-SFC          ,  VID: V01,  SN: CAB0429AU0M
NAME: “sfslot 3”, DESCR: “GSR 12008 Switch Fabric Card”
PID: GSR8-SFC          ,  VID: V01,  SN: CAB0429ARD7
NAME: “PSslot 1”, DESCR: “GSR 12008 AC Power Supply”
PID: FWR-GSR8-AC-B     ,  VID: V01,  SN: CAB041999CW

    Enter theshowinventorycommand with an entity argument value to display the UDI information for a specific type of Cisco entity installed in the networking device. In this example, a list of Cisco entities that match the sfslot argument string is displayed.



    Example:
    Router# show inventory sfslot
NAME: “sfslot 1”, DESCR: “GSR 12008 Switch Fabric Card”
PID: GSR8-SFC          ,  VID: V01,  SN: CAB0428ALOS
NAME: “sfslot 2”, DESCR: “GSR 12008 Switch Fabric Card”
PID: GSR8-SFC          ,  VID: V01,  SN: CAB0429AU0M
NAME: “sfslot 3”, DESCR: “GSR 12008 Switch Fabric Card”
PID: GSR8-SFC          ,  VID: V01,  SN: CAB0429ARD7

    You can request even more specific UDI information using theshowinventorycommand with an entity argument value that is enclosed in quotation marks. In this example, only the details for the entity that exactly matches the sfslot 1 argument string are displayed.



    Example:
    Router# show inventory “sfslot 1”
NAME: “sfslot 1”, DESCR: “GSR 12008 Switch Fabric Card”
PID: GSR8-SFC          ,  VID: V01,  SN: CAB0428ALOS

    For diagnostic purposes, theshowinventorycommand can be used with the raw keyword to display every RFC 2737 entity including those without a PID, UDI, or other physical identification.

    Note   

    The raw keyword option is primarily intended for troubleshooting problems with the showinventory command itself.



    Example:
    Router# show inventory raw
NAME: “Chassis”, DESCR: “12008/GRP chassis”
PID:                   ,  VID: V01,  SN: 63915640
NAME: “slot 0”, DESCR: “GRP”
PID:                   ,  VID: V01,  SN: CAB021300R5
NAME: “slot 1”, DESCR: “4 port ATM OC3 multimode”
PID: 4OC3/ATM-MM-SC    ,  VID: V01,  SN: CAB04036GT1
NAME: “slot 3”, DESCR: “4 port 0C3 POS multimode”
PID: LC-4OC3/POS-MM    ,  VID: V01,  SN: CAB014900GU

    Enter theshowinventorycommand with the raw keyword and an entity argument value to display the UDI information for the Cisco entities that are installed in the networking device and that match the argument string, even if they do not contain an assigned PID.



    Example:
    Router# show inventory raw slot
NAME: “slot 0”, DESCR: “GRP”
PID:                  ,  VID: V01,  SN: CAB021300R5
NAME: “slot 1”, DESCR: “4 port ATM OC3 multimode”
PID: 4OC3/ATM-MM-SC    ,  VID: V01,  SN: CAB04036GT1
NAME: “slot 3”, DESCR: “4 port 0C3 POS multimode”
PID: LC-4OC3/POS-MM    ,  VID: V01,  SN: CAB014900GU

    Troubleshooting Tips

    If any of the Cisco products do not have an assigned PID, the output may display incorrect PIDs and the VID and SN elements may be missing, as in the following example.

    NAME: "Four Port High-Speed Serial", DESCR: "Four Port High-Speed Serial"
PID: Four Port High-Speed Serial, VID: 1.1, SN: 17202570   
NAME: "Serial1/0", DESCR: "M4T"
PID: M4T               , VID:    , SN:

    In the sample output, the PID is exactly the same as the product description. The UDI is designed for use with new Cisco products that have a PID assigned. UDI information on older Cisco products is not always reliable.

    Configuration Examples for Unique Device Identifier Retrieval

    There are no configuration examples for the UDI Retrieval feature. For sample display output from the show inventory command, see the “Retrieving the Unique Device Identifier” section.

    Additional References

    This section provides references related to the UDI Retrieval feature.

    Related Documents

    Related Topic

    Document Title

    Information about managing configuration files

    • Cisco IOS Configuration Fundamentals Configuration Guide, Release 12.0

    • Cisco IOS Configuration Fundamentals Configuration Guide, Release 12.2

    • Cisco IOS Configuration Fundamentals and Network Management Configuration Guide, Release 12.3

    Commands for showing interface statistics

    • Cisco IOS Interface Command Reference, Release 12.0

    • Cisco IOS Interface Command Reference, Release 12.2

    • Cisco IOS Interface and Hardware Component Command Reference, Release 12.3T

    Standards

    Standards

    Title

    No new or modified standards are supported by this feature, and support for existing standards has not been modified by this feature.

    --

    MIBs

    MIBs

    MIBs Link

    CISCO-ENTITY-ASSET-MIB

    To locate and download MIBs for selected platforms, Cisco IOS releases, and feature sets, use Cisco MIB Locator found at the following URL:

    http:/​/​www.cisco.com/​go/​mibs

    RFCs

    RFCs

    Title

    RFC 2737

    Entity MIB (Version 2)

    Technical Assistance

    Description

    Link

    The Cisco Technical Support website contains thousands of pages of searchable technical content, including links to products, technologies, solutions, technical tips, and tools. Registered Cisco.com users can log in from this page to access even more content.

    http:/​/​www.cisco.com/​techsupport

    Unique Device Identifier Retrieval

    Unique Device Identifier Retrieval

    The Unique Device Identifier Retrieval feature provides the ability to retrieve and display the Unique Device Identifier (UDI) information from any Cisco product that has electronically stored such identity information.

    History for Unique Device Identifier Retrieval Feature

    Release

    Modification

    12.3(4)T

    This feature was introduced.

    12.0(27)S

    This feature was integrated into Cisco IOS Release 12.0(27)S.

    12.2(25)S

    This feature was integrated into Cisco IOS Release 12.2(25)S.

    12.2(27)SBC

    This feature was integrated into Cisco IOS Release 12.2(27)SBC.

    12.2(18)SXE5

    This feature was integrated into Cisco IOS Release 12.2(18)SXE5.

    Software images for Cisco 12000 series Internet routers have been deferred to Cisco IOS Release 12.0(27)S1.

    Finding Support Information for Platforms and Cisco IOS Software Images

    Use Cisco Feature Navigator to find information about platform support and Cisco IOS software image support. Access Cisco Feature Navigator at http:/​/​www.cisco.com/​go/​fn . You must have an account on Cisco.com. If you do not have an account or have forgotten your username or password, click Cancel at the login dialog box and follow the instructions that appear.

    Prerequisites for Unique Device Identifier Retrieval

    In order to use UDI retrieval, the Cisco product in use must be UDI-enabled. A UDI-enabled Cisco product supports five required Entity MIB objects. The five Entity MIB v2 (RFC-2737) objects are as follows:

    • entPhysicalName

    • entPhysicalDescr

    • entPhysicalModelName

    • entPhysicalHardwareRev

    • entPhysicalSerialNum

    Although the showinventory command may be available, using that command on devices that are not UDI-enabled will likely produce no output.

    Information About Unique Device Identifier Retrieval

    Unique Device Identifier Overview

    Each identifiable product is an entity, as defined by the Entity MIB (RFC-2737) and its supporting documents. Some entities, such as a chassis, will have subentities like slots. An Ethernet switch might be a member of a superentity like a stack. Most Cisco entities that are orderable products will leave the factory with an assigned UDI. The UDI information is printed on a label that is affixed to the physical hardware device, and it is also stored electronically on the device in order to facilitate remote retrieval.

    A UDI consists of the following elements:

    • Product identifier (PID)

    • Version identifier (VID)

    • Serial number (SN)

    The PID is the name by which the product can be ordered; it has been historically called the “Product Name” or “Part Number.” This is the identifier that one would use to order an exact replacement part.

    The VID is the version of the product. Whenever a product has been revised, the VID will be incremented. The VID is incremented according to a rigorous process derived from Telcordia GR-209-CORE, an industry guideline that governs product change notices.

    The SN is the vendor-unique serialization of the product. Each manufactured product will carry a unique serial number assigned at the factory, which cannot be changed in the field. This is the means by which to identify an individual, specific instance of a product.

    Benefits of the Unique Device Identifier Retrieval Feature

    • Identifies individual Cisco products in your networks.

    • Reduces operating expenses for asset management through simple, cross-platform, consistent identification of Cisco products.

    • Identifies PIDs for replaceable products.

    • Facilitates discovery of products subject to recall or revision.

    • Automates Cisco product inventory (capital and asset management).

    • Provides a mechanism to determine the entitlement level of a Cisco product for repair and replacement service.

    How to Retrieve the Unique Device Identifier

    Retrieving the Unique Device Identifier

    Perform this task to retrieve and display identification information for a Cisco product.

    SUMMARY STEPS

      1.    enable

      2.    show inventory [raw] [entity


    DETAILED STEPS
      Step 1   enable

      Enters privileged EXEC mode. Enter your password if prompted.



      Example:
      Router> enable
      Step 2   show inventory [raw] [entity

      Enter theshowinventory command to retrieve and display information about all of the Cisco products installed in the networking device that are assigned a PID, VID, and SN. If a Cisco entity is not assigned a PID, that entity is not retrieved or displayed.



      Example:
      Router# show inventory
NAME: “Chassis”, DESCR: “12008/GRP chassis”
PID: GSR8/40           ,  VID: V01,  SN: 63915640
NAME: “slot 0”, DESCR: “GRP”
PID: GRP-B             ,  VID: V01,  SN: CAB021300R5
NAME: “slot 1”, DESCR: “4 port ATM OC3 multimode”
PID: 4OC3/ATM-MM-SC    ,  VID: V01,  SN: CAB04036GT1
NAME: “slot 3”, DESCR: “4 port 0C3 POS multimode”
PID: LC-4OC3/POS-MM    ,  VID: V01,  SN: CAB014900GU
NAME: “slot 5”, DESCR: “1 port Gigabit Ethernet”
PID: GE-GBIC-SC-B      ,  VID: V01,  SN: CAB034251NX
NAME: “slot 7”, DESCR: “GRP”
PID: GRP-B             ,  VID: V01,  SN: CAB0428AN4O
NAME: “slot 16”, DESCR: “GSR 12008 Clock Scheduler Card”
PID: GSR8-CSC/ALRM     ,  VID: V01,  SN: CAB0429AUYH
NAME: “sfslot 1”, DESCR: “GSR 12008 Switch Fabric Card”
PID: GSR8-SFC          ,  VID: V01,  SN: CAB0428ALOS
NAME: “sfslot 2”, DESCR: “GSR 12008 Switch Fabric Card”
PID: GSR8-SFC          ,  VID: V01,  SN: CAB0429AU0M
NAME: “sfslot 3”, DESCR: “GSR 12008 Switch Fabric Card”
PID: GSR8-SFC          ,  VID: V01,  SN: CAB0429ARD7
NAME: “PSslot 1”, DESCR: “GSR 12008 AC Power Supply”
PID: FWR-GSR8-AC-B     ,  VID: V01,  SN: CAB041999CW

      Enter theshowinventorycommand with an entity argument value to display the UDI information for a specific type of Cisco entity installed in the networking device. In this example, a list of Cisco entities that match the sfslot argument string is displayed.



      Example:
      Router# show inventory sfslot
NAME: “sfslot 1”, DESCR: “GSR 12008 Switch Fabric Card”
PID: GSR8-SFC          ,  VID: V01,  SN: CAB0428ALOS
NAME: “sfslot 2”, DESCR: “GSR 12008 Switch Fabric Card”
PID: GSR8-SFC          ,  VID: V01,  SN: CAB0429AU0M
NAME: “sfslot 3”, DESCR: “GSR 12008 Switch Fabric Card”
PID: GSR8-SFC          ,  VID: V01,  SN: CAB0429ARD7

      You can request even more specific UDI information using theshowinventorycommand with an entity argument value that is enclosed in quotation marks. In this example, only the details for the entity that exactly matches the sfslot 1 argument string are displayed.



      Example:
      Router# show inventory “sfslot 1”
NAME: “sfslot 1”, DESCR: “GSR 12008 Switch Fabric Card”
PID: GSR8-SFC          ,  VID: V01,  SN: CAB0428ALOS

      For diagnostic purposes, theshowinventorycommand can be used with the raw keyword to display every RFC 2737 entity including those without a PID, UDI, or other physical identification.

      Note   

      The raw keyword option is primarily intended for troubleshooting problems with the showinventory command itself.



      Example:
      Router# show inventory raw
NAME: “Chassis”, DESCR: “12008/GRP chassis”
PID:                   ,  VID: V01,  SN: 63915640
NAME: “slot 0”, DESCR: “GRP”
PID:                   ,  VID: V01,  SN: CAB021300R5
NAME: “slot 1”, DESCR: “4 port ATM OC3 multimode”
PID: 4OC3/ATM-MM-SC    ,  VID: V01,  SN: CAB04036GT1
NAME: “slot 3”, DESCR: “4 port 0C3 POS multimode”
PID: LC-4OC3/POS-MM    ,  VID: V01,  SN: CAB014900GU

      Enter theshowinventorycommand with the raw keyword and an entity argument value to display the UDI information for the Cisco entities that are installed in the networking device and that match the argument string, even if they do not contain an assigned PID.



      Example:
      Router# show inventory raw slot
NAME: “slot 0”, DESCR: “GRP”
PID:                  ,  VID: V01,  SN: CAB021300R5
NAME: “slot 1”, DESCR: “4 port ATM OC3 multimode”
PID: 4OC3/ATM-MM-SC    ,  VID: V01,  SN: CAB04036GT1
NAME: “slot 3”, DESCR: “4 port 0C3 POS multimode”
PID: LC-4OC3/POS-MM    ,  VID: V01,  SN: CAB014900GU

      Troubleshooting Tips

      If any of the Cisco products do not have an assigned PID, the output may display incorrect PIDs and the VID and SN elements may be missing, as in the following example.

      NAME: "Four Port High-Speed Serial", DESCR: "Four Port High-Speed Serial"
PID: Four Port High-Speed Serial, VID: 1.1, SN: 17202570   
NAME: "Serial1/0", DESCR: "M4T"
PID: M4T               , VID:    , SN:

      In the sample output, the PID is exactly the same as the product description. The UDI is designed for use with new Cisco products that have a PID assigned. UDI information on older Cisco products is not always reliable.

      Configuration Examples for Unique Device Identifier Retrieval

      There are no configuration examples for the UDI Retrieval feature. For sample display output from the show inventory command, see the “Retrieving the Unique Device Identifier” section.

      Additional References

      This section provides references related to the UDI Retrieval feature.

      Related Documents

      Related Topic

      Document Title

      Information about managing configuration files

      • Cisco IOS Configuration Fundamentals Configuration Guide, Release 12.0

      • Cisco IOS Configuration Fundamentals Configuration Guide, Release 12.2

      • Cisco IOS Configuration Fundamentals and Network Management Configuration Guide, Release 12.3

      Commands for showing interface statistics

      • Cisco IOS Interface Command Reference, Release 12.0

      • Cisco IOS Interface Command Reference, Release 12.2

      • Cisco IOS Interface and Hardware Component Command Reference, Release 12.3T

      Standards

      Standards

      Title

      No new or modified standards are supported by this feature, and support for existing standards has not been modified by this feature.

      --

      MIBs

      MIBs

      MIBs Link

      CISCO-ENTITY-ASSET-MIB

      To locate and download MIBs for selected platforms, Cisco IOS releases, and feature sets, use Cisco MIB Locator found at the following URL:

      http:/​/​www.cisco.com/​go/​mibs

      RFCs

      RFCs

      Title

      RFC 2737

      Entity MIB (Version 2)

      Technical Assistance

      Description

      Link

      The Cisco Technical Support website contains thousands of pages of searchable technical content, including links to products, technologies, solutions, technical tips, and tools. Registered Cisco.com users can log in from this page to access even more content.

      http:/​/​www.cisco.com/​techsupport