man/man8/ip.8

   1 .TH IP 8 "20 Dec 2011" "iproute2" "Linux"
   2 .SH NAME
   3 ip \- show / manipulate routing, devices, policy routing and tunnels
   4 .SH SYNOPSIS
   5
   6 .ad l
   7 .in +8
   8 .ti -8
   9 .B ip
  10 .RI "[ " OPTIONS " ] " OBJECT " { " COMMAND " | "
  11 .BR help " }"
  12 .sp
  13
  14 .ti -8
  15 .IR OBJECT " := { "
  16 .BR link " | " addr " | " addrlabel " | " route " | " rule " | " neigh " | "\
  17  tunnel " | " maddr " | "  mroute " }"
  18 .sp
  19
  20 .ti -8
  21 .IR OPTIONS " := { "
  22 \fB\-V\fR[\fIersion\fR] |
  23 \fB\-s\fR[\fItatistics\fR] |
  24 \fB\-r\fR[\fIesolve\fR] |
  25 \fB\-f\fR[\fIamily\fR] {
  26 .BR inet " | " inet6 " | " ipx " | " dnet " | " link " } | "
  27 \fB\-o\fR[\fIneline\fR] }
  28
  29 .SH OPTIONS
  30
  31 .TP
  32 .BR "\-V" , " -Version"
  33 print the version of the
  34 .B ip
  35 utility and exit.
  36
  37 .TP
  38 .BR "\-s" , " \-stats", " \-statistics"
  39 output more information.  If the option
  40 appears twice or more, the amount of information increases.
  41 As a rule, the information is statistics or some time values.
  42
  43 .TP
  44 .BR "\-l" , " \-loops"
  45 Specify maximum number of loops the 'ip addr flush' logic
  46 will attempt before giving up.  The default is 10.
  47 Zero (0) means loop until all addresses are removed.
  48
  49 .TP
  50 .BR "\-f" , " \-family"
  51 followed by protocol family identifier:
  52 .BR "inet" , " inet6"
  53 or
  54 .B link
  55 ,enforce the protocol family to use.  If the option is not present,
  56 the protocol family is guessed from other arguments.  If the rest
  57 of the command line does not give enough information to guess the
  58 family,
  59 .B ip
  60 falls back to the default one, usually
  61 .B inet
  62 or
  63 .BR "any" .
  64 .B link
  65 is a special family identifier meaning that no networking protocol
  66 is involved.
  67
  68 .TP
  69 .B \-4
  70 shortcut for
  71 .BR "-family inet" .
  72
  73 .TP
  74 .B \-6
  75 shortcut for
  76 .BR "\-family inet6" .
  77
  78 .TP
  79 .B \-0
  80 shortcut for
  81 .BR "\-family link" .
  82
  83 .TP
  84 .BR "\-o" , " \-oneline"
  85 output each record on a single line, replacing line feeds
  86 with the
  87 .B '\e\'
  88 character. This is convenient when you want to count records
  89 with
  90 .BR wc (1)
  91  or to
  92 .BR grep (1)
  93 the output.
  94
  95 .TP
  96 .BR "\-r" , " \-resolve"
  97 use the system's name resolver to print DNS names instead of
  98 host addresses.
  99
 100 .SH IP - COMMAND SYNTAX
 101
 102 .SS
 103 .I OBJECT
 104
 105 .TP
 106 .B link
 107 - network device.
 108
 109 .TP
 110 .B address
 111 - protocol (IP or IPv6) address on a device.
 112
 113 .TP
 114 .B addrlabel
 115 - label configuration for protocol address selection.
 116
 117 .TP
 118 .B neighbour
 119 - ARP or NDISC cache entry.
 120
 121 .TP
 122 .B route
 123 - routing table entry.
 124
 125 .TP
 126 .B rule
 127 - rule in routing policy database.
 128
 129 .TP
 130 .B maddress
 131 - multicast address.
 132
 133 .TP
 134 .B mroute
 135 - multicast routing cache entry.
 136
 137 .TP
 138 .B tunnel
 139 - tunnel over IP.
 140
 141 .PP
 142 The names of all objects may be written in full or
 143 abbreviated form, f.e.
 144 .B address
 145 is abbreviated as
 146 .B addr
 147 or just
 148 .B a.
 149
 150 .SS
 151 .I COMMAND
 152
 153 Specifies the action to perform on the object.
 154 The set of possible actions depends on the object type.
 155 As a rule, it is possible to
 156 .BR "add" , " delete"
 157 and
 158 .B show
 159 (or
 160 .B list
 161 ) objects, but some objects do not allow all of these operations
 162 or have some additional commands.  The
 163 .B help
 164 command is available for all objects.  It prints
 165 out a list of available commands and argument syntax conventions.
 166 .sp
 167 If no command is given, some default command is assumed.
 168 Usually it is
 169 .B list
 170 or, if the objects of this class cannot be listed,
 171 .BR "help" .
 172
 173 .SH HISTORY
 174 .B ip
 175 was written by Alexey N. Kuznetsov and added in Linux 2.2.
 176 .SH SEE ALSO
 177 .BR ip-address (8),
 178 .BR ip-addrlabel (8),
 179 .BR ip-link (8),
 180 .BR ip-maddress (8),
 181 .BR ip-monitor (8),
 182 .BR ip-mroute (8),
 183 .BR ip-neighbour (8),
 184 .BR ip-ntable (8),
 185 .BR ip-route (8),
 186 .BR ip-rule (8),
 187 .BR ip-tunnel (8),
 188 .BR ip-xfrm (8)
 189 .br
 190 .RB "IP Command reference " ip-cref.ps
 191 .SH REPORTING BUGS
 192 Report bug to the Network Developers mailing list
 193 .B <netdev@vger.kernel.org>
 194 where the development and maintenance is primarily done.
 195 You do not have to be subscribed to the list to send a message there.
 196
 197 .SH AUTHOR
 198 Original Manpage by Michail Litvak <mci@owl.openwall.com>