1IP-ADDRESS(8)                        Linux                       IP-ADDRESS(8)
2
3
4

NAME

6       ip-address - protocol address management
7

SYNOPSIS

9       ip [ OPTIONS ] address  { COMMAND | help }
10
11
12       ip address { add | change | replace } IFADDR dev IFNAME [ LIFETIME ] [
13               CONFFLAG-LIST ]
14
15       ip address del IFADDR dev IFNAME [ mngtmpaddr ]
16
17       ip address { save | flush } [ dev IFNAME ] [ scope SCOPE-ID ] [ metric
18               METRIC ] [ to PREFIX ] [ FLAG-LIST ] [ label PATTERN ] [ up ]
19
20       ip address [ show [ dev IFNAME ] [ scope SCOPE-ID ] [ to PREFIX ] [
21               FLAG-LIST ] [ label PATTERN ] [ master DEVICE ] [ type TYPE ] [
22               vrf NAME ] [ up ] ]
23
24       ip address { showdump | restore }
25
26       IFADDR := PREFIX | ADDR peer PREFIX [ broadcast ADDR ] [ anycast ADDR ]
27               [ label LABEL ] [ scope SCOPE-ID ]
28
29       SCOPE-ID := [ host | link | global | NUMBER ]
30
31       FLAG-LIST := [ FLAG-LIST ] FLAG
32
33       FLAG := [ permanent | dynamic | secondary | primary | [-]tentative |
34               [-]deprecated | [-]dadfailed | temporary | CONFFLAG-LIST ]
35
36       CONFFLAG-LIST := [ CONFFLAG-LIST ] CONFFLAG
37
38       CONFFLAG := [ home | mngtmpaddr | nodad | noprefixroute | autojoin ]
39
40       LIFETIME := [ valid_lft LFT ] [ preferred_lft LFT ]
41
42       LFT := [ forever | SECONDS ]
43
44       TYPE := [ bridge | bridge_slave | bond | bond_slave | can | dummy | hsr
45               | ifb | ipoib | macvlan | macvtap | vcan | veth | vlan | vxlan
46               | ip6tnl | ipip | sit | gre | gretap | erspan | ip6gre |
47               ip6gretap | ip6erspan | vti | vrf | nlmon | ipvlan | lowpan |
48               geneve | macsec ]
49
50

DESCRIPTION

