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.
Finding Feature Information
For the latest feature information and caveats, see the release notes for your platform and software release. To find information about the features documented in this module, and to see a list of the releases in which each feature is supported, see the "Feature Information for Unique Device Identifier Retrieval" section.
Use Cisco Feature Navigator to find information about platform support and Cisco IOS XE software image support. To access Cisco Feature Navigator, go to http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Contents
•Prerequisites for Unique Device Identifier Retrieval
•Information About Unique Device Identifier Retrieval
•How to Retrieve the Unique Device Identifier
•Configuration Examples for Unique Device Identifier Retrieval
•Additional References
•Feature Information for Unique Device Identifier Retrieval
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 show inventory 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
Before using the UDI Retrieval feature, you should understand the following concepts:
•Unique Device Identifier Overview
•Benefits of the Unique Device Identifier Retrieval Feature
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. A Fast 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
This section contains the following task:
•Retrieving the Unique Device Identifier (required)
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.
Step 2 show inventory [raw] [entity]
Enter the show inventory 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.
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 the show inventory command 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 module RO argument string is displayed.
Router# show inventory "module RO"
NAME: ''module R0'', DESCR: ''Cisco ASR1000 Route Processor 2''
PID: ASR1000-RP2 , VID: V01, SN: JAE13041JEX
Note The raw keyword option is primarily intended for troubleshooting problems with the show inventory command itself.
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
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"
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
Standards
|
|
No new or modified standards are supported by this feature, and support for existing standards has not been modified by this feature. |
— |
MIBs
|
|
CISCO-ENTITY-ASSET-MIB |
To locate and download MIBs for selected platforms, Cisco IOS XE releases, and feature sets, use Cisco MIB Locator found at the following URL: http://www.cisco.com/go/mibs |
RFCs
|
|
RFC 2737 |
Entity MIB (Version 2) |
Technical Assistance
|
|
The Cisco Support website provides extensive online resources, including documentation and tools for troubleshooting and resolving technical issues with Cisco products and technologies. To receive security and technical information about your products, you can subscribe to various services, such as the Product Alert Tool (accessed from Field Notices), the Cisco Technical Services Newsletter, and Really Simple Syndication (RSS) Feeds. Access to most tools on the Cisco Support website requires a Cisco.com user ID and password. |
http://www.cisco.com/techsupport |
Feature Information for Unique Device Identifier Retrieval
Table 1 lists the features in this module and provides links to specific configuration information.
Use Cisco Feature Navigator to find information about platform support and software image support. Cisco Feature Navigator enables you to determine which Ciso IOS XE software images support a specific software release, feature set, or platform. To access Cisco Feature Navigator, go to http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 1 lists only the Cisco IOS XE software release that introduced support for a given feature in a given Cisco IOS XE software release train. Unless noted otherwise, subsequent releases of that Cisco IOS XE software release train also support that feature.
Table 1 Feature Information for Unique Device Identifier Retrieval
|
|
|
Unique Device Identifier Retrieval |
Cisco IOS XE Release 2.1 |
This feature was introduced. |
CCDE, CCENT, Cisco Eos, Cisco HealthPresence, the Cisco logo, Cisco Lumin, Cisco Nexus, Cisco StadiumVision, Cisco TelePresence, Cisco WebEx, DCE, and Welcome to the Human Network are trademarks; Changing the Way We Work, Live, Play, and Learn and Cisco Store are service marks; and Access Registrar, Aironet, AsyncOS, Bringing the Meeting To You, Catalyst, CCDA, CCDP, CCIE, CCIP, CCNA, CCNP, CCSP, CCVP, Cisco, the Cisco Certified Internetwork Expert logo, Cisco IOS, Cisco Press, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo, Cisco Unity, Collaboration Without Limitation, EtherFast, EtherSwitch, Event Center, Fast Step, Follow Me Browsing, FormShare, GigaDrive, HomeLink, Internet Quotient, IOS, iPhone, iQuick Study, IronPort, the IronPort logo, LightStream, Linksys, MediaTone, MeetingPlace, MeetingPlace Chime Sound, MGX, Networkers, Networking Academy, Network Registrar, PCNow, PIX, PowerPanels, ProConnect, ScriptShare, SenderBase, SMARTnet, Spectrum Expert, StackWise, The Fastest Way to Increase Your Internet Quotient, TransPath, WebEx, and the WebEx logo are registered trademarks of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries.
All other trademarks mentioned in this document or website are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (0812R)
Any Internet Protocol (IP) addresses used in this document are not intended to be actual addresses. Any examples, command display output, and figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses in illustrative content is unintentional and coincidental.
© 2005-2009 Cisco Systems, Inc. All rights reserved.