Add devlink-exception man page. Devlink-exception tool will control device
exception attributes, conditions, actions and logging.
Signed-off-by: Eran Ben Elisha <era...@mellanox.com>
-------------------------------------------------------
Copy paste man output to here for easier review process of the RFC.
DEVLINK-EXCEPTION(8)
Linux
DEVLINK-EXCEPTION(8)
NAME
devlink-exception - devlink exception configuration
SYNOPSIS
devlink [ OPTIONS ] exception { COMMAND | help }
OPTIONS := { -V[ersion] | -n[no-nice-names] }
devlink exception show [ DEV ] [ condition NAME ] [ action NAME ]
devlink exception condition set DEV name NAME [ action NAME { active |
inactive } ]
devlink exception action set DEV name NAME period PERIOD count COUNT
fail { ignore | down }
devlink exception help
DESCRIPTION
devlink-exception tool allows user to configure the way driver treats
unexpected status. The tool allows configuration of the conditions that can
trigger exception activity. Set for each condition the follow up opera‐
tions, such as, reset and dump of info. In addition, set the exception
activity termination action.
devlink exception show - Display devlink exception conditions and actions
attributes
DEV Specifies the devlink device to show.
condition NAME
Specifies the devlink condition to show.
action NAME
Specifies the devlink action to show.
devlink exception condition set - sets devlink exception condition attributes
DEV Specifies the devlink device to set.
name NAME
Name of the condition to set.
action NAME { active | inactive }
Specify which actions to activate and which to deactivate
once a condition was triggered. Actions can be dump, reset, etc.
devlink exception action set - sets devlink action attributes.
Once this command is launched, period and count measurement will be
reset.
DEV Specifies the devlink device to set.
name NAME
Specifies the devlink action to set.
period PERIOD
The period on which we limit the amount of performed actions,
measured in seconds.
count COUNT
The maximum number of actions performed in a limited time frame.
fail { ignore | down }
Specify the behavior once count limit was reached.
ignore - Skip triggering this action.
down - Driver will remain in nonoperational state.
EXAMPLES
devlink exception show
Shows the exception state of all devlink devices on the system.
devlink exception show pci/0000:01:00.0
Shows the exception state of specified devlink device.
devlink exception condition set pci/0000:01:00.0 name TX_COMP_ERROR
action reset off action dump on
Sets TX_COMP_ERROR condition parameters for a specific device.
devlink exception action set pci/0000:01:00.0 name reset period 3600
count 5 fail ignore
Sets exception attributes for reset action. Period timer and counter
are being reset.
SEE ALSO
devlink(8), devlink-port(8), devlink-sb(8), devlink-monitor(8),
devlink-dev(8),
AUTHOR
Eran ben Elisha <era...@mellanox.com>
iproute2
15 Aug 2018
DEVLINK-EXCEPTION(8)
---
man/man8/devlink-exception.8 | 158 +++++++++++++++++++++++++++++++++++++++++++
1 file changed, 158 insertions(+)
create mode 100644 man/man8/devlink-exception.8
diff --git a/man/man8/devlink-exception.8 b/man/man8/devlink-exception.8
new file mode 100644
index 000000000000..03f24b32cc98
--- /dev/null
+++ b/man/man8/devlink-exception.8
@@ -0,0 +1,158 @@
+.TH DEVLINK\-EXCEPTION 8 "15 Aug 2018" "iproute2" "Linux"
+.SH NAME
+devlink-exception \- devlink exception configuration
+.SH SYNOPSIS
+.sp
+.ad l
+.in +8
+.ti -8
+.B devlink
+.RI "[ " OPTIONS " ]"
+.BR exception
+.RI " { " COMMAND " | "
+.BR help " }"
+.sp
+
+.ti -8
+.IR OPTIONS " := { "
+\fB\-V\fR[\fIersion\fR] |
+\fB\-n\fR[\fIno-nice-names\fR] }
+
+.ti -8
+.B devlink exception show
+.RI "[ " DEV " ]"
+.RI "[ "
+.B condition
+.IR NAME
+.RI "]"
+.RI "[ "
+.B action
+.IR NAME
+.RI "]"
+
+.ti -8
+.B devlink exception condition set
+.IR DEV
+.B name
+.IR NAME
+.RI "[ "
+.BR action
+.IR NAME
+.R "{" active "|" inactive "}" ]
+
+.ti -8
+.B devlink exception action set
+.IR DEV
+.B name
+.IR NAME
+.BR period
+.IR PERIOD
+.BR count
+.IR COUNT
+.BR fail " { "
+.IR ignore
+.BR "| "
+.IR down
+.R "} "
+
+.ti -8
+.B devlink exception help
+
+.SH "DESCRIPTION"
+.B devlink-exception
+tool allows user to configure the way driver treats unexpected status. The
tool allows configuration of the conditions that can trigger exception
activity. Set for each condition the follow up operations, such as, reset and
dump of info. In addition, set the exception activity termination action.
+
+.SS devlink exception show - Display devlink exception conditions and actions
attributes
+.TP
+.BI "DEV"
+Specifies the devlink device to show.
+
+.PP
+.TP
+.BI condition " NAME"
+Specifies the devlink condition to show.
+
+.TP
+.BI action " NAME"
+Specifies the devlink action to show.
+
+.SS devlink exception condition set - sets devlink exception condition
attributes
+
+.TP
+.B "DEV"
+Specifies the devlink device to set.
+
+.TP
+.BI name " NAME"
+Name of the condition to set.
+
+.TP
+.BR action
+.IR NAME
+.R "{" active "|" inactive "} "
+.in +4
+Specify which actions to activate and which to deactivate once a condition was
triggered. Actions can be dump, reset, etc.
+
+.SS devlink exception action set - sets devlink action attributes.
+Once this command is launched, period and count measurement will be reset.
+
+.TP
+.B "DEV"
+Specifies the devlink device to set.
+
+.TP
+.BI name " NAME"
+Specifies the devlink action to set.
+
+.TP
+.BI period " PERIOD"
+The period on which we limit the amount of performed actions, measured in
seconds.
+
+.TP
+.BI count " COUNT"
+The maximum number of actions performed in a limited time frame.
+
+.TP
+.BR fail
+.R "{" ignore "|" down "}"
+.in +4
+Specify the behavior once count limit was reached.
+
+.I ignore
+- Skip triggering this action.
+
+.I down
+- Driver will remain in nonoperational state.
+
+.SH "EXAMPLES"
+.PP
+devlink exception show
+.RS 4
+Shows the exception state of all devlink devices on the system.
+.RE
+.PP
+devlink exception show pci/0000:01:00.0
+.RS 4
+Shows the exception state of specified devlink device.
+.RE
+.PP
+devlink exception condition set pci/0000:01:00.0 name TX_COMP_ERROR action
reset off action dump on
+.RS 4
+Sets TX_COMP_ERROR condition parameters for a specific device.
+.RE
+.PP
+devlink exception action set pci/0000:01:00.0 name reset period 3600 count 5
fail ignore
+.RS 4
+Sets exception attributes for reset action. Period timer and counter are being
reset.
+.RE
+
+.SH SEE ALSO
+.BR devlink (8),
+.BR devlink-port (8),
+.BR devlink-sb (8),
+.BR devlink-monitor (8),
+.BR devlink-dev (8),
+.br
+
+.SH AUTHOR
+Eran ben Elisha <era...@mellanox.com>
--
1.8.3.1
