DEVLINK-HEALTH(8) Linux DEVLINK-HEALTH(8) # [NAME](#NAME) devlink-health - devlink health reporting and recovery # [SYNOPSIS](#SYNOPSIS) **devlink** \[ *OPTIONS* ] **health** { *COMMAND* | **help** } *OPTIONS* := { **-V**\[*ersion*] } **devlink health show** \[ { *DEV* | *DEV/PORT\_INDEX* } **reporter** *REPORTER* ] **devlink health recover** { *DEV* | *DEV/PORT\_INDEX* } **reporter** *REPORTER* **devlink health diagnose** { *DEV* | *DEV/PORT\_INDEX* } **reporter** *REPORTER* **devlink health dump show** { *DEV* | *DEV/PORT\_INDEX* } **reporter** *REPORTER* **devlink health test** { *DEV* | *DEV/PORT\_INDEX* } **reporter** *REPORTER* **devlink health dump clear** { *DEV* | *DEV/PORT\_INDEX* } **reporter** *REPORTER* **devlink health set** { *DEV* | *DEV/PORT\_INDEX* } **reporter** *REPORTER* \[ **grace\_period MSEC** ] \[ **burst\_period MSEC** ] \[ **auto\_recover** { **true** | **false** } ] \[ **auto\_dump** { **true** | **false** } ] **devlink health help** # [DESCRIPTION](#DESCRIPTION) ## [devlink health show - Show status and configuration on all supported reporters.](#devlink_health_show_-_Show_status_and_configuration_on_all_supported_reporters.) Displays info about reporters registered on devlink devices and ports. *DEV* - specifies the devlink device. *DEV/PORT\_INDEX* - specifies the devlink port. *REPORTER* - specifies the reporter's name registered on specified devlink device or port. ## [devlink health recover - Initiate a recovery operation on a reporter.](#devlink_health_recover_-_Initiate_a_recovery_operation_on_a_reporter.) This action performs a recovery and increases the recoveries counter on success. *DEV* - specifies the devlink device. *DEV/PORT\_INDEX* - specifies the devlink port. *REPORTER* - specifies the reporter's name registered on specified devlink device or port. ## [devlink health diagnose - Retrieve diagnostics data on a reporter.](#devlink_health_diagnose_-_Retrieve_diagnostics_data_on_a_reporter.) *DEV* - specifies the devlink device. *DEV/PORT\_INDEX* - specifies the devlink port. *REPORTER* - specifies the reporter's name registered on specified devlink device or port. ## [devlink health test - Trigger a test event on a reporter.](#devlink_health_test_-_Trigger_a_test_event_on_a_reporter.) *DEV* - specifies the devlink device. *REPORTER* - specifies the reporter's name registered on the devlink device. ## [devlink health dump show - Display the last saved dump.](#devlink_health_dump_show_-_Display_the_last_saved_dump.) devlink health saves a single dump per reporter. If an dump is not already stored by the Devlink, this command will generate a new dump. The dump can be generated either automatically when a reporter reports on an error or manually at the user's request. *DEV* - specifies the devlink device. *DEV/PORT\_INDEX* - specifies the devlink port. *REPORTER* - specifies the reporter's name registered on specified devlink device or port. ## [devlink health dump clear - Delete the saved dump.](#devlink_health_dump_clear_-_Delete_the_saved_dump.) Deleting the saved dump enables a generation of a new dump on the next "devlink health dump show" command. *DEV* - specifies the devlink device. *DEV/PORT\_INDEX* - specifies the devlink port. *REPORTER* - specifies the reporter's name registered on specified devlink device or port. ## [devlink health set - Configure health reporter.](#devlink_health_set_-_Configure_health_reporter.) Please note that some params are not supported on a reporter which doesn't support a recovery or dump method. *DEV* - specifies the devlink device. *DEV/PORT\_INDEX* - specifies the devlink port. *REPORTER* - specifies the reporter's name registered on specified devlink device or port. [**grace\_period MSEC**](#grace_period) Time interval between consecutive auto recoveries. [**burst\_period MSEC**](#burst_period) Time window for error recoveries before starting the grace period. Configuring burst\_period is invalid when the grace period is disabled. [**auto\_recover** { **true** | **false** }](#auto_recover) Indicates whether the devlink should execute automatic recover on error. [**auto\_dump** { **true** | **false** }](#auto_dump) Indicates whether the devlink should execute automatic dump on error. # [EXAMPLES](#EXAMPLES) devlink health show List status and configuration of available reporters on devices and ports. devlink health show pci/0000:00:09.0/1 reporter tx List status and configuration of tx reporter registered on port on pci/0000:00:09.0/1 devlink health recover pci/0000:00:09.0 reporter fw\_fatal Initiate recovery on fw\_fatal reporter registered on device on pci/0000:00:09.0. devlink health recover pci/0000:00:09.0/1 reporter tx Initiate recovery on tx reporter registered on port on pci/0000:00:09.0/1. devlink health diagnose pci/0000:00:09.0 reporter fw List diagnostics data on the specified device and reporter. devlink health dump show pci/0000:00:09.0/1 reporter tx Display the last saved dump on the specified port and reporter. devlink health dump clear pci/0000:00:09.0/1 reporter tx Delete saved dump on the specified port and reporter. devlink health set pci/0000:00:09.0 reporter fw\_fatal grace\_period 3500 Set time interval between auto recoveries to minimum of 3500 msec on the specified device and reporter. devlink health set pci/0000:00:09.0/1 reporter tx grace\_period 3500 Set time interval between auto recoveries to minimum of 3500 msec on the specified port and reporter. devlink health set pci/0000:00:09.0 reporter fw\_fatal auto\_recover false Turn off auto recovery on the specified device and reporter. devlink health set pci/0000:00:09.0 reporter tx burst\_period 5000 Set the burst period to 5000 milliseconds on the specified device and reporter, prior to initiating the grace period. devlink health set pci/0000:00:09.0 reporter tx grace\_period 0 Disable grace period on the specified device and reporter. Disabling the grace period also deactivates the burst period. # [SEE ALSO](#SEE_ALSO) [**devlink**(8)](/man/os/iproute2/devlink.8), [**devlink-dev**(8)](/man/os/iproute2/devlink-dev.8), [**devlink-port**(8)](/man/os/iproute2/devlink-port.8), [**devlink-param**(8)](/man/os/iproute2/devlink-param.8), [**devlink-region**(8)](/man/os/iproute2/devlink-region.8), # [AUTHOR](#AUTHOR) Aya Levin <ayal@mellanox.com> 20 Feb 2019 iproute2 --- Document: devlink-health(8) from iproute2 7.2.0-r1 (Chainguard OS) Source: https://kernel.googlesource.com/pub/scm/network/iproute2/iproute2