1DEVLINK-HEALTH(8)                    Linux                   DEVLINK-HEALTH(8)
2
3
4

NAME

6       devlink-health - devlink health reporting and recovery
7

SYNOPSIS

9       devlink [ OPTIONS ] health  { COMMAND | help }
10
11
12       OPTIONS := { -V[ersion] }
13
14       devlink health show [ { DEV | DEV/PORT_INDEX } reporter REPORTER ]
15
16       devlink health recover { DEV | DEV/PORT_INDEX } reporter REPORTER
17
18       devlink health diagnose { DEV | DEV/PORT_INDEX } reporter REPORTER
19
20       devlink health dump show { DEV | DEV/PORT_INDEX } reporter REPORTER
21
22       devlink health test { DEV | DEV/PORT_INDEX } reporter REPORTER
23
24       devlink health dump clear { DEV | DEV/PORT_INDEX } reporter REPORTER
25
26       devlink health set { DEV | DEV/PORT_INDEX } reporter REPORTER [
27               grace_period MSEC ] [ auto_recover { true | false } ] [
28               auto_dump { true | false } ]
29
30       devlink health help
31
32

DESCRIPTION

34   devlink health show - Show status and configuration on all supported re‐
35       porters.
36       Displays info about reporters registered on devlink devices and ports.
37
38
39       DEV - specifies the devlink device.
40       DEV/PORT_INDEX - specifies the devlink port.
41
42
43       REPORTER - specifies the reporter's name registered on specified de‐
44       vlink device or port.
45
46
47   devlink health recover - Initiate a recovery operation on a reporter.
48       This action performs a recovery and increases the recoveries counter on
49       success.
50
51
52       DEV - specifies the devlink device.
53       DEV/PORT_INDEX - specifies the devlink port.
54
55
56       REPORTER - specifies the reporter's name registered on specified de‐
57       vlink device or port.
58
59
60   devlink health diagnose - Retrieve diagnostics data on a reporter.
61       DEV - specifies the devlink device.
62       DEV/PORT_INDEX - specifies the devlink port.
63
64
65       REPORTER - specifies the reporter's name registered on specified de‐
66       vlink device or port.
67
68
69   devlink health test - Trigger a test event on a reporter.
70       DEV - specifies the devlink device.
71
72
73       REPORTER - specifies the reporter's name registered on the devlink de‐
74       vice.
75
76
77   devlink health dump show - Display the last saved dump.
78       devlink health saves a single dump per reporter. If an dump is
79       not already stored by the Devlink, this command will generate a new
80       dump. The dump can be generated either automatically when a
81       reporter reports on an error or manually at the user's request.
82
83
84       DEV - specifies the devlink device.
85       DEV/PORT_INDEX - specifies the devlink port.
86
87
88       REPORTER - specifies the reporter's name registered on specified de‐
89       vlink device or port.
90
91
92   devlink health dump clear - Delete the saved dump.
93       Deleting the saved dump enables a generation of a new dump on
94       the next "devlink health dump show" command.
95
96
97       DEV - specifies the devlink device.
98       DEV/PORT_INDEX - specifies the devlink port.
99
100
101       REPORTER - specifies the reporter's name registered on specified de‐
102       vlink device or port.
103
104
105   devlink health set - Configure health reporter.
106       Please note that some params are not supported on a reporter which
107       doesn't support a recovery or dump method.
108
109
110       DEV - specifies the devlink device.
111       DEV/PORT_INDEX - specifies the devlink port.
112
113
114       REPORTER - specifies the reporter's name registered on specified de‐
115       vlink device or port.
116
117
118       grace_period MSEC
119              Time interval between consecutive auto recoveries.
120
121
122       auto_recover { true | false }
123              Indicates whether the devlink should execute automatic recover
124              on error.
125
126
127       auto_dump { true | false }
128              Indicates whether the devlink should execute automatic dump on
129              error.
130
131

EXAMPLES

133       devlink health show
134           List status and configuration of available reporters on devices and
135           ports.
136
137       devlink health show pci/0000:00:09.0/1 reporter tx
138           List status and configuration of tx reporter registered on port on
139           pci/0000:00:09.0/1
140
141       devlink health recover pci/0000:00:09.0 reporter fw_fatal
142           Initiate recovery on fw_fatal reporter registered on device on
143           pci/0000:00:09.0.
144
145       devlink health recover pci/0000:00:09.0/1 reporter tx
146           Initiate recovery on tx reporter registered on port on
147           pci/0000:00:09.0/1.
148
149       devlink health diagnose pci/0000:00:09.0 reporter fw
150           List diagnostics data on the specified device and reporter.
151
152       devlink health dump show pci/0000:00:09.0/1 reporter tx
153           Display the last saved dump on the specified port and reporter.
154
155       devlink health dump clear pci/0000:00:09.0/1 reporter tx
156           Delete saved dump on the specified port and reporter.
157
158       devlink health set pci/0000:00:09.0 reporter fw_fatal grace_period 3500
159           Set time interval between auto recoveries to minimum of 3500 msec
160           on the specified device and reporter.
161
162       devlink health set pci/0000:00:09.0/1 reporter tx grace_period 3500
163           Set time interval between auto recoveries to minimum of 3500 msec
164           on the specified port and reporter.
165
166       devlink health set pci/0000:00:09.0 reporter fw_fatal auto_recover
167       false
168           Turn off auto recovery on the specified device and reporter.
169
170

SEE ALSO

172       devlink(8), devlink-dev(8), devlink-port(8), devlink-param(8), devlink-
173       region(8),
174
175

AUTHOR

177       Aya Levin <ayal@mellanox.com>
178
179
180
181iproute2                          20 Feb 2019                DEVLINK-HEALTH(8)