]>
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 | ||
a2a6f759 MT |
35 | <cmdsynopsis> |
36 | <command>network zone <replaceable>ZONE</replaceable> <arg choice="plain">command</arg> ...</command> | |
37 | </cmdsynopsis> | |
38 | </refsynopsisdiv> | |
39 | ||
40 | <refsect1> | |
41 | <title>Description</title> | |
42 | ||
43 | <para> | |
44 | With help of the <command>zone</command> command, it is very easy to | |
45 | configure network zones. | |
46 | </para> | |
47 | <para> | |
48 | It is possible to create zones and remove them. Zones may also | |
49 | be brought up and down and reconfigured. Their status may be viewed | |
50 | as well. | |
51 | </para> | |
52 | </refsect1> | |
53 | ||
54 | <refsect1> | |
55 | <title>Commands</title> | |
56 | ||
57 | <para> | |
58 | The following commands are understood: | |
59 | </para> | |
60 | ||
61 | <variablelist> | |
62 | <varlistentry> | |
63 | <term> | |
cf0fc8ab | 64 | <command>new <replaceable>ZONE</replaceable> <replaceable>HOOK</replaceable> <arg choice="opt" rep="repeat">OPTIONS</arg></command> |
a2a6f759 MT |
65 | </term> |
66 | ||
67 | <listitem> | |
68 | <para> | |
69 | A new zone may be created by the <command>create</command> | |
70 | command. There are at least two arguments required. | |
71 | </para> | |
72 | <para> | |
73 | <replaceable>ZONE</replaceable> must be valid name for a | |
74 | zone which does not already exist. | |
75 | <replaceable>HOOK</replaceable> is a valid zone hook which | |
76 | may require additional options. | |
77 | </para> | |
78 | </listitem> | |
79 | </varlistentry> | |
80 | ||
81 | <varlistentry> | |
82 | <term> | |
cf0fc8ab | 83 | <command>destroy <replaceable>ZONE</replaceable></command> |
a2a6f759 MT |
84 | </term> |
85 | ||
86 | <listitem> | |
87 | <para> | |
cf0fc8ab | 88 | A zone can be destroyed with this command. |
a2a6f759 MT |
89 | </para> |
90 | <para> | |
91 | There are two possible ways to remove a zone. The case | |
92 | is when the zone is not up. Then, it will be removed | |
93 | immediately. When the zone is current up and used, it | |
94 | will tagged to be remove later, after it has been brought | |
95 | down. | |
96 | </para> | |
97 | </listitem> | |
98 | </varlistentry> | |
a2a6f759 MT |
99 | </variablelist> |
100 | ||
101 | <para> | |
102 | For all other commands, the name of the zone needs to be passed first: | |
103 | </para> | |
104 | ||
105 | <variablelist> | |
106 | <varlistentry> | |
107 | <term> | |
108 | <command><replaceable>ZONE</replaceable> edit <arg choice="opt" rep="repeat">OPTIONS</arg></command> | |
109 | </term> | |
110 | ||
111 | <listitem> | |
112 | <para> | |
113 | The settings of a zone may be edited after it has been created. | |
114 | The options that can be passed depend on the hook that is used | |
115 | for the zone. | |
116 | Run <command>network zone <replaceable>ZONE</replaceable> edit --help</command> | |
117 | to learn more about that. | |
118 | </para> | |
119 | <para> | |
120 | It usually is required to restart/reload the zone until | |
121 | the new settings are taken into account. | |
122 | </para> | |
123 | </listitem> | |
124 | </varlistentry> | |
125 | ||
126 | <varlistentry> | |
127 | <term> | |
128 | <command><replaceable>ZONE</replaceable> [up|down]</command> | |
129 | </term> | |
130 | ||
131 | <listitem> | |
132 | <para> | |
133 | These commands will bring the zone up/down. This is done | |
134 | without control of systemd, therefore not intended to be | |
135 | done in a productive environment. | |
136 | However, these commands may be used for debugging. | |
137 | </para> | |
138 | </listitem> | |
139 | </varlistentry> | |
140 | ||
5c5b8e36 SS |
141 | <varlistentry> |
142 | <term> | |
143 | <command><replaceable>ZONE</replaceable> [enable|disable]</command> | |
144 | </term> | |
145 | ||
146 | <listitem> | |
147 | <para> | |
148 | These commands will enable or disable the zone. An enabled | |
149 | zone will automatically be started either during the boot process | |
150 | or a hotplug event of an associated port or other device. | |
151 | </para> | |
152 | </listitem> | |
153 | </varlistentry> | |
154 | ||
a2a6f759 MT |
155 | <varlistentry> |
156 | <term> | |
157 | <command><replaceable>ZONE</replaceable> status</command> | |
158 | </term> | |
159 | ||
160 | <listitem> | |
161 | <para> | |
162 | This will show some detailed information about the state | |
163 | if the specified zone. | |
164 | </para> | |
165 | </listitem> | |
166 | </varlistentry> | |
89c81bcf JS |
167 | <varlistentry> |
168 | <term> | |
169 | <command><replaceable>ZONE</replaceable> color</command> | |
170 | </term> | |
2bb20bbd | 171 | |
89c81bcf JS |
172 | <listitem> |
173 | <para> | |
c4c9a7c1 | 174 | This command allows settings a color for a zone. |
89c81bcf JS |
175 | See |
176 | <citerefentry> | |
177 | <refentrytitle>network-color</refentrytitle> | |
c4c9a7c1 | 178 | <manvolnum>8</manvolnum> |
89c81bcf JS |
179 | </citerefentry> |
180 | for more information. | |
181 | </para> | |
182 | </listitem> | |
183 | </varlistentry> | |
6135a5b3 JS |
184 | <varlistentry> |
185 | <term> | |
186 | <command><replaceable>ZONE</replaceable>description</command> | |
187 | </term> | |
188 | ||
189 | <listitem> | |
190 | <para> | |
191 | This command make is possible to add a description to a zone. | |
192 | See | |
193 | <citerefentry> | |
194 | <refentrytitle>network-description</refentrytitle> | |
195 | <manvolnum>8</manvolnum>, | |
196 | </citerefentry> | |
197 | for more information. | |
198 | </para> | |
199 | </listitem> | |
200 | </varlistentry> | |
f5ee091e MT |
201 | <varlistentry> |
202 | <term> | |
203 | <command><replaceable>ZONE</replaceable> identify</command> | |
204 | </term> | |
205 | ||
206 | <listitem> | |
207 | <para> | |
208 | This command will make all ports of the zone flash for | |
209 | a few seconds so that you can identify the correct network | |
210 | adapters in the system. | |
211 | </para> | |
212 | </listitem> | |
213 | </varlistentry> | |
214 | ||
2bb20bbd SS |
215 | <varlistentry> |
216 | <term> | |
217 | <command><replaceable>ZONE</replaceable> rename <replaceable>NAME</replaceable></command> | |
218 | </term> | |
219 | ||
220 | <listitem> | |
221 | <para> | |
222 | Renames the zone to <replaceable>NAME</replaceable>. | |
223 | </para> | |
224 | <para> | |
225 | The command will shut down the zone if it is up and | |
226 | start it again with the new name. If the zone is not | |
227 | up it won't be started. | |
228 | </para> | |
229 | <para> | |
230 | Zones that are marked to be destroyed cannot be renamed. | |
231 | </para> | |
232 | </listitem> | |
233 | </varlistentry> | |
a2a6f759 MT |
234 | </variablelist> |
235 | </refsect1> | |
236 | ||
237 | <refsect1> | |
238 | <title>See Also</title> | |
239 | ||
240 | <para> | |
241 | <citerefentry> | |
242 | <refentrytitle>network</refentrytitle> | |
243 | <manvolnum>8</manvolnum> | |
244 | </citerefentry> | |
245 | </para> | |
246 | </refsect1> | |
247 | </refentry> |