Table Of Contents

Onboard Failure Logging Commands on Cisco IOS XR Software

clear logging onboard

hw-module logging onboard

show logging onboard

Onboard Failure Logging Commands on Cisco IOS XR Software

---

This chapter describes the Cisco IOS XR commands used to configure onboard failure logging (OBFL). OBFL gathers boot, environmental, and critical hardware failure 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.

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.

---

Caution OBFL is activated by default in all cards and should not be deactivated. OBFL is used to diagnose problems in FRUs and to display a history of FRU data.

---

Related Documents

For detailed information about OBFL concepts, configuration tasks, and examples, see the Onboard Failure Logging Services on Cisco IOS XR Software module in Cisco IOS XR System Monitoring Configuration Guide.

For detailed information about logging concepts, configuration tasks, and examples, see the Implementing Logging Services on Cisco IOS XR Software module. in Cisco IOS XR System Monitoring Configuration Guide For logging services commands, see the Logging Services Commands on Cisco IOS XR Software module in Cisco IOS XR System Monitoring Command Reference.

For alarm management and logging correlation commands, see the Alarm Management and Logging Correlation Commands on Cisco IOS XR Software module in Cisco IOS XR System Monitoring Command Reference. For detailed information about alarm and logging correlation concepts, configuration tasks, and examples, see the Implementing Alarm Logs and Logging Correlation on Cisco IOS XR module in Cisco IOS XR System Monitoring Configuration Guide.

clear logging onboard

To clear OBFL logging messages from a node or from all nodes, use the clear logging onboard command in administration EXEC mode.

clear logging onboard [all | corrupted-files | diagnostic | environment | error | temperature | uptime | voltage] [all | continuous | historical] [location node-id]

Syntax Description

location node-id	(Optional) Clears OBFL messages from the designated node. The node-id argument is entered in the rack/slot/module notation.
all	Clears all OBFL logs.
corrupted-files	Clears corrupted file information
continuous	Clears continuous information.
diagnostic	Clears the on-line diagnostics information from the OBFL logs.
environment	Clears the environmental information from the OBFL logs.
error	Clear Syslog information.
historical	Clears historical information.
temperature	Clears temperature information.
uptime	Clears uptime information.
voltage	Clears voltage information.

Defaults

All OBFL logging messages are cleared from all nodes.

Command Modes

Administration EXEC

Command History

Release	Modification
Release 3.4.0	This command was introduced on the Cisco CRS-1.
Release 3.4.1	This command was supported on the Cisco XR 12000 Series Router.
Release 3.5.0	No modification.
Release 3.6.0	No modification.
Release 3.7.0	No modification.
Release 3.8.0	No modification.

Usage Guidelines

To use this command, your Cisco IOS XR software system administrator must assign you to a user group associated with a task group that includes the corresponding command task IDs. If you need assistance with your task group assignment, contact your system administrator. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of Cisco IOS XR System Security Configuration Guide.

Use the clear logging onboard command to clear OBFL messages from all nodes. Use the clear logging onboard command with the location node-id keyword and argument to clear OBFL messages for a specific node. If the specified node is not present, an error message is displayed.

---

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.

---

Task ID

Task ID	Operations
logging	read

Examples

In the following example, the OBFL data is cleared for all nodes in the system:

RP/0/RP0/CPU0:router(admin)# clear logging onboard

Related Commands

Command	Description
hw-module logging onboard	Enables or disables OBFL.
show logging onboard	Displays the OBFL messages.

hw-module logging onboard

To disable onboard failure logging (OBFL), use the hw-module logging onboard command in administration configuration mode. To enable OBFL again, use the no form of this command.

hw-module {all | subslot node-id} logging onboard [disable | severity {alerts | emergencies}]

no hw-module {all | subslot node-id} logging onboard [disable]

Syntax Description

all	Enables or disables OBFL for all nodes.
subslot node-id	Enables or disables OBFL for the designated node. The node-id argument is entered in the rack/slot/module notation.
disable	Enables or disables OBFL. See the Usage Guidelines for more information.
severity	(Optional) Specifies the severity level for the syslog message that is logged into the OBFL storage device.
alerts	Specifies that both emergency and alert syslog messages are logged. The default is the alerts keyword.
emergencies	Specifies that only the emergency syslog messages are logged.

Defaults

By default, OBFL logging is enabled.
severity: 1 (alerts) and 0 (emergencies)

Command Modes

Administration configuration

Command History

Release	Modification
Release 3.4.0	This command was introduced on the Cisco CRS-1.
Release 3.4.1	The severity, alerts, and emergencies keywords were added on the Cisco CRS-1 and Cisco XR 12000 Series Router.
Release 3.5.0	No modification.
Release 3.6.0	No modification.
Release 3.7.0	No modification.
Release 3.8.0	No modification.

