summaryrefslogtreecommitdiffstats
path: root/man/man8/devlink.8
blob: de53061bc88011754088c81982dbd7f0a2f57b3e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
.TH DEVLINK 8 "14 Mar 2016" "iproute2" "Linux"
.SH NAME
devlink \- Devlink tool
.SH SYNOPSIS
.sp
.ad l
.in +8
.ti -8
.B devlink
.RI "[ " OPTIONS " ] { " dev | port | monitor | sb | resource | region | health | trap " } { " COMMAND " | "
.BR help " }"
.sp

.ti -8
.B devlink
.RB "[ " -force " ] "
.BI "-batch " filename
.sp

.SH OPTIONS

.TP
.BR "\-V" , " --Version"
Print the version of the
.B devlink
utility and exit.

.TP
.BR "\-b", " \-batch " <FILENAME>
Read commands from provided file or standard input and invoke them.
First failure will cause termination of devlink.

.TP
.B \-force
Don't terminate devlink on errors in batch mode.
If there were any errors during execution of the commands, the application return code will be non zero.

.TP
.BR "\-n" , " --no-nice-names"
Turn off printing out nice names, for example netdevice ifnames instead of devlink port identification.

.TP
.BR "\-j" , " --json"
Generate JSON output.

.TP
.BR "\-p" , " --pretty"
When combined with -j generate a pretty JSON output.

.TP
.BR "\-v" , " --verbose"
Turn on verbose output.

.TP
.BR "\-s" , " --statistics"
Output statistics.

.TP
.BR "\-N", " \-Netns " <NETNSNAME>
Switches to the specified network namespace.

.TP
.BR "\-i", " --iec"
Print human readable rates in IEC units (e.g. 1Ki = 1024).

.TP
.BR "\-x", " --hex"
Print dump numbers in hexadecimal format.

.SS
.I OBJECT

.TP
.B dev
- devlink device.

.TP
.B port
- devlink port.

.TP
.B monitor
- watch for netlink messages.

.TP
.B sb
- devlink shared buffer configuration.

.TP
.B resource
- devlink device resource configuration.

.TP
.B region
- devlink address region access

.TP
.B health
- devlink reporting and recovery

.TP
.B trap
- devlink trap configuration

.SS
.I COMMAND

Specifies the action to perform on the object.
The set of possible actions depends on the object type.
As a rule, it is possible to
.B show
(or
.B list
) objects, but some objects do not allow all of these operations
or have some additional commands. The
.B help
command is available for all objects. It prints
out a list of available commands and argument syntax conventions.
.sp
If no command is given, some default command is assumed.
Usually it is
.B list
or, if the objects of this class cannot be listed,
.BR "help" .

.SH EXIT STATUS
Exit status is 0 if command was successful or a positive integer upon failure.

.SH SEE ALSO
.BR devlink-dev (8),
.BR devlink-port (8),
.BR devlink-monitor (8),
.BR devlink-sb (8),
.BR devlink-resource (8),
.BR devlink-region (8),
.BR devlink-health (8),
.BR devlink-trap (8),
.br

.SH REPORTING BUGS
Report any bugs to the Network Developers mailing list
.B <netdev@vger.kernel.org>
where the development and maintenance is primarily done.
You do not have to be subscribed to the list to send a message there.

.SH AUTHOR
Jiri Pirko <jiri@mellanox.com>