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