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 .B ip
  16 .RB "[ " -force " ] "
  17 .BI "-batch " filename
  18 .sp
  19
  20 .ti -8
  21 .IR OBJECT " := { "
  22 .BR link " | " addr " | " addrlabel " | " route " | " rule " | " neigh " | "\
  23  ntable " | " tunnel " | " tuntap " | " maddr " | "  mroute " | " mrule " | "\
  24  monitor " | " xfrm " | " netns " | "  l2tp " | "  tcp_metrics " }"
  25 .sp
  26
  27 .ti -8
  28 .IR OPTIONS " := { "
  29 \fB\-V\fR[\fIersion\fR] |
  30 \fB\-s\fR[\fItatistics\fR] |
  31 \fB\-r\fR[\fIesolve\fR] |
  32 \fB\-f\fR[\fIamily\fR] {
  33 .BR inet " | " inet6 " | " ipx " | " dnet " | " link " } | "
  34 \fB\-o\fR[\fIneline\fR] }
  35
  36
  37 .SH OPTIONS
  38
  39 .TP
  40 .BR "\-V" , " -Version"
  41 Print the version of the
  42 .B ip
  43 utility and exit.
  44
  45 .TP
  46 .BR "\-b", " \-batch " <FILENAME>
  47 Read commands from provided file or standard input and invoke them.
  48 First failure will cause termination of ip.
  49
  50 .TP
  51 .BR "\-force"
  52 Don't terminate ip on errors in batch mode.
  53 If there were any errors during execution of the commands, the application return code will be non zero.
  54
  55 .TP
  56 .BR "\-s" , " \-stats" , " \-statistics"
  57 Output more information.  If the option
  58 appears twice or more, the amount of information increases.
  59 As a rule, the information is statistics or some time values.
  60
  61 .TP
  62 .BR "\-d" , " \-details"
  63 Output more detailed information.
  64
  65 .TP
  66 .BR "\-l" , " \-loops " <COUNT>
  67 Specify maximum number of loops the 'ip addr flush' logic
  68 will attempt before giving up.  The default is 10.
  69 Zero (0) means loop until all addresses are removed.
  70
  71 .TP
  72 .BR "\-f" , " \-family " <FAMILY>
  73 Specifies the protocol family to use. The protocol family identifier can be one of
  74 .BR "inet" , " inet6" , " bridge" , " ipx" , " dnet"
  75 or
  76 .BR link .
  77 If this option is not present,
  78 the protocol family is guessed from other arguments.  If the rest
  79 of the command line does not give enough information to guess the
  80 family,
  81 .B ip
  82 falls back to the default one, usually
  83 .B inet
  84 or
  85 .BR "any" .
  86 .B link
  87 is a special family identifier meaning that no networking protocol
  88 is involved.
  89
  90 .TP
  91 .B \-4
  92 shortcut for
  93 .BR "-family inet" .
  94
  95 .TP
  96 .B \-6
  97 shortcut for
  98 .BR "\-family inet6" .
  99
 100 .TP
 101 .B \-B
 102 shortcut for
 103 .BR "\-family bridge" .
 104
 105 .TP
 106 .B \-D
 107 shortcut for
 108 .BR "\-family decnet" .
 109
 110 .TP
 111 .B \-I
 112 shortcut for
 113 .BR "\-family ipx" .
 114
 115 .TP
 116 .B \-0
 117 shortcut for
 118 .BR "\-family link" .
 119
 120 .TP
 121 .BR "\-o" , " \-oneline"
 122 output each record on a single line, replacing line feeds
 123 with the
 124 .B '\e'
 125 character. This is convenient when you want to count records
 126 with
 127 .BR wc (1)
 128 or to
 129 .BR grep (1)
 130 the output.
 131
 132 .TP
 133 .BR "\-r" , " \-resolve"
 134 use the system's name resolver to print DNS names instead of
 135 host addresses.
 136
 137 .SH IP - COMMAND SYNTAX
 138
 139 .SS
 140 .I OBJECT
 141
 142 .TP
 143 .B address
 144 - protocol (IP or IPv6) address on a device.
 145
 146 .TP
 147 .B addrlabel
 148 - label configuration for protocol address selection.
 149
 150 .TP
 151 .B l2tp
 152 - tunnel ethernet over IP (L2TPv3).
 153
 154 .TP
 155 .B link
 156 - network device.
 157
 158 .TP
 159 .B maddress
 160 - multicast address.
 161
 162 .TP
 163 .B monitor
 164 - watch for netlink messages.
 165
 166 .TP
 167 .B mroute
 168 - multicast routing cache entry.
 169
 170 .TP
 171 .B mrule
 172 - rule in multicast routing policy database.
 173
 174 .TP
 175 .B neighbour
 176 - manage ARP or NDISC cache entries.
 177
 178 .TP
 179 .B netns
 180 - manage network namespaces.
 181
 182 .TP
 183 .B ntable
 184 - manage the neighbor cache's operation.
 185
 186 .TP
 187 .B route
 188 - routing table entry.
 189
 190 .TP
 191 .B rule
 192 - rule in routing policy database.
 193
 194 .TP
 195 .B tcp_metrics/tcpmetrics
 196 - manage TCP Metrics
 197
 198 .TP
 199 .B tunnel
 200 - tunnel over IP.
 201
 202 .TP
 203 .B tuntap
 204 - manage TUN/TAP devices.
 205
 206 .TP
 207 .B xfrm
 208 - manage IPSec policies.
 209
 210 .PP
 211 The names of all objects may be written in full or
 212 abbreviated form, for exampe
 213 .B address
 214 can be abbreviated as
 215 .B addr
 216 or just
 217 .B a.
 218
 219 .SS
 220 .I COMMAND
 221
 222 Specifies the action to perform on the object.
 223 The set of possible actions depends on the object type.
 224 As a rule, it is possible to
 225 .BR "add" , " delete"
 226 and
 227 .B show
 228 (or
 229 .B list
 230 ) objects, but some objects do not allow all of these operations
 231 or have some additional commands.  The
 232 .B help
 233 command is available for all objects.  It prints
 234 out a list of available commands and argument syntax conventions.
 235 .sp
 236 If no command is given, some default command is assumed.
 237 Usually it is
 238 .B list
 239 or, if the objects of this class cannot be listed,
 240 .BR "help" .
 241
 242 .SH HISTORY
 243 .B ip
 244 was written by Alexey N. Kuznetsov and added in Linux 2.2.
 245 .SH SEE ALSO
 246 .BR ip-address (8),
 247 .BR ip-addrlabel (8),
 248 .BR ip-l2tp (8),
 249 .BR ip-link (8),
 250 .BR ip-maddress (8),
 251 .BR ip-monitor (8),
 252 .BR ip-mroute (8),
 253 .BR ip-neighbour (8),
 254 .BR ip-netns (8),
 255 .BR ip-ntable (8),
 256 .BR ip-route (8),
 257 .BR ip-rule (8),
 258 .BR ip-tcp_metrics (8),
 259 .BR ip-tunnel (8),
 260 .BR ip-xfrm (8)
 261 .br
 262 .RB "IP Command reference " ip-cref.ps
 263 .SH REPORTING BUGS
 264 Report any bugs to the Network Developers mailing list
 265 .B <netdev@vger.kernel.org>
 266 where the development and maintenance is primarily done.
 267 You do not have to be subscribed to the list to send a message there.
 268
 269 .SH AUTHOR
 270 Original Manpage by Michail Litvak <mci@owl.openwall.com>