| 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 |
.BI "burst_period " MSEC " |
| 65 |
] [ |
| 66 |
.BR auto_recover " { " true " | " false " } " |
| 67 |
] [ |
| 68 |
.BR auto_dump " { " true " | " false " } " |
| 69 |
] |
| 70 |
|
| 71 |
.ti -8 |
| 72 |
.B devlink health help |
| 73 |
|
| 74 |
.SH "DESCRIPTION" |
| 75 |
.SS devlink health show - Show status and configuration on all supported reporters. |
| 76 |
Displays info about reporters registered on devlink devices and ports. |
| 77 |
|
| 78 |
.PP |
| 79 |
.I "DEV" |
| 80 |
- specifies the devlink device. |
| 81 |
.br |
| 82 |
.I DEV/PORT_INDEX |
| 83 |
- specifies the devlink port. |
| 84 |
|
| 85 |
.PP |
| 86 |
.I "REPORTER" |
| 87 |
- specifies the reporter's name registered on specified devlink device or port. |
| 88 |
|
| 89 |
.SS devlink health recover - Initiate a recovery operation on a reporter. |
| 90 |
This action performs a recovery and increases the recoveries counter on success. |
| 91 |
|
| 92 |
.PP |
| 93 |
.I "DEV" |
| 94 |
- specifies the devlink device. |
| 95 |
.br |
| 96 |
.I DEV/PORT_INDEX |
| 97 |
- specifies the devlink port. |
| 98 |
|
| 99 |
.PP |
| 100 |
.I "REPORTER" |
| 101 |
- specifies the reporter's name registered on specified devlink device or port. |
| 102 |
|
| 103 |
.SS devlink health diagnose - Retrieve diagnostics data on a reporter. |
| 104 |
|
| 105 |
.PP |
| 106 |
.I DEV |
| 107 |
- specifies the devlink device. |
| 108 |
.br |
| 109 |
.I DEV/PORT_INDEX |
| 110 |
- specifies the devlink port. |
| 111 |
|
| 112 |
.PP |
| 113 |
.I "REPORTER" |
| 114 |
- specifies the reporter's name registered on specified devlink device or port. |
| 115 |
|
| 116 |
.SS devlink health test - Trigger a test event on a reporter. |
| 117 |
|
| 118 |
.PP |
| 119 |
.I "DEV" |
| 120 |
- specifies the devlink device. |
| 121 |
|
| 122 |
.PP |
| 123 |
.I "REPORTER" |
| 124 |
- specifies the reporter's name registered on the devlink device. |
| 125 |
|
| 126 |
.SS devlink health dump show - Display the last saved dump. |
| 127 |
|
| 128 |
.PD 0 |
| 129 |
.P |
| 130 |
devlink health saves a single dump per reporter. If an dump is |
| 131 |
.P |
| 132 |
not already stored by the Devlink, this command will generate a new |
| 133 |
.P |
| 134 |
dump. The dump can be generated either automatically when a |
| 135 |
.P |
| 136 |
reporter reports on an error or manually at the user's request. |
| 137 |
.PD |
| 138 |
|
| 139 |
.PP |
| 140 |
.I "DEV" |
| 141 |
- specifies the devlink device. |
| 142 |
.br |
| 143 |
.I DEV/PORT_INDEX |
| 144 |
- specifies the devlink port. |
| 145 |
|
| 146 |
.PP |
| 147 |
.I "REPORTER" |
| 148 |
- specifies the reporter's name registered on specified devlink device or port. |
| 149 |
|
| 150 |
.SS devlink health dump clear - Delete the saved dump. |
| 151 |
Deleting the saved dump enables a generation of a new dump on |
| 152 |
.PD 0 |
| 153 |
.P |
| 154 |
the next "devlink health dump show" command. |
| 155 |
.PD |
| 156 |
|
| 157 |
.PP |
| 158 |
.I "DEV" |
| 159 |
- specifies the devlink device. |
| 160 |
.br |
| 161 |
.I DEV/PORT_INDEX |
| 162 |
- specifies the devlink port. |
| 163 |
|
| 164 |
.PP |
| 165 |
.I "REPORTER" |
| 166 |
- specifies the reporter's name registered on specified devlink device or port. |
| 167 |
|
| 168 |
.SS devlink health set - Configure health reporter. |
| 169 |
Please note that some params are not supported on a reporter which |
| 170 |
doesn't support a recovery or dump method. |
| 171 |
|
| 172 |
.PP |
| 173 |
.I "DEV" |
| 174 |
- specifies the devlink device. |
| 175 |
.br |
| 176 |
.I DEV/PORT_INDEX |
| 177 |
- specifies the devlink port. |
| 178 |
|
| 179 |
.PP |
| 180 |
.I "REPORTER" |
| 181 |
- specifies the reporter's name registered on specified devlink device or port. |
| 182 |
|
| 183 |
.TP |
| 184 |
.BI grace_period " MSEC " |
| 185 |
Time interval between consecutive auto recoveries. |
| 186 |
|
| 187 |
.TP |
| 188 |
.BI burst_period " MSEC " |
| 189 |
Time window for error recoveries before starting the grace period. |
| 190 |
Configuring burst_period is invalid when the grace period is disabled. |
| 191 |
|
| 192 |
.TP |
| 193 |
.BR auto_recover " { " true " | " false " } " |
| 194 |
Indicates whether the devlink should execute automatic recover on error. |
| 195 |
|
| 196 |
.TP |
| 197 |
.BR auto_dump " { " true " | " false " } " |
| 198 |
Indicates whether the devlink should execute automatic dump on error. |
| 199 |
|
| 200 |
.SH "EXAMPLES" |
| 201 |
.PP |
| 202 |
devlink health show |
| 203 |
.RS 4 |
| 204 |
List status and configuration of available reporters on devices and ports. |
| 205 |
.RE |
| 206 |
.PP |
| 207 |
devlink health show pci/0000:00:09.0/1 reporter tx |
| 208 |
.RS 4 |
| 209 |
List status and configuration of tx reporter registered on port on pci/0000:00:09.0/1 |
| 210 |
.RE |
| 211 |
.PP |
| 212 |
devlink health recover pci/0000:00:09.0 reporter fw_fatal |
| 213 |
.RS 4 |
| 214 |
Initiate recovery on fw_fatal reporter registered on device on pci/0000:00:09.0. |
| 215 |
.RE |
| 216 |
.PP |
| 217 |
devlink health recover pci/0000:00:09.0/1 reporter tx |
| 218 |
.RS 4 |
| 219 |
Initiate recovery on tx reporter registered on port on pci/0000:00:09.0/1. |
| 220 |
.RE |
| 221 |
.PP |
| 222 |
devlink health diagnose pci/0000:00:09.0 reporter fw |
| 223 |
.RS 4 |
| 224 |
List diagnostics data on the specified device and reporter. |
| 225 |
.RE |
| 226 |
.PP |
| 227 |
devlink health dump show pci/0000:00:09.0/1 reporter tx |
| 228 |
.RS 4 |
| 229 |
Display the last saved dump on the specified port and reporter. |
| 230 |
.RE |
| 231 |
.PP |
| 232 |
devlink health dump clear pci/0000:00:09.0/1 reporter tx |
| 233 |
.RS 4 |
| 234 |
Delete saved dump on the specified port and reporter. |
| 235 |
.RE |
| 236 |
.PP |
| 237 |
devlink health set pci/0000:00:09.0 reporter fw_fatal grace_period 3500 |
| 238 |
.RS 4 |
| 239 |
Set time interval between auto recoveries to minimum of 3500 msec on |
| 240 |
the specified device and reporter. |
| 241 |
.RE |
| 242 |
.PP |
| 243 |
devlink health set pci/0000:00:09.0/1 reporter tx grace_period 3500 |
| 244 |
.RS 4 |
| 245 |
Set time interval between auto recoveries to minimum of 3500 msec on |
| 246 |
the specified port and reporter. |
| 247 |
.RE |
| 248 |
.PP |
| 249 |
devlink health set pci/0000:00:09.0 reporter fw_fatal auto_recover false |
| 250 |
.RS 4 |
| 251 |
Turn off auto recovery on the specified device and reporter. |
| 252 |
.RE |
| 253 |
.PP |
| 254 |
devlink health set pci/0000:00:09.0 reporter tx burst_period 5000 |
| 255 |
.RS 4 |
| 256 |
Set the burst period to 5000 milliseconds on the specified |
| 257 |
device and reporter, prior to initiating the grace period. |
| 258 |
.RE |
| 259 |
.PP |
| 260 |
devlink health set pci/0000:00:09.0 reporter tx grace_period 0 |
| 261 |
.RS 4 |
| 262 |
Disable grace period on the specified device and reporter. Disabling the grace |
| 263 |
period also deactivates the burst period. |
| 264 |
.RE |
| 265 |
|
| 266 |
.RE |
| 267 |
.SH SEE ALSO |
| 268 |
.BR devlink (8), |
| 269 |
.BR devlink-dev (8), |
| 270 |
.BR devlink-port (8), |
| 271 |
.BR devlink-param (8), |
| 272 |
.BR devlink-region (8), |
| 273 |
.br |
| 274 |
|
| 275 |
.SH AUTHOR |
| 276 |
Aya Levin <[email protected]> |