|
Packit Service |
3880ab |
.TH DEVLINK\-HEALTH 8 "20 Feb 2019" "iproute2" "Linux"
|
|
Packit Service |
3880ab |
.SH NAME
|
|
Packit Service |
3880ab |
devlink-health \- devlink health reporting and recovery
|
|
Packit Service |
3880ab |
.SH SYNOPSIS
|
|
Packit Service |
3880ab |
.sp
|
|
Packit Service |
3880ab |
.ad l
|
|
Packit Service |
3880ab |
.in +8
|
|
Packit Service |
3880ab |
.ti -8
|
|
Packit Service |
3880ab |
.B devlink
|
|
Packit Service |
3880ab |
.RI "[ " OPTIONS " ]"
|
|
Packit Service |
3880ab |
.B health
|
|
Packit Service |
3880ab |
.RI " { " COMMAND " | "
|
|
Packit Service |
3880ab |
.BR help " }"
|
|
Packit Service |
3880ab |
.sp
|
|
Packit Service |
3880ab |
|
|
Packit Service |
3880ab |
.ti -8
|
|
Packit Service |
3880ab |
.IR OPTIONS " := { "
|
|
Packit Service |
3880ab |
\fB\-V\fR[\fIersion\fR] }
|
|
Packit Service |
3880ab |
|
|
Packit Service |
3880ab |
.ti -8
|
|
Packit Service |
3880ab |
.B devlink health show
|
|
Packit Service |
3880ab |
.RI "[ { " DEV " | " DEV/PORT_INDEX " }"
|
|
Packit Service |
3880ab |
.B reporter
|
|
Packit Service |
3880ab |
.RI ""REPORTER " ] "
|
|
Packit Service |
3880ab |
|
|
Packit Service |
3880ab |
.ti -8
|
|
Packit Service |
3880ab |
.B devlink health recover
|
|
Packit Service |
3880ab |
.RI "{ " DEV " | " DEV/PORT_INDEX " }"
|
|
Packit Service |
3880ab |
.B reporter
|
|
Packit Service |
3880ab |
.RI "" REPORTER ""
|
|
Packit Service |
3880ab |
|
|
Packit Service |
3880ab |
.ti -8
|
|
Packit Service |
3880ab |
.B devlink health diagnose
|
|
Packit Service |
3880ab |
.RI "{ " DEV " | " DEV/PORT_INDEX " }"
|
|
Packit Service |
3880ab |
.B reporter
|
|
Packit Service |
3880ab |
.RI "" REPORTER ""
|
|
Packit Service |
3880ab |
|
|
Packit Service |
3880ab |
.ti -8
|
|
Packit Service |
3880ab |
.B devlink health dump show
|
|
Packit Service |
3880ab |
.RI "{ " DEV " | " DEV/PORT_INDEX " }"
|
|
Packit Service |
3880ab |
.B reporter
|
|
Packit Service |
3880ab |
.RI "" REPORTER ""
|
|
Packit Service |
3880ab |
|
|
Packit Service |
3880ab |
.ti -8
|
|
Packit Service |
3880ab |
.B devlink health dump clear
|
|
Packit Service |
3880ab |
.RI "{ " DEV " | " DEV/PORT_INDEX " }"
|
|
Packit Service |
3880ab |
.B reporter
|
|
Packit Service |
3880ab |
.RI "" REPORTER ""
|
|
Packit Service |
3880ab |
|
|
Packit Service |
3880ab |
.ti -8
|
|
Packit Service |
3880ab |
.B devlink health set
|
|
Packit Service |
3880ab |
.RI "{ " DEV " | " DEV/PORT_INDEX " }"
|
|
Packit Service |
3880ab |
.B reporter
|
|
Packit Service |
3880ab |
.RI "" REPORTER ""
|
|
Packit Service |
3880ab |
[
|
|
Packit Service |
3880ab |
.BI "grace_period " MSEC "
|
|
Packit Service |
3880ab |
] [
|
|
Packit Service |
3880ab |
.BR auto_recover " { " true " | " false " } "
|
|
Packit Service |
3880ab |
] [
|
|
Packit Service |
3880ab |
.BR auto_dump " { " true " | " false " } "
|
|
Packit Service |
3880ab |
]
|
|
Packit Service |
3880ab |
|
|
Packit Service |
3880ab |
.ti -8
|
|
Packit Service |
3880ab |
.B devlink health help
|
|
Packit Service |
3880ab |
|
|
Packit Service |
3880ab |
.SH "DESCRIPTION"
|
|
Packit Service |
3880ab |
.SS devlink health show - Show status and configuration on all supported reporters.
|
|
Packit Service |
3880ab |
Displays info about reporters registered on devlink devices and ports.
|
|
Packit Service |
3880ab |
|
|
Packit Service |
3880ab |
.PP
|
|
Packit Service |
3880ab |
.I "DEV"
|
|
Packit Service |
3880ab |
- specifies the devlink device.
|
|
Packit Service |
3880ab |
.br
|
|
Packit Service |
3880ab |
.I DEV/PORT_INDEX
|
|
Packit Service |
3880ab |
- specifies the devlink port.
|
|
Packit Service |
3880ab |
|
|
Packit Service |
3880ab |
.PP
|
|
Packit Service |
3880ab |
.I "REPORTER"
|
|
Packit Service |
3880ab |
- specifies the reporter's name registered on specified devlink device or port.
|
|
Packit Service |
3880ab |
|
|
Packit Service |
3880ab |
.SS devlink health recover - Initiate a recovery operation on a reporter.
|
|
Packit Service |
3880ab |
This action performs a recovery and increases the recoveries counter on success.
|
|
Packit Service |
3880ab |
|
|
Packit Service |
3880ab |
.PP
|
|
Packit Service |
3880ab |
.I "DEV"
|
|
Packit Service |
3880ab |
- specifies the devlink device.
|
|
Packit Service |
3880ab |
.br
|
|
Packit Service |
3880ab |
.I DEV/PORT_INDEX
|
|
Packit Service |
3880ab |
- specifies the devlink port.
|
|
Packit Service |
3880ab |
|
|
Packit Service |
3880ab |
.PP
|
|
Packit Service |
3880ab |
.I "REPORTER"
|
|
Packit Service |
3880ab |
- specifies the reporter's name registered on specified devlink device or port.
|
|
Packit Service |
3880ab |
|
|
Packit Service |
3880ab |
.SS devlink health diagnose - Retrieve diagnostics data on a reporter.
|
|
Packit Service |
3880ab |
|
|
Packit Service |
3880ab |
.PP
|
|
Packit Service |
3880ab |
.I DEV
|
|
Packit Service |
3880ab |
- specifies the devlink device.
|
|
Packit Service |
3880ab |
.br
|
|
Packit Service |
3880ab |
.I DEV/PORT_INDEX
|
|
Packit Service |
3880ab |
- specifies the devlink port.
|
|
Packit Service |
3880ab |
|
|
Packit Service |
3880ab |
.PP
|
|
Packit Service |
3880ab |
.I "REPORTER"
|
|
Packit Service |
3880ab |
- specifies the reporter's name registered on specified devlink device or port.
|
|
Packit Service |
3880ab |
|
|
Packit Service |
3880ab |
.SS devlink health dump show - Display the last saved dump.
|
|
Packit Service |
3880ab |
|
|
Packit Service |
3880ab |
.PD 0
|
|
Packit Service |
3880ab |
.P
|
|
Packit Service |
3880ab |
devlink health saves a single dump per reporter. If an dump is
|
|
Packit Service |
3880ab |
.P
|
|
Packit Service |
3880ab |
not already stored by the Devlink, this command will generate a new
|
|
Packit Service |
3880ab |
.P
|
|
Packit Service |
3880ab |
dump. The dump can be generated either automatically when a
|
|
Packit Service |
3880ab |
.P
|
|
Packit Service |
3880ab |
reporter reports on an error or manually at the user's request.
|
|
Packit Service |
3880ab |
.PD
|
|
Packit Service |
3880ab |
|
|
Packit Service |
3880ab |
.PP
|
|
Packit Service |
3880ab |
.I "DEV"
|
|
Packit Service |
3880ab |
- specifies the devlink device.
|
|
Packit Service |
3880ab |
.br
|
|
Packit Service |
3880ab |
.I DEV/PORT_INDEX
|
|
Packit Service |
3880ab |
- specifies the devlink port.
|
|
Packit Service |
3880ab |
|
|
Packit Service |
3880ab |
.PP
|
|
Packit Service |
3880ab |
.I "REPORTER"
|
|
Packit Service |
3880ab |
- specifies the reporter's name registered on specified devlink device or port.
|
|
Packit Service |
3880ab |
|
|
Packit Service |
3880ab |
.SS devlink health dump clear - Delete the saved dump.
|
|
Packit Service |
3880ab |
Deleting the saved dump enables a generation of a new dump on
|
|
Packit Service |
3880ab |
.PD 0
|
|
Packit Service |
3880ab |
.P
|
|
Packit Service |
3880ab |
the next "devlink health dump show" command.
|
|
Packit Service |
3880ab |
.PD
|
|
Packit Service |
3880ab |
|
|
Packit Service |
3880ab |
.PP
|
|
Packit Service |
3880ab |
.I "DEV"
|
|
Packit Service |
3880ab |
- specifies the devlink device.
|
|
Packit Service |
3880ab |
.br
|
|
Packit Service |
3880ab |
.I DEV/PORT_INDEX
|
|
Packit Service |
3880ab |
- specifies the devlink port.
|
|
Packit Service |
3880ab |
|
|
Packit Service |
3880ab |
.PP
|
|
Packit Service |
3880ab |
.I "REPORTER"
|
|
Packit Service |
3880ab |
- specifies the reporter's name registered on specified devlink device or port.
|
|
Packit Service |
3880ab |
|
|
Packit Service |
3880ab |
.SS devlink health set - Configure health reporter.
|
|
Packit Service |
3880ab |
Please note that some params are not supported on a reporter which
|
|
Packit Service |
3880ab |
doesn't support a recovery or dump method.
|
|
Packit Service |
3880ab |
|
|
Packit Service |
3880ab |
.PP
|
|
Packit Service |
3880ab |
.I "DEV"
|
|
Packit Service |
3880ab |
- specifies the devlink device.
|
|
Packit Service |
3880ab |
.br
|
|
Packit Service |
3880ab |
.I DEV/PORT_INDEX
|
|
Packit Service |
3880ab |
- specifies the devlink port.
|
|
Packit Service |
3880ab |
|
|
Packit Service |
3880ab |
.PP
|
|
Packit Service |
3880ab |
.I "REPORTER"
|
|
Packit Service |
3880ab |
- specifies the reporter's name registered on specified devlink device or port.
|
|
Packit Service |
3880ab |
|
|
Packit Service |
3880ab |
.TP
|
|
Packit Service |
3880ab |
.BI grace_period " MSEC "
|
|
Packit Service |
3880ab |
Time interval between consecutive auto recoveries.
|
|
Packit Service |
3880ab |
|
|
Packit Service |
3880ab |
.TP
|
|
Packit Service |
3880ab |
.BR auto_recover " { " true " | " false " } "
|
|
Packit Service |
3880ab |
Indicates whether the devlink should execute automatic recover on error.
|
|
Packit Service |
3880ab |
|
|
Packit Service |
3880ab |
.TP
|
|
Packit Service |
3880ab |
.BR auto_dump " { " true " | " false " } "
|
|
Packit Service |
3880ab |
Indicates whether the devlink should execute automatic dump on error.
|
|
Packit Service |
3880ab |
|
|
Packit Service |
3880ab |
.SH "EXAMPLES"
|
|
Packit Service |
3880ab |
.PP
|
|
Packit Service |
3880ab |
devlink health show
|
|
Packit Service |
3880ab |
.RS 4
|
|
Packit Service |
3880ab |
List status and configuration of available reporters on devices and ports.
|
|
Packit Service |
3880ab |
.RE
|
|
Packit Service |
3880ab |
.PP
|
|
Packit Service |
3880ab |
devlink health show pci/0000:00:09.0/1 reporter tx
|
|
Packit Service |
3880ab |
.RS 4
|
|
Packit Service |
3880ab |
List status and configuration of tx reporter registered on port on pci/0000:00:09.0/1
|
|
Packit Service |
3880ab |
.RE
|
|
Packit Service |
3880ab |
.PP
|
|
Packit Service |
3880ab |
devlink health recover pci/0000:00:09.0 reporter fw_fatal
|
|
Packit Service |
3880ab |
.RS 4
|
|
Packit Service |
3880ab |
Initiate recovery on fw_fatal reporter registered on device on pci/0000:00:09.0.
|
|
Packit Service |
3880ab |
.RE
|
|
Packit Service |
3880ab |
.PP
|
|
Packit Service |
3880ab |
devlink health recover pci/0000:00:09.0/1 reporter tx
|
|
Packit Service |
3880ab |
.RS 4
|
|
Packit Service |
3880ab |
Initiate recovery on tx reporter registered on port on pci/0000:00:09.0/1.
|
|
Packit Service |
3880ab |
.RE
|
|
Packit Service |
3880ab |
.PP
|
|
Packit Service |
3880ab |
devlink health diagnose pci/0000:00:09.0 reporter fw
|
|
Packit Service |
3880ab |
.RS 4
|
|
Packit Service |
3880ab |
List diagnostics data on the specified device and reporter.
|
|
Packit Service |
3880ab |
.RE
|
|
Packit Service |
3880ab |
.PP
|
|
Packit Service |
3880ab |
devlink health dump show pci/0000:00:09.0/1 reporter tx
|
|
Packit Service |
3880ab |
.RS 4
|
|
Packit Service |
3880ab |
Display the last saved dump on the specified port and reporter.
|
|
Packit Service |
3880ab |
.RE
|
|
Packit Service |
3880ab |
.PP
|
|
Packit Service |
3880ab |
devlink health dump clear pci/0000:00:09.0/1 reporter tx
|
|
Packit Service |
3880ab |
.RS 4
|
|
Packit Service |
3880ab |
Delete saved dump on the specified port and reporter.
|
|
Packit Service |
3880ab |
.RE
|
|
Packit Service |
3880ab |
.PP
|
|
Packit Service |
3880ab |
devlink health set pci/0000:00:09.0 reporter fw_fatal grace_period 3500
|
|
Packit Service |
3880ab |
.RS 4
|
|
Packit Service |
3880ab |
Set time interval between auto recoveries to minimum of 3500 msec on
|
|
Packit Service |
3880ab |
the specified device and reporter.
|
|
Packit Service |
3880ab |
.RE
|
|
Packit Service |
3880ab |
.PP
|
|
Packit Service |
3880ab |
devlink health set pci/0000:00:09.0/1 reporter tx grace_period 3500
|
|
Packit Service |
3880ab |
.RS 4
|
|
Packit Service |
3880ab |
Set time interval between auto recoveries to minimum of 3500 msec on
|
|
Packit Service |
3880ab |
the specified port and reporter.
|
|
Packit Service |
3880ab |
.RE
|
|
Packit Service |
3880ab |
.PP
|
|
Packit Service |
3880ab |
devlink health set pci/0000:00:09.0 reporter fw_fatal auto_recover false
|
|
Packit Service |
3880ab |
.RS 4
|
|
Packit Service |
3880ab |
Turn off auto recovery on the specified device and reporter.
|
|
Packit Service |
3880ab |
|
|
Packit Service |
3880ab |
.RE
|
|
Packit Service |
3880ab |
.SH SEE ALSO
|
|
Packit Service |
3880ab |
.BR devlink (8),
|
|
Packit Service |
3880ab |
.BR devlink-dev (8),
|
|
Packit Service |
3880ab |
.BR devlink-port (8),
|
|
Packit Service |
3880ab |
.BR devlink-param (8),
|
|
Packit Service |
3880ab |
.BR devlink-region (8),
|
|
Packit Service |
3880ab |
.br
|
|
Packit Service |
3880ab |
|
|
Packit Service |
3880ab |
.SH AUTHOR
|
|
Packit Service |
3880ab |
Aya Levin <ayal@mellanox.com>
|