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 " }"
  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"
  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"
  52 followed by protocol family identifier:
  53 .BR "inet" , " inet6"
  54 or
  55 .B link
  56 ,enforce the protocol family to use.  If the 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 \-0
  81 shortcut for
  82 .BR "\-family link" .
  83
  84 .TP
  85 .BR "\-o" , " \-oneline"
  86 output each record on a single line, replacing line feeds
  87 with the
  88 .B '\e\'
  89 character. This is convenient when you want to count records
  90 with
  91 .BR wc (1)
  92  or to
  93 .BR grep (1)
  94 the output.
  95
  96 .TP
  97 .BR "\-r" , " \-resolve"
  98 use the system's name resolver to print DNS names instead of
  99 host addresses.
 100
 101 .SH IP - COMMAND SYNTAX
 102
 103 .SS
 104 .I OBJECT
 105
 106 .TP
 107 .B address
 108 - protocol (IP or IPv6) address on a device.
 109
 110 .TP
 111 .B addrlabel
 112 - label configuration for protocol address selection.
 113
 114 .TP
 115 .B l2tp
 116 - tunnel PPP over IP (L2TP).
 117
 118 .TP
 119 .B link
 120 - network device.
 121
 122 .TP
 123 .B maddress
 124 - multicast address.
 125
 126 .TP
 127 .B monitor
 128 - watch for netlink messages.
 129
 130 .TP
 131 .B mroute
 132 - multicast routing cache entry.
 133
 134 .TP
 135 .B mrule
 136 - rule in multicast routing policy database.
 137
 138 .TP
 139 .B neighbour
 140 - manage ARP or NDISC cache entries.
 141
 142 .TP
 143 .B netns
 144 - manage network namespaces.
 145
 146 .TP
 147 .B ntable
 148 - manage the neighbor cache's operation.
 149
 150 .TP
 151 .B route
 152 - routing table entry.
 153
 154 .TP
 155 .B rule
 156 - rule in routing policy database.
 157
 158 .TP
 159 .B tunnel
 160 - tunnel over IP.
 161
 162 .TP
 163 .B tuntap
 164 - manage TUN/TAP devices.
 165
 166 .TP
 167 .B xfrm
 168 - manage IPSec policies.
 169
 170 .PP
 171 The names of all objects may be written in full or
 172 abbreviated form, f.e.
 173 .B address
 174 is abbreviated as
 175 .B addr
 176 or just
 177 .B a.
 178
 179 .SS
 180 .I COMMAND
 181
 182 Specifies the action to perform on the object.
 183 The set of possible actions depends on the object type.
 184 As a rule, it is possible to
 185 .BR "add" , " delete"
 186 and
 187 .B show
 188 (or
 189 .B list
 190 ) objects, but some objects do not allow all of these operations
 191 or have some additional commands.  The
 192 .B help
 193 command is available for all objects.  It prints
 194 out a list of available commands and argument syntax conventions.
 195 .sp
 196 If no command is given, some default command is assumed.
 197 Usually it is
 198 .B list
 199 or, if the objects of this class cannot be listed,
 200 .BR "help" .
 201
 202 .SH HISTORY
 203 .B ip
 204 was written by Alexey N. Kuznetsov and added in Linux 2.2.
 205 .SH SEE ALSO
 206 .BR ip-address (8),
 207 .BR ip-addrlabel (8),
 208 .BR ip-link (8),
 209 .BR ip-maddress (8),
 210 .BR ip-monitor (8),
 211 .BR ip-mroute (8),
 212 .BR ip-neighbour (8),
 213 .BR ip-netns (8),
 214 .BR ip-ntable (8),
 215 .BR ip-route (8),
 216 .BR ip-rule (8),
 217 .BR ip-tunnel (8),
 218 .BR ip-xfrm (8)
 219 .br
 220 .RB "IP Command reference " ip-cref.ps
 221 .SH REPORTING BUGS
 222 Report bug to the Network Developers mailing list
 223 .B <netdev@vger.kernel.org>
 224 where the development and maintenance is primarily done.
 225 You do not have to be subscribed to the list to send a message there.
 226
 227 .SH AUTHOR
 228 Original Manpage by Michail Litvak <mci@owl.openwall.com>