devlink-health(8)

1DEVLINK-HEALTH(8)                    Linux                   DEVLINK-HEALTH(8)
2
3
4

NAME

6       devlink-health - devlink health reporting and recovery
7

SYNOPSIS

9       devlink [ OPTIONS ] health  { COMMAND | help }
10
11
12       OPTIONS := { -V[ersion] }
13
14       devlink health show [ { DEV | DEV/PORT_INDEX } reporter REPORTER ]
15
16       devlink health recover { DEV | DEV/PORT_INDEX } reporter REPORTER
17
18       devlink health diagnose { DEV | DEV/PORT_INDEX } reporter REPORTER
19
20       devlink health dump show { DEV | DEV/PORT_INDEX } reporter REPORTER
21
22       devlink health dump clear { DEV | DEV/PORT_INDEX } reporter REPORTER
23
24       devlink health set { DEV | DEV/PORT_INDEX } reporter REPORTER [
25               grace_period MSEC ] [ auto_recover { true | false } ] [
26               auto_dump { true | false } ]
27
28       devlink health help
29
30

DESCRIPTION

32   devlink health show - Show status and configuration on all supported
33       reporters.
34       Displays info about reporters registered on devlink devices and ports.
35
36
37       DEV - specifies the devlink device.
38       DEV/PORT_INDEX - specifies the devlink port.
39
40
41       REPORTER - specifies the reporter's name registered on specified
42       devlink device or port.
43
44
45   devlink health recover - Initiate a recovery operation on a reporter.
46       This action performs a recovery and increases the recoveries counter on
47       success.
48
49
50       DEV - specifies the devlink device.
51       DEV/PORT_INDEX - specifies the devlink port.
52
53
54       REPORTER - specifies the reporter's name registered on specified
55       devlink device or port.
56
57
58   devlink health diagnose - Retrieve diagnostics data on a reporter.
59       DEV - specifies the devlink device.
60       DEV/PORT_INDEX - specifies the devlink port.
61
62
63       REPORTER - specifies the reporter's name registered on specified
64       devlink device or port.
65
66
67   devlink health dump show - Display the last saved dump.
68       devlink health saves a single dump per reporter. If an dump is
69       not already stored by the Devlink, this command will generate a new
70       dump. The dump can be generated either automatically when a
71       reporter reports on an error or manually at the user's request.
72
73
74       DEV - specifies the devlink device.
75       DEV/PORT_INDEX - specifies the devlink port.
76
77
78       REPORTER - specifies the reporter's name registered on specified
79       devlink device or port.
80
81
82   devlink health dump clear - Delete the saved dump.
83       Deleting the saved dump enables a generation of a new dump on
84       the next "devlink health dump show" command.
85
86
87       DEV - specifies the devlink device.
88       DEV/PORT_INDEX - specifies the devlink port.
89
90
91       REPORTER - specifies the reporter's name registered on specified
92       devlink device or port.
93
94
95   devlink health set - Configure health reporter.
96       Please note that some params are not supported on a reporter which
97       doesn't support a recovery or dump method.
98
99
100       DEV - specifies the devlink device.
101       DEV/PORT_INDEX - specifies the devlink port.
102
103
104       REPORTER - specifies the reporter's name registered on specified
105       devlink device or port.
106
107
108       grace_period MSEC
109              Time interval between consecutive auto recoveries.
110
111
112       auto_recover { true | false }
113              Indicates whether the devlink should execute automatic recover
114              on error.
115
116
117       auto_dump { true | false }
118              Indicates whether the devlink should execute automatic dump on
119              error.
120
121

EXAMPLES

123       devlink health show
124           List status and configuration of available reporters on devices and
125           ports.
126
127       devlink health show pci/0000:00:09.0/1 reporter tx
128           List status and configuration of tx reporter registered on port on
129           pci/0000:00:09.0/1
130
131       devlink health recover pci/0000:00:09.0 reporter fw_fatal
132           Initiate recovery on fw_fatal reporter registered on device on
133           pci/0000:00:09.0.
134
135       devlink health recover pci/0000:00:09.0/1 reporter tx
136           Initiate recovery on tx reporter registered on port on
137           pci/0000:00:09.0/1.
138
139       devlink health diagnose pci/0000:00:09.0 reporter fw
140           List diagnostics data on the specified device and reporter.
141
142       devlink health dump show pci/0000:00:09.0/1 reporter tx
143           Display the last saved dump on the specified port and reporter.
144
145       devlink health dump clear pci/0000:00:09.0/1 reporter tx
146           Delete saved dump on the specified port and reporter.
147
148       devlink health set pci/0000:00:09.0 reporter fw_fatal grace_period 3500
149           Set time interval between auto recoveries to minimum of 3500 msec
150           on the specified device and reporter.
151
152       devlink health set pci/0000:00:09.0/1 reporter tx grace_period 3500
153           Set time interval between auto recoveries to minimum of 3500 msec
154           on the specified port and reporter.
155
156       devlink health set pci/0000:00:09.0 reporter fw_fatal auto_recover
157       false
158           Turn off auto recovery on the specified device and reporter.
159
160

AUTHOR

167       Aya Levin <ayal@mellanox.com>
168
169
170
171iproute2                          20 Feb 2019                DEVLINK-HEALTH(8)

NAME

SYNOPSIS

DESCRIPTION

EXAMPLES

SEE ALSO

AUTHOR