Onboard Failure
Logging
OBFL gathers boot, environmental, and critical hardware data for field-replaceable units (FRUs), and stores the information in the nonvolatile memory of the FRU. This information is used for troubleshooting, testing, and diagnosis if a failure or other error occurs, providing improved accuracy in hardware troubleshooting and root cause isolation analysis. Stored OBFL data can be retrieved in the event of a failure and is accessible even if the card does not boot.
Because OBFL is on by default, data is collected and stored as soon as the card is installed. If a problem occurs, the data can provide information about historical environmental conditions, uptime, downtime, errors, and other operating conditions.
The Onboard Failure Logging (OBFL) functionality is enhanced to provide a generic library that can be used by different clients to log string messages.
 Caution | OBFL is activated by default in all cards. Do not deactivate OBFL without specific reasons, because the OBFL data is used to diagnose and resolve problems in FRUs. |
 Note | For information about OBFL commands, console logging, alarms, and logging correlation, see Related Documents. |
Feature History for Implementing OBFL
|
Release |
Modification |
|---|---|
|
Release 3.4.1 |
This feature was introduced. |
|
Release 5.2.2 |
Generic string logging feature was introduced. |
- Prerequisites
- Information About Implementing OBFL
- How to Implement OBFL
- Configuration Examples for OBFL
- Where to Go Next
- Additional References
Prerequisites
You must be in a user group associated with a task group that includes the proper task IDs. The command reference guides include the task IDs required for each command. If you suspect user group assignment is preventing you from using a command, contact your AAA administrator for assistance.
Information About Implementing OBFL
Data Collection Types
OBFL collects and stores both baseline and event- driven information in the nonvolatile memory of each supported card where OBFL is enabled. The data collected includes these:
-
FRU part serial number
-
OS version
-
Boot time
-
Total run time (hours in use)
-
Boot status
-
Temperature and voltage at boot
-
Temperature and voltage history
-
Other board specific errors
This data is collected in two different ways: as baseline data and event- driven data:
Baseline Data Collection
Baseline data is stored independent of hardware or software failures. This includes:
|
Data Type |
Details |
|---|---|
|
Installation |
Chassis name and slot number are stored at initial boot and for the most recent nine boots. |
|
Temperature |
Inlet and hotpoint temperatures are recorded 10 minutes after boot. |
|
Run-time |
Total run-time since initial installation. This is based on the local router clock with a granularity of 30 minutes. |
Event-Driven Data Collection
Event driven data include card failure events. Failure events are card crashes, memory errors, ASIC resets, and similar hardware failure indications.
|
Data Type |
Details |
|
|---|---|---|
|
Environmental Factors |
Temperature Value |
Inlet and hot point temperature value change beyond the threshold set in the hardware inventory XML files. |
|
Voltage Value |
+5, and MBUS +5, +3.3, and +2.2 voltage value. |
|
|
An environmental reading is logged when the following temperature or voltage events occur: On reboot, these environmental readings are consolidated into a single environmental history record that shows the duration and extent out of normal range for a consecutive set of environmental readings. |
||
|
Calendar Time |
Disabled |
The time when OBFL logging was disabled with the hw-module {all | subslot node-id} logging onboard disable command in global configuration or administration configuration mode. |
|
Cleared |
The time when OBFL logging was cleared with the clear logging onboard command in EXEC or administration EXEC mode. |
|
|
Reset to 0 |
The time when total line card runtime is reset to zero with the clear logging onboard command in EXEC or administration EXEC mode. |
|
Supported Cards and Platforms
OBFL data collection is supported.
FRUs that have sufficient nonvolatile memory available for OBFL data storage support OBFL. For example, the processor supports the OBFL.
|
Card Type |
Cisco XR 12000 Series Router |
|---|---|
|
Route processor (RP) |
Supported |
|
Distributed route processor (DRP) |
Not Supported |
|
Modular service card (MSC) |
Supported |
|
Switch fabric cards (SFC) |
Supported |
|
Power supply cards: AC rectifier modules and DC power entry modules (PEMs) |
Supported |
|
Fan controller cards |
Supported |
|
Alarm modules |
Supported |
|
Optical interface module (OIM) and light emitting diode (LED) |
Not Supported |
|
Shared port adapters (SPA) |
Supported |
|
Physical layer interface module (PLIM) |
Not Supported |
How to Implement OBFL
OBFL logging is configured for the router. If a new node is inserted, and OBFL is enabled for that slot or for all slots, then OBFL is enabled for the new node. If a card is removed from a router and inserted into a different router, the card assumes the OBFL configuration for the new router.
This section contains these procedures:
- Enabling or Disabling OBFL
- Configuring Message Severity Levels
- Monitoring and Maintaining OBFL
- Clearing OBFL Data
Enabling or Disabling OBFL
OBFL is enabled for all nodes by default and is active until disabled for a specified node or for all nodes.
Caution | Do not deactivate OBFL without specific reasons since the OBFL data is used to diagnose and resolve problems in FRUs. |
There are no configuration requirements other than to enable and disable OBFL.
1.
admin
2.
configure
3.
hw-module {all |
subslot
node-id}
logging
onboard [disable |
severity {alerts |
emergencies}]
4.
commit
DETAILED STEPS
Configuring Message Severity Levels
Perform this task to configure message severity levels.
1.
admin
2.
configure
3.
hw-module {all |
subslot
node-id}
logging
onboard [disable |
severity {alerts |
emergencies}]
4.
commit
DETAILED STEPS
Monitoring and Maintaining OBFL
Use the commands described in this section to display the status of OBFL, and the data collected by OBFL. Enter these commands in EXEC or administration EXEC mode.
1.
admin
2.
show logging onboard
[all |
cbc
{dump-all |
dump-range {start-address |
end-address |
most-recent {fans
fan-tray-slot | [location
node-id]} |
diagnostic |
environment |
error
|
temperature |
uptime
|
verbose |
voltage] [continuous |
historical |
static-data] [detail |
raw |
summary] [location
node-id]
3.
show
processes
include
obfl
4.
show
running-config
DETAILED STEPS
Clearing OBFL Data
To erase all OBFL data on a specific card or on all cards, use the following command:
clear logging onboard [all | cbc {dump-all | dump-range {start-address | end-address | most-recent {fans fan-tray-slot | [location node-id]} | corrupted-files | diagnostic | environment | error | poweron-time | temperature | uptime | voltage] [location node-id]
Caution | The clear logging onboard command permanently deletes all OBFL data for a node or for all nodes. Do not clear the OBFL logs without specific reasons because the OBFL data is used to diagnose and resolve problems in FRUs. |
Caution | If OBFL is actively running on a card, issuing the clear logging onboard command can result in a corrupt or incomplete log at a later point in time. OBFL should always be disabled before this command is issued. |
For more information, see the Onboard Failure Logging Commands module in the Cisco IOS XR System Monitoring Command Reference for the Cisco XR 12000 Series Router.
Configuration Examples for OBFL
This section provides these configuration examples:
- Enabling and Disabling OBFL: Example
- Configuring Message Severity Levels: Example
- Clearing OBFL Messages: Example
- Displaying OBFL Data: Example
Enabling and Disabling OBFL: Example
The following example shows how to disable OBFL:
RP/0/0/CPU0:router(admin-config)# hw-module all logging onboard disable
The following example shows how to enable OBFL again:
RP/0/0/CPU0:router(admin-config)# no hw-module all logging onboard disable
The following example shows that OBFL is enabled and message severity level is reset to the default:
RP/0/0/CPU0:router(admin-config)# no hw-module all logging onboard
Configuring Message Severity Levels: Example
The following example shows how to save only the syslog message in which the severity level is set to 0 (emergency) to a storage device:
RP/0/0/CPU0:router(admin-config)# hw-module subslot 0/2/CPU0 logging onboard severity emergencies
The following example shows how to save the syslog message in which the severity level is set to 0 (emergency) and 1 (alert) to a storage device:
RP/0/0/CPU0:router(admin-config)# hw-module subslot 0/2/CPU0 logging onboard severity
alerts
Clearing OBFL Messages: Example
In the following example, all OBFL messages are cleared for all nodes in the system:
RP/0/0/CPU0:router(admin)# clear logging onboard
Displaying OBFL Data: Example
The following example shows how to display uptime information from the OBFL feature:
RP/0/0/CPU0:router(admin)# show logging onboard uptime detail location 0/7/cpu0
-------------------------------------------------------------------------------
UPTIME CONTINUOUS DETAIL INFORMATION (Node: node0_7_CPU0)
-------------------------------------------------------------------------------
The first record : 01/05/2009 00:58:41
The last record : 01/17/2007916:07:13
Number of records : 478
File size : 15288 bytes
Current reset reason : 0x00
Current uptime : 0 years 0 weeks 0 days 3 hours 0 minutes
-------------------------------------------------------------------------------
Time Stamp |
MM/DD/YYYY HH:MM:SS | Users operation
-------------------------------------------------------------------------------
01/05/2009 01:44:35 File cleared by user request.
-------------------------------------------------------------------------------
Where to Go Next
To configure alarm log correlation, see the Implementing and Monitoring Alarms and Logging Correlation module in the Cisco IOS XR System Monitoring Configuration Guide for the Cisco XR 12000 Series Router.
Additional References
The following sections provide references related to implementing logging services on Cisco IOS XR software .
Related Documents
|
Related Topic |
Document Title |
|---|---|
|
Logging services command reference |
Logging Services Commands module in the Cisco IOS XR System Monitoring Command Reference for the Cisco XR 12000 Series Router |
|
Onboard Failure Logging (OBFL) configuration |
Onboard Failure Logging Commands module in the Cisco IOS XR System Monitoring Configuration Guide for the Cisco XR 12000 Series Router. |
|
Onboard Failure Logging (OBFL) commands |
Onboard Failure Logging Commands module in the Cisco IOS XR System Monitoring Command Reference for the Cisco XR 12000 Series Router. |
|
Alarm and logging correlation commands |
Alarm Management and Logging Correlation Commands module in the Cisco IOS XR System Monitoring Command Reference for the Cisco XR 12000 Series Router. |
|
Alarm and logging correlation configuration and monitoring tasks |
Implementing and Monitoring Alarms and Alarm Log Correlation module in the Cisco IOS XR System Monitoring Configuration Guide for the Cisco XR 12000 Series Router. |
|
SNMP commands |
SNMP Commands module in the Cisco IOS XR System Monitoring Command Reference for the Cisco XR 12000 Series Router. |
|
SNMP configuration tasks |
Implementing SNMP module in the Cisco IOS XR System Monitoring Configuration Guide for the Cisco XR 12000 Series Router |
|
Cisco IOS XR getting started material |
Cisco IOS XR Getting Started Guide for the Cisco XR 12000 Series Router |
|
Information about user groups and task IDs |
Configuring AAA Services module in the Cisco IOS XR System Security Command Reference for the Cisco XR 12000 Series Router. |
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 |
|---|---|
| — |
To locate and download MIBs using Cisco IOS XR software, use the Cisco MIB Locator found at the following URL and choose a platform under the Cisco Access Products menu: http://cisco.com/public/sw-center/netmgmt/cmtk/mibs.shtml |
RFCs
|
RFCs |
Title |
|---|---|
|
No new or modified RFCs are supported by this feature, and support for existing RFCs has not been modified by this feature. |
— |
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/cisco/web/support/index.html |
Feedback