man/network-port.txt

   1 network-port(8)
   2 ===============
   3
   4 NAME
   5 ----
   6 network-port - Controls Network Ports
   7
   8 SYNOPSIS
   9 --------
  10 [verse]
  11 'network port' new HOOK ...
  12 'network port' destroy PORT
  13 'network port' PORT color
  14 'network port' PORT create
  15 'network port' PORT description edit
  16 'network port' PORT description show
  17 'network port' PORT down
  18 'network port' PORT edit ...
  19 'network port' PORT identify
  20 'network port' PORT remove
  21 'network port' PORT status
  22 'network port' PORT up
  23
  24 DESCRIPTION
  25 -----------
  26 This command creates, deletes, changes and views the configuration
  27 and status of ports.
  28
  29 NOTE: A port is a physical or virtual device that is directly connected
  30 to an other network. It connects those and zones together.
  31 The 'network device' command shows status information of network devices
  32 and other things.
  33
  34 COMMANDS
  35 --------
  36 The following commands are understood:
  37
  38 'new' HOOK ...::
  39         A new port may be created with this command.
  40         HOOK must be a valid hook which may require more options.
  41
  42 'destroy' PORT::
  43         Destroys the port PORT.
  44         The port is removed from any zones it is attached to and shut down.
  45
  46 For all other commands, the name of the port needs to be passed first:
  47
  48 'color'::
  49         This command allows settings a color for a port.
  50         See link:network-color[8] for more information.
  51
  52 'create'::
  53         This will create devices for the existing port PORT.
  54
  55         This does not create a new port. It will just create the (possibly
  56         virtual) interface this port (i.e. create an interface for a WiFi
  57         module or a VLAN device).
  58
  59         The interface is not brought up. Use the 'up' command to do that.
  60
  61 include::include-description.txt[]
  62
  63 'down'::
  64         Shuts down the port.
  65
  66 'edit'::
  67         This command can be used to alter the configuration of a port.
  68         Consult the documentation of the port hook to find out what is supported.
  69
  70 'identify'::
  71         This command will make the port flash for a few seconds
  72         so that you can identify the correct network adapters
  73         in the system.
  74
  75         This is not supported by all network adapters.
  76
  77 'remove'::
  78         This will remove an existing PORT.
  79
  80         This does not destroy the port. It inverses the operation performed
  81         by the 'create' command.
  82
  83 'status'::
  84         This will show some detailed information about the status
  85         of the specified port.
  86
  87 'up'::
  88         Brings up the port. It has to be created first.
  89
  90 AUTHORS
  91 -------
  92 Michael Tremer
  93
  94 SEE ALSO
  95 --------
  96 link:network[8],
  97 link:network-zone[8]