summaryrefslogtreecommitdiffstats
path: root/upstream/fedora-40/man8/devlink-health.8
blob: 975b8c75d79818dbcb977218ab304547fd044b13 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
.TH DEVLINK\-HEALTH 8 "20 Feb 2019" "iproute2" "Linux"
.SH NAME
devlink-health \- devlink health reporting and recovery
.SH SYNOPSIS
.sp
.ad l
.in +8
.ti -8
.B devlink
.RI "[ " OPTIONS " ]"
.B health
.RI  " { " COMMAND " | "
.BR help " }"
.sp

.ti -8
.IR OPTIONS " := { "
\fB\-V\fR[\fIersion\fR] }

.ti -8
.B devlink health show
.RI "[ { " DEV " | " DEV/PORT_INDEX " }"
.B reporter
.RI ""REPORTER " ] "

.ti -8
.B devlink health recover
.RI "{ " DEV " | " DEV/PORT_INDEX " }"
.B reporter
.RI "" REPORTER ""

.ti -8
.B devlink health diagnose
.RI "{ " DEV " | " DEV/PORT_INDEX " }"
.B reporter
.RI "" REPORTER ""

.ti -8
.B devlink health dump show
.RI "{ " DEV " | " DEV/PORT_INDEX " }"
.B  reporter
.RI "" REPORTER ""

.ti -8
.BR "devlink health test"
.RI "{ " DEV " | " DEV/PORT_INDEX " }"
.B reporter
.RI "" REPORTER ""

.ti -8
.B devlink health dump clear
.RI "{ " DEV " | " DEV/PORT_INDEX " }"
.B reporter
.RI "" REPORTER ""

.ti -8
.B devlink health set
.RI "{ " DEV " | " DEV/PORT_INDEX " }"
.B reporter
.RI "" REPORTER ""
[
.BI "grace_period " MSEC "
] [
.BR auto_recover " { " true " | " false " } "
] [
.BR auto_dump " { " true " | " false " } "
]

.ti -8
.B devlink health help

.SH "DESCRIPTION"
.SS devlink health show - Show status and configuration on all supported reporters.
Displays info about reporters registered on devlink devices and ports.

.PP
.I "DEV"
- specifies the devlink device.
.br
.I DEV/PORT_INDEX
- specifies the devlink port.

.PP
.I "REPORTER"
- specifies the reporter's name registered on specified devlink device or port.

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

.PP
.I "DEV"
- specifies the devlink device.
.br
.I DEV/PORT_INDEX
- specifies the devlink port.

.PP
.I "REPORTER"
- specifies the reporter's name registered on specified devlink device or port.

.SS devlink health diagnose - Retrieve diagnostics data on a reporter.

.PP
.I DEV
- specifies the devlink device.
.br
.I DEV/PORT_INDEX
- specifies the devlink port.

.PP
.I "REPORTER"
- specifies the reporter's name registered on specified devlink device or port.

.SS devlink health test - Trigger a test event on a reporter.

.PP
.I "DEV"
- specifies the devlink device.

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

.SS devlink health dump show - Display the last saved dump.

.PD 0
.P
devlink health saves a single dump per reporter. If an dump is
.P
not already stored by the Devlink, this command will generate a new
.P
dump. The dump can be generated either automatically when a
.P
reporter reports on an error or manually at the user's request.
.PD

.PP
.I "DEV"
- specifies the devlink device.
.br
.I DEV/PORT_INDEX
- specifies the devlink port.

.PP
.I "REPORTER"
- specifies the reporter's name registered on specified devlink device or port.

.SS devlink health dump clear - Delete the saved dump.
Deleting the saved dump enables a generation of a new dump on
.PD 0
.P
the next "devlink health dump show" command.
.PD

.PP
.I "DEV"
- specifies the devlink device.
.br
.I DEV/PORT_INDEX
- specifies the devlink port.

.PP
.I "REPORTER"
- specifies the reporter's name registered on specified devlink device or port.

.SS 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.

.PP
.I "DEV"
- specifies the devlink device.
.br
.I DEV/PORT_INDEX
- specifies the devlink port.

.PP
.I "REPORTER"
- specifies the reporter's name registered on specified devlink device or port.

.TP
.BI grace_period " MSEC "
Time interval between consecutive auto recoveries.

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

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

.SH "EXAMPLES"
.PP
devlink health show
.RS 4
List status and configuration of available reporters on devices and ports.
.RE
.PP
devlink health show pci/0000:00:09.0/1 reporter tx
.RS 4
List status and configuration of tx reporter registered on port on pci/0000:00:09.0/1
.RE
.PP
devlink health recover pci/0000:00:09.0 reporter fw_fatal
.RS 4
Initiate recovery on fw_fatal reporter registered on device on pci/0000:00:09.0.
.RE
.PP
devlink health recover pci/0000:00:09.0/1 reporter tx
.RS 4
Initiate recovery on tx reporter registered on port on pci/0000:00:09.0/1.
.RE
.PP
devlink health diagnose pci/0000:00:09.0 reporter fw
.RS 4
List diagnostics data on the specified device and reporter.
.RE
.PP
devlink health dump show pci/0000:00:09.0/1 reporter tx
.RS 4
Display the last saved dump on the specified port and reporter.
.RE
.PP
devlink health dump clear pci/0000:00:09.0/1 reporter tx
.RS 4
Delete saved dump on the specified port and reporter.
.RE
.PP
devlink health set pci/0000:00:09.0 reporter fw_fatal grace_period 3500
.RS 4
Set time interval between auto recoveries to minimum of 3500 msec on
the specified device and reporter.
.RE
.PP
devlink health set pci/0000:00:09.0/1 reporter tx grace_period 3500
.RS 4
Set time interval between auto recoveries to minimum of 3500 msec on
the specified port and reporter.
.RE
.PP
devlink health set pci/0000:00:09.0 reporter fw_fatal auto_recover false
.RS 4
Turn off auto recovery on the specified device and reporter.

.RE
.SH SEE ALSO
.BR devlink (8),
.BR devlink-dev (8),
.BR devlink-port (8),
.BR devlink-param (8),
.BR devlink-region (8),
.br

.SH AUTHOR
Aya Levin <ayal@mellanox.com>