1IP(8) Linux IP(8)
2
6 ip - show / manipulate routing, network devices, interfaces and tunnels
7
9 ip [ OPTIONS ] OBJECT { COMMAND | help }
10 ip [ -force ] -batch filename
13 OBJECT := { link | address | addrlabel | route | rule | neigh | ntable
16 | tunnel | tuntap | maddress | mroute | mrule | monitor | xfrm
17 | netns | l2tp | tcp_metrics | token | macsec }
18 OPTIONS := { -V[ersion] | -h[uman-readable] | -s[tatistics] |
21 -d[etails] | -r[esolve] | -iec | -f[amily] { inet | inet6 | ipx
22 | dnet | link } | -4 | -6 | -I | -D | -B | -0 | -l[oops] { max‐
23 imum-addr-flush-attempts } | -o[neline] | -rc[vbuf] [size] |
24 -t[imestamp] | -ts[hort] | -n[etns] name | -a[ll] | -c[olor] |
25 -br[ief] | -j[son] | -p[retty] }
26
29 -V, -Version
30 Print the version of the ip utility and exit.
31 -h, -human, -human-readable
34 output statistics with human readable values followed by suffix.
35 -b, -batch <FILENAME>
38 Read commands from provided file or standard input and invoke
39 them. First failure will cause termination of ip.
40 -force Don't terminate ip on errors in batch mode. If there were any
43 errors during execution of the commands, the application return
44 code will be non zero.
45 -s, -stats, -statistics
48 Output more information. If the option appears twice or more,
49 the amount of information increases. As a rule, the information
50 is statistics or some time values.
51 -d, -details
54 Output more detailed information.
55 -l, -loops <COUNT>
58 Specify maximum number of loops the 'ip address flush' logic
59 will attempt before giving up. The default is 10. Zero (0)
60 means loop until all addresses are removed.
61 -f, -family <FAMILY>
64 Specifies the protocol family to use. The protocol family iden‐
65 tifier can be one of inet, inet6, bridge, ipx, dnet, mpls or
66 link. If this option is not present, the protocol family is
67 guessed from other arguments. If the rest of the command line
68 does not give enough information to guess the family, ip falls
69 back to the default one, usually inet or any. link is a special
70 family identifier meaning that no networking protocol is
71 involved.
72 -4 shortcut for -family inet.
75 -6 shortcut for -family inet6.
78 -B shortcut for -family bridge.
81 -D shortcut for -family decnet.
84 -I shortcut for -family ipx.
87 -M shortcut for -family mpls.
90 -0 shortcut for -family link.
93 -o, -oneline
96 output each record on a single line, replacing line feeds with
97 the '\' character. This is convenient when you want to count
98 records with wc(1) or to grep(1) the output.
99 -r, -resolve
102 use the system's name resolver to print DNS names instead of
103 host addresses.
104 -n, -netns <NETNS>
107 switches ip to the specified network namespace NETNS. Actually
108 it just simplifies executing of:
109 ip netns exec NETNS ip [ OPTIONS ] OBJECT { COMMAND | help }
111 to
113 ip -n[etns] NETNS [ OPTIONS ] OBJECT { COMMAND | help }
115 -a, -all
118 executes specified command over all objects, it depends if com‐
119 mand supports this option.
120 -c[color][={always|auto|never}
123 Configure color output. If parameter is omitted or always, color
124 output is enabled regardless of stdout state. If parameter is
125 auto, stdout is checked to be a terminal before enabling color
126 output. If parameter is never, color output is disabled. If
127 specified multiple times, the last one takes precedence. This
128 flag is ignored if -json is also given.
129 -t, -timestamp
132 display current time when using monitor option.
133 -ts, -tshort
136 Like -timestamp, but use shorter format.
137 -rc, -rcvbuf<SIZE>
140 Set the netlink socket receive buffer size, defaults to 1MB.
141 -iec print human readable rates in IEC units (e.g. 1Ki = 1024).
144 -br, -brief
147 Print only basic information in a tabular format for better
148 readability. This option is currently only supported by ip addr
149 show and ip link show commands.
150 -j, -json
153 Output results in JavaScript Object Notation (JSON).
154 -p, -pretty
157 The default JSON format is compact and more efficient to parse
158 but hard for most users to read. This flag adds indentation for
159 readability.
160
163 OBJECT
164 address
165 - protocol (IP or IPv6) address on a device.
166 addrlabel
169 - label configuration for protocol address selection.
170 l2tp - tunnel ethernet over IP (L2TPv3).
173 link - network device.
176 maddress
179 - multicast address.
180 monitor
183 - watch for netlink messages.
184 mroute - multicast routing cache entry.
187 mrule - rule in multicast routing policy database.
190 neighbour
193 - manage ARP or NDISC cache entries.
194 netns - manage network namespaces.
197 ntable - manage the neighbor cache's operation.
200 route - routing table entry.
203 rule - rule in routing policy database.
206 tcp_metrics/tcpmetrics
209 - manage TCP Metrics
210 token - manage tokenized interface identifiers.
213 tunnel - tunnel over IP.
216 tuntap - manage TUN/TAP devices.
219 xfrm - manage IPSec policies.
222 The names of all objects may be written in full or abbreviated form,
225 for example address can be abbreviated as addr or just a.
226 COMMAND
229 Specifies the action to perform on the object. The set of possible
230 actions depends on the object type. As a rule, it is possible to add,
231 delete and show (or list ) objects, but some objects do not allow all
232 of these operations or have some additional commands. The help command
233 is available for all objects. It prints out a list of available com‐
234 mands and argument syntax conventions.
235 If no command is given, some default command is assumed. Usually it is
237 list or, if the objects of this class cannot be listed, help.
238
241 Exit status is 0 if command was successful, and 1 if there is a syntax
242 error. If an error was reported by the kernel exit status is 2.
243
246 ip addr
247 Shows addresses assigned to all network interfaces.
248 ip neigh
250 Shows the current neighbour table in kernel.
251 ip link set x up
253 Bring up interface x.
254 ip link set x down
256 Bring down interface x.
257 ip route
259 Show table routes.
260
263 ip was written by Alexey N. Kuznetsov and added in Linux 2.2.
264
266 ip-address(8), ip-addrlabel(8), ip-l2tp(8), ip-link(8), ip-maddress(8),
267 ip-monitor(8), ip-mroute(8), ip-neighbour(8), ip-netns(8), ip-
268 ntable(8), ip-route(8), ip-rule(8), ip-tcp_metrics(8), ip-token(8), ip-
269 tunnel(8), ip-xfrm(8)
270 IP Command reference ip-cref.ps
271
273 Report any bugs to the Network Developers mailing list <net‐
274 dev@vger.kernel.org> where the development and maintenance is primarily
275 done. You do not have to be subscribed to the list to send a message
276 there.
277
280 Original Manpage by Michail Litvak <mci@owl.openwall.com>
281iproute2 20 Dec 2011 IP(8)