projects / mirror_iproute2.git / blame
| Commit | Line | Data |
|---|---|---|
| a3c4b484 JP |
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 | |
| a7a56f6f | 10 | .RI "[ " OPTIONS " ] { " dev | port | monitor | sb | resource | region | health | trap " } { " COMMAND " | " |
| a3c4b484 JP |
11 | .BR help " }" |
| 12 | .sp | |
| 13 | ||
| 3e897912 IV |
14 | .ti -8 |
| 15 | .B devlink | |
| 16 | .RB "[ " -force " ] " | |
| 17 | .BI "-batch " filename | |
| 18 | .sp | |
| 19 | ||
| a3c4b484 JP |
20 | .SH OPTIONS |
| 21 | ||
| 22 | .TP | |
| 639785ff | 23 | .BR "\-V" , " --Version" |
| a3c4b484 JP |
24 | Print the version of the |
| 25 | .B devlink | |
| 26 | utility and exit. | |
| 27 | ||
| 3e897912 IV |
28 | .TP |
| 29 | .BR "\-b", " \-batch " <FILENAME> | |
| 30 | Read commands from provided file or standard input and invoke them. | |
| 31 | First failure will cause termination of devlink. | |
| 32 | ||
| 33 | .TP | |
| 472fb39d | 34 | .B \-force |
| 3e897912 IV |
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 | ||
| 43f35be4 | 38 | .TP |
| 639785ff | 39 | .BR "\-n" , " --no-nice-names" |
| 43f35be4 JP |
40 | Turn off printing out nice names, for example netdevice ifnames instead of devlink port identification. |
| 41 | ||
| 639785ff RD |
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 | ||
| 29b1430b PS |
50 | .TP |
| 51 | .BR "\-v" , " --verbose" | |
| 52 | Turn on verbose output. | |
| 53 | ||
| a7a56f6f IS |
54 | .TP |
| 55 | .BR "\-s" , " --statistics" | |
| 56 | Output statistics. | |
| 57 | ||
| 29993df8 JP |
58 | .TP |
| 59 | .BR "\-N", " \-Netns " <NETNSNAME> | |
| 60 | Switches to the specified network namespace. | |
| 61 | ||
| a3c4b484 JP |
62 | .SS |
| 63 | .I OBJECT | |
| 64 | ||
| 65 | .TP | |
| 66 | .B dev | |
| 67 | - devlink device. | |
| 68 | ||
| 69 | .TP | |
| 70 | .B port | |
| 71 | - devlink port. | |
| 72 | ||
| 73 | .TP | |
| 74 | .B monitor | |
| 75 | - watch for netlink messages. | |
| 76 | ||
| 6b4f03f5 JP |
77 | .TP |
| 78 | .B sb | |
| 79 | - devlink shared buffer configuration. | |
| 80 | ||
| 81 | .TP | |
| 82 | .B resource | |
| 83 | - devlink device resource configuration. | |
| 84 | ||
| 995015be AV |
85 | .TP |
| 86 | .B region | |
| 87 | - devlink address region access | |
| 88 | ||
| 3147e0d3 AL |
89 | .TP |
| 90 | .B health | |
| 91 | - devlink reporting and recovery | |
| 92 | ||
| a7a56f6f IS |
93 | .TP |
| 94 | .B trap | |
| 95 | - devlink trap configuration | |
| 96 | ||
| a3c4b484 JP |
97 | .SS |
| 98 | .I COMMAND | |
| 99 | ||
| 100 | Specifies the action to perform on the object. | |
| 101 | The set of possible actions depends on the object type. | |
| 102 | As a rule, it is possible to | |
| 103 | .B show | |
| 104 | (or | |
| 105 | .B list | |
| 106 | ) objects, but some objects do not allow all of these operations | |
| 107 | or have some additional commands. The | |
| 108 | .B help | |
| 109 | command is available for all objects. It prints | |
| 110 | out a list of available commands and argument syntax conventions. | |
| 111 | .sp | |
| 112 | If no command is given, some default command is assumed. | |
| 113 | Usually it is | |
| 114 | .B list | |
| 115 | or, if the objects of this class cannot be listed, | |
| 116 | .BR "help" . | |
| 117 | ||
| 118 | .SH EXIT STATUS | |
| 119 | Exit status is 0 if command was successful or a positive integer upon failure. | |
| 120 | ||
| 121 | .SH SEE ALSO | |
| 122 | .BR devlink-dev (8), | |
| 123 | .BR devlink-port (8), | |
| 124 | .BR devlink-monitor (8), | |
| 78c610e6 | 125 | .BR devlink-sb (8), |
| 58b48c5d | 126 | .BR devlink-resource (8), |
| 8b4fbf0b | 127 | .BR devlink-region (8), |
| 3147e0d3 | 128 | .BR devlink-health (8), |
| a7a56f6f | 129 | .BR devlink-trap (8), |
| a3c4b484 JP |
130 | .br |
| 131 | ||
| 132 | .SH REPORTING BUGS | |
| 133 | Report any bugs to the Network Developers mailing list | |
| 134 | .B <netdev@vger.kernel.org> | |
| 135 | where the development and maintenance is primarily done. | |
| 136 | You do not have to be subscribed to the list to send a message there. | |
| 137 | ||
| 138 | .SH AUTHOR | |
| 139 | Jiri Pirko <jiri@mellanox.com> |