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 | vrf | mptcp }
18 OPTIONS := { -V[ersion] | -h[uman-readable] | -s[tatistics] |
21 -d[etails] | -r[esolve] | -iec | -f[amily] { inet | inet6 |
22 link } | -4 | -6 | -I | -D | -B | -0 | -l[oops] { maximum-addr-
23 flush-attempts } | -o[neline] | -rc[vbuf] [size] | -t[imestamp]
24 | -ts[hort] | -n[etns] name | -N[umeric] | -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, mpls or link. If this
66 option is not present, the protocol family is guessed from other
67 arguments. If the rest of the command line does not give enough
68 information to guess the family, ip falls back to the default
69 one, usually inet or any. link is a special family identifier
70 meaning that no networking protocol is involved.
71 -4 shortcut for -family inet.
74 -6 shortcut for -family inet6.
77 -B shortcut for -family bridge.
80 -M shortcut for -family mpls.
83 -0 shortcut for -family link.
86 -o, -oneline
89 output each record on a single line, replacing line feeds with
90 the '\' character. This is convenient when you want to count
91 records with wc(1) or to grep(1) the output.
92 -r, -resolve
95 use the system's name resolver to print DNS names instead of
96 host addresses.
97 -n, -netns <NETNS>
100 switches ip to the specified network namespace NETNS. Actually
101 it just simplifies executing of:
102 ip netns exec NETNS ip [ OPTIONS ] OBJECT { COMMAND | help }
104 to
106 ip -n[etns] NETNS [ OPTIONS ] OBJECT { COMMAND | help }
108 -N, -Numeric
111 Print the number of protocol, scope, dsfield, etc directly
112 instead of converting it to human readable name.
113 -a, -all
116 executes specified command over all objects, it depends if com‐
117 mand supports this option.
118 -c[color][={always|auto|never}
121 Configure color output. If parameter is omitted or always, color
122 output is enabled regardless of stdout state. If parameter is
123 auto, stdout is checked to be a terminal before enabling color
124 output. If parameter is never, color output is disabled. If
125 specified multiple times, the last one takes precedence. This
126 flag is ignored if -json is also given.
127 Used color palette can be influenced by COLORFGBG environment
129 variable (see ENVIRONMENT).
130 -t, -timestamp
133 display current time when using monitor option.
134 -ts, -tshort
137 Like -timestamp, but use shorter format.
138 -rc, -rcvbuf<SIZE>
141 Set the netlink socket receive buffer size, defaults to 1MB.
142 -iec print human readable rates in IEC units (e.g. 1Ki = 1024).
145 -br, -brief
148 Print only basic information in a tabular format for better
149 readability. This option is currently only supported by ip addr
150 show and ip link show commands.
151 -j, -json
154 Output results in JavaScript Object Notation (JSON).
155 -p, -pretty
158 The default JSON format is compact and more efficient to parse
159 but hard for most users to read. This flag adds indentation for
160 readability.
161
164 OBJECT
165 address
166 - protocol (IP or IPv6) address on a device.
167 addrlabel
170 - label configuration for protocol address selection.
171 l2tp - tunnel ethernet over IP (L2TPv3).
174 link - network device.
177 maddress
180 - multicast address.
181 monitor
184 - watch for netlink messages.
185 mptcp - manage MPTCP path manager.
188 mroute - multicast routing cache entry.
191 mrule - rule in multicast routing policy database.
194 neighbour
197 - manage ARP or NDISC cache entries.
198 netns - manage network namespaces.
201 ntable - manage the neighbor cache's operation.
204 route - routing table entry.
207 rule - rule in routing policy database.
210 tcp_metrics/tcpmetrics
213 - manage TCP Metrics
214 token - manage tokenized interface identifiers.
217 tunnel - tunnel over IP.
220 tuntap - manage TUN/TAP devices.
223 vrf - manage virtual routing and forwarding devices.
226 xfrm - manage IPSec policies.
229 The names of all objects may be written in full or abbreviated form,
232 for example address can be abbreviated as addr or just a.
233 COMMAND
236 Specifies the action to perform on the object. The set of possible
237 actions depends on the object type. As a rule, it is possible to add,
238 delete and show (or list ) objects, but some objects do not allow all
239 of these operations or have some additional commands. The help command
240 is available for all objects. It prints out a list of available com‐
241 mands and argument syntax conventions.
242 If no command is given, some default command is assumed. Usually it is
244 list or, if the objects of this class cannot be listed, help.
245
248 COLORFGBG
249 If set, it's value is used for detection whether background is
250 dark or light and use contrast colors for it.
251 COLORFGBG environment variable usually contains either two or
253 three values separated by semicolons; we want the last value in
254 either case. If this value is 0-6 or 8, chose colors suitable
255 for dark background:
256 COLORFGBG=";0" ip -c a
258
261 Exit status is 0 if command was successful, and 1 if there is a syntax
262 error. If an error was reported by the kernel exit status is 2.
263
266 ip addr
267 Shows addresses assigned to all network interfaces.
268 ip neigh
270 Shows the current neighbour table in kernel.
271 ip link set x up
273 Bring up interface x.
274 ip link set x down
276 Bring down interface x.
277 ip route
279 Show table routes.
280
283 ip was written by Alexey N. Kuznetsov and added in Linux 2.2.
284
286 ip-address(8), ip-addrlabel(8), ip-l2tp(8), ip-link(8), ip-maddress(8),
287 ip-monitor(8), ip-mptcp(8), ip-mroute(8), ip-neighbour(8), ip-netns(8),
288 ip-ntable(8), ip-route(8), ip-rule(8), ip-tcp_metrics(8), ip-token(8),
289 ip-tunnel(8), ip-vrf(8), ip-xfrm(8)
290 IP Command reference ip-cref.ps
291
293 Report any bugs to the Network Developers mailing list <net‐
294 dev@vger.kernel.org> where the development and maintenance is primarily
295 done. You do not have to be subscribed to the list to send a message
296 there.
297
300 Original Manpage by Michail Litvak <mci@owl.openwall.com>
301iproute2 20 Dec 2011 IP(8)