52       The address is a protocol (IPv4 or IPv6) address attached to a network
53       device. Each device must have at least one address to use the corre‐
54       sponding protocol. It is possible to have several different addresses
55       attached to one device. These addresses are not discriminated, so that
56       the term alias is not quite appropriate for them and we do not use it
57       in this document.
58
59       The ip address command displays addresses and their properties, adds
60       new addresses and deletes old ones.
61
62
63   ip address add - add new protocol address.
64       dev IFNAME
65              the name of the device to add the address to.
66
67
68       local ADDRESS (default)
69              the address of the interface. The format of the address depends
70              on the protocol. It is a dotted quad for IP and a sequence of
71              hexadecimal halfwords separated by colons for IPv6. The ADDRESS
72              may be followed by a slash and a decimal number which encodes
73              the network prefix length.
74
75
76       peer ADDRESS
77              the address of the remote endpoint for pointopoint interfaces.
78              Again, the ADDRESS may be followed by a slash and a decimal num‐
79              ber, encoding the network prefix length. If a peer address is
80              specified, the local address cannot have a prefix length. The
81              network prefix is associated with the peer rather than with the
82              local address.
83
84
85       broadcast ADDRESS
86              the broadcast address on the interface.
87
88              It is possible to use the special symbols '+' and '-' instead of
89              the broadcast address. In this case, the broadcast address is
90              derived by setting/resetting the host bits of the interface pre‐
91              fix.
92
93
94       label LABEL
95              Each address may be tagged with a label string.  In order to
96              preserve compatibility with Linux-2.0 net aliases, this string
97              must coincide with the name of the device or must be prefixed
98              with the device name followed by colon.  The maximum allowed
99              total length of label is 15 characters.
100
101
102       scope SCOPE_VALUE
103              the scope of the area where this address is valid.  The avail‐
104              able scopes are listed in file /etc/iproute2/rt_scopes.  Prede‐
105              fined scope values are:
106
107                      global - the address is globally valid.
108
109                      site - (IPv6 only, deprecated) the address is site
110                      local, i.e. it is valid inside this site.
111
112                      link - the address is link local, i.e. it is valid only
113                      on this device.
114
115                      host - the address is valid only inside this host.
116
117
118       metric NUMBER
119              priority of prefix route associated with address.
120
121
122       valid_lft LFT
123              the valid lifetime of this address; see section 5.5.4 of RFC
124              4862. When it expires, the address is removed by the kernel.
125              Defaults to forever.
126
127
128       preferred_lft LFT
129              the preferred lifetime of this address; see section 5.5.4 of RFC
130              4862. When it expires, the address is no longer used for new
131              outgoing connections. Defaults to forever.
132
133
134       home   (IPv6 only) designates this address the "home address" as
135              defined in RFC 6275.
136
137
138       mngtmpaddr
139              (IPv6 only) make the kernel manage temporary addresses created
140              from this one as template on behalf of Privacy Extensions
141              (RFC3041). For this to become active, the use_tempaddr sysctl
142              setting has to be set to a value greater than zero.  The given
143              address needs to have a prefix length of 64. This flag allows to
144              use privacy extensions in a manually configured network, just
145              like if stateless auto-configuration was active.
146
147
148       nodad  (IPv6 only) do not perform Duplicate Address Detection (RFC
149              4862) when adding this address.
150
151
152       noprefixroute
153              Do not automatically create a route for the network prefix of
154              the added address, and don't search for one to delete when
155              removing the address. Changing an address to add this flag will
156              remove the automatically added prefix route, changing it to
157              remove this flag will create the prefix route automatically.
158
159
160       autojoin
161              Joining multicast groups on Ethernet level via ip maddr command
162              does not work if connected to an Ethernet switch that does IGMP
163              snooping since the switch would not replicate multicast packets
164              on ports that did not have IGMP reports for the multicast
165              addresses.
166
167              Linux VXLAN interfaces created via ip link add vxlan have the
168              group option that enables them to do the required join.
169
170              Using the autojoin flag when adding a multicast address enables
171              similar functionality for Openvswitch VXLAN interfaces as well
172              as other tunneling mechanisms that need to receive multicast
173              traffic.
174
175
176   ip address delete - delete protocol address
177       Arguments: coincide with the arguments of ip addr add.  The device name
178       is a required argument. The rest are optional.  If no arguments are
179       given, the first address is deleted.
180
181
182   ip address show - look at protocol addresses
183       dev IFNAME (default)
184              name of device.
185
186
187       scope SCOPE_VAL
188              only list addresses with this scope.
189
190
191       to PREFIX
192              only list addresses matching this prefix.
193
194
195       label PATTERN
196              only list addresses with labels matching the PATTERN.  PATTERN
197              is a usual shell style pattern.
198
199
200       master DEVICE
201              only list interfaces enslaved to this master device.
202
203
204       vrf NAME
205              only list interfaces enslaved to this vrf.
206
207
208       type TYPE
209              only list interfaces of the given type.
210
211              Note that the type name is not checked against the list of sup‐
212              ported types - instead it is sent as-is to the kernel. Later it
213              is used to filter the returned interface list by comparing it
214              with the relevant attribute in case the kernel didn't filter
215              already. Therefore any string is accepted, but may lead to empty
216              output.
217
218
219       up     only list running interfaces.
220
221
222       dynamic and permanent
223              (IPv6 only) only list addresses installed due to stateless
224              address configuration or only list permanent (not dynamic)
225              addresses.
226
227
228       tentative
229              (IPv6 only) only list addresses which have not yet passed dupli‐
230              cate address detection.
231
232
233       -tentative
234              (IPv6 only) only list addresses which are not in the process of
235              duplicate address detection currently.
236
237
238       deprecated
239              (IPv6 only) only list deprecated addresses.
240
241
242       -deprecated
243              (IPv6 only) only list addresses not being deprecated.
244
245
246       dadfailed
247              (IPv6 only) only list addresses which have failed duplicate
248              address detection.
249
250
251       -dadfailed
252              (IPv6 only) only list addresses which have not failed duplicate
253              address detection.
254
255
256       temporary
257              (IPv6 only) only list temporary addresses.
258
259
260       primary and secondary
261              only list primary (or secondary) addresses.
262
263
264   ip address flush - flush protocol addresses
265       This command flushes the protocol addresses selected by some criteria.
266
267
268       This command has the same arguments as show except that type and master
269       selectors are not supported.  Another difference is that it does not
270       run when no arguments are given.
271
272
273       Warning: This command and other flush commands are unforgiving. They
274       will cruelly purge all the addresses.
275
276
277       With the -statistics option, the command becomes verbose. It prints out
278       the number of deleted addresses and the number of rounds made to flush
279       the address list.  If this option is given twice, ip address flush also
280       dumps all the deleted addresses in the format described in the previous
281       subsection.
282
283

EXAMPLES

285       ip address show
286           Shows IPv4 and IPv6 addresses assigned to all network interfaces.
287           The 'show' subcommand can be omitted.
288
289       ip address show up
290           Same as above except that only addresses assigned to active network
291           interfaces are shown.
292
293       ip address show dev eth0
294           Shows IPv4 and IPv6 addresses assigned to network interface eth0.
295
296       ip address add 2001:0db8:85a3::0370:7334/64 dev eth1
297           Adds an IPv6 address to network interface eth1.
298
299       ip address delete 2001:0db8:85a3::0370:7334/64 dev eth1
300           Delete the IPv6 address added above.
301
302       ip address flush dev eth4 scope global
303           Removes all global IPv4 and IPv6 addresses from device eth4. With‐
304           out 'scope global' it would remove all addresses including IPv6
305           link-local ones.
306
307

SEE ALSO

309       ip(8)
310
311

AUTHOR

313       Original Manpage by Michail Litvak <mci@owl.openwall.com>
314
315
316
317iproute2                          20 Dec 2011                    IP-ADDRESS(8)
Impressum