man/network-port.xml

   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-port">
   6         <refentryinfo>
   7                 <title>network-port</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-port</refentrytitle>
  22                 <manvolnum>8</manvolnum>
  23         </refmeta>
  24
  25         <refnamediv>
  26                 <refname>network-port</refname>
  27                 <refpurpose>Network Configuration Control Program</refpurpose>
  28         </refnamediv>
  29
  30         <refsynopsisdiv>
  31                 <cmdsynopsis>
  32                         <command>network port <arg choice="plain">[new|destroy]</arg> <replaceable>PORT</replaceable> ...</command>
  33                 </cmdsynopsis>
  34
  35                 <cmdsynopsis>
  36                         <command>network port <replaceable>PORT</replaceable> <arg choice="plain">command</arg> ...</command>
  37                 </cmdsynopsis>
  38         </refsynopsisdiv>
  39
  40         <refsect1>
  41                 <title>Description</title>
  42
  43                 <para>
  44                         With help of the <command>port</command> command, you can create, delete,
  45                         change and view the configuration and status of ports.
  46                 </para>
  47
  48                 <para>
  49                         A port is a physical or virtual device that is directly connected
  50                         to an other network. If connects those and zones together.
  51                 </para>
  52         </refsect1>
  53
  54         <refsect1>
  55                 <title>Commands</title>
  56
  57                 <para>
  58                         The following commands are understood:
  59                 </para>
  60
  61                 <variablelist>
  62                         <varlistentry>
  63                                 <term>
  64                                         <command>new <replaceable>HOOK</replaceable> <arg choice="opt" rep="repeat">ARGUMENTS</arg></command>
  65                                 </term>
  66
  67                                 <listitem>
  68                                         <para>
  69                                                 A new port may be created by the <command>new</command>
  70                                                 command.
  71                                         </para>
  72                                         <para>
  73                                                 <replaceable>HOOK</replaceable> must be a valid
  74                                                 hook which may require more <replaceable>ARGUMENTS</replaceable>.
  75                                         </para>
  76                                 </listitem>
  77                         </varlistentry>
  78
  79                         <varlistentry>
  80                                 <term>
  81                                         <command>destroy <replaceable>PORT</replaceable></command>
  82                                 </term>
  83
  84                                 <listitem>
  85                                         <para>
  86                                                 A port can be destroyed with this command.
  87                                         </para>
  88                                         <para>
  89                                                 The port is removed from any zones it is attached
  90                                                 to and shut down.
  91                                         </para>
  92                                 </listitem>
  93                         </varlistentry>
  94                 </variablelist>
  95
  96                 <para>
  97                         For all other commands, the name of the port needs to be passed first:
  98                 </para>
  99
 100                 <variablelist>
 101                         <varlistentry>
 102                                 <term>
 103                                         <command><replaceable>PORT</replaceable> create</command>
 104                                 </term>
 105
 106                                 <listitem>
 107                                         <para>
 108                                                 This will create an existing <replaceable>PORT</replaceable>.
 109                                         </para>
 110                                         <para>
 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).
 114                                         </para>
 115                                         <para>
 116                                                 The interface is not brought up. Use the <command>up</command> command
 117                                                 to do that.
 118                                         </para>
 119                                 </listitem>
 120                         </varlistentry>
 121
 122                         <varlistentry>
 123                                 <term>
 124                                         <command><replaceable>PORT</replaceable> remove</command>
 125                                 </term>
 126
 127                                 <listitem>
 128                                         <para>
 129                                                 This will remove an existing <replaceable>PORT</replaceable>.
 130                                         </para>
 131                                         <para>
 132                                                 This does not destroy the port. It inverses the operation performed
 133                                                 by the <command>create</command> command.
 134                                         </para>
 135                                 </listitem>
 136                         </varlistentry>
 137
 138                         <varlistentry>
 139                                 <term>
 140                                         <command><replaceable>PORT</replaceable> [up|down]</command>
 141                                 </term>
 142
 143                                 <listitem>
 144                                         <para>
 145                                                 These commands will bring the port up or down. It has to be
 146                                                 created first.
 147                                         </para>
 148                                 </listitem>
 149                         </varlistentry>
 150
 151                         <varlistentry>
 152                                 <term>
 153                                         <command><replaceable>PORT</replaceable> edit <arg choice="opt" rep="repeat">ARGUMENTS</arg></command>
 154                                 </term>
 155
 156                                 <listitem>
 157                                         <para>
 158                                                 The <command>edit</command> command can be used to alter
 159                                                 the configuration of a port. Consult the documentation of the
 160                                                 port hook to find out which <replaceable>ARGUMENTS</replaceable>
 161                                                 are supported.
 162                                         </para>
 163                                 </listitem>
 164                         </varlistentry>
 165
 166                         <varlistentry>
 167                                 <term>
 168                                         <command><replaceable>PORT</replaceable> status</command>
 169                                 </term>
 170
 171                                 <listitem>
 172                                         <para>
 173                                                 This will show some detailed information about the state
 174                                                 if the specified port.
 175                                         </para>
 176                                 </listitem>
 177                         </varlistentry>
 178
 179                         <varlistentry>
 180                                 <term>
 181                                         <command><replaceable>PORT</replaceable> identify</command>
 182                                 </term>
 183
 184                                 <listitem>
 185                                         <para>
 186                                                 This command will make the port flash for a few seconds
 187                                                 so that you can identify the correct network adapters
 188                                                 in the system.
 189                                         </para>
 190                                         <para>
 191                                                 This is not supported by all network adapters.
 192                                         </para>
 193                                 </listitem>
 194                         </varlistentry>
 195                 </variablelist>
 196         </refsect1>
 197
 198         <refsect1>
 199                 <title>See Also</title>
 200
 201                 <para>
 202                         <citerefentry>
 203                                 <refentrytitle>network</refentrytitle>
 204                                 <manvolnum>8</manvolnum>,
 205                         </citerefentry>
 206                         <citerefentry>
 207                                 <refentrytitle>network-zone</refentrytitle>
 208                                 <manvolnum>8</manvolnum>
 209                         </citerefentry>
 210                 </para>
 211         </refsect1>
 212 </refentry>