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 |
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 | -a[ll] | -c[olor] | -br[ief] |
25 -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 -a, -all
111 executes specified command over all objects, it depends if com‐
112 mand supports this option.
113 -c[color][={always|auto|never}
116 Configure color output. If parameter is omitted or always, color
117 output is enabled regardless of stdout state. If parameter is
118 auto, stdout is checked to be a terminal before enabling color
119 output. If parameter is never, color output is disabled. If
120 specified multiple times, the last one takes precedence. This
121 flag is ignored if -json is also given.
122 Used color palette can be influenced by COLORFGBG environment
124 variable (see ENVIRONMENT).
125 -t, -timestamp
128 display current time when using monitor option.
129 -ts, -tshort
132 Like -timestamp, but use shorter format.
133 -rc, -rcvbuf<SIZE>
136 Set the netlink socket receive buffer size, defaults to 1MB.
137 -iec print human readable rates in IEC units (e.g. 1Ki = 1024).
140 -br, -brief
143 Print only basic information in a tabular format for better
144 readability. This option is currently only supported by ip addr
145 show and ip link show commands.
146 -j, -json
149 Output results in JavaScript Object Notation (JSON).
150 -p, -pretty
153 The default JSON format is compact and more efficient to parse
154 but hard for most users to read. This flag adds indentation for
155 readability.
156
159 OBJECT
160 address
161 - protocol (IP or IPv6) address on a device.
162 addrlabel
165 - label configuration for protocol address selection.
166 l2tp - tunnel ethernet over IP (L2TPv3).
169 link - network device.
172 maddress
175 - multicast address.
176 monitor
179 - watch for netlink messages.
180 mroute - multicast routing cache entry.
183 mrule - rule in multicast routing policy database.
186 neighbour
189 - manage ARP or NDISC cache entries.
190 netns - manage network namespaces.
193 ntable - manage the neighbor cache's operation.
196 route - routing table entry.
199 rule - rule in routing policy database.
202 tcp_metrics/tcpmetrics
205 - manage TCP Metrics
206 token - manage tokenized interface identifiers.
209 tunnel - tunnel over IP.
212 tuntap - manage TUN/TAP devices.
215 xfrm - manage IPSec policies.
218 The names of all objects may be written in full or abbreviated form,
221 for example address can be abbreviated as addr or just a.
222 COMMAND
225 Specifies the action to perform on the object. The set of possible
226 actions depends on the object type. As a rule, it is possible to add,
227 delete and show (or list ) objects, but some objects do not allow all
228 of these operations or have some additional commands. The help command
229 is available for all objects. It prints out a list of available com‐
230 mands and argument syntax conventions.
231 If no command is given, some default command is assumed. Usually it is
233 list or, if the objects of this class cannot be listed, help.
234
237 COLORFGBG
238 If set, it's value is used for detection whether background is
239 dark or light and use contrast colors for it.
240 COLORFGBG environment variable usually contains either two or
242 three values separated by semicolons; we want the last value in
243 either case. If this value is 0-6 or 8, chose colors suitable
244 for dark background:
245 COLORFGBG=";0" ip -c a
247
250 Exit status is 0 if command was successful, and 1 if there is a syntax
251 error. If an error was reported by the kernel exit status is 2.
252
255 ip addr
256 Shows addresses assigned to all network interfaces.
257 ip neigh
259 Shows the current neighbour table in kernel.
260 ip link set x up
262 Bring up interface x.
263 ip link set x down
265 Bring down interface x.
266 ip route
268 Show table routes.
269
272 ip was written by Alexey N. Kuznetsov and added in Linux 2.2.
273
275 ip-address(8), ip-addrlabel(8), ip-l2tp(8), ip-link(8), ip-maddress(8),
276 ip-monitor(8), ip-mroute(8), ip-neighbour(8), ip-netns(8), ip-
277 ntable(8), ip-route(8), ip-rule(8), ip-tcp_metrics(8), ip-token(8), ip-
278 tunnel(8), ip-xfrm(8)
279 IP Command reference ip-cref.ps
280
282 Report any bugs to the Network Developers mailing list <net‐
283 dev@vger.kernel.org> where the development and maintenance is primarily
284 done. You do not have to be subscribed to the list to send a message
285 there.
286
289 Original Manpage by Michail Litvak <mci@owl.openwall.com>
290iproute2 20 Dec 2011 IP(8)