DEVLINK-HEALTH(8)         (20 Feb 2019)         DEVLINK-HEALTH(8)

     NAME
          devlink-health - devlink health reporting and recovery

     SYNOPSIS
          devlink [ OPTIONS ] health  { COMMAND | help }

          OPTIONS := {  -V[ersion] }

          devlink health show [ { DEV | DEV/PORT_INDEX } reporter

          devlink health recover { DEV | DEV/PORT_INDEX } reporter

          devlink health diagnose { DEV | DEV/PORT_INDEX } reporter

          devlink health dump show { DEV | DEV/PORT_INDEX } reporter

          devlink health test { DEV | DEV/PORT_INDEX } reporter

          devlink health dump clear { DEV | DEV/PORT_INDEX } reporter

          devlink health set { DEV | DEV/PORT_INDEX } reporter  [
                  grace_period MSEC ] [ auto_recover { true | false }
                  ] [ auto_dump { true | false } ]

          devlink health help

     DESCRIPTION
        devlink health show - Show status
          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 spec-
          ified devlink device or port.

        devlink health recover - Initiate a
          This action performs a recovery and increases the recoveries
          counter on success.

          DEV - specifies the devlink device.
          DEV/PORT_INDEX - specifies the devlink port.

     Page 1                      iproute2            (printed 5/24/22)

     DEVLINK-HEALTH(8)         (20 Feb 2019)         DEVLINK-HEALTH(8)

          REPORTER - specifies the reporter's name registered on spec-
          ified devlink device or port.

        devlink health diagnose - Retrieve diagnostics
          DEV - specifies the devlink device.
          DEV/PORT_INDEX - specifies the devlink port.

          REPORTER - specifies the reporter's name registered on spec-
          ified devlink device or port.

        devlink health test - Trigger a
          DEV - specifies the devlink device.

          REPORTER - specifies the reporter's name registered on the
          devlink device.

        devlink health dump show - Display
          devlink health saves a single dump per reporter. If an dump
          is
          not already stored by the Devlink, this command will gener-
          ate 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 spec-
          ified devlink device or port.

        devlink health dump clear - Delete
          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 spec-
          ified devlink device or port.

     Page 2                      iproute2            (printed 5/24/22)

     DEVLINK-HEALTH(8)         (20 Feb 2019)         DEVLINK-HEALTH(8)

        devlink health set - Configure health
          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 spec-
          ified devlink device or port.

          grace_period MSEC
               Time interval between consecutive auto recoveries.

          auto_recover { true | false }
               Indicates whether the devlink should execute automatic
               recover on error.

          auto_dump { true | false }
               Indicates whether the devlink should execute automatic
               dump on error.

     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.

     Page 3                      iproute2            (printed 5/24/22)

     DEVLINK-HEALTH(8)         (20 Feb 2019)         DEVLINK-HEALTH(8)

          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.

     SEE ALSO
          devlink(8), devlink-dev(8), devlink-port(8),
          devlink-param(8), devlink-region(8),

     AUTHOR
          Aya Levin <ayal@mellanox.com>

     Page 4                      iproute2            (printed 5/24/22)