[a088964] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[b06ca36] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[a088964] | 4 | <!ENTITY % general-entities SYSTEM "../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 | ]>
|
---|
[bdea25ce] | 7 |
|
---|
[81fd230] | 8 | <sect1 id="ch-system-iproute2" role="wrap">
|
---|
[bdea25ce] | 9 | <?dbhtml filename="iproute2.html"?>
|
---|
| 10 |
|
---|
[f0d59f2] | 11 | <title>IPRoute2-&iproute2-version;</title>
|
---|
[bdea25ce] | 12 |
|
---|
[a088964] | 13 | <indexterm zone="ch-system-iproute2">
|
---|
[89ed081] | 14 | <primary sortas="a-IPRoute2">IPRoute2</primary>
|
---|
[a088964] | 15 | </indexterm>
|
---|
[bdea25ce] | 16 |
|
---|
[a088964] | 17 | <sect2 role="package">
|
---|
| 18 | <title/>
|
---|
[bdea25ce] | 19 |
|
---|
| 20 | <para>The IPRoute2 package contains programs for basic and advanced IPV4-based
|
---|
| 21 | networking.</para>
|
---|
| 22 |
|
---|
[a088964] | 23 | <segmentedlist>
|
---|
| 24 | <segtitle>&buildtime;</segtitle>
|
---|
| 25 | <segtitle>&diskspace;</segtitle>
|
---|
[bdea25ce] | 26 |
|
---|
[a088964] | 27 | <seglistitem>
|
---|
[e4a5635] | 28 | <seg>&iproute2-ch6-sbu;</seg>
|
---|
| 29 | <seg>&iproute2-ch6-du;</seg>
|
---|
[a088964] | 30 | </seglistitem>
|
---|
| 31 | </segmentedlist>
|
---|
[bdea25ce] | 32 |
|
---|
[a088964] | 33 | </sect2>
|
---|
[bdea25ce] | 34 |
|
---|
[a088964] | 35 | <sect2 role="installation">
|
---|
[f0d59f2] | 36 | <title>Installation of IPRoute2</title>
|
---|
[a088964] | 37 |
|
---|
[e3ebd9fb] | 38 | <para>The installation of two manual pages is broken and results in
|
---|
| 39 | dangling symlinks. Fix this with the following command:</para>
|
---|
| 40 |
|
---|
| 41 | <screen><userinput>sed -i -e '/tc-bfifo.8/d' -e '/tc-pfifo.8/s/pbfifo/bfifo/' Makefile</userinput></screen>
|
---|
| 42 |
|
---|
[a088964] | 43 | <para>Compile the package:</para>
|
---|
| 44 |
|
---|
[bdea25ce] | 45 | <screen><userinput>make SBINDIR=/sbin</userinput></screen>
|
---|
[81fd230] | 46 |
|
---|
| 47 | <variablelist>
|
---|
[bdea25ce] | 48 | <title>The meaning of the make option:</title>
|
---|
| 49 |
|
---|
| 50 | <varlistentry>
|
---|
| 51 | <term><parameter>SBINDIR=/sbin</parameter></term>
|
---|
| 52 | <listitem>
|
---|
| 53 | <para>This ensures that the IPRoute2 binaries will install into
|
---|
| 54 | <filename class="directory">/sbin</filename>. This is the correct
|
---|
| 55 | location according to the FHS, because some of the IPRoute2 binaries
|
---|
| 56 | are used by the LFS-Bootscripts package.</para>
|
---|
| 57 | </listitem>
|
---|
| 58 | </varlistentry>
|
---|
| 59 |
|
---|
[81fd230] | 60 | </variablelist>
|
---|
| 61 |
|
---|
[0be3d41] | 62 | <para>This package does not come with a test suite.</para>
|
---|
| 63 |
|
---|
[81fd230] | 64 | <para>Install the package:</para>
|
---|
| 65 |
|
---|
[bdea25ce] | 66 | <screen><userinput>make SBINDIR=/sbin install</userinput></screen>
|
---|
| 67 |
|
---|
| 68 | <para>The <command>arpd</command> binary links against the Berkeley DB
|
---|
| 69 | libraries that reside in <filename class="directory">/usr</filename> and
|
---|
| 70 | uses a database in <filename>/var/lib/arpd/arpd.db</filename>. Thus,
|
---|
| 71 | according to the FHS, it must be in <filename
|
---|
| 72 | class="directory">/usr/sbin</filename>. Move it there:</para>
|
---|
[fa21b3d] | 73 |
|
---|
| 74 | <screen><userinput>mv -v /sbin/arpd /usr/sbin</userinput></screen>
|
---|
[bdea25ce] | 75 |
|
---|
[a088964] | 76 | </sect2>
|
---|
| 77 |
|
---|
| 78 | <sect2 id="contents-iproute2" role="content">
|
---|
[f0d59f2] | 79 | <title>Contents of IPRoute2</title>
|
---|
[bdea25ce] | 80 |
|
---|
[81fd230] | 81 | <segmentedlist>
|
---|
| 82 | <segtitle>Installed programs</segtitle>
|
---|
[bdea25ce] | 83 |
|
---|
[81fd230] | 84 | <seglistitem>
|
---|
[2791a8e] | 85 | <seg>arpd, ctstat (link to lnstat), genl, ifcfg, ifstat, ip, lnstat,
|
---|
| 86 | nstat, routef, routel, rtacct, rtmon, rtpr, rtstat (link to lnstat), ss,
|
---|
[bdea25ce] | 87 | and tc.</seg>
|
---|
[81fd230] | 88 | </seglistitem>
|
---|
| 89 | </segmentedlist>
|
---|
| 90 |
|
---|
[bdea25ce] | 91 | <variablelist>
|
---|
| 92 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 93 | <?dbfo list-presentation="list"?>
|
---|
| 94 | <?dbhtml list-presentation="table"?>
|
---|
| 95 |
|
---|
[fa21b3d] | 96 | <varlistentry id="arpd">
|
---|
[bdea25ce] | 97 | <term><command>arpd</command></term>
|
---|
[fa21b3d] | 98 | <listitem>
|
---|
[bdea25ce] | 99 | <para>Userspace ARP daemon, useful in really large networks, where the
|
---|
| 100 | kernelspace ARP implementation is insufficient, or when setting up a
|
---|
| 101 | honeypot</para>
|
---|
[fa21b3d] | 102 | <indexterm zone="ch-system-iproute2 arpd">
|
---|
| 103 | <primary sortas="b-arpd">arpd</primary>
|
---|
| 104 | </indexterm>
|
---|
| 105 | </listitem>
|
---|
| 106 | </varlistentry>
|
---|
| 107 |
|
---|
[46a500e] | 108 | <varlistentry id="ctstat">
|
---|
[bdea25ce] | 109 | <term><command>ctstat</command></term>
|
---|
[46a500e] | 110 | <listitem>
|
---|
[89ed081] | 111 | <para>Connection status utility</para>
|
---|
[46a500e] | 112 | <indexterm zone="ch-system-iproute2 ctstat">
|
---|
[005dc3f] | 113 | <primary sortas="b-ctstat">ctstat</primary>
|
---|
[46a500e] | 114 | </indexterm>
|
---|
| 115 | </listitem>
|
---|
| 116 | </varlistentry>
|
---|
| 117 |
|
---|
[2791a8e] | 118 | <varlistentry id="genl">
|
---|
| 119 | <term><command>genl</command></term>
|
---|
| 120 | <listitem>
|
---|
| 121 | <para></para>
|
---|
| 122 | <indexterm zone="ch-system-iproute2 genl">
|
---|
| 123 | <primary sortas="b-genl">genl</primary>
|
---|
| 124 | </indexterm>
|
---|
| 125 | </listitem>
|
---|
| 126 | </varlistentry>
|
---|
| 127 |
|
---|
[46a500e] | 128 | <varlistentry id="ifcfg">
|
---|
[bdea25ce] | 129 | <term><command>ifcfg</command></term>
|
---|
[46a500e] | 130 | <listitem>
|
---|
[89ed081] | 131 | <para>A shell script wrapper for the <command>ip</command> command</para>
|
---|
[46a500e] | 132 | <indexterm zone="ch-system-iproute2 ifcfg">
|
---|
| 133 | <primary sortas="b-ifcfg">ifcfg</primary>
|
---|
| 134 | </indexterm>
|
---|
| 135 | </listitem>
|
---|
| 136 | </varlistentry>
|
---|
[81fd230] | 137 |
|
---|
| 138 | <varlistentry id="ifstat">
|
---|
[bdea25ce] | 139 | <term><command>ifstat</command></term>
|
---|
[81fd230] | 140 | <listitem>
|
---|
[bdea25ce] | 141 | <para>Shows the interface statistics, including the amount of
|
---|
| 142 | transmitted and received packets by interface</para>
|
---|
[81fd230] | 143 | <indexterm zone="ch-system-iproute2 ifstat">
|
---|
| 144 | <primary sortas="b-ifstat">ifstat</primary>
|
---|
| 145 | </indexterm>
|
---|
| 146 | </listitem>
|
---|
| 147 | </varlistentry>
|
---|
| 148 |
|
---|
| 149 | <varlistentry id="ip">
|
---|
[bdea25ce] | 150 | <term><command>ip</command></term>
|
---|
[81fd230] | 151 | <listitem>
|
---|
| 152 | <para>The main executable. It has several different functions:</para>
|
---|
| 153 |
|
---|
[0090db5] | 154 | <para><command>ip link <replaceable><device></replaceable></command>
|
---|
[bdea25ce] | 155 | allows users to look at the state of devices and to make changes</para>
|
---|
[81fd230] | 156 |
|
---|
| 157 | <para><command>ip addr</command> allows users to look at addresses and
|
---|
[bdea25ce] | 158 | their properties, add new addresses, and delete old ones</para>
|
---|
[81fd230] | 159 |
|
---|
[bdea25ce] | 160 | <para><command>ip neighbor</command> allows users to look at neighbor
|
---|
| 161 | bindings and their properties, add new neighbor entries, and delete
|
---|
| 162 | old ones</para>
|
---|
[81fd230] | 163 |
|
---|
| 164 | <para><command>ip rule</command> allows users to look at the routing
|
---|
[bdea25ce] | 165 | policies and change them</para>
|
---|
[81fd230] | 166 |
|
---|
| 167 | <para><command>ip route</command> allows users to look at the routing
|
---|
[bdea25ce] | 168 | table and change routing table rules</para>
|
---|
[81fd230] | 169 |
|
---|
| 170 | <para><command>ip tunnel</command> allows users to look at the IP
|
---|
[bdea25ce] | 171 | tunnels and their properties, and change them</para>
|
---|
[81fd230] | 172 |
|
---|
| 173 | <para><command>ip maddr</command> allows users to look at the multicast
|
---|
[bdea25ce] | 174 | addresses and their properties, and change them</para>
|
---|
[81fd230] | 175 |
|
---|
| 176 | <para><command>ip mroute</command> allows users to set, change, or
|
---|
[bdea25ce] | 177 | delete the multicast routing</para>
|
---|
[81fd230] | 178 |
|
---|
[bdea25ce] | 179 | <para><command>ip monitor</command> allows users to continously monitor
|
---|
| 180 | the state of devices, addresses and routes</para>
|
---|
[81fd230] | 181 | <indexterm zone="ch-system-iproute2 ip">
|
---|
| 182 | <primary sortas="b-ip">ip</primary>
|
---|
| 183 | </indexterm>
|
---|
| 184 | </listitem>
|
---|
| 185 | </varlistentry>
|
---|
| 186 |
|
---|
[46a500e] | 187 | <varlistentry id="lnstat">
|
---|
[bdea25ce] | 188 | <term><command>lnstat</command></term>
|
---|
[46a500e] | 189 | <listitem>
|
---|
| 190 | <para>Provides Linux network statistics. It is a generalized and more
|
---|
[bdea25ce] | 191 | feature-complete replacement for the old <command>rtstat</command>
|
---|
| 192 | program</para>
|
---|
[46a500e] | 193 | <indexterm zone="ch-system-iproute2 lnstat">
|
---|
[005dc3f] | 194 | <primary sortas="b-lnstat">lnstat</primary>
|
---|
[46a500e] | 195 | </indexterm>
|
---|
| 196 | </listitem>
|
---|
| 197 | </varlistentry>
|
---|
| 198 |
|
---|
[81fd230] | 199 | <varlistentry id="nstat">
|
---|
[bdea25ce] | 200 | <term><command>nstat</command></term>
|
---|
[81fd230] | 201 | <listitem>
|
---|
[89ed081] | 202 | <para>Shows network statistics</para>
|
---|
[81fd230] | 203 | <indexterm zone="ch-system-iproute2 nstat">
|
---|
| 204 | <primary sortas="b-nstat">nstat</primary>
|
---|
| 205 | </indexterm>
|
---|
| 206 | </listitem>
|
---|
| 207 | </varlistentry>
|
---|
| 208 |
|
---|
| 209 | <varlistentry id="routef">
|
---|
[bdea25ce] | 210 | <term><command>routef</command></term>
|
---|
[81fd230] | 211 | <listitem>
|
---|
[bdea25ce] | 212 | <para>A component of <command>ip route</command>. This is for flushing
|
---|
| 213 | the routing tables</para>
|
---|
[81fd230] | 214 | <indexterm zone="ch-system-iproute2 routef">
|
---|
| 215 | <primary sortas="b-routef">routef</primary>
|
---|
| 216 | </indexterm>
|
---|
| 217 | </listitem>
|
---|
| 218 | </varlistentry>
|
---|
| 219 |
|
---|
| 220 | <varlistentry id="routel">
|
---|
[bdea25ce] | 221 | <term><command>routel</command></term>
|
---|
[81fd230] | 222 | <listitem>
|
---|
[bdea25ce] | 223 | <para>A component of <command>ip route</command>. This is for listing
|
---|
| 224 | the routing tables</para>
|
---|
[81fd230] | 225 | <indexterm zone="ch-system-iproute2 routel">
|
---|
| 226 | <primary sortas="b-routel">routel</primary>
|
---|
| 227 | </indexterm>
|
---|
| 228 | </listitem>
|
---|
| 229 | </varlistentry>
|
---|
| 230 |
|
---|
[46a500e] | 231 | <varlistentry id="rtacct">
|
---|
[bdea25ce] | 232 | <term><command>rtacct</command></term>
|
---|
[46a500e] | 233 | <listitem>
|
---|
[bdea25ce] | 234 | <para>Displays the contents of
|
---|
| 235 | <filename>/proc/net/rt_acct</filename></para>
|
---|
[46a500e] | 236 | <indexterm zone="ch-system-iproute2 rtacct">
|
---|
| 237 | <primary sortas="b-rtacct">rtacct</primary>
|
---|
| 238 | </indexterm>
|
---|
| 239 | </listitem>
|
---|
| 240 | </varlistentry>
|
---|
| 241 |
|
---|
[81fd230] | 242 | <varlistentry id="rtmon">
|
---|
[bdea25ce] | 243 | <term><command>rtmon</command></term>
|
---|
[81fd230] | 244 | <listitem>
|
---|
[89ed081] | 245 | <para>Route monitoring utility</para>
|
---|
[81fd230] | 246 | <indexterm zone="ch-system-iproute2 rtmon">
|
---|
| 247 | <primary sortas="b-rtmon">rtmon</primary>
|
---|
| 248 | </indexterm>
|
---|
| 249 | </listitem>
|
---|
| 250 | </varlistentry>
|
---|
| 251 |
|
---|
[46a500e] | 252 | <varlistentry id="rtpr">
|
---|
[bdea25ce] | 253 | <term><command>rtpr</command></term>
|
---|
[46a500e] | 254 | <listitem>
|
---|
| 255 | <para>Converts the output of <command>ip -o</command> back into a
|
---|
[bdea25ce] | 256 | readable form</para>
|
---|
[46a500e] | 257 | <indexterm zone="ch-system-iproute2 rtpr">
|
---|
| 258 | <primary sortas="b-rtpr">rtpr</primary>
|
---|
| 259 | </indexterm>
|
---|
| 260 | </listitem>
|
---|
| 261 | </varlistentry>
|
---|
| 262 |
|
---|
[81fd230] | 263 | <varlistentry id="rtstat">
|
---|
[bdea25ce] | 264 | <term><command>rtstat</command></term>
|
---|
[81fd230] | 265 | <listitem>
|
---|
[89ed081] | 266 | <para>Route status utility</para>
|
---|
[81fd230] | 267 | <indexterm zone="ch-system-iproute2 rtstat">
|
---|
| 268 | <primary sortas="b-rtstat">rtstat</primary>
|
---|
| 269 | </indexterm>
|
---|
| 270 | </listitem>
|
---|
| 271 | </varlistentry>
|
---|
| 272 |
|
---|
| 273 | <varlistentry id="ss">
|
---|
[bdea25ce] | 274 | <term><command>ss</command></term>
|
---|
[81fd230] | 275 | <listitem>
|
---|
[bdea25ce] | 276 | <para>Similar to the <command>netstat</command> command; shows active
|
---|
| 277 | connections</para>
|
---|
[81fd230] | 278 | <indexterm zone="ch-system-iproute2 ss">
|
---|
| 279 | <primary sortas="b-ss">ss</primary>
|
---|
| 280 | </indexterm>
|
---|
| 281 | </listitem>
|
---|
| 282 | </varlistentry>
|
---|
| 283 |
|
---|
| 284 | <varlistentry id="tc">
|
---|
[bdea25ce] | 285 | <term><command>tc</command></term>
|
---|
[81fd230] | 286 | <listitem>
|
---|
[bdea25ce] | 287 | <para>Traffic Controlling Executable; this is for Quality Of Service
|
---|
| 288 | (QOS) and Class Of Service (COS) implementations</para>
|
---|
[81fd230] | 289 |
|
---|
| 290 | <para><command>tc qdisc</command> allows users to setup the queueing
|
---|
[bdea25ce] | 291 | discipline</para>
|
---|
[81fd230] | 292 |
|
---|
[bdea25ce] | 293 | <para><command>tc class</command> allows users to setup classes based
|
---|
| 294 | on the queuing discipline scheduling</para>
|
---|
[81fd230] | 295 |
|
---|
| 296 | <para><command>tc estimator</command> allows users to estimate the
|
---|
[bdea25ce] | 297 | network flow into a network</para>
|
---|
[81fd230] | 298 |
|
---|
| 299 | <para><command>tc filter</command> allows users to setup the QOS/COS
|
---|
[bdea25ce] | 300 | packet filtering</para>
|
---|
[81fd230] | 301 |
|
---|
| 302 | <para><command>tc policy</command> allows users to setup the QOS/COS
|
---|
[bdea25ce] | 303 | policies</para>
|
---|
[81fd230] | 304 | <indexterm zone="ch-system-iproute2 ss">
|
---|
| 305 | <primary sortas="b-tc">tc</primary>
|
---|
| 306 | </indexterm>
|
---|
| 307 | </listitem>
|
---|
| 308 | </varlistentry>
|
---|
[bdea25ce] | 309 |
|
---|
[81fd230] | 310 | </variablelist>
|
---|
[bdea25ce] | 311 |
|
---|
[a088964] | 312 | </sect2>
|
---|
[81fd230] | 313 |
|
---|
[bdea25ce] | 314 | </sect1>
|
---|