man/man8/devlink-health.8

   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 .BR "devlink health show"
  22 .RI "[ " DEV ""
  23 .B reporter
  24 .RI ""REPORTER " ] "
  25
  26 .ti -8
  27 .BR "devlink health recover"
  28 .RI "" DEV ""
  29 .B reporter
  30 .RI "" REPORTER ""
  31
  32 .ti -8
  33 .BR "devlink health diagnose"
  34 .RI "" DEV ""
  35 .B reporter
  36 .RI "" REPORTER ""
  37
  38 .ti -8
  39 .BR "devlink health dump show"
  40 .RI "" DEV ""
  41 .B  reporter
  42 .RI "" REPORTER ""
  43
  44 .ti -8
  45 .BR "devlink health dump clear"
  46 .RI "" DEV ""
  47 .B reporter
  48 .RI "" REPORTER ""
  49
  50 .ti -8
  51 .BR "devlink health set"
  52 .RI "" DEV ""
  53 .B reporter
  54 .RI "" REPORTER ""
  55 .RI " { "
  56 .B grace_period | auto_recover
  57 .RI " } { "
  58 .RI "" msec ""
  59 .RI "|"
  60 .RI "" boolean ""
  61 .RI " } "
  62 .ti -8
  63 .B devlink health help
  64
  65 .SH "DESCRIPTION"
  66 .SS devlink health show - Show status and configuration on all supported reporters on all devlink devices.
  67
  68 .PP
  69 .I "DEV"
  70 - specifies the devlink device.
  71
  72 .PP
  73 .I "REPORTER"
  74 - specifies the reporter's name registered on the devlink device.
  75
  76 .SS devlink health recover - Initiate a recovery operation on a reporter.
  77 This action performs a recovery and increases the recoveries counter on success.
  78
  79 .PP
  80 .I "DEV"
  81 - specifies the devlink device.
  82
  83 .PP
  84 .I "REPORTER"
  85 - specifies the reporter's name registered on the devlink device.
  86
  87 .SS devlink health diagnose - Retrieve diagnostics data on a reporter.
  88
  89 .PP
  90 .I "DEV"
  91 - specifies the devlink device.
  92
  93 .PP
  94 .I "REPORTER"
  95 - specifies the reporter's name registered on the devlink device.
  96
  97 .SS devlink health dump show - Display the last saved dump.
  98
  99 .PD 0
 100 .P
 101 devlink health saves a single dump per reporter. If an dump is
 102 .P
 103 not already stored by the Devlink, this command will generate a new
 104 .P
 105 dump. The dump can be generated either automatically when a
 106 .P
 107 reporter reports on an error or manually at the user's request.
 108 .PD
 109
 110 .PP
 111 .I "DEV"
 112 - specifies the devlink device.
 113
 114 .PP
 115 .I "REPORTER"
 116 - specifies the reporter's name registered on the devlink device.
 117
 118 .SS devlink health dump clear - Delete the saved dump.
 119 Deleting the saved dump enables a generation of a new dump on
 120 .PD 0
 121 .P
 122 the next "devlink health dump show" command.
 123 .PD
 124
 125 .PP
 126 .I "DEV"
 127 - specifies the devlink device.
 128
 129 .PP
 130 .I "REPORTER"
 131 - specifies the reporter's name registered on the devlink device.
 132
 133 .SS devlink health set - Enable the user to configure:
 134 .PD 0
 135 1) grace_period [msec] - Time interval between consecutive auto recoveries.
 136 .P
 137 2) auto_recover [true/false] - Indicates whether the devlink should execute automatic recover on error.
 138 .P
 139 Please note that this command is not supported on a reporter which
 140 doesn't support a recovery method.
 141 .PD
 142
 143 .PP
 144 .I "DEV"
 145 - specifies the devlink device.
 146
 147 .PP
 148 .I "REPORTER"
 149 - specifies the reporter's name registered on the devlink device.
 150
 151 .SH "EXAMPLES"
 152 .PP
 153 devlink health show
 154 .RS 4
 155 List status and configuration of available reporters on devices.
 156 .RE
 157 .PP
 158 devlink health recover pci/0000:00:09.0 reporter tx
 159 .RS 4
 160 Initiate recovery on tx reporter registered on pci/0000:00:09.0.
 161 .RE
 162 .PP
 163 devlink health diagnose pci/0000:00:09.0 reporter tx
 164 .RS 4
 165 List diagnostics data on the specified device and reporter.
 166 .RE
 167 .PP
 168 devlink health dump show pci/0000:00:09.0 reporter tx
 169 .RS 4
 170 Display the last saved dump on the specified device and reporter.
 171 .RE
 172 .PP
 173 devlink health dump clear pci/0000:00:09.0 reporter tx
 174 .RS 4
 175 Delete saved dump on the specified device and reporter.
 176 .RE
 177 .PP
 178 devlink health set pci/0000:00:09.0 reporter tx grace_period 3500
 179 .RS 4
 180 Set time interval between auto recoveries to minimum of 3500 msec on
 181 the specified device and reporter.
 182 .RE
 183 .PP
 184 devlink health set pci/0000:00:09.0 reporter tx auto_recover false
 185 .RS 4
 186 Turn off auto recovery on the specified device and reporter.
 187 .RE
 188 .SH SEE ALSO
 189 .BR devlink (8),
 190 .BR devlink-dev (8),
 191 .BR devlink-port (8),
 192 .BR devlink-param (8),
 193 .BR devlink-region (8),
 194 .br
 195
 196 .SH AUTHOR
 197 Aya Levin <ayal@mellanox.com>