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