Debian Codegraph @

upstream/debian-trixie/man8/devlink-health.8

raw
1 .TH DEVLINK\-HEALTH 8 "20 Feb 2019" "iproute2" "Linux"
2 .SH NAME
3 devlink-health \- devlink health reporting and recovery
4 .SH SYNOPSIS
5 .sp
6 .ad l
7 .in +8
8 .ti -8
9 .B devlink
10 .RI "[ " OPTIONS " ]"
11 .B health
12 .RI " { " COMMAND " | "
13 .BR help " }"
14 .sp
15
16 .ti -8
17 .IR OPTIONS " := { "
18 \fB\-V\fR[\fIersion\fR] }
19
20 .ti -8
21 .B devlink health show
22 .RI "[ { " DEV " | " DEV/PORT_INDEX " }"
23 .B reporter
24 .RI ""REPORTER " ] "
25
26 .ti -8
27 .B devlink health recover
28 .RI "{ " DEV " | " DEV/PORT_INDEX " }"
29 .B reporter
30 .RI "" REPORTER ""
31
32 .ti -8
33 .B devlink health diagnose
34 .RI "{ " DEV " | " DEV/PORT_INDEX " }"
35 .B reporter
36 .RI "" REPORTER ""
37
38 .ti -8
39 .B devlink health dump show
40 .RI "{ " DEV " | " DEV/PORT_INDEX " }"
41 .B reporter
42 .RI "" REPORTER ""
43
44 .ti -8
45 .BR "devlink health test"
46 .RI "{ " DEV " | " DEV/PORT_INDEX " }"
47 .B reporter
48 .RI "" REPORTER ""
49
50 .ti -8
51 .B devlink health dump clear
52 .RI "{ " DEV " | " DEV/PORT_INDEX " }"
53 .B reporter
54 .RI "" REPORTER ""
55
56 .ti -8
57 .B devlink health set
58 .RI "{ " DEV " | " DEV/PORT_INDEX " }"
59 .B reporter
60 .RI "" REPORTER ""
61 [
62 .BI "grace_period " MSEC "
63 ] [
64 .BR auto_recover " { " true " | " false " } "
65 ] [
66 .BR auto_dump " { " true " | " false " } "
67 ]
68
69 .ti -8
70 .B devlink health help
71
72 .SH "DESCRIPTION"
73 .SS devlink health show - Show status and configuration on all supported reporters.
74 Displays info about reporters registered on devlink devices and ports.
75
76 .PP
77 .I "DEV"
78 - specifies the devlink device.
79 .br
80 .I DEV/PORT_INDEX
81 - specifies the devlink port.
82
83 .PP
84 .I "REPORTER"
85 - specifies the reporter's name registered on specified devlink device or port.
86
87 .SS devlink health recover - Initiate a recovery operation on a reporter.
88 This action performs a recovery and increases the recoveries counter on success.
89
90 .PP
91 .I "DEV"
92 - specifies the devlink device.
93 .br
94 .I DEV/PORT_INDEX
95 - specifies the devlink port.
96
97 .PP
98 .I "REPORTER"
99 - specifies the reporter's name registered on specified devlink device or port.
100
101 .SS devlink health diagnose - Retrieve diagnostics data on a reporter.
102
103 .PP
104 .I DEV
105 - specifies the devlink device.
106 .br
107 .I DEV/PORT_INDEX
108 - specifies the devlink port.
109
110 .PP
111 .I "REPORTER"
112 - specifies the reporter's name registered on specified devlink device or port.
113
114 .SS devlink health test - Trigger a test event on a reporter.
115
116 .PP
117 .I "DEV"
118 - specifies the devlink device.
119
120 .PP
121 .I "REPORTER"
122 - specifies the reporter's name registered on the devlink device.
123
124 .SS devlink health dump show - Display the last saved dump.
125
126 .PD 0
127 .P
128 devlink health saves a single dump per reporter. If an dump is
129 .P
130 not already stored by the Devlink, this command will generate a new
131 .P
132 dump. The dump can be generated either automatically when a
133 .P
134 reporter reports on an error or manually at the user's request.
135 .PD
136
137 .PP
138 .I "DEV"
139 - specifies the devlink device.
140 .br
141 .I DEV/PORT_INDEX
142 - specifies the devlink port.
143
144 .PP
145 .I "REPORTER"
146 - specifies the reporter's name registered on specified devlink device or port.
147
148 .SS devlink health dump clear - Delete the saved dump.
149 Deleting the saved dump enables a generation of a new dump on
150 .PD 0
151 .P
152 the next "devlink health dump show" command.
153 .PD
154
155 .PP
156 .I "DEV"
157 - specifies the devlink device.
158 .br
159 .I DEV/PORT_INDEX
160 - specifies the devlink port.
161
162 .PP
163 .I "REPORTER"
164 - specifies the reporter's name registered on specified devlink device or port.
165
166 .SS devlink health set - Configure health reporter.
167 Please note that some params are not supported on a reporter which
168 doesn't support a recovery or dump method.
169
170 .PP
171 .I "DEV"
172 - specifies the devlink device.
173 .br
174 .I DEV/PORT_INDEX
175 - specifies the devlink port.
176
177 .PP
178 .I "REPORTER"
179 - specifies the reporter's name registered on specified devlink device or port.
180
181 .TP
182 .BI grace_period " MSEC "
183 Time interval between consecutive auto recoveries.
184
185 .TP
186 .BR auto_recover " { " true " | " false " } "
187 Indicates whether the devlink should execute automatic recover on error.
188
189 .TP
190 .BR auto_dump " { " true " | " false " } "
191 Indicates whether the devlink should execute automatic dump on error.
192
193 .SH "EXAMPLES"
194 .PP
195 devlink health show
196 .RS 4
197 List status and configuration of available reporters on devices and ports.
198 .RE
199 .PP
200 devlink health show pci/0000:00:09.0/1 reporter tx
201 .RS 4
202 List status and configuration of tx reporter registered on port on pci/0000:00:09.0/1
203 .RE
204 .PP
205 devlink health recover pci/0000:00:09.0 reporter fw_fatal
206 .RS 4
207 Initiate recovery on fw_fatal reporter registered on device on pci/0000:00:09.0.
208 .RE
209 .PP
210 devlink health recover pci/0000:00:09.0/1 reporter tx
211 .RS 4
212 Initiate recovery on tx reporter registered on port on pci/0000:00:09.0/1.
213 .RE
214 .PP
215 devlink health diagnose pci/0000:00:09.0 reporter fw
216 .RS 4
217 List diagnostics data on the specified device and reporter.
218 .RE
219 .PP
220 devlink health dump show pci/0000:00:09.0/1 reporter tx
221 .RS 4
222 Display the last saved dump on the specified port and reporter.
223 .RE
224 .PP
225 devlink health dump clear pci/0000:00:09.0/1 reporter tx
226 .RS 4
227 Delete saved dump on the specified port and reporter.
228 .RE
229 .PP
230 devlink health set pci/0000:00:09.0 reporter fw_fatal grace_period 3500
231 .RS 4
232 Set time interval between auto recoveries to minimum of 3500 msec on
233 the specified device and reporter.
234 .RE
235 .PP
236 devlink health set pci/0000:00:09.0/1 reporter tx grace_period 3500
237 .RS 4
238 Set time interval between auto recoveries to minimum of 3500 msec on
239 the specified port and reporter.
240 .RE
241 .PP
242 devlink health set pci/0000:00:09.0 reporter fw_fatal auto_recover false
243 .RS 4
244 Turn off auto recovery on the specified device and reporter.
245
246 .RE
247 .SH SEE ALSO
248 .BR devlink (8),
249 .BR devlink-dev (8),
250 .BR devlink-port (8),
251 .BR devlink-param (8),
252 .BR devlink-region (8),
253 .br
254
255 .SH AUTHOR
256 Aya Levin <[email protected]>