{
    "content": [
        {
            "type": "text",
            "text": "# devlink-health (man)\n\n## NAME\n\ndevlink-health - devlink health reporting and recovery\n\n## SYNOPSIS\n\ndevlink [ OPTIONS ] health  { COMMAND | help }\nOPTIONS := { -V[ersion] }\ndevlink health show [ { DEV | DEV/PORTINDEX } reporter REPORTER ]\ndevlink health recover { DEV | DEV/PORTINDEX } reporter REPORTER\ndevlink health diagnose { DEV | DEV/PORTINDEX } reporter REPORTER\ndevlink health dump show { DEV | DEV/PORTINDEX } reporter REPORTER\ndevlink health test { DEV | DEV/PORTINDEX } reporter REPORTER\ndevlink health dump clear { DEV | DEV/PORTINDEX } reporter REPORTER\ndevlink health set { DEV | DEV/PORTINDEX } reporter REPORTER [ graceperiod MSEC ] [\nautorecover { true | false } ] [ autodump { true | false } ]\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS** (1 subsections)\n- **DESCRIPTION** (7 subsections)\n- **EXAMPLES**\n- **SEE ALSO**\n- **AUTHOR**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "devlink-health",
        "section": "",
        "mode": "man",
        "summary": "devlink-health - devlink health reporting and recovery",
        "synopsis": "devlink [ OPTIONS ] health  { COMMAND | help }\nOPTIONS := { -V[ersion] }\ndevlink health show [ { DEV | DEV/PORTINDEX } reporter REPORTER ]\ndevlink health recover { DEV | DEV/PORTINDEX } reporter REPORTER\ndevlink health diagnose { DEV | DEV/PORTINDEX } reporter REPORTER\ndevlink health dump show { DEV | DEV/PORTINDEX } reporter REPORTER\ndevlink health test { DEV | DEV/PORTINDEX } reporter REPORTER\ndevlink health dump clear { DEV | DEV/PORTINDEX } reporter REPORTER\ndevlink health set { DEV | DEV/PORTINDEX } reporter REPORTER [ graceperiod MSEC ] [\nautorecover { true | false } ] [ autodump { true | false } ]",
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "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 fwfatal",
            "Initiate recovery on fwfatal 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 fwfatal graceperiod 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 graceperiod 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 fwfatal autorecover false",
            "Turn off auto recovery on the specified device and reporter."
        ],
        "see_also": [
            {
                "name": "devlink",
                "section": "8",
                "url": "https://www.chedong.com/phpMan.php/man/devlink/8/json"
            },
            {
                "name": "devlink-dev",
                "section": "8",
                "url": "https://www.chedong.com/phpMan.php/man/devlink-dev/8/json"
            },
            {
                "name": "devlink-port",
                "section": "8",
                "url": "https://www.chedong.com/phpMan.php/man/devlink-port/8/json"
            },
            {
                "name": "devlink-param",
                "section": "8",
                "url": "https://www.chedong.com/phpMan.php/man/devlink-param/8/json"
            },
            {
                "name": "devlink-region",
                "section": "8",
                "url": "https://www.chedong.com/phpMan.php/man/devlink-region/8/json"
            }
        ],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 20,
                "subsections": [
                    {
                        "name": "devlink health help",
                        "lines": 1
                    }
                ]
            },
            {
                "name": "DESCRIPTION",
                "lines": 1,
                "subsections": [
                    {
                        "name": "devlink health show - Show status and configuration on all supported reporters.",
                        "lines": 10
                    },
                    {
                        "name": "devlink health recover - Initiate a recovery operation on a reporter.",
                        "lines": 10
                    },
                    {
                        "name": "devlink health diagnose - Retrieve diagnostics data on a reporter.",
                        "lines": 7
                    },
                    {
                        "name": "devlink health test - Trigger a test event on a reporter.",
                        "lines": 6
                    },
                    {
                        "name": "devlink health dump show - Display the last saved dump.",
                        "lines": 13
                    },
                    {
                        "name": "devlink health dump clear - Delete the saved dump.",
                        "lines": 11
                    },
                    {
                        "name": "devlink health set - Configure health reporter.",
                        "lines": 23
                    }
                ]
            },
            {
                "name": "EXAMPLES",
                "lines": 33,
                "subsections": []
            },
            {
                "name": "SEE ALSO",
                "lines": 3,
                "subsections": []
            },
            {
                "name": "AUTHOR",
                "lines": 5,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "devlink-health - devlink health reporting and recovery\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "devlink [ OPTIONS ] health  { COMMAND | help }\n\n\nOPTIONS := { -V[ersion] }\n\ndevlink health show [ { DEV | DEV/PORTINDEX } reporter REPORTER ]\n\ndevlink health recover { DEV | DEV/PORTINDEX } reporter REPORTER\n\ndevlink health diagnose { DEV | DEV/PORTINDEX } reporter REPORTER\n\ndevlink health dump show { DEV | DEV/PORTINDEX } reporter REPORTER\n\ndevlink health test { DEV | DEV/PORTINDEX } reporter REPORTER\n\ndevlink health dump clear { DEV | DEV/PORTINDEX } reporter REPORTER\n\ndevlink health set { DEV | DEV/PORTINDEX } reporter REPORTER [ graceperiod MSEC ] [\nautorecover { true | false } ] [ autodump { true | false } ]\n",
                "subsections": [
                    {
                        "name": "devlink health help",
                        "content": ""
                    }
                ]
            },
            "DESCRIPTION": {
                "content": "",
                "subsections": [
                    {
                        "name": "devlink health show - Show status and configuration on all supported reporters.",
                        "content": "Displays info about reporters registered on devlink devices and ports.\n\n\nDEV - specifies the devlink device.\nDEV/PORTINDEX - specifies the devlink port.\n\n\nREPORTER - specifies the reporter's name registered on specified devlink device or port.\n\n"
                    },
                    {
                        "name": "devlink health recover - Initiate a recovery operation on a reporter.",
                        "content": "This action performs a recovery and increases the recoveries counter on success.\n\n\nDEV - specifies the devlink device.\nDEV/PORTINDEX - specifies the devlink port.\n\n\nREPORTER - specifies the reporter's name registered on specified devlink device or port.\n\n"
                    },
                    {
                        "name": "devlink health diagnose - Retrieve diagnostics data on a reporter.",
                        "content": "DEV - specifies the devlink device.\nDEV/PORTINDEX - specifies the devlink port.\n\n\nREPORTER - specifies the reporter's name registered on specified devlink device or port.\n\n"
                    },
                    {
                        "name": "devlink health test - Trigger a test event on a reporter.",
                        "content": "DEV - specifies the devlink device.\n\n\nREPORTER - specifies the reporter's name registered on the devlink device.\n\n"
                    },
                    {
                        "name": "devlink health dump show - Display the last saved dump.",
                        "content": "devlink health saves a single dump per reporter. If an dump is\nnot already stored by the Devlink, this command will generate a new\ndump. The dump can be generated either automatically when a\nreporter reports on an error or manually at the user's request.\n\n\nDEV - specifies the devlink device.\nDEV/PORTINDEX - specifies the devlink port.\n\n\nREPORTER - specifies the reporter's name registered on specified devlink device or port.\n\n"
                    },
                    {
                        "name": "devlink health dump clear - Delete the saved dump.",
                        "content": "Deleting the saved dump enables a generation of a new dump on\nthe next \"devlink health dump show\" command.\n\n\nDEV - specifies the devlink device.\nDEV/PORTINDEX - specifies the devlink port.\n\n\nREPORTER - specifies the reporter's name registered on specified devlink device or port.\n\n"
                    },
                    {
                        "name": "devlink health set - Configure health reporter.",
                        "content": "Please note that some params are not supported on a reporter which doesn't support a recovery\nor dump method.\n\n\nDEV - specifies the devlink device.\nDEV/PORTINDEX - specifies the devlink port.\n\n\nREPORTER - specifies the reporter's name registered on specified devlink device or port.\n\n\ngraceperiod MSEC\nTime interval between consecutive auto recoveries.\n\n\nautorecover { true | false }\nIndicates whether the devlink should execute automatic recover on error.\n\n\nautodump { true | false }\nIndicates whether the devlink should execute automatic dump on error.\n\n"
                    }
                ]
            },
            "EXAMPLES": {
                "content": "devlink health show\nList status and configuration of available reporters on devices and ports.\n\ndevlink health show pci/0000:00:09.0/1 reporter tx\nList status and configuration of tx reporter registered on port on pci/0000:00:09.0/1\n\ndevlink health recover pci/0000:00:09.0 reporter fwfatal\nInitiate recovery on fwfatal reporter registered on device on pci/0000:00:09.0.\n\ndevlink health recover pci/0000:00:09.0/1 reporter tx\nInitiate recovery on tx reporter registered on port on pci/0000:00:09.0/1.\n\ndevlink health diagnose pci/0000:00:09.0 reporter fw\nList diagnostics data on the specified device and reporter.\n\ndevlink health dump show pci/0000:00:09.0/1 reporter tx\nDisplay the last saved dump on the specified port and reporter.\n\ndevlink health dump clear pci/0000:00:09.0/1 reporter tx\nDelete saved dump on the specified port and reporter.\n\ndevlink health set pci/0000:00:09.0 reporter fwfatal graceperiod 3500\nSet time interval between auto recoveries to minimum of 3500 msec on the specified device\nand reporter.\n\ndevlink health set pci/0000:00:09.0/1 reporter tx graceperiod 3500\nSet time interval between auto recoveries to minimum of 3500 msec on the specified port\nand reporter.\n\ndevlink health set pci/0000:00:09.0 reporter fwfatal autorecover false\nTurn off auto recovery on the specified device and reporter.\n\n",
                "subsections": []
            },
            "SEE ALSO": {
                "content": "devlink(8), devlink-dev(8), devlink-port(8), devlink-param(8), devlink-region(8),\n\n",
                "subsections": []
            },
            "AUTHOR": {
                "content": "Aya Levin <ayal@mellanox.com>\n\n\n\niproute2                                     20 Feb 2019                           DEVLINK-HEALTH(8)",
                "subsections": []
            }
        }
    }
}