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