proxmox-mirrors/mirror_iproute2
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_iproute2 synced 2025-12-08 03:31:54 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

devlink: Update devlink-health and devlink-port manpages

Browse Source 
Describe support for per-port reporters in devlink-health and
devlink-port commands.

Signed-off-by: Vladyslav Tarasiuk <vladyslavt@mellanox.com>
Reviewed-by: Moshe Shemesh <moshe@mellanox.com>
Reviewed-by: Jiri Pirko <jiri@mellanox.com>
Signed-off-by: David Ahern <dsahern@kernel.org>
This commit is contained in:
Vladyslav Tarasiuk 2020-07-19 16:36:03 +03:00 committed by David Ahern
parent 211c8d6ca9
commit 1fe8c44bd9
2 changed files with 79 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

84
man/man8/devlink-health.8
View File

@ -19,37 +19,37 @@ devlink-health \- devlink health reporting and recovery
.ti -8 .ti -8
.B devlink health show .B devlink health show
.RI "[ " DEV "" .RI "[ { " DEV " | " DEV/PORT_INDEX " }"
.B reporter .B reporter
.RI ""REPORTER " ] " .RI ""REPORTER " ] "
.ti -8 .ti -8
.B devlink health recover .B devlink health recover
.RI "" DEV "" .RI "{ " DEV " | " DEV/PORT_INDEX " }"
.B reporter .B reporter
.RI "" REPORTER "" .RI "" REPORTER ""
.ti -8 .ti -8
.B devlink health diagnose .B devlink health diagnose
.RI "" DEV "" .RI "{ " DEV " | " DEV/PORT_INDEX " }"
.B reporter .B reporter
.RI "" REPORTER "" .RI "" REPORTER ""
.ti -8 .ti -8
.B devlink health dump show .B devlink health dump show
.RI "" DEV "" .RI "{ " DEV " | " DEV/PORT_INDEX " }"
.B reporter .B reporter
.RI "" REPORTER "" .RI "" REPORTER ""
.ti -8 .ti -8
.B devlink health dump clear .B devlink health dump clear
.RI "" DEV "" .RI "{ " DEV " | " DEV/PORT_INDEX " }"
.B reporter .B reporter
.RI "" REPORTER "" .RI "" REPORTER ""
.ti -8 .ti -8
.B devlink health set .B devlink health set
.RI "" DEV "" .RI "{ " DEV " | " DEV/PORT_INDEX " }"
.B reporter .B reporter
.RI "" REPORTER "" .RI "" REPORTER ""
[ [
@ -64,15 +64,19 @@ devlink-health \- devlink health reporting and recovery
.B devlink health help .B devlink health help
.SH "DESCRIPTION" .SH "DESCRIPTION"
.SS devlink health show - Show status and configuration on all supported reporters on all devlink devices. .SS devlink health show - Show status and configuration on all supported reporters.
Displays info about reporters registered on devlink devices and ports.
.PP .PP
.I "DEV" .I "DEV"
- specifies the devlink device. - specifies the devlink device.
.br
.I DEV/PORT_INDEX
- specifies the devlink port.
.PP .PP
.I "REPORTER" .I "REPORTER"
- specifies the reporter's name registered on the devlink device. - specifies the reporter's name registered on specified devlink device or port.
.SS devlink health recover - Initiate a recovery operation on a reporter. .SS devlink health recover - Initiate a recovery operation on a reporter.
This action performs a recovery and increases the recoveries counter on success. This action performs a recovery and increases the recoveries counter on success.
@ -80,20 +84,26 @@ This action performs a recovery and increases the recoveries counter on success.
.PP .PP
.I "DEV" .I "DEV"
- specifies the devlink device. - specifies the devlink device.
.br
.I DEV/PORT_INDEX
- specifies the devlink port.
.PP .PP
.I "REPORTER" .I "REPORTER"
- specifies the reporter's name registered on the devlink device. - specifies the reporter's name registered on specified devlink device or port.
.SS devlink health diagnose - Retrieve diagnostics data on a reporter. .SS devlink health diagnose - Retrieve diagnostics data on a reporter.
.PP .PP
.I "DEV" .I DEV
- specifies the devlink device. - specifies the devlink device.
.br
.I DEV/PORT_INDEX
- specifies the devlink port.
.PP .PP
.I "REPORTER" .I "REPORTER"
- specifies the reporter's name registered on the devlink device. - specifies the reporter's name registered on specified devlink device or port.
.SS devlink health dump show - Display the last saved dump. .SS devlink health dump show - Display the last saved dump.
@ -111,10 +121,13 @@ reporter reports on an error or manually at the user's request.
.PP .PP
.I "DEV" .I "DEV"
- specifies the devlink device. - specifies the devlink device.
.br
.I DEV/PORT_INDEX
- specifies the devlink port.
.PP .PP
.I "REPORTER" .I "REPORTER"
- specifies the reporter's name registered on the devlink device. - specifies the reporter's name registered on specified devlink device or port.
.SS devlink health dump clear - Delete the saved dump. .SS devlink health dump clear - Delete the saved dump.
Deleting the saved dump enables a generation of a new dump on Deleting the saved dump enables a generation of a new dump on
@ -126,10 +139,13 @@ the next "devlink health dump show" command.
.PP .PP
.I "DEV" .I "DEV"
- specifies the devlink device. - specifies the devlink device.
.br
.I DEV/PORT_INDEX
- specifies the devlink port.
.PP .PP
.I "REPORTER" .I "REPORTER"
- specifies the reporter's name registered on the devlink device. - specifies the reporter's name registered on specified devlink device or port.
.SS devlink health set - Configure health reporter. .SS devlink health set - Configure health reporter.
Please note that some params are not supported on a reporter which Please note that some params are not supported on a reporter which
@ -138,10 +154,13 @@ doesn't support a recovery or dump method.
.PP .PP
.I "DEV" .I "DEV"
- specifies the devlink device. - specifies the devlink device.
.br
.I DEV/PORT_INDEX
- specifies the devlink port.
.PP .PP
.I "REPORTER" .I "REPORTER"
- specifies the reporter's name registered on the devlink device. - specifies the reporter's name registered on specified devlink device or port.
.TP .TP
.BI grace_period " MSEC " .BI grace_period " MSEC "
@ -159,38 +178,55 @@ Indicates whether the devlink should execute automatic dump on error.
.PP .PP
devlink health show devlink health show
.RS 4 .RS 4
List status and configuration of available reporters on devices. List status and configuration of available reporters on devices and ports.
.RE .RE
.PP .PP
devlink health recover pci/0000:00:09.0 reporter tx devlink health show pci/0000:00:09.0/1 reporter tx
.RS 4 .RS 4
Initiate recovery on tx reporter registered on pci/0000:00:09.0. List status and configuration of tx reporter registered on port on pci/0000:00:09.0/1
.RE .RE
.PP .PP
devlink health diagnose pci/0000:00:09.0 reporter tx 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 .RS 4
List diagnostics data on the specified device and reporter. List diagnostics data on the specified device and reporter.
.RE .RE
.PP .PP
devlink health dump show pci/0000:00:09.0 reporter tx devlink health dump show pci/0000:00:09.0/1 reporter tx
.RS 4 .RS 4
Display the last saved dump on the specified device and reporter. Display the last saved dump on the specified port and reporter.
.RE .RE
.PP .PP
devlink health dump clear pci/0000:00:09.0 reporter tx devlink health dump clear pci/0000:00:09.0/1 reporter tx
.RS 4 .RS 4
Delete saved dump on the specified device and reporter. Delete saved dump on the specified port and reporter.
.RE .RE
.PP .PP
devlink health set pci/0000:00:09.0 reporter tx grace_period 3500 devlink health set pci/0000:00:09.0 reporter fw_fatal grace_period 3500
.RS 4 .RS 4
Set time interval between auto recoveries to minimum of 3500 msec on Set time interval between auto recoveries to minimum of 3500 msec on
the specified device and reporter. the specified device and reporter.
.RE .RE
.PP .PP
devlink health set pci/0000:00:09.0 reporter tx auto_recover false 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 .RS 4
Turn off auto recovery on the specified device and reporter. Turn off auto recovery on the specified device and reporter.
.RE .RE
.SH SEE ALSO .SH SEE ALSO
.BR devlink (8), .BR devlink (8),

19
man/man8/devlink-port.8
View File

@ -39,6 +39,10 @@ devlink-port \- devlink port configuration
.B devlink port show .B devlink port show
.RI "[ " DEV/PORT_INDEX " ]" .RI "[ " DEV/PORT_INDEX " ]"
.ti -8
.B devlink port health
.RI "{ " show " | " recover " | " diagnose " | " dump " | " set " }"
.ti -8 .ti -8
.B devlink port help .B devlink port help
@ -91,6 +95,10 @@ Could be performed on any split port of the same split group.
- specifies the devlink port to show. - specifies the devlink port to show.
If this argument is omitted all ports are listed. If this argument is omitted all ports are listed.
.SS devlink port health - devlink health reporting and recovery
Is an alias for
.BR devlink-health (8).
.SH "EXAMPLES" .SH "EXAMPLES"
.PP .PP
devlink port show devlink port show
@ -117,12 +125,23 @@ devlink port unsplit pci/0000:01:00.0/1
.RS 4 .RS 4
Unplit the specified previously split devlink port. Unplit the specified previously split devlink port.
.RE .RE
.PP
devlink port health show
.RS 4
Shows status and configuration of all supported reporters registered on all devlink ports.
.RE
.PP
devlink port health show pci/0000:01:00.0/1 reporter tx
.RS 4
Shows status and configuration of tx reporter registered on pci/0000:01:00.0/1 devlink port.
.RE
.SH SEE ALSO .SH SEE ALSO
.BR devlink (8), .BR devlink (8),
.BR devlink-dev (8), .BR devlink-dev (8),
.BR devlink-sb (8), .BR devlink-sb (8),
.BR devlink-monitor (8), .BR devlink-monitor (8),
.BR devlink-health (8),
.br .br
.SH AUTHOR .SH AUTHOR