Usage Guidelines

To use this command, your Cisco IOS XR software system administrator must assign you to a user group associated with a task group that includes the corresponding command task IDs. If you need assistance with your task group assignment, contact your system administrator. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of Cisco IOS XR System Security Configuration Guide.

Use the hw-module logging onboard command to enable or disable OBFL.

•To disable OBFL use the disable keyword. OBFL is enabled by default.

hw-module {all | subslot node-id} logging onboard disable

•To enable OBFL, use the no form of the hw-module logging onboard command with the disable keyword. OBFL is enabled by default. Use this command only if you disabled OBFL:

no hw-module {all | subslot node-id} logging onboard disable

•To enable OBFL and return the configuration to the default message severity level, use the no form of the hw-module logging onboard command with the severity keyword:

no hw-module {all | subslot node-id} logging onboard severity

When the OBFL feature is disabled, existing OBFL logs are preserved. To resume OBFL data collection, enable the OBFL feature again.

---

Note If a new node is inserted, and OBFL is enabled for that slot, 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.

---

Task ID

Task ID	Operations
logging	read, write
root-lr	read, write

Examples

The following example shows how to disable OBFL for all cards:

RP/0/RP0/CPU0:router(admin-config)# hw-module all logging onboard disable

The following example shows how to disable OBFL for a card:

RP/0/RP0/CPU0:router(admin-config)# hw-module subslot 0/2/CPU0 logging onboard disable

The following example shows how to enable OBFL again:

RP/0/RP0/CPU0:router(admin-config)# no hw-module all logging onboard disable

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/RP0/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/RP0/CPU0:router(admin-config)# hw-module subslot 0/2/CPU0 logging onboard severity 
alerts

Related Commands

Command	Description
clear logging onboard	Clears OBFL logging messages from a node or from all nodes.
show logging onboard	Displays the OBFL messages.

show logging onboard

To display the OBFL messages, use the show logging onboard command in administration EXEC mode.

show logging onboard [all | diagnostic | environment | error | temperature | uptime | voltage] [all | continuous | historical | static-data] [detail | raw | summary] [location node-id]

Syntax Description

location node-id	(Optional) Displays OBFL messages from the designated node. The node-id argument is entered in the rack/slot/module notation.
all	Displays all file information.
continuous	Displays continuous information.
detail	Displays detailed logging information.
diagnostic	Display diagnostic information
environment	Display system environment information.
error	Displays output from the message application
historical	Displays historical information.
raw	Displays raw OBFL data.
static-data	Display system descriptor data.
summary	Displays a summary of OBFL logging information.
temperature	Displays temperature information
uptime	Displays the OBFL uptime.
voltage	Display voltage information.

Defaults

No default behavior or values

Command Modes

Administration EXEC

Command History

Release	Modification
Release 3.4.0	This command was introduced on the Cisco CRS-1.
Release 3.4.1	This command was supported on the Cisco XR 12000 Series Router.
Release 3.5.0	No modification.
Release 3.6.0	No modification.
Release 3.7.0	No modification.
Release 3.8.0	No modification.

Usage Guidelines

To use this command, your Cisco IOS XR software system administrator must assign you to a user group associated with a task group that includes the corresponding command task IDs. If you need assistance with your task group assignment, contact your system administrator. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of Cisco IOS XR System Security Configuration Guide.

Use the show logging onboard command to display all logging messages for OBFL.

To narrow the output of the command, enter the show logging onboard command with one of the optional keywords.

Use the location node-id keyword and argument to display OBFL messages for a specific node.

Task ID

Task ID	Operations
logging	read

Examples

The following example displays uptime information from the OBFL feature:

RP/0/RP0/CPU0:router(admin)# show logging onboard uptime detail location 0/10/cpu0

-------------------------------------------------------------------------------

UPTIME CONTINUOUS DETAIL INFORMATION (Node: node0_10_CPU0)

-------------------------------------------------------------------------------

The first record     : 01/05/2007 00:58:41

The last record      : 01/17/2007 16: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/2007 01:44:35   File cleared by user request.

-------------------------------------------------------------------------------

The following example displays continuous information about the temperature:

RP/0/RP0/CPU0:router(admin)# show logging onboard temperature continuous

-------------------------------------------------------------------------------

TEMPERATURE CONTINUOUS INFORMATION (Node: node0_2_CPU0)

-------------------------------------------------------------------------------

Sensor                            | ID  | 

-------------------------------------------------------------------------------

host__Inlet0                        0xf0301  

host__Inlet1                        0xf0302  

host__Exhaust0                      0xf0303  

host__Exhaust1                      0xf0304  

host__Hotspot0                      0xf0305  

cpu__Hotspot0                       0x100301 

fabricq0__Hotspot0                  0x110301 

fabricq1__Hotspot1                  0x120301 

