1IP-ADDRESS(8) Linux IP-ADDRESS(8)
2
6 ip-address - protocol address management
7
9 ip [ OPTIONS ] address { COMMAND | help }
10 ip address { add | change | replace } IFADDR dev IFNAME [ LIFETIME ] [
13 CONFFLAG-LIST ]
14 ip address del IFADDR dev IFNAME [ mngtmpaddr ]
16 ip address { save | flush } [ dev IFNAME ] [ scope SCOPE-ID ] [ metric
18 METRIC ] [ to PREFIX ] [ FLAG-LIST ] [ label PATTERN ] [ up ]
19 ip address [ show [ dev IFNAME ] [ scope SCOPE-ID ] [ to PREFIX ] [
21 FLAG-LIST ] [ label PATTERN ] [ master DEVICE ] [ type TYPE ] [
22 vrf NAME ] [ up ] ]
23 ip address { showdump | restore }
25 IFADDR := PREFIX | ADDR peer PREFIX [ broadcast ADDR ] [ anycast ADDR ]
27 [ label LABEL ] [ scope SCOPE-ID ]
28 SCOPE-ID := [ host | link | global | NUMBER ]
30 FLAG-LIST := [ FLAG-LIST ] FLAG
32 FLAG := [ [-]permanent | [-]dynamic | [-]secondary | [-]primary |
34 [-]tentative | [-]deprecated | [-]dadfailed | [-]temporary |
35 CONFFLAG-LIST ]
36 CONFFLAG-LIST := [ CONFFLAG-LIST ] CONFFLAG
38 CONFFLAG := [ home | mngtmpaddr | nodad | optimstic | noprefixroute |
40 autojoin ]
41 LIFETIME := [ valid_lft LFT ] [ preferred_lft LFT ]
43 LFT := [ forever | SECONDS ]
45 TYPE := [ bridge | bridge_slave | bond | bond_slave | can | dummy | hsr
47 | ifb | ipoib | macvlan | macvtap | vcan | veth | vlan | vxlan
48 | ip6tnl | ipip | sit | gre | gretap | erspan | ip6gre |
49 ip6gretap | ip6erspan | vti | vrf | nlmon | ipvlan | lowpan |
50 geneve | macsec ]
51
54 The address is a protocol (IPv4 or IPv6) address attached to a network
55 device. Each device must have at least one address to use the corre‐
56 sponding protocol. It is possible to have several different addresses
57 attached to one device. These addresses are not discriminated, so that
58 the term alias is not quite appropriate for them and we do not use it
59 in this document.
60 The ip address command displays addresses and their properties, adds
62 new addresses and deletes old ones.
63 ip address add - add new protocol address.
66 dev IFNAME
67 the name of the device to add the address to.
68 local ADDRESS (default)
71 the address of the interface. The format of the address depends
72 on the protocol. It is a dotted quad for IP and a sequence of
73 hexadecimal halfwords separated by colons for IPv6. The ADDRESS
74 may be followed by a slash and a decimal number which encodes
75 the network prefix length.
76 peer ADDRESS
79 the address of the remote endpoint for pointopoint interfaces.
80 Again, the ADDRESS may be followed by a slash and a decimal num‐
81 ber, encoding the network prefix length. If a peer address is
82 specified, the local address cannot have a prefix length. The
83 network prefix is associated with the peer rather than with the
84 local address.
85 broadcast ADDRESS
88 the broadcast address on the interface.
89 It is possible to use the special symbols '+' and '-' instead of
91 the broadcast address. In this case, the broadcast address is
92 derived by setting/resetting the host bits of the interface pre‐
93 fix.
94 label LABEL
97 Each address may be tagged with a label string. In order to
98 preserve compatibility with Linux-2.0 net aliases, this string
99 must coincide with the name of the device or must be prefixed
100 with the device name followed by colon. The maximum allowed
101 total length of label is 15 characters.
102 scope SCOPE_VALUE
105 the scope of the area where this address is valid. The avail‐
106 able scopes are listed in file /etc/iproute2/rt_scopes. Prede‐
107 fined scope values are:
108 global - the address is globally valid.
110 site - (IPv6 only, deprecated) the address is site
112 local, i.e. it is valid inside this site.
113 link - the address is link local, i.e. it is valid only
115 on this device.
116 host - the address is valid only inside this host.
118 metric NUMBER
121 priority of prefix route associated with address.
122 valid_lft LFT
125 the valid lifetime of this address; see section 5.5.4 of RFC
126 4862. When it expires, the address is removed by the kernel.
127 Defaults to forever.
128 preferred_lft LFT
131 the preferred lifetime of this address; see section 5.5.4 of RFC
132 4862. When it expires, the address is no longer used for new
133 outgoing connections. Defaults to forever.
134 home (IPv6 only) designates this address the "home address" as
137 defined in RFC 6275.
138 mngtmpaddr
141 (IPv6 only) make the kernel manage temporary addresses created
142 from this one as template on behalf of Privacy Extensions
143 (RFC3041). For this to become active, the use_tempaddr sysctl
144 setting has to be set to a value greater than zero. The given
145 address needs to have a prefix length of 64. This flag allows to
146 use privacy extensions in a manually configured network, just
147 like if stateless auto-configuration was active.
148 nodad (IPv6 only) do not perform Duplicate Address Detection (RFC
151 4862) when adding this address.
152 optimistic
155 (IPv6 only) When performing Duplicate Address Detection, use the
156 RFC 4429 optimistic variant.
157 noprefixroute
160 Do not automatically create a route for the network prefix of
161 the added address, and don't search for one to delete when
162 removing the address. Changing an address to add this flag will
163 remove the automatically added prefix route, changing it to
164 remove this flag will create the prefix route automatically.
165 autojoin
168 Joining multicast groups on Ethernet level via ip maddr command
169 does not work if connected to an Ethernet switch that does IGMP
170 snooping since the switch would not replicate multicast packets
171 on ports that did not have IGMP reports for the multicast
172 addresses.
173 Linux VXLAN interfaces created via ip link add vxlan have the
175 group option that enables them to do the required join.
176 Using the autojoin flag when adding a multicast address enables
178 similar functionality for Openvswitch VXLAN interfaces as well
179 as other tunneling mechanisms that need to receive multicast
180 traffic.
181 ip address delete - delete protocol address
184 Arguments: coincide with the arguments of ip addr add. The device name
185 is a required argument. The rest are optional. If no arguments are
186 given, the first address is deleted.
187 ip address show - look at protocol addresses
190 dev IFNAME (default)
191 name of device.
192 scope SCOPE_VAL
195 only list addresses with this scope.
196 to PREFIX
199 only list addresses matching this prefix.
200 label PATTERN
203 only list addresses with labels matching the PATTERN. PATTERN
204 is a usual shell style pattern.
205 master DEVICE
208 only list interfaces enslaved to this master device.
209 vrf NAME
212 only list interfaces enslaved to this vrf.
213 type TYPE
216 only list interfaces of the given type.
217 Note that the type name is not checked against the list of sup‐
219 ported types - instead it is sent as-is to the kernel. Later it
220 is used to filter the returned interface list by comparing it
221 with the relevant attribute in case the kernel didn't filter
222 already. Therefore any string is accepted, but may lead to empty
223 output.
224 up only list running interfaces.
227 dynamic and permanent
230 (IPv6 only) only list addresses installed due to stateless
231 address configuration or only list permanent (not dynamic)
232 addresses. These two flags are inverses of each other, so
233 -dynamic is equal to permanent and -permanent is equal to
234 dynamic.
235 tentative
238 (IPv6 only) only list addresses which have not yet passed dupli‐
239 cate address detection.
240 -tentative
243 (IPv6 only) only list addresses which are not in the process of
244 duplicate address detection currently.
245 deprecated
248 (IPv6 only) only list deprecated addresses.
249 -deprecated
252 (IPv6 only) only list addresses not being deprecated.
253 dadfailed
256 (IPv6 only) only list addresses which have failed duplicate
257 address detection.
258 -dadfailed
261 (IPv6 only) only list addresses which have not failed duplicate
262 address detection.
263 temporary or secondary
266 List temporary IPv6 or secondary IPv4 addresses only. The Linux
267 kernel shares a single bit for those, so they are actually
268 aliases for each other although the meaning differs depending on
269 address family.
270 -temporary or -secondary
273 These flags are aliases for primary.
274 primary
277 List only primary addresses, in IPv6 exclude temporary ones.
278 This flag is the inverse of temporary and secondary.
279 -primary
282 This is an alias for temporary or secondary.
283 ip address flush - flush protocol addresses
286 This command flushes the protocol addresses selected by some criteria.
287 This command has the same arguments as show except that type and master
290 selectors are not supported. Another difference is that it does not
291 run when no arguments are given.
292 Warning: This command and other flush commands are unforgiving. They
295 will cruelly purge all the addresses.
296 With the -statistics option, the command becomes verbose. It prints out
299 the number of deleted addresses and the number of rounds made to flush
300 the address list. If this option is given twice, ip address flush also
301 dumps all the deleted addresses in the format described in the previous
302 subsection.
303
306 ip address show
307 Shows IPv4 and IPv6 addresses assigned to all network interfaces.
308 The 'show' subcommand can be omitted.
309 ip address show up
311 Same as above except that only addresses assigned to active network
312 interfaces are shown.
313 ip address show dev eth0
315 Shows IPv4 and IPv6 addresses assigned to network interface eth0.
316 ip address add 2001:0db8:85a3::0370:7334/64 dev eth1
318 Adds an IPv6 address to network interface eth1.
319 ip address delete 2001:0db8:85a3::0370:7334/64 dev eth1
321 Delete the IPv6 address added above.
322 ip address flush dev eth4 scope global
324 Removes all global IPv4 and IPv6 addresses from device eth4. With‐
325 out 'scope global' it would remove all addresses including IPv6
326 link-local ones.
327
330 ip(8)
331
334 Original Manpage by Michail Litvak <mci@owl.openwall.com>
335iproute2 20 Dec 2011 IP-ADDRESS(8)