From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-9.0 required=3.0 tests=HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY,SPF_PASS,UNPARSEABLE_RELAY, USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id E09D9C43381 for ; Sun, 24 Feb 2019 12:46:57 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id BBE0120645 for ; Sun, 24 Feb 2019 12:46:57 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1728293AbfBXMqu (ORCPT ); Sun, 24 Feb 2019 07:46:50 -0500 Received: from mail-il-dmz.mellanox.com ([193.47.165.129]:53825 "EHLO mellanox.co.il" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1728194AbfBXMqt (ORCPT ); Sun, 24 Feb 2019 07:46:49 -0500 Received: from Internal Mail-Server by MTLPINE1 (envelope-from ayal@mellanox.com) with ESMTPS (AES256-SHA encrypted); 24 Feb 2019 14:46:45 +0200 Received: from dev-l-vrt-210.mtl.labs.mlnx (dev-l-vrt-210.mtl.labs.mlnx [10.134.210.1]) by labmailer.mlnx (8.13.8/8.13.8) with ESMTP id x1OCkjA4011188; Sun, 24 Feb 2019 14:46:45 +0200 Received: from dev-l-vrt-210.mtl.labs.mlnx (localhost [127.0.0.1]) by dev-l-vrt-210.mtl.labs.mlnx (8.15.2/8.15.2/Debian-8ubuntu1) with ESMTP id x1OCkjTQ029237; Sun, 24 Feb 2019 14:46:45 +0200 Received: (from ayal@localhost) by dev-l-vrt-210.mtl.labs.mlnx (8.15.2/8.15.2/Submit) id x1OCkjm0029236; Sun, 24 Feb 2019 14:46:45 +0200 From: Aya Levin To: David Ahern Cc: netdev@vger.kernel.org, Jiri Pirko , Moshe Shemesh , Eran Ben Elisha , Aya Levin Subject: [PATCH v3 iproute2-next 11/11] devlink: Add devlink-health man page Date: Sun, 24 Feb 2019 14:46:18 +0200 Message-Id: <1551012378-29167-12-git-send-email-ayal@mellanox.com> X-Mailer: git-send-email 1.8.4.3 In-Reply-To: <1551012378-29167-1-git-send-email-ayal@mellanox.com> References: <1551012378-29167-1-git-send-email-ayal@mellanox.com> Sender: netdev-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: netdev@vger.kernel.org Add a man page describing devlink health's command set. Also add a reference link from devlink main man page. Signed-off-by: Aya Levin Reviewed-by: Moshe Shemesh Acked-by: Jiri Pirko --- man/man8/devlink-health.8 | 197 ++++++++++++++++++++++++++++++++++++++++++++++ man/man8/devlink.8 | 7 +- 2 files changed, 203 insertions(+), 1 deletion(-) create mode 100644 man/man8/devlink-health.8 diff --git a/man/man8/devlink-health.8 b/man/man8/devlink-health.8 new file mode 100644 index 000000000000..7ed0ae4534dc --- /dev/null +++ b/man/man8/devlink-health.8 @@ -0,0 +1,197 @@ +.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 +.BR "devlink health show" +.RI "[ " DEV "" +.B reporter +.RI ""REPORTER " ] " + +.ti -8 +.BR "devlink health recover" +.RI "" DEV "" +.B reporter +.RI "" REPORTER "" + +.ti -8 +.BR "devlink health diagnose" +.RI "" DEV "" +.B reporter +.RI "" REPORTER "" + +.ti -8 +.BR "devlink health dump show" +.RI "" DEV "" +.B reporter +.RI "" REPORTER "" + +.ti -8 +.BR "devlink health dump clear" +.RI "" DEV "" +.B reporter +.RI "" REPORTER "" + +.ti -8 +.BR "devlink health set" +.RI "" DEV "" +.B reporter +.RI "" REPORTER "" +.RI " { " +.B grace_period | auto_recover +.RI " } { " +.RI "" msec "" +.RI "|" +.RI "" boolean "" +.RI " } " +.ti -8 +.B devlink health help + +.SH "DESCRIPTION" +.SS devlink health show - Show status and configuration on all supported reporters on all devlink devices. + +.PP +.I "DEV" +- specifies the devlink device. + +.PP +.I "REPORTER" +- specifies the reporter's name registered on the devlink device. + +.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. + +.PP +.I "REPORTER" +- specifies the reporter's name registered on the devlink device. + +.SS devlink health diagnose - Retrieve diagnostics data 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. + +.PP +.I "REPORTER" +- specifies the reporter's name registered on the devlink device. + +.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. + +.PP +.I "REPORTER" +- specifies the reporter's name registered on the devlink device. + +.SS devlink health set - Enable the user to configure: +.PD 0 +1) grace_period [msec] - Time interval between consecutive auto recoveries. +.P +2) auto_recover [true/false] - Indicates whether the devlink should execute automatic recover on error. +.P +Please note that this command is not supported on a reporter which +doesn't support a recovery method. +.PD + +.PP +.I "DEV" +- specifies the devlink device. + +.PP +.I "REPORTER" +- specifies the reporter's name registered on the devlink device. + +.SH "EXAMPLES" +.PP +devlink health show +.RS 4 +List status and configuration of available reporters on devices. +.RE +.PP +devlink health recover pci/0000:00:09.0 reporter tx +.RS 4 +Initiate recovery on tx reporter registered on pci/0000:00:09.0. +.RE +.PP +devlink health diagnose pci/0000:00:09.0 reporter tx +.RS 4 +List diagnostics data on the specified device and reporter. +.RE +.PP +devlink health dump show pci/0000:00:09.0 reporter tx +.RS 4 +Display the last saved dump on the specified device and reporter. +.RE +.PP +devlink health dump clear pci/0000:00:09.0 reporter tx +.RS 4 +Delete saved dump on the specified device and reporter. +.RE +.PP +devlink health set pci/0000:00:09.0 reporter tx 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 reporter tx 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 diff --git a/man/man8/devlink.8 b/man/man8/devlink.8 index 8d527e7e1d60..13d4dcd908b3 100644 --- a/man/man8/devlink.8 +++ b/man/man8/devlink.8 @@ -7,7 +7,7 @@ devlink \- Devlink tool .in +8 .ti -8 .B devlink -.RI "[ " OPTIONS " ] { " dev | port | monitor | sb | resource | region " } { " COMMAND " | " +.RI "[ " OPTIONS " ] { " dev | port | monitor | sb | resource | region | health " } { " COMMAND " | " .BR help " }" .sp @@ -78,6 +78,10 @@ Turn on verbose output. .B region - devlink address region access +.TP +.B health +- devlink reporting and recovery + .SS .I COMMAND @@ -109,6 +113,7 @@ Exit status is 0 if command was successful or a positive integer upon failure. .BR devlink-sb (8), .BR devlink-resource (8), .BR devlink-region (8), +.BR devlink-health (8), .br .SH REPORTING BUGS -- 2.14.1