man/network-quick-start.txt

   1 = network-quick-start(8)
   2
   3 == NAME
   4 network-quick-start - Quick Start Guide for Networking
   5
   6 == DESCRIPTION
   7 The link:network[8] is a very powerful command that allows you to configure
   8 the entire networking stack.
   9 Unfortunately that makes it quite complicated to use as well.
  10
  11 This guide tries to be a good starting point to set up basic networking with
  12 the 'network' command.
  13
  14 === Adding an Uplink Zone
  15
  16 The first step is to create a new uplink zone with name 'upl0'.
  17
  18 This zone will be of the link:network-zone-bridge[8] type which is the default
  19 for all local networks.
  20
  21 ------------
  22 # network zone new upl0 bridge
  23 ------------
  24
  25 The zone will be created and brought up immediately.
  26
  27 === Attaching Ports
  28
  29 To connect the zone to the physical world outside of our box we will need
  30 to attach ports to the zone. That is done with a single command.
  31 To execute this command, we will need to know which ports are available.
  32 One of the easiest way to find out about that is to use the auto-completion
  33 feature of the shell like this:
  34
  35 ------------
  36 # network zone upl0 port attach [TAB] [TAB]
  37 ------------
  38
  39 That will list all not yet attached ports. The following command will actually
  40 attach the port (which is 'p0' in this example).
  41
  42 -----------
  43 # network zone upl0 port attach p0
  44 -----------
  45
  46 You can as well get a list of all detected devices, zones and ports by running:
  47
  48 -----------
  49 # network device list
  50 -----------
  51
  52 To a zone of the 'bridge' type you may attach more than just one port if you
  53 wish to.
  54
  55 === IP Connectivity
  56
  57 After a zone has been created and ports have been attached, you are now
  58 able to add IP connectivity.
  59
  60 The easiest way to do that is using DHCP which can be enabled by this simple command:
  61
  62 ------------
  63 # network zone upl0 config new dhcp
  64 ------------
  65
  66 === Debugging
  67
  68 You may see the current status of the network by running this command:
  69
  70 ------------
  71 # network status
  72 ------------
  73
  74 The entire network can be restarted by running:
  75
  76 ------------
  77 # network restart
  78 ------------
  79
  80 == AUTHORS
  81 Michael Tremer
  82
  83 == SEE ALSO
  84 link:network[8],
  85 link:network-device[8],
  86 link:network-port[8],
  87 link:network-zone[8]