ingressq__Hotspot0                  0x130301 

egressq__Exhaust0                   0x140301 

egressq__Hotspot0                   0x140302 

ingresspse__Hotspot                 0x150301 

egresspse__Hotspot1                 0x160301 

-------------------------------------------------------------------------------

Time Stamp          |Sensor Temperature C

MM/DD/YYYY HH:MM:SS |    1    2    3    4    5    6    7    8    9   10

                    |   11   12   13   14   15   16   17   18   19   20

-------------------------------------------------------------------------------

12/08/2006 21:27:04     28   24   43   44   47   29   40   39   27   38

                        42   32   39

12/08/2006 21:33:04     28   24   43   44   47   29   40   38   27   38

                        42   32   39

12/08/2006 21:39:04     28   24   43   44   47   29   40   38   27   38

The following example displays raw information about the temperature:

RP/0/RP0/CPU0:router(admin)# show logging onboard temperature raw

Feature: Temperature

node: node0_2_CPU0, file name: nvram:/temp_cont, file size: 47525

00000000: 00 29 01 02 45 79 d8 a8  00 00 00 00 00 00 ba 37   .)..Ey.........7

00000010: aa 0d 00 00 45 79 d8 a8  1c 18 2b 2c 2f 1d 28 27   ....Ey....+,/.('

00000020: 1b 26 2a 20 27 00 00 fa  fa 00 1f 01 02 45 79 da   .&* '........Ey.

00000030: 2b 00 00 00 00 00 00 ba  38 ca 0d 00 06 00 00 00   +.......8.......

00000040: 0f 00 00 00 00 00 fa fa  00 1f 01 02 45 79 db ae   ............Ey..

00000050: 00 00 00 00 00 00 ba 39  ca 0d 00 06 00 00 00 00   .......9........

00000060: 00 f0 00 00 00 fa fa 00  1f 01 02 45 79 dd 32 00   ...........Ey.2.

00000070: 00 00 00 00 00 ba 3a ca  0d 00 06 00 00 00 00 00   ......:.........

00000080: 00 00 00 00 fa fa 00 1f  01 02 45 79 de b8 00 00   ..........Ey....

00000090: 00 00 00 00 ba 3b ca 0d  00 06 00 00 00 00 00 10   .....;..........

000000a0: 00 00 00 fa fa 00 1f 01  02 45 79 e0 3c 00 00 00   .........Ey.<...

000000b0: 00 00 00 ba 3c ca 0d 00  06 00 00 01 00 00 00 00   ....<...........

000000c0: 00 00 fa fa 00 1f 01 02  45 79 e1 be 00 00 00 00   ........Ey......

000000d0: 00 00 ba 3d ca 0d 00 06  11 00 00 00 00 00 00 00   ...=............

000000e0: 00 fa fa 00 1f 01 02 45  79 e3 43 00 00 00 00 00   .......Ey.C.....

000000f0: 00 ba 3e ca 0d 00 06 ff  00 0f 00 00 00 00 00 00   ..>.............

00000100: fa fa 00 1f 01 02 45 79  e4 c6 00 00 00 00 00 00   ......Ey........

00000110: ba 3f ca 0d 00 06 00 00  00 00 00 00 00 00 00 fa   .?..............

00000120: fa 00 1f 01 02 45 79 e6  49 00 00 00 00 00 00 ba   .....Ey.I.......

00000130: 40 ca 0d 00 06 00 00 00  00 00 00 00 00 00 fa fa   @...............

00000140: 00 1f 01 02 45 79 e7 cc  00 00 00 00 00 00 ba 41   ....Ey.........A

00000150: ca 0d 00 06 00 00 00 10  00 f0 00 00 00 fa fa 00   ................

00000160: 1f 01 02 45 79 e9 4f 00  00 00 00 00 00 ba 42 ca   ...Ey.O.......B.

00000170: 0d 00 06 00 00 00 f0 00  10 00 00 00 fa fa 00 1f   ................

00000180: 01 02 45 79 ea d2 00 00  00 00 00 00 ba 43 ca 0d   ..Ey.........C..

00000190: 00 06 00 00 01 01 00 00  00 00 00 fa fa 00 1f 01   ................

000001a0: 02 45 79 ec 55 00 00 00  00 00 00 ba 44 ca 0d 00   .Ey.U.......D...

000001b0: 06 01 00 00 10 00 00 00  00 00 fa fa 00 1f 01 02   ................

000001c0: 45 79 ed d8 00 00 00 00  00 00 ba 45 ca 0d 00 06   Ey.........E....

000001d0: 0f 00 0f ff 00 00 00 00  00 fa fa 00 1f 01 02 45   ...............E

Related Commands

Command	Description
clear logging onboard	Clears OBFL logging messages from a node or from all nodes.
hw-module logging onboard	Enables or disables OBFL.