projects / people / ms / network.git / blame
| Commit | Line | Data |
|---|---|---|
| de28a630 MT |
1 | .TH network-zone 8 "1 Jun 2012" "@VERSION@" "network man page" |
| 2 | ||
| 3 | .SH NAME | |
| 4 | network-zone \- Network Configuration Control Program | |
| 5 | ||
| 6 | .SH SYNOPSIS | |
| 3871df73 MT |
7 | \fBnetwork [OPTIONS] zone [create|remove] <zone> ...\fR |
| 8 | .P | |
| 9 | \fBnetwork [OPTIONS] zone list-hooks\fR | |
| de28a630 MT |
10 | .P |
| 11 | \fBnetwork [OPTIONS] zone <zone> command ...\fR | |
| 12 | ||
| 13 | .SH DESCRIPTION | |
| 14 | By the zone subcommands, it is very easy to configure network zones. | |
| 15 | .PP | |
| 16 | It is possible to create zones and remove them. Zones may also | |
| 17 | be brought up and down and reconfigured. Their status may be viewed | |
| 18 | as well. | |
| 19 | ||
| 20 | .SH OPTIONS | |
| 21 | The \fBnetwork zone\fR command offers various commands: | |
| 22 | ||
| 23 | \fBcreate <zone> <hook> [options]\fR | |
| 24 | .RS 4 | |
| 25 | A new zone may be created by the \fBcreate\fR command. There are at least two arguments | |
| 26 | required. | |
| 27 | .PP | |
| 28 | \fB<zone>\fR must be valid name for a zone which does not already exist. | |
| 29 | \fB<hook>\fR is a valid zone hook which may require additional options. | |
| 30 | .RE | |
| 31 | .PP | |
| 32 | ||
| 33 | \fBremove <zone>\fR | |
| 34 | .RS 4 | |
| 69ace22b MT |
35 | A zone can be simple removed with this command. |
| 36 | .PP | |
| 37 | There are two possible ways to remove a zone. The case is when the zone is not up. Then, | |
| 38 | it will be removed immediately. When the zone is current up and used, it will tagged | |
| 39 | to be remove later, after it has been brought down. | |
| de28a630 MT |
40 | .RE |
| 41 | .PP | |
| 42 | ||
| 3871df73 MT |
43 | \fBlist-hooks\fR |
| 44 | .RS 4 | |
| 45 | Outputs a list of all possible hooks for the zones. | |
| 46 | .RE | |
| 47 | .PP | |
| 48 | ||
| de28a630 MT |
49 | For all other commands, the name of the zone needs to be passed first: |
| 50 | \fBnetwork zone <zone> command\fR. | |
| 51 | ||
| 52 | \fB<zone> edit [OPTIONS]\fR | |
| 53 | .RS 4 | |
| 54 | The settings of a zone may be edited after it has been created. The options that can | |
| 55 | be passed depend on the hook that is used for the zone. Run \fBnetwork zone <zone> edit --help\fR | |
| 56 | to learn more about that. | |
| 57 | .PP | |
| 58 | It normally is required to restart/reload the zone until the new settings are taken into account. | |
| 59 | .RE | |
| 60 | .PP | |
| 61 | ||
| 62 | \fB<zone> [up|down]\fR | |
| 63 | .RS 4 | |
| 64 | These commands will bring the zone up/down. This is done without control of systemd, therefore | |
| 65 | not intended to be done in a productive environment. However, these commands may be used for | |
| 66 | debugging. | |
| 67 | .RE | |
| 68 | .PP | |
| 69 | ||
| 70 | \fB<zone> status\fR | |
| 71 | .RS 4 | |
| 72 | This will show some detailed information about the state if the specified zone. | |
| 73 | .RE | |
| 74 | .PP | |
| 75 | ||
| 76 | .SH SEE ALSO | |
| 77 | network(8) | |
| 78 | ||
| 79 | .SH AUTHOR | |
| 80 | Michael Tremer (michael.tremer@ipfire.org) |