Table Of Contents

Configuring Onboard Failure Logging

Information About OBFL

OBFL Overview

Virtualization Support

Licensing Requirements for OBFL

Prerequisites for OBFL

Configuration Guidelines and Limitations

Configuring OBFL

Verifying the OBFL Configuration

OBFL Example Configuration

Default Settings

Additional References

Related Documents

Standards

Configuring Onboard Failure Logging

---

This chapter describes how to configure the onboard failure logging (OBFL) features in Cisco NX-OS.

This chapter includes the following sections:

•Information About OBFL

•Licensing Requirements for OBFL

•Prerequisites for OBFL

•Configuration Guidelines and Limitations

•Configuring OBFL

•Verifying the OBFL Configuration

•OBFL Example Configuration

•Default Settings

•Additional References

Information About OBFL

This section includes the following topics:

•OBFL Overview

•Virtualization Support

OBFL Overview

Cisco NX-OS provides the ability to log failure data to persistent storage, which you can retrieve and display for analysis at a later time. This onboard failure logging (OBFL) feature stores failure and environmental information in nonvolatile memory on the module. The information will help analyze failed modules.

The data stored by OBFL include the following:

•Time of initial power-on

•Slot number of the module in the chassis

•Initial temperature of the module

•Firmware, BIOS, FPGA, and ASIC versions

•Serial number of the module

•Stack trace for crashes

•CPU hog information

•Memory leak information

•Software error messages

•Hardware exception logs

•Environmental history

•OBFL-specific history information

•ASIC interrupt and error statistics history

•ASIC register dumps

OBFL stores kernel trace in case Cisco NX-OS crashes.

Virtualization Support

You must be in the default virtual device context (VDC) to configure and display OBFL information. See the Cisco Nexus 7000 Series NX-OS Virtual Device Context Configuration Guide, Release 4.0 for more information on VDCs.

Licensing Requirements for OBFL

The following table shows the licensing requirements for this feature:

Product	License Requirement
NX-OS	OBFL requires no license. Any feature not included in a license package is bundled with the Cisco NX-OS system images and is provided at no extra charge to you. For a complete explanation of the NX-OS licensing scheme, see the Cisco Nexus 7000 Series NX-OS Licensing Guide, Release 4.0

Prerequisites for OBFL

If you configure VDCs, install the Advanced Services license and enter the desired VDC (see to the Cisco Nexus 7000 Series NX-OS Virtual Device Context Configuration Guide, Release 4.0).

You must have network-admin user privileges and be logged into the default VDC.

Configuration Guidelines and Limitations

OBFL has the following guidelines and limitations:

•OBFL is enabled by default.

•OBFL flash supports a limited number of writes and erases. The more logging you enable, the faster you use up this number of writes and erases.

---

Note f you are familiar with the Cisco IOS CLI, be aware that the Cisco NX-OS commands for this feature might differ from the Cisco IOS commands that you would use.

---

Configuring OBFL

To configure OBFL, use the following commands in global configuration mode

Command	Purpose
hw-module logging onboard	Enables all OBFL features.
hw-module logging onboard environmental-history	Enables the OBFL environmental history.
hw-module logging onboard error-stats	Enables the OBFL error statistics.
hw-module logging onboard interrupt-stats	Enables the OBFL interrupt statistics.
hw-module logging onboard module slot	Enables the OBFL information for a module.
hw-module logging onboard obfl-log	Enables the boot uptime, device version, and OBFL history.
no hw-module logging onboard	Disables all OBFL features.

Verifying the OBFL Configuration

Use the show logging onboard status command to display the configuration status of OBFL.

switch# show logging onboard status

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

OBFL Status

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

    Switch OBFL Log:                                    Enabled

    Module:  2 OBFL Log:                                Enabled

    cpu-hog                                             Enabled

    environmental-history                               Enabled

    error-stats                                         Enabled

    exception-log                                       Enabled

    interrupt-stats                                     Enabled

    mem-leak                                            Enabled

    miscellaneous-error                                 Enabled

    obfl-log (boot-uptime/device-version/obfl-history)  Enabled

    register-log                                        Enabled

    stack-trace                                         Enabled

    system-health                                       Enabled

    Module:  6 OBFL Log:                                Enabled

    cpu-hog                                             Enabled

    environmental-history                               Enabled

    error-stats                                         Enabled

    exception-log                                       Enabled

    interrupt-stats                                     Enabled

    mem-leak                                            Enabled

    miscellaneous-error                                 Enabled

    obfl-log (boot-uptime/device-version/obfl-history)  Enabled

    register-log                                        Enabled

    stack-trace                                         Enabled

    system-health                                       Enabled

    temp Error                                          Enabled

To display OBFL information stored in flash on a module, use the following commands:

Command	Purpose
show logging onboard boot-uptime	Displays the boot and uptime information.
show logging onboard counter-stats	Displays statistics on all ASIC counters.
show logging onboard device-version	Displays device version information.
show logging onboard endtime	Displays OBFL logs to a specified end time.
show logging onboard environmental-history	Displays environmental history.
show logging onboard error-stats	Displays error statistics.
show logging onboard exception-log	Displays exception log information.
show logging onboard interrupt-stats	Displays interrupt statistics.
show logging onboard kernel-trace	Displays kernel trace information.
show logging onboard module slot	Displays OBFL information for a specific module.
show logging onboard obfl-history	Displays history information.
show logging onboard obfl-logs	Displays log information.
show logging onboard stack-trace	Displays kernel stack trace information.
show logging onboard starttime	Displays OBFL logs from a specified start time.
show logging onboard status	Displays OBFL status information.

---

Note Use the clear logging onboard command to clear the OBFL information for each of the show command options listed.

---

OBFL Example Configuration

This example shows how to enable OBFL on module 2 for environmental information.

conf t

 hw-module logging onboard module 2 environmental-history

Default Settings

Table 11-1 lists the default settings for OBFL parameters.

Table 11-1 Default OBFL Parameters 

Parameters	Default
OBFL	All features enabled

Additional References

For additional information related to implementing OBFL, see the following sections:

•Related Documents

•Standards

Related Documents

Related Topic	Document Title
OBFL CLI commands	Cisco Nexus 7000 Series NX-OS System Management Configuration Guide, Release 4.0
configuration files	Cisco Nexus 7000 Series NX-OS Fundamentals Configuration Guide, Release 4.0
VDCs	Cisco Nexus 7000 Series NX-OS Virtual Device Context Configuration Guide, Release 4.0

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.	—