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">
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
</refentrytitle>
22 <manvolnum>8</manvolnum>
26 <refname>network
</refname>
27 <refpurpose>Network Configuration Control Program
</refpurpose>
32 <command>network
</command>
33 <arg choice=
"opt" rep=
"repeat">OPTIONS
</arg>
34 <arg choice=
"plain">COMMAND
</arg>
39 <title>Description
</title>
42 The
<command>network
</command> command is a tool which configures
43 the network on every IPFire system. It is a fast and versatile
44 way to create, edit and remove configurations, review the status
45 of the network and it is working in the background of the system
46 making sure that things are running smoothly.
51 <title>Options
</title>
54 The following options are understood:
63 <option>--debug
</option>
68 Enables the debugging mode.
69 In this mode, there will be debug output on
70 the console and written to the log.
73 The debugging mode can be permanently enabled by setting
74 <varname>DEBUG=
1</varname>
82 <title>Commands
</title>
85 The following commands are understood:
91 <command>start
<replaceable>ZONE-NAME
</replaceable>...
</command>
96 Starts a zone. That means the network zone will be created
98 If one or more zone names are passed to the command, only
99 these will be started.
106 <command>stop
<replaceable>ZONE-NAME
</replaceable>...
</command>
111 Stops a zone. This is the inverse of the
<command>start
</command>
119 <command>restart
<replaceable>ZONE-NAME
</replaceable>...
</command>
131 <command>status
<replaceable>ZONE-NAME
</replaceable>...
</command>
136 Shows a human-readable overview of the status
144 <command>zone ...
</command>
149 Configure a zone or show status information.
151 <refentrytitle>network-zone
</refentrytitle>
152 <manvolnum>8</manvolnum>
153 </citerefentry> for details.
160 <command>port ...
</command>
165 Configure a port or show status information.
167 <refentrytitle>network-port
</refentrytitle>
168 <manvolnum>8</manvolnum>
169 </citerefentry> for details.
176 <command>device ...
</command>
181 Show status information about network devices.
183 <refentrytitle>network-device
</refentrytitle>
184 <manvolnum>8</manvolnum>
185 </citerefentry> for details.
192 <command>config
<replaceable><varname>KEY=VALUE
</varname></replaceable></command>
197 Shows and alters global configuration parameters.
199 <refentrytitle>network-settings
</refentrytitle>
200 <manvolnum>8</manvolnum>
201 </citerefentry> for details.
208 <command>help [
<replaceable>TYPE
</replaceable>
209 <replaceable>HOOK
</replaceable>|
<replaceable>TYPE
</replaceable> list-hooks]
</command>
214 Calling
<command>network help
</command> without any
215 arguments will show you this man page.
218 <command>network help
<replaceable>TYPE
</replaceable> list-hooks
</command>
219 will print a list of all hooks of
<replaceable>TYPE
</replaceable>.
222 You may optionally pass two arguments, to view the help
224 The type of the hook
<replaceable>TYPE
</replaceable>
225 needs to be passed as well as the name of the hook
226 <replaceable>HOOK
</replaceable>.
233 <command>hostname
<replaceable>HOSTNAME
</replaceable></command>
238 The
<command>hostname
</command> command will return the
239 currently configured hostname of the system.
242 If a new hostname is added to the command line,
243 it will be configured, but will be set after the next
251 <command>dns-server ...
</command>
256 The
<command>dns-server
</command> command will help you
257 configuring the local DNS servers.
259 <refentrytitle>network-dns-server
</refentrytitle>
260 <manvolnum>8</manvolnum>
261 </citerefentry> for details.
268 <command>route ...
</command>
273 The
<command>route
</command> command allows managing static routes.
275 <refentrytitle>network-route
</refentrytitle>
276 <manvolnum>8</manvolnum>
277 </citerefentry> for details.
284 <command>vpn ...
</command>
289 The
<command>vpn
</command> allows managing VPN connections.
291 <refentrytitle>network-vpn
</refentrytitle>
292 <manvolnum>8</manvolnum>
293 </citerefentry> for details.
300 <command>reset
</command>
305 The
<command>reset
</command> command will reset all
306 network configuration. That means all zone configurations
307 will be removed and there will be no networking after the
316 <title>Exit Codes
</title>
319 The
<command>network
</command> command will normally exit with code
0.
320 If there has been a problem and the requested action could not be done,
321 the exit code is unequal to zero.
329 Please report all bugs to the official bugtracker at
330 http://bugs.ipfire.org/.
335 <title>See Also
</title>
339 <refentrytitle>network-settings
</refentrytitle>
340 <manvolnum>8</manvolnum>
343 <refentrytitle>network-device
</refentrytitle>
344 <manvolnum>8</manvolnum>
347 <refentrytitle>network-dns-server
</refentrytitle>
348 <manvolnum>8</manvolnum>
351 <refentrytitle>network-performance-tuning
</refentrytitle>
352 <manvolnum>8</manvolnum>
355 <refentrytitle>network-port
</refentrytitle>
356 <manvolnum>8</manvolnum>
359 <refentrytitle>network-quick-start
</refentrytitle>
360 <manvolnum>8</manvolnum>
363 <refentrytitle>network-zone
</refentrytitle>
364 <manvolnum>8</manvolnum>