Home : Computers : Linux : Man Pages : ip-address

ip-address


SYNOPSIS

       ip [ OPTIONS ] address  { COMMAND | help }

       ip address { add | change | replace } IFADDR dev IFNAME [ LIFETIME ] [
               CONFFLAG-LIST ]

       ip address del IFADDR dev IFNAME [ mngtmpaddr ]

       ip address { save | flush } [ dev IFNAME ] [ scope SCOPE-ID ] [ to PRE-
               FIX ] [ FLAG-LIST ] [ label PATTERN ] [ up ]

       ip address [ show [ dev IFNAME ] [ scope SCOPE-ID ] [ to PREFIX ] [
               FLAG-LIST ] [ label PATTERN ] [ master DEVICE ] [ type TYPE ] [
               up ] ]

       ip address { showdump | restore }

       IFADDR := PREFIX | ADDR peer PREFIX [ broadcast ADDR ] [ anycast ADDR ]
               [ label LABEL ] [ scope SCOPE-ID ]

       SCOPE-ID := [ host | link | global | NUMBER ]

       FLAG-LIST := [ FLAG-LIST ] FLAG

       FLAG := [ permanent | dynamic | secondary | primary | [-]tentative |
               [-]deprecated | [-]dadfailed | temporary | CONFFLAG-LIST ]

       CONFFLAG-LIST := [ CONFFLAG-LIST ] CONFFLAG

       CONFFLAG := [ home | mngtmpaddr | nodad | noprefixroute | autojoin ]

       LIFETIME := [ valid_lft LFT ] [ preferred_lft LFT ]

       LFT := [ forever | SECONDS ]

       TYPE := [ bridge | bond | can | dummy | hsr | ifb | ipoib | macvlan |
               macvtap | vcan | veth | vlan | vxlan | ip6tnl | ipip | sit |
               gre | gretap | ip6gre | ip6gretap | vti | nlmon | lowpan | gen-
               eve | macsec ]


DESCRIPTION

       The address is a protocol (IPv4 or IPv6) address attached to a network
       device. Each device must have at least one address to use the corre-
       sponding protocol. It is possible to have several different addresses
       attached to one device. These addresses are not discriminated, so that
       the term alias is not quite appropriate for them and we do not use it
       in this document.

       The ip address command displays addresses and their properties, adds
       new addresses and deletes old ones.

       peer ADDRESS
              the address of the remote endpoint for pointopoint interfaces.
              Again, the ADDRESS may be followed by a slash and a decimal num-
              ber, encoding the network prefix length. If a peer address is
              specified, the local address cannot have a prefix length. The
              network prefix is associated with the peer rather than with the
              local address.

       broadcast ADDRESS
              the broadcast address on the interface.

              It is possible to use the special symbols '+' and '-' instead of
              the broadcast address. In this case, the broadcast address is
              derived by setting/resetting the host bits of the interface pre-
              fix.

       label LABEL
              Each address may be tagged with a label string.  In order to
              preserve compatibility with Linux-2.0 net aliases, this string
              must coincide with the name of the device or must be prefixed
              with the device name followed by colon.

       scope SCOPE_VALUE
              the scope of the area where this address is valid.  The avail-
              able scopes are listed in file /etc/iproute2/rt_scopes.  Prede-
              fined scope values are:

                      global - the address is globally valid.

                      site - (IPv6 only, deprecated) the address is site
                      local, i.e. it is valid inside this site.

                      link - the address is link local, i.e. it is valid only
                      on this device.

                      host - the address is valid only inside this host.

       valid_lft LFT
              the valid lifetime of this address; see section 5.5.4 of RFC
              4862. When it expires, the address is removed by the kernel.
              Defaults to forever.

       preferred_lft LFT
              the preferred lifetime of this address; see section 5.5.4 of RFC
              4862. When it expires, the address is no longer used for new
              outgoing connections. Defaults to forever.

       nodad  (IPv6 only) do not perform Duplicate Address Detection (RFC
              4862) when adding this address.

       noprefixroute
              Do not automatically create a route for the network prefix of
              the added address, and don't search for one to delete when
              removing the address. Changing an address to add this flag will
              remove the automatically added prefix route, changing it to
              remove this flag will create the prefix route automatically.

       autojoin
              Joining multicast groups on Ethernet level via ip maddr command
              does not work if connected to an Ethernet switch that does IGMP
              snooping since the switch would not replicate multicast packets
              on ports that did not have IGMP reports for the multicast
              addresses.

              Linux VXLAN interfaces created via ip link add vxlan have the
              group option that enables them to do the required join.

              Using the autojoin flag when adding a multicast address enables
              similar functionality for Openvswitch VXLAN interfaces as well
              as other tunneling mechanisms that need to receive multicast
              traffic.

   ip address delete - delete protocol address
       Arguments: coincide with the arguments of ip addr add.  The device name
       is a required argument. The rest are optional.  If no arguments are
       given, the first address is deleted.

   ip address show - look at protocol addresses
       dev IFNAME (default)
              name of device.

       scope SCOPE_VAL
              only list addresses with this scope.

       to PREFIX
              only list addresses matching this prefix.

       label PATTERN
              only list addresses with labels matching the PATTERN.  PATTERN
              is a usual shell style pattern.
              output.

       up     only list running interfaces.

       dynamic and permanent
              (IPv6 only) only list addresses installed due to stateless
              address configuration or only list permanent (not dynamic)
              addresses.

       tentative
              (IPv6 only) only list addresses which have not yet passed dupli-
              cate address detection.

       -tentative
              (IPv6 only) only list addresses which are not in the process of
              duplicate address detection currently.

       deprecated
              (IPv6 only) only list deprecated addresses.

       -deprecated
              (IPv6 only) only list addresses not being deprecated.

       dadfailed
              (IPv6 only) only list addresses which have failed duplicate
              address detection.

       -dadfailed
              (IPv6 only) only list addresses which have not failed duplicate
              address detection.

       temporary
              (IPv6 only) only list temporary addresses.

       primary and secondary
              only list primary (or secondary) addresses.

   ip address flush - flush protocol addresses
       This command flushes the protocol addresses selected by some criteria.



EXAMPLES

       ip address show
           Shows IPv4 and IPv6 addresses assigned to all network interfaces.
           The 'show' subcommand can be omitted.

       ip address show up
           Same as above except that only addresses assigned to active network
           interfaces are shown.

       ip address show dev eth0
           Shows IPv4 and IPv6 addresses assigned to network interface eth0.

       ip address add 2001:0db8:85a3::0370:7334/64 dev eth1
           Adds an IPv6 address to network interface eth1.

       ip address delete 2001:0db8:85a3::0370:7334/64 dev eth1
           Delete the IPv6 address added above.

       ip address flush dev eth4 scope global
           Removes all global IPv4 and IPv6 addresses from device eth4. With-
           out 'scope global' it would remove all addresses including IPv6
           link-local ones.


SEE ALSO

       ip(8)


AUTHOR

       Original Manpage by Michail Litvak <mci@owl.openwall.com>


iproute2 20 Dec 2011 IP-ADDRESS(8)



Subscribe to us on YouTube