]>
Commit | Line | Data |
---|---|---|
19331e5f JS |
1 | <?xml version="1.0"?> |
2 | <!DOCTYPE refentry PUBLIC "-//OASIS/DTD DocBook XML V4.2//EN" | |
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | |
4 | ||
5 | <refentry id="network-route-static"> | |
6 | <refentryinfo> | |
7 | <title>network-route-static</title> | |
8 | <productname>network</productname> | |
9 | ||
10 | <authorgroup> | |
11 | <author> | |
12 | <contrib>Developer</contrib> | |
13 | <firstname>Michael</firstname> | |
14 | <surname>Tremer</surname> | |
15 | <email>michael.tremer@ipfire.org</email> | |
16 | </author> | |
17 | </authorgroup> | |
18 | </refentryinfo> | |
19 | ||
20 | <refmeta> | |
21 | <refentrytitle>network-route-static</refentrytitle> | |
22 | <manvolnum>8</manvolnum> | |
23 | </refmeta> | |
24 | ||
25 | <refnamediv> | |
26 | <refname>network-route-static</refname> | |
27 | <refpurpose>Network Configuration Control Program</refpurpose> | |
28 | </refnamediv> | |
29 | ||
30 | <refsynopsisdiv> | |
31 | <cmdsynopsis> | |
32 | <command>network route static <arg choice="plain">COMMAND</arg></command> | |
33 | </cmdsynopsis> | |
34 | </refsynopsisdiv> | |
35 | ||
36 | <refsect1> | |
37 | <title>Description</title> | |
38 | ||
39 | <para> | |
40 | The <command>route static</command> helps to manage static routes. | |
41 | </para> | |
42 | </refsect1> | |
43 | ||
44 | <refsect1> | |
45 | <title>Commands</title> | |
46 | ||
47 | <para> | |
48 | The following commands are understood: | |
49 | </para> | |
50 | ||
51 | <variablelist> | |
52 | <varlistentry> | |
53 | <term> | |
54 | <command>add <replaceable>NETWORK</replaceable> [<option>--gateway=GATEWAY</option>, <option>--unreachable</option>, <option>--prohibit</option>, <option>--blackhole</option>] [<option>--mtu=MTU</option>]</command> | |
55 | </term> | |
56 | ||
57 | <listitem> | |
58 | <para> | |
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 | |
62 | IPv6 or IPv4. | |
63 | </para> | |
64 | <para> | |
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 | |
68 | network prefix is. | |
69 | </para> | |
70 | <para> | |
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. | |
75 | </para> | |
76 | <para> | |
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 | |
80 | the given device. | |
81 | </para> | |
82 | </listitem> | |
83 | </varlistentry> | |
84 | ||
85 | <varlistentry> | |
86 | <term> | |
87 | <command>remove <replaceable>NETWORK</replaceable></command> | |
88 | </term> | |
89 | ||
90 | <listitem> | |
91 | <para> | |
92 | A route can be removed with the command. | |
93 | </para> | |
94 | <para> | |
95 | <replaceable>NETWORK</replaceable> is the network prefix | |
96 | of an existing route. | |
97 | </para> | |
98 | </listitem> | |
99 | </varlistentry> | |
100 | ||
101 | <varlistentry> | |
102 | <term> | |
103 | <command>list [<option>--protocol=ipv6|ipv4</option>]</command> | |
104 | </term> | |
105 | ||
106 | <listitem> | |
107 | <para> | |
108 | Shows a list of all configured routes. | |
109 | </para> | |
110 | <para> | |
111 | Pass the protocol option to filter the output only for the | |
112 | given protocol. | |
113 | </para> | |
114 | </listitem> | |
115 | </varlistentry> | |
116 | </variablelist> | |
117 | </refsect1> | |
118 | ||
119 | <refsect1> | |
120 | <title>Route Types</title> | |
121 | ||
122 | <refsect2> | |
123 | <title>unicast</title> | |
124 | ||
125 | <para> | |
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 | |
130 | a route. | |
131 | </para> | |
132 | </refsect2> | |
133 | ||
134 | <refsect2> | |
135 | <title>unreachable</title> | |
136 | ||
137 | <para> | |
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 | |
141 | address. | |
142 | </para> | |
143 | </refsect2> | |
144 | ||
145 | <refsect2> | |
146 | <title>prohibit</title> | |
147 | ||
148 | <para> | |
149 | This works like an <emphasis>unreachable</emphasis> route, but | |
150 | the returned ICMP message is an ICMP prohibited message. | |
151 | </para> | |
152 | </refsect2> | |
153 | ||
154 | <refsect2> | |
155 | <title>blackhole</title> | |
156 | ||
157 | <para> | |
158 | Packets matching this kind of route are silently discarded. | |
159 | There will be no ICMP message sent to the source and no packet | |
160 | be forwarded. | |
161 | </para> | |
162 | </refsect2> | |
163 | </refsect1> | |
164 | ||
165 | <refsect1> | |
166 | <title>See Also</title> | |
167 | ||
168 | <para> | |
169 | <citerefentry> | |
170 | <refentrytitle>network</refentrytitle> | |
171 | <manvolnum>8</manvolnum> | |
172 | </citerefentry>, | |
173 | <citerefentry> | |
174 | <refentrytitle>network-route</refentrytitle> | |
175 | <manvolnum>8</manvolnum> | |
176 | </citerefentry>, | |
177 | <citerefentry> | |
178 | <refentrytitle>ip-route</refentrytitle> | |
179 | <manvolnum>8</manvolnum> | |
180 | </citerefentry> | |
181 | </para> | |
182 | </refsect1> | |
183 | </refentry> |