ip Command Syntax, Objects, Commands, Environment, Exit Status, Examples, and References

This flag adds indentation for readability. -echo Request the kernel to send the applied configuration back. IP ‐ COMMAND SYNTAX OBJECT address ‐ protocol (IP or IPv6) address on a device. addrlabel ‐ label configuration for protocol address selection. ioam ‐ manage IOAM namespaces and IOAM schemas. l2tp ‐ tunnel ethernet over IP (L2TPv3). link ‐ network device. maddress ‐ multicast address. monitor ‐ watch for netlink messages. mptcp ‐ manage MPTCP path manager. mroute ‐ multicast routing cache entry. mrule ‐ rule in multicast routing policy database. neighbour ‐ manage ARP or NDISC cache entries. netns ‐ manage network namespaces. ntable ‐ manage the neighbor cache’s operation. route ‐ routing table entry. rule ‐ rule in routing policy database. stats ‐ manage and show interface statistics. tcp_metrics/tcpmetrics ‐ manage TCP Metrics token ‐ manage tokenized interface identifiers. tunnel ‐ tunnel over IP. tuntap ‐ manage TUN/TAP devices. vrf ‐ manage virtual routing and forwarding devices. xfrm ‐ manage IPSec policies. The names of all objects may be written in full or abbreviated form, for example address can be abbreviated as addr or just a. COMMAND Specifies the action to perform on the object. The set of possible actions depends on the object type. As a rule, it is possible to add, delete and show (or list ) objects, but some objects do not allow all of these operations or have some additional commands. The help command is available for all objects. It prints out a list of available commands and argument syntax conventions. If no command is given, some default command is assumed. Usually it is list or, if the objects of this class cannot be listed, help. ENVIRONMENT COLORFGBG If set, it’s value is used for detection whether background is dark or light and use contrast colors for it. COLORFGBG environment variable usually contains either two or three values separated by semicolons; we want the last value in either case. If this value is 0‐6 or 8, chose colors suitable for dark background: COLORFGBG=";0" ip ‐c a EXIT STATUS Exit status is 0 if command was successful, and 1 if there is a syntax error. If an error was reported by the kernel exit status is 2. EXAMPLES ip addr Shows addresses assigned to all network interfaces. ip neigh Shows the current neighbour table in kernel. ip link set x up Bring up interface x. ip link set x down Bring down interface x. ip route Show table routes. HISTORY ip was written by Alexey N. Kuznetsov and added in Linux 2.2. SEE ALSO ip‐address(8), ip‐addrlabel(8), ip‐ioam(8), ip‐l2tp(8), ip‐link(8), ip‐maddress(8), ip‐monitor(8), ip‐mptcp(8), ip‐mroute(8), ip‐neighbour(8), ip‐netns(8), ip‐ntable(8), ip‐route(8), ip‐rule(8), ip‐stats(8) ip‐ tcp_metrics(8), ip‐token(8), ip‐tunnel(8), ip‐vrf(8), ip‐xfrm(8) IP Command reference ip‐cref.ps REPORTING BUGS Report any bugs to the Network Developers mailing list <netdev@vger.kernel.org> where the development and maintenance is primarily done. You do not have to be subscribed to the list to send a message there. AUTHOR Original Manpage by Michail Litvak <mci@owl.openwall.com> iproute2 20 Dec 2011 IP(8)

This section details the syntax of the `ip` command, including object types like 'address', 'link', 'route', and 'neighbour', and actions that can be performed on them. It covers the COLORFGBG environment variable, exit status codes, example commands, historical context, related manual pages, bug reporting, and author information.