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