]>
Commit | Line | Data |
---|---|---|
a2a6f759 MT |
1 | <?xml version="1.0"?> |
2 | <!DOCTYPE refentry PUBLIC "-//OASIS/DTD DocBook XML V4.2//EN" | |
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | |
4 | ||
5 | <refentry id="network-zone"> | |
6 | <refentryinfo> | |
7 | <title>network-zone</title> | |
8 | <productname>network</productname> | |
9 | ||
10 | <authorgroup> | |
11 | <author> | |
12 | <contrib>Developer</contrib> | |
13 | <firstname>Michael</firstname> | |
14 | <surname>Tremer</surname> | |
15 | <email>michael.tremer@ipfire.org</email> | |
16 | </author> | |
17 | </authorgroup> | |
18 | </refentryinfo> | |
19 | ||
20 | <refmeta> | |
21 | <refentrytitle>network-zone</refentrytitle> | |
22 | <manvolnum>8</manvolnum> | |
23 | </refmeta> | |
24 | ||
25 | <refnamediv> | |
26 | <refname>network-zone</refname> | |
27 | <refpurpose>Network Configuration Control Program</refpurpose> | |
28 | </refnamediv> | |
29 | ||
30 | <refsynopsisdiv> | |
31 | <cmdsynopsis> | |
cf0fc8ab | 32 | <command>network zone <arg choice="plain">[new|destroy]</arg> <replaceable>ZONE</replaceable> ...</command> |
a2a6f759 MT |
33 | </cmdsynopsis> |
34 | ||
35 | <cmdsynopsis> | |
36 | <command>network zone <arg choice="plain">list-hooks</arg></command> | |
37 | </cmdsynopsis> | |
38 | ||
39 | <cmdsynopsis> | |
40 | <command>network zone <replaceable>ZONE</replaceable> <arg choice="plain">command</arg> ...</command> | |
41 | </cmdsynopsis> | |
42 | </refsynopsisdiv> | |
43 | ||
44 | <refsect1> | |
45 | <title>Description</title> | |
46 | ||
47 | <para> | |
48 | With help of the <command>zone</command> command, it is very easy to | |
49 | configure network zones. | |
50 | </para> | |
51 | <para> | |
52 | It is possible to create zones and remove them. Zones may also | |
53 | be brought up and down and reconfigured. Their status may be viewed | |
54 | as well. | |
55 | </para> | |
56 | </refsect1> | |
57 | ||
58 | <refsect1> | |
59 | <title>Commands</title> | |
60 | ||
61 | <para> | |
62 | The following commands are understood: | |
63 | </para> | |
64 | ||
65 | <variablelist> | |
66 | <varlistentry> | |
67 | <term> | |
cf0fc8ab | 68 | <command>new <replaceable>ZONE</replaceable> <replaceable>HOOK</replaceable> <arg choice="opt" rep="repeat">OPTIONS</arg></command> |
a2a6f759 MT |
69 | </term> |
70 | ||
71 | <listitem> | |
72 | <para> | |
73 | A new zone may be created by the <command>create</command> | |
74 | command. There are at least two arguments required. | |
75 | </para> | |
76 | <para> | |
77 | <replaceable>ZONE</replaceable> must be valid name for a | |
78 | zone which does not already exist. | |
79 | <replaceable>HOOK</replaceable> is a valid zone hook which | |
80 | may require additional options. | |
81 | </para> | |
82 | </listitem> | |
83 | </varlistentry> | |
84 | ||
85 | <varlistentry> | |
86 | <term> | |
cf0fc8ab | 87 | <command>destroy <replaceable>ZONE</replaceable></command> |
a2a6f759 MT |
88 | </term> |
89 | ||
90 | <listitem> | |
91 | <para> | |
cf0fc8ab | 92 | A zone can be destroyed with this command. |
a2a6f759 MT |
93 | </para> |
94 | <para> | |
95 | There are two possible ways to remove a zone. The case | |
96 | is when the zone is not up. Then, it will be removed | |
97 | immediately. When the zone is current up and used, it | |
98 | will tagged to be remove later, after it has been brought | |
99 | down. | |
100 | </para> | |
101 | </listitem> | |
102 | </varlistentry> | |
103 | ||
104 | <varlistentry> | |
105 | <term> | |
106 | <command>list-hooks</command> | |
107 | </term> | |
108 | ||
109 | <listitem> | |
110 | <para> | |
111 | Outputs a list of all eligible hooks for the zones. | |
112 | </para> | |
113 | </listitem> | |
114 | </varlistentry> | |
115 | </variablelist> | |
116 | ||
117 | <para> | |
118 | For all other commands, the name of the zone needs to be passed first: | |
119 | </para> | |
120 | ||
121 | <variablelist> | |
122 | <varlistentry> | |
123 | <term> | |
124 | <command><replaceable>ZONE</replaceable> edit <arg choice="opt" rep="repeat">OPTIONS</arg></command> | |
125 | </term> | |
126 | ||
127 | <listitem> | |
128 | <para> | |
129 | The settings of a zone may be edited after it has been created. | |
130 | The options that can be passed depend on the hook that is used | |
131 | for the zone. | |
132 | Run <command>network zone <replaceable>ZONE</replaceable> edit --help</command> | |
133 | to learn more about that. | |
134 | </para> | |
135 | <para> | |
136 | It usually is required to restart/reload the zone until | |
137 | the new settings are taken into account. | |
138 | </para> | |
139 | </listitem> | |
140 | </varlistentry> | |
141 | ||
142 | <varlistentry> | |
143 | <term> | |
144 | <command><replaceable>ZONE</replaceable> [up|down]</command> | |
145 | </term> | |
146 | ||
147 | <listitem> | |
148 | <para> | |
149 | These commands will bring the zone up/down. This is done | |
150 | without control of systemd, therefore not intended to be | |
151 | done in a productive environment. | |
152 | However, these commands may be used for debugging. | |
153 | </para> | |
154 | </listitem> | |
155 | </varlistentry> | |
156 | ||
5c5b8e36 SS |
157 | <varlistentry> |
158 | <term> | |
159 | <command><replaceable>ZONE</replaceable> [enable|disable]</command> | |
160 | </term> | |
161 | ||
162 | <listitem> | |
163 | <para> | |
164 | These commands will enable or disable the zone. An enabled | |
165 | zone will automatically be started either during the boot process | |
166 | or a hotplug event of an associated port or other device. | |
167 | </para> | |
168 | </listitem> | |
169 | </varlistentry> | |
170 | ||
a2a6f759 MT |
171 | <varlistentry> |
172 | <term> | |
173 | <command><replaceable>ZONE</replaceable> status</command> | |
174 | </term> | |
175 | ||
176 | <listitem> | |
177 | <para> | |
178 | This will show some detailed information about the state | |
179 | if the specified zone. | |
180 | </para> | |
181 | </listitem> | |
182 | </varlistentry> | |
2bb20bbd SS |
183 | |
184 | <varlistentry> | |
185 | <term> | |
186 | <command><replaceable>ZONE</replaceable> rename <replaceable>NAME</replaceable></command> | |
187 | </term> | |
188 | ||
189 | <listitem> | |
190 | <para> | |
191 | Renames the zone to <replaceable>NAME</replaceable>. | |
192 | </para> | |
193 | <para> | |
194 | The command will shut down the zone if it is up and | |
195 | start it again with the new name. If the zone is not | |
196 | up it won't be started. | |
197 | </para> | |
198 | <para> | |
199 | Zones that are marked to be destroyed cannot be renamed. | |
200 | </para> | |
201 | </listitem> | |
202 | </varlistentry> | |
a2a6f759 MT |
203 | </variablelist> |
204 | </refsect1> | |
205 | ||
206 | <refsect1> | |
207 | <title>See Also</title> | |
208 | ||
209 | <para> | |
210 | <citerefentry> | |
211 | <refentrytitle>network</refentrytitle> | |
212 | <manvolnum>8</manvolnum> | |
213 | </citerefentry> | |
214 | </para> | |
215 | </refsect1> | |
216 | </refentry> |