88a198891a72a39f6b3237df47e8cfcae1ffe9a0
[people/ms/network.git] / man / network-zone.txt
1 = network-zone(8)
2 Michael Tremer <michael.tremer@ipfire.org>
3
4 == NAME
5 network-zone - Manage network zones
6
7 == SYNOPSIS
8 [verse]
9 'network zone [new|destroy]' ZONE
10 'network zone' ZONE ...
11
12 == DESCRIPTION
13 With help of the 'zone' command, it is very easy to configure network zones.
14
15 It is possible to create zones and remove them. Zones may also be brought up
16 and down and reconfigured. Their status may be viewed as well.
17
18 == COMMANDS
19 The following commands are understood:
20
21 'new ZONE HOOK OPTIONS'::
22         A new zone may be created by the 'create' command.
23         There are at least two arguments required.
24         +
25         ZONE must be valid name for a zone which does not already exist.
26         HOOK is a valid zone hook which may require additional options.
27
28 'destroy ZONE'::
29         A zone can be destroyed with this command.
30         +
31         There are two possible ways to remove a zone. The case is when the zone is
32         not up. Then, it will be removed immediately. When the zone is current up
33         and used, it will tagged to be remove later, after it has been brought down.
34
35 For all other commands, the name of the zone needs to be passed first:
36
37 'edit OPTIONS'::
38         The settings of a zone may be edited after it has been created.
39         The options that can be passed depend on the hook that is used for the zone.
40         Run 'network zone ZONE edit --help' to learn more about that.
41         +
42         It usually is required to restart/reload the zone until the new settings
43         are taken into account.
44
45 '[up|down]'::
46         These commands will bring the zone up/down. This is done without control
47         of systemd, therefore not intended to be done in a productive environment.
48         However, these commands may be used for debugging.
49
50 '[enable|disable]'::
51         These commands will enable or disable the zone. An enabled zone will
52         automatically be started either during the boot process or a hotplug event
53         of an associated port or other device.
54
55 'status'::
56         This will show some detailed information about the state if the specified zone.
57
58 include::include-color.txt[]
59
60 include::include-description.txt[]
61
62 'identify'::
63         This command will make all ports of the zone flash for a few seconds so
64         that you can identify the correct network adapters in the system.
65
66 'rename' NAME::
67         Renames the zone to NAME.
68         +
69         The command will shut down the zone if it is up and start it again with
70         the new name. If the zone is not up it won't be started.
71
72 == SEE ALSO
73 link:network[8]