[people/ms/network.git] / man / network-quick-start.txt

= network-quick-start(8)

== NAME
network-quick-start - Quick Start Guide for Networking

== DESCRIPTION
The link:network[8] is a very powerful command that allows you to configure
the entire networking stack.
Unfortunately that makes it quite complicated to use as well.

This guide tries to be a good starting point to set up basic networking with
the 'network' command.

=== Adding an Uplink Zone

The first step is to create a new uplink zone with name 'upl0'.

This zone will be of the link:network-zone-bridge[8] type which is the default
for all local networks.

------------
# network zone new upl0 bridge
------------

The zone will be created and brought up immediately.

=== Attaching Ports

To connect the zone to the physical world outside of our box we will need
to attach ports to the zone. That is done with a single command.
To execute this command, we will need to know which ports are available.
One of the easiest way to find out about that is to use the auto-completion
feature of the shell like this:

------------
# network zone upl0 port attach [TAB] [TAB]
------------

That will list all not yet attached ports. The following command will actually
attach the port (which is 'p0' in this example).

-----------
# network zone upl0 port attach p0
-----------

You can as well get a list of all detected devices, zones and ports by running:

-----------
# network device list
-----------

To a zone of the 'bridge' type you may attach more than just one port if you
wish to.

=== IP Connectivity

After a zone has been created and ports have been attached, you are now
able to add IP connectivity.

The easiest way to do that is using DHCP which can be enabled by this simple command:

------------
# network zone upl0 config new dhcp
------------

=== Debugging

You may see the current status of the network by running this command:

------------
# network status
------------

The entire network can be restarted by running:

------------
# network restart
------------

== AUTHORS
Michael Tremer

== SEE ALSO
link:network[8],
link:network-device[8],
link:network-port[8],
link:network-zone[8]
Commit	Line	Data
39cfece8	1	= network-quick-start(8)
27b9807e	2
39cfece8	3	== NAME
27b9807e MT	4	network-quick-start - Quick Start Guide for Networking
27b9807e MT	5
39cfece8	6	== DESCRIPTION
27b9807e MT	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
39cfece8	80	== AUTHORS
27b9807e MT	81	Michael Tremer
27b9807e MT	82
39cfece8	83	== SEE ALSO
27b9807e MT	84	link:network[8],
	85	link:network-device[8],
	86	link:network-port[8],
	87	link:network-zone[8]