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-port">
7 <title>network-port
</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-port
</refentrytitle>
22 <manvolnum>8</manvolnum>
26 <refname>network-port
</refname>
27 <refpurpose>Network Configuration Control Program
</refpurpose>
32 <command>network port
<arg choice=
"plain">[new|destroy]
</arg> <replaceable>PORT
</replaceable> ...
</command>
36 <command>network port
<replaceable>PORT
</replaceable> <arg choice=
"plain">command
</arg> ...
</command>
41 <title>Description
</title>
44 With help of the
<command>port
</command> command, you can create, delete,
45 change and view the configuration and status of ports.
49 A port is a physical or virtual device that is directly connected
50 to an other network. If connects those and zones together.
55 <title>Commands
</title>
58 The following commands are understood:
64 <command>new
<replaceable>HOOK
</replaceable> <arg choice=
"opt" rep=
"repeat">ARGUMENTS
</arg></command>
69 A new port may be created by the
<command>new
</command>
73 <replaceable>HOOK
</replaceable> must be a valid
74 hook which may require more
<replaceable>ARGUMENTS
</replaceable>.
81 <command>destroy
<replaceable>PORT
</replaceable></command>
86 A port can be destroyed with this command.
89 The port is removed from any zones it is attached
97 For all other commands, the name of the port needs to be passed first:
103 <command><replaceable>PORT
</replaceable> create
</command>
108 This will create an existing
<replaceable>PORT
</replaceable>.
111 This does not create a new port. It will just create the (possibly
112 virtual) interface this port (i.e. create an interface for a WiFi
113 module or a VLAN device).
116 The interface is not brought up. Use the
<command>up
</command> command
124 <command><replaceable>PORT
</replaceable> remove
</command>
129 This will remove an existing
<replaceable>PORT
</replaceable>.
132 This does not destroy the port. It inverses the operation performed
133 by the
<command>create
</command> command.
140 <command><replaceable>PORT
</replaceable> [up|down]
</command>
145 These commands will bring the port up or down. It has to be
152 <command><replaceable>PORT
</replaceable> color
</command>
157 This command allows settings a color for a port.
160 <refentrytitle>network-color
</refentrytitle>
161 <manvolnum>8</manvolnum>
163 for more information.
169 <command><replaceable>PORT
</replaceable>description
</command>
174 This command allows you to add a description to a port.
177 <refentrytitle>network-description
</refentrytitle>
178 <manvolnum>8</manvolnum>,
180 for more information.
186 <command><replaceable>PORT
</replaceable> edit
<arg choice=
"opt" rep=
"repeat">ARGUMENTS
</arg></command>
191 The
<command>edit
</command> command can be used to alter
192 the configuration of a port. Consult the documentation of the
193 port hook to find out which
<replaceable>ARGUMENTS
</replaceable>
201 <command><replaceable>PORT
</replaceable> status
</command>
206 This will show some detailed information about the state
207 if the specified port.
214 <command><replaceable>PORT
</replaceable> identify
</command>
219 This command will make the port flash for a few seconds
220 so that you can identify the correct network adapters
224 This is not supported by all network adapters.
232 <title>See Also
</title>
236 <refentrytitle>network
</refentrytitle>
237 <manvolnum>8</manvolnum>,
240 <refentrytitle>network-zone
</refentrytitle>
241 <manvolnum>8</manvolnum>