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 | noprefixroute | autojoin ]
40 LIFETIME := [ valid_lft LFT ] [ preferred_lft LFT ]
42 LFT := [ forever | SECONDS ]
44 TYPE := [ bridge | bridge_slave | bond | bond_slave | can | dummy | hsr
46 | ifb | ipoib | macvlan | macvtap | vcan | veth | vlan | vxlan
47 | ip6tnl | ipip | sit | gre | gretap | erspan | ip6gre |
48 ip6gretap | ip6erspan | vti | vrf | nlmon | ipvlan | lowpan |
49 geneve | macsec ]
50
53 The address is a protocol (IPv4 or IPv6) address attached to a network
54 device. Each device must have at least one address to use the corre‐
55 sponding protocol. It is possible to have several different addresses
56 attached to one device. These addresses are not discriminated, so that
57 the term alias is not quite appropriate for them and we do not use it
58 in this document.
59 The ip address command displays addresses and their properties, adds
61 new addresses and deletes old ones.
62 ip address add - add new protocol address.
65 dev IFNAME
66 the name of the device to add the address to.
67 local ADDRESS (default)
70 the address of the interface. The format of the address depends
71 on the protocol. It is a dotted quad for IP and a sequence of
72 hexadecimal halfwords separated by colons for IPv6. The ADDRESS
73 may be followed by a slash and a decimal number which encodes
74 the network prefix length.
75 peer ADDRESS
78 the address of the remote endpoint for pointopoint interfaces.
79 Again, the ADDRESS may be followed by a slash and a decimal num‐
80 ber, encoding the network prefix length. If a peer address is
81 specified, the local address cannot have a prefix length. The
82 network prefix is associated with the peer rather than with the
83 local address.
84 broadcast ADDRESS
87 the broadcast address on the interface.
88 It is possible to use the special symbols '+' and '-' instead of
90 the broadcast address. In this case, the broadcast address is
91 derived by setting/resetting the host bits of the interface pre‐
92 fix.
93 label LABEL
96 Each address may be tagged with a label string. In order to
97 preserve compatibility with Linux-2.0 net aliases, this string
98 must coincide with the name of the device or must be prefixed
99 with the device name followed by colon. The maximum allowed
100 total length of label is 15 characters.
101 scope SCOPE_VALUE
104 the scope of the area where this address is valid. The avail‐
105 able scopes are listed in file /etc/iproute2/rt_scopes. Prede‐
106 fined scope values are:
107 global - the address is globally valid.
109 site - (IPv6 only, deprecated) the address is site
111 local, i.e. it is valid inside this site.
112 link - the address is link local, i.e. it is valid only
114 on this device.
115 host - the address is valid only inside this host.
117 metric NUMBER
120 priority of prefix route associated with address.
121 valid_lft LFT
124 the valid lifetime of this address; see section 5.5.4 of RFC
125 4862. When it expires, the address is removed by the kernel.
126 Defaults to forever.
127 preferred_lft LFT
130 the preferred lifetime of this address; see section 5.5.4 of RFC
131 4862. When it expires, the address is no longer used for new
132 outgoing connections. Defaults to forever.
133 home (IPv6 only) designates this address the "home address" as
136 defined in RFC 6275.
137 mngtmpaddr
140 (IPv6 only) make the kernel manage temporary addresses created
141 from this one as template on behalf of Privacy Extensions
142 (RFC3041). For this to become active, the use_tempaddr sysctl
143 setting has to be set to a value greater than zero. The given
144 address needs to have a prefix length of 64. This flag allows to
145 use privacy extensions in a manually configured network, just
146 like if stateless auto-configuration was active.
147 nodad (IPv6 only) do not perform Duplicate Address Detection (RFC
150 4862) when adding this address.
151 noprefixroute
154 Do not automatically create a route for the network prefix of
155 the added address, and don't search for one to delete when
156 removing the address. Changing an address to add this flag will
157 remove the automatically added prefix route, changing it to
158 remove this flag will create the prefix route automatically.
159 autojoin
162 Joining multicast groups on Ethernet level via ip maddr command
163 does not work if connected to an Ethernet switch that does IGMP
164 snooping since the switch would not replicate multicast packets
165 on ports that did not have IGMP reports for the multicast
166 addresses.
167 Linux VXLAN interfaces created via ip link add vxlan have the
169 group option that enables them to do the required join.
170 Using the autojoin flag when adding a multicast address enables
172 similar functionality for Openvswitch VXLAN interfaces as well
173 as other tunneling mechanisms that need to receive multicast
174 traffic.
175 ip address delete - delete protocol address
178 Arguments: coincide with the arguments of ip addr add. The device name
179 is a required argument. The rest are optional. If no arguments are
180 given, the first address is deleted.
181 ip address show - look at protocol addresses
184 dev IFNAME (default)
185 name of device.
186 scope SCOPE_VAL
189 only list addresses with this scope.
190 to PREFIX
193 only list addresses matching this prefix.
194 label PATTERN
197 only list addresses with labels matching the PATTERN. PATTERN
198 is a usual shell style pattern.
199 master DEVICE
202 only list interfaces enslaved to this master device.
203 vrf NAME
206 only list interfaces enslaved to this vrf.
207 type TYPE
210 only list interfaces of the given type.
211 Note that the type name is not checked against the list of sup‐
213 ported types - instead it is sent as-is to the kernel. Later it
214 is used to filter the returned interface list by comparing it
215 with the relevant attribute in case the kernel didn't filter
216 already. Therefore any string is accepted, but may lead to empty
217 output.
218 up only list running interfaces.
221 dynamic and permanent
224 (IPv6 only) only list addresses installed due to stateless
225 address configuration or only list permanent (not dynamic)
226 addresses. These two flags are inverses of each other, so
227 -dynamic is equal to permanent and -permanent is equal to
228 dynamic.
229 tentative
232 (IPv6 only) only list addresses which have not yet passed dupli‐
233 cate address detection.
234 -tentative
237 (IPv6 only) only list addresses which are not in the process of
238 duplicate address detection currently.
239 deprecated
242 (IPv6 only) only list deprecated addresses.
243 -deprecated
246 (IPv6 only) only list addresses not being deprecated.
247 dadfailed
250 (IPv6 only) only list addresses which have failed duplicate
251 address detection.
252 -dadfailed
255 (IPv6 only) only list addresses which have not failed duplicate
256 address detection.
257 temporary or secondary
260 List temporary IPv6 or secondary IPv4 addresses only. The Linux
261 kernel shares a single bit for those, so they are actually
262 aliases for each other although the meaning differs depending on
263 address family.
264 -temporary or -secondary
267 These flags are aliases for primary.
268 primary
271 List only primary addresses, in IPv6 exclude temporary ones.
272 This flag is the inverse of temporary and secondary.
273 -primary
276 This is an alias for temporary or secondary.
277 ip address flush - flush protocol addresses
280 This command flushes the protocol addresses selected by some criteria.
281 This command has the same arguments as show except that type and master
284 selectors are not supported. Another difference is that it does not
285 run when no arguments are given.
286 Warning: This command and other flush commands are unforgiving. They
289 will cruelly purge all the addresses.
290 With the -statistics option, the command becomes verbose. It prints out
293 the number of deleted addresses and the number of rounds made to flush
294 the address list. If this option is given twice, ip address flush also
295 dumps all the deleted addresses in the format described in the previous
296 subsection.
297
300 ip address show
301 Shows IPv4 and IPv6 addresses assigned to all network interfaces.
302 The 'show' subcommand can be omitted.
303 ip address show up
305 Same as above except that only addresses assigned to active network
306 interfaces are shown.
307 ip address show dev eth0
309 Shows IPv4 and IPv6 addresses assigned to network interface eth0.
310 ip address add 2001:0db8:85a3::0370:7334/64 dev eth1
312 Adds an IPv6 address to network interface eth1.
313 ip address delete 2001:0db8:85a3::0370:7334/64 dev eth1
315 Delete the IPv6 address added above.
316 ip address flush dev eth4 scope global
318 Removes all global IPv4 and IPv6 addresses from device eth4. With‐
319 out 'scope global' it would remove all addresses including IPv6
320 link-local ones.
321
324 ip(8)
325
328 Original Manpage by Michail Litvak <mci@owl.openwall.com>
329iproute2 20 Dec 2011 IP-ADDRESS(8)