2 <!DOCTYPE refentry PUBLIC
"-//OASIS/DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
5 <refentry id=
"network-route">
7 <title>network-route
</title>
8 <productname>network
</productname>
12 <contrib>Developer
</contrib>
13 <firstname>Michael
</firstname>
14 <surname>Tremer
</surname>
15 <email>michael.tremer@ipfire.org
</email>
21 <refentrytitle>network-route
</refentrytitle>
22 <manvolnum>8</manvolnum>
26 <refname>network-route
</refname>
27 <refpurpose>Network Configuration Control Program
</refpurpose>
32 <command>network route
<arg choice=
"plain">COMMAND
</arg></command>
37 <title>Description
</title>
40 The
<command>route
</command> helps to manage static routes.
45 <title>Commands
</title>
48 The following commands are understood:
54 <command>add
<replaceable>NETWORK
</replaceable> [
<option>--gateway=GATEWAY
</option>,
<option>--unreachable
</option>,
<option>--prohibit
</option>,
<option>--blackhole
</option>] [
<option>--mtu=MTU
</option>]
</command>
59 A new route may be added by the
<command>add
</command> command.
60 It is always required to pass a valid network prefix
61 <replaceable>NETWORK
</replaceable>, which can be either
65 For unicast routes, the
<option>--gateway=GATEWAY
</option>
66 option must be passed, where
<varname>GATEWAY
</varname>
67 is a valid IP address of the same protocol type as the
71 Use
<option>--unreachable
</option>,
<option>--prohibit
</option>,
72 <option>--blackhole
</option> can be used to create of that
73 type. See
<emphasis>ROUTE TYPES
</emphasis> below for more
74 information about these options.
77 The optional
<option>--mtu=MTU
</option> parameter defines the
78 MTU along the path to the destination and must be an integer
79 number. This will show you very detailed information about
87 <command>remove
<replaceable>NETWORK
</replaceable></command>
92 A route can be removed with the command.
95 <replaceable>NETWORK
</replaceable> is the network prefix
103 <command>list [
<option>--protocol=ipv6|ipv4
</option>]
</command>
108 Shows a list of all configured routes.
111 Pass the protocol option to filter the output only for the
120 <title>Route Types
</title>
123 <title>unicast
</title>
126 A unicast route is the most common route in routing tables.
127 It is a route to a destination network address, which describes
128 the path to the destination.
129 Use the
<option>--gateway=GATEWAY
</option> option to create such
135 <title>unreachable
</title>
138 When a route is determined and the routing decision process
139 returns a destination with an unreachable route type, an ICMP
140 unreachable message is generated and returned to the source
146 <title>prohibit
</title>
149 This works like an
<emphasis>unreachable
</emphasis> route, but
150 the returned ICMP message is an ICMP prohibited message.
155 <title>blackhole
</title>
158 Packets matching this kind of route are silently discarded.
159 There will be no ICMP message sent to the source and no packet
166 <title>See Also
</title>
170 <refentrytitle>network
</refentrytitle>
171 <manvolnum>8</manvolnum>
174 <refentrytitle>ip-route
</refentrytitle>
175 <manvolnum>8</manvolnum>