| 1 |
.TH DEVLINK 8 "14 Mar 2016" "iproute2" "Linux" |
| 2 |
.SH NAME |
| 3 |
devlink \- Devlink tool |
| 4 |
.SH SYNOPSIS |
| 5 |
.sp |
| 6 |
.ad l |
| 7 |
.in +8 |
| 8 |
.ti -8 |
| 9 |
.B devlink |
| 10 |
.RI "[ " OPTIONS " ] { " dev | port | monitor | sb | resource | region | health | trap | rate | lc | dpipe " } { " COMMAND " | " |
| 11 |
.BR help " }" |
| 12 |
.sp |
| 13 |
|
| 14 |
.ti -8 |
| 15 |
.B devlink |
| 16 |
.RB "[ " -force " ] " |
| 17 |
.BI "-batch " filename |
| 18 |
.sp |
| 19 |
|
| 20 |
.SH OPTIONS |
| 21 |
|
| 22 |
.TP |
| 23 |
.BR "\-V" , " --Version" |
| 24 |
Print the version of the |
| 25 |
.B devlink |
| 26 |
utility and exit. |
| 27 |
|
| 28 |
.TP |
| 29 |
.BR "\-b", " \-batch " <FILENAME> |
| 30 |
Read commands from provided file or standard input and invoke them. |
| 31 |
The first failure will cause termination of devlink. |
| 32 |
|
| 33 |
.TP |
| 34 |
.B \-force |
| 35 |
Don't terminate devlink on errors in batch mode. |
| 36 |
If there were any errors during execution of the commands, the application return code will be non zero. |
| 37 |
|
| 38 |
.TP |
| 39 |
.BR "\-n" , " --no-nice-names" |
| 40 |
Turn off printing out nice names, for example netdevice ifnames instead of devlink port identification. |
| 41 |
|
| 42 |
.TP |
| 43 |
.BR "\-j" , " --json" |
| 44 |
Generate JSON output. |
| 45 |
|
| 46 |
.TP |
| 47 |
.BR "\-p" , " --pretty" |
| 48 |
When combined with -j generate a pretty JSON output. |
| 49 |
|
| 50 |
.TP |
| 51 |
.BR "\-v" , " --verbose" |
| 52 |
Turn on verbose output. |
| 53 |
|
| 54 |
.TP |
| 55 |
.BR "\-s" , " --statistics" |
| 56 |
Output statistics. |
| 57 |
|
| 58 |
.TP |
| 59 |
.BR "\-N", " \-Netns " <NETNSNAME> |
| 60 |
Switches to the specified network namespace. |
| 61 |
|
| 62 |
.TP |
| 63 |
.BR "\-i", " --iec" |
| 64 |
Print human readable rates in IEC units (e.g. 1Ki = 1024). |
| 65 |
|
| 66 |
.TP |
| 67 |
.BR "\-x", " --hex" |
| 68 |
Print dump numbers in hexadecimal format. |
| 69 |
|
| 70 |
.SS |
| 71 |
.I OBJECT |
| 72 |
|
| 73 |
.TP |
| 74 |
.B dev |
| 75 |
- devlink device. |
| 76 |
|
| 77 |
.TP |
| 78 |
.B port |
| 79 |
- devlink port. |
| 80 |
|
| 81 |
.TP |
| 82 |
.B monitor |
| 83 |
- watch for netlink messages. |
| 84 |
|
| 85 |
.TP |
| 86 |
.B sb |
| 87 |
- devlink shared buffer configuration. |
| 88 |
|
| 89 |
.TP |
| 90 |
.B resource |
| 91 |
- devlink device resource configuration. |
| 92 |
|
| 93 |
.TP |
| 94 |
.B region |
| 95 |
- devlink address region access. |
| 96 |
|
| 97 |
.TP |
| 98 |
.B health |
| 99 |
- devlink reporting and recovery. |
| 100 |
|
| 101 |
.TP |
| 102 |
.B trap |
| 103 |
- devlink trap configuration. |
| 104 |
|
| 105 |
.TP |
| 106 |
.B rate |
| 107 |
- devlink rate object configuration. |
| 108 |
|
| 109 |
.TP |
| 110 |
.B lc |
| 111 |
- devlink line card configuration. |
| 112 |
|
| 113 |
.TP |
| 114 |
.B dpipe |
| 115 |
- devlink datapath pipeline visualization. |
| 116 |
|
| 117 |
.SS |
| 118 |
.I COMMAND |
| 119 |
|
| 120 |
Specifies the action to perform on the object. |
| 121 |
The set of possible actions depends on the object type. |
| 122 |
As a rule, it is possible to |
| 123 |
.B show |
| 124 |
(or |
| 125 |
.B list |
| 126 |
) objects, but some objects do not allow all of these operations |
| 127 |
or have some additional commands. The |
| 128 |
.B help |
| 129 |
command is available for all objects. It prints |
| 130 |
out a list of available commands and argument syntax conventions. |
| 131 |
.sp |
| 132 |
If no command is given, some default command is assumed. |
| 133 |
Usually it is |
| 134 |
.B list |
| 135 |
or, if the objects of this class cannot be listed, |
| 136 |
.BR "help" . |
| 137 |
|
| 138 |
.SH EXIT STATUS |
| 139 |
Exit status is 0 if command was successful or a positive integer upon failure. |
| 140 |
|
| 141 |
.SH SEE ALSO |
| 142 |
.BR devlink-dev (8), |
| 143 |
.BR devlink-port (8), |
| 144 |
.BR devlink-monitor (8), |
| 145 |
.BR devlink-sb (8), |
| 146 |
.BR devlink-resource (8), |
| 147 |
.BR devlink-region (8), |
| 148 |
.BR devlink-health (8), |
| 149 |
.BR devlink-trap (8), |
| 150 |
.BR devlink-rate (8), |
| 151 |
.BR devlink-lc (8), |
| 152 |
.BR devlink-dpipe (8) |
| 153 |
.br |
| 154 |
|
| 155 |
.SH REPORTING BUGS |
| 156 |
Report any bugs to the Network Developers mailing list |
| 157 |
.B <[email protected]> |
| 158 |
where the development and maintenance is primarily done. |
| 159 |
You do not have to be subscribed to the list to send a message there. |
| 160 |
|
| 161 |
.SH AUTHOR |
| 162 |
Jiri Pirko <[email protected]> |