VirtualBox

source: vbox/trunk/doc/manual/en_US/man_VBoxManage-natnetwork.xml@ 103131

Last change on this file since 103131 was 99513, checked in by vboxsync, 19 months ago

manual,VBoxManage,isomaker/viso: Require all refsect1 and refsect2 elements to have @id attributes in manpages (refentry) to make these predictable and the split up topic files easier to handle for the docs team. Also requires these @id values to start with the refentry @id + '-'. Corrected a few bogus ones. Because 'controlvm' has too many sub-commands, HELP_SCOPE_ IDs will not be generated for 'See Also' and 'Examples' sections. bugref:10302

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 14.4 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3 manpage, user manual, usage: VBoxManage natnetwork
4-->
5<!--
6 Copyright (C) 2006-2023 Oracle and/or its affiliates.
7
8 This file is part of VirtualBox base platform packages, as
9 available from https://www.virtualbox.org.
10
11 This program is free software; you can redistribute it and/or
12 modify it under the terms of the GNU General Public License
13 as published by the Free Software Foundation, in version 3 of the
14 License.
15
16 This program is distributed in the hope that it will be useful, but
17 WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 General Public License for more details.
20
21 You should have received a copy of the GNU General Public License
22 along with this program; if not, see <https://www.gnu.org/licenses>.
23
24 SPDX-License-Identifier: GPL-3.0-only
25-->
26<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
27 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"[
28<!ENTITY % all.entities SYSTEM "all-entities.ent">
29%all.entities;
30]>
31<refentry id="vboxmanage-natnetwork" lang="en">
32 <refentryinfo>
33 <pubdate>$Date: 2023-04-21 21:59:02 +0000 (Fri, 21 Apr 2023) $</pubdate>
34 <title>VBoxManage natnetwork</title>
35 </refentryinfo>
36
37 <refmeta>
38 <refentrytitle>VBoxManage-natnetwork</refentrytitle>
39 <manvolnum>1</manvolnum>
40 </refmeta>
41
42 <refnamediv>
43 <refname>VBoxManage-natnetwork</refname>
44 <refpurpose>create, modify, and manage a NAT network</refpurpose>
45 <refclass>&product-name;</refclass>
46 </refnamediv>
47
48 <refsynopsisdiv>
49 <cmdsynopsis id="synopsis-vboxmanage-natnetwork-add">
50<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
51 <command>VBoxManage natnetwork add</command>
52 <group>
53 <arg choice="plain">--disable</arg>
54 <arg choice="plain">--enable</arg>
55 </group>
56 <arg choice="req">--netname=<replaceable>name</replaceable></arg>
57 <arg choice="req">--network=<replaceable>network</replaceable></arg>
58 <arg>--dhcp=on|off</arg>
59 <arg>--ipv6=on|off</arg>
60 <arg>--loopback-4=<replaceable>rule</replaceable></arg>
61 <arg>--loopback-6=<replaceable>rule</replaceable></arg>
62 <arg>--port-forward-4=<replaceable>rule</replaceable></arg>
63 <arg>--port-forward-6=<replaceable>rule</replaceable></arg>
64 </cmdsynopsis>
65
66 <cmdsynopsis id="synopsis-vboxmanage-natnetwork-list">
67 <command>VBoxManage natnetwork list</command>
68 <arg><replaceable>filter-pattern</replaceable></arg>
69 </cmdsynopsis>
70
71 <cmdsynopsis id="synopsis-vboxmanage-natnetwork-modify">
72 <command>VBoxManage natnetwork modify</command>
73 <arg>--dhcp=on|off</arg>
74 <group>
75 <arg choice="plain">--disable</arg>
76 <arg choice="plain">--enable</arg>
77 </group>
78 <arg choice="req">--netname=<replaceable>name</replaceable></arg>
79 <arg choice="req">--network=<replaceable>network</replaceable></arg>
80 <arg>--ipv6=on|off</arg>
81 <arg>--loopback-4=<replaceable>rule</replaceable></arg>
82 <arg>--loopback-6=<replaceable>rule</replaceable></arg>
83 <arg>--port-forward-4=<replaceable>rule</replaceable></arg>
84 <arg>--port-forward-6=<replaceable>rule</replaceable></arg>
85 </cmdsynopsis>
86
87 <cmdsynopsis id="synopsis-vboxmanage-natnetwork-remove">
88 <command>VBoxManage natnetwork remove</command>
89 <arg choice="req">--netname=<replaceable>name</replaceable></arg>
90 </cmdsynopsis>
91
92 <cmdsynopsis id="synopsis-vboxmanage-natnetwork-start">
93 <command>VBoxManage natnetwork start</command>
94 <arg choice="req">--netname=<replaceable>name</replaceable></arg>
95 </cmdsynopsis>
96
97 <cmdsynopsis id="synopsis-vboxmanage-natnetwork-stop">
98 <command>VBoxManage natnetwork stop</command>
99 <arg choice="req">--netname=<replaceable>name</replaceable></arg>
100 </cmdsynopsis>
101 </refsynopsisdiv>
102
103 <refsect1 id="vboxmanage-natnetwork-description">
104 <title>Description</title>
105 <para>
106 The <command>VBoxManage natnetwork</command> command enables you
107 to create, modify and manage a NAT network.
108 </para>
109 <para>
110 NAT networks use the Network Address Translation (NAT) service.
111 The service groups systems into a network and prevents external
112 systems from directly accessing the systems in the network. The
113 service also enables the systems in the network to communicate
114 with each other and with external systems by means of TCP and UDP
115 over IPv4 and IPv6.
116 </para>
117 <para>
118 A NAT service is attached to an internal network. For a VM to use
119 the NAT service, you must attach the VM to the internal network.
120 Specify the name of the internal network when you create the NAT
121 service. Note that the internal network is created if it does not
122 already exist.
123 </para>
124 <refsect2 id="vboxmanage-natnetwork-add">
125 <title>Add a NAT Network Service</title>
126 <remark role="help-copy-synopsis"/>
127 <para>
128 The <command>VBoxManage natnetwork add</command> command creates
129 a new internal network interface, and adds a NAT network
130 service. You must use this command before you can attach the VM
131 to the NAT network.
132 </para>
133 <variablelist>
134 <varlistentry>
135 <term><option>--disable</option></term>
136 <listitem><para>
137 Disables the NAT network service.
138 </para></listitem>
139 </varlistentry>
140 <varlistentry>
141 <term><option>--enable</option></term>
142 <listitem><para>
143 Enables the NAT network service.
144 </para></listitem>
145 </varlistentry>
146 <varlistentry>
147 <term><option>--netname=<replaceable>name</replaceable></option></term>
148 <listitem><para>
149 Specifies the name of the new internal network interface
150 on the host OS.
151 </para></listitem>
152 </varlistentry>
153 <varlistentry>
154 <term><option>--network</option></term>
155 <listitem><para>
156 Specifies the static or DHCP network address and mask of
157 the NAT service interface. By default, this value
158 specifies the static network address.
159 </para></listitem>
160 </varlistentry>
161 <varlistentry>
162 <term><option>--dhcp</option></term>
163 <listitem><para>
164 Enables or disables the DHCP server that you specify by
165 using the <option>--netname</option> option.
166 </para></listitem>
167 </varlistentry>
168 <varlistentry>
169 <term><option>--ipv6</option></term>
170 <listitem><para>
171 Enables or disables IPv6. By default, IPv6 is disabled and
172 IPv4 is enabled.
173 </para></listitem>
174 </varlistentry>
175 <varlistentry>
176 <term><option>--loopback-4=<replaceable>rule</replaceable></option></term>
177 <listitem><para>
178 Enables an IPv4 loopback interface by using the specified
179 rule.
180 </para></listitem>
181 </varlistentry>
182 <varlistentry>
183 <term><option>--loopback-6=<replaceable>rule</replaceable></option></term>
184 <listitem><para>
185 Enables an IPv6 loopback interface by using the specified
186 rule.
187 </para></listitem>
188 </varlistentry>
189 <varlistentry>
190 <term><option>--port-forward-4=<replaceable>rule</replaceable></option></term>
191 <listitem><para>
192 Enables IPv4 port forwarding by using the rule specified
193 by <replaceable>rule</replaceable>.
194 </para></listitem>
195 </varlistentry>
196 <varlistentry>
197 <term><option>--port-forward-6=<replaceable>rule</replaceable></option></term>
198 <listitem><para>
199 Enables IPv6 port forwarding by using the rule specified
200 by <replaceable>rule</replaceable>.
201 </para></listitem>
202 </varlistentry>
203 </variablelist>
204 </refsect2>
205 <refsect2 id="vboxmanage-natnetwork-remove">
206 <title>Remove a NAT Network Service</title>
207 <remark role="help-copy-synopsis"/>
208 <para>
209 The <command>VBoxManage natnetwork remove</command> command
210 removes the specified NAT network service.
211 </para>
212 <variablelist>
213 <varlistentry>
214 <term><option>--netname=<replaceable>name</replaceable></option></term>
215 <listitem><para>
216 Specifies the name of the NAT network service to remove.
217 </para></listitem>
218 </varlistentry>
219 </variablelist>
220 </refsect2>
221 <refsect2 id="vboxmanage-natnetwork-start">
222 <title>Start a NAT Network Service</title>
223 <remark role="help-copy-synopsis"/>
224 <para>
225 The <command>VBoxManage natnetwork start</command> command
226 starts a NAT network service and any associated DHCP server.
227 </para>
228 <variablelist>
229 <varlistentry>
230 <term><option>--netname=<replaceable>name</replaceable></option></term>
231 <listitem><para>
232 Specifies the name of the NAT network service to start.
233 </para></listitem>
234 </varlistentry>
235 </variablelist>
236 </refsect2>
237 <refsect2 id="vboxmanage-natnetwork-stop">
238 <title>Stop a NAT Network Service</title>
239 <remark role="help-copy-synopsis"/>
240 <para>
241 The <command>VBoxManage natnetwork stop</command> command stops
242 a NAT network service and any associated DHCP server.
243 </para>
244 <variablelist>
245 <varlistentry>
246 <term><option>--netname=<replaceable>name</replaceable></option></term>
247 <listitem><para>
248 Specifies the name of the NAT network service to stop.
249 </para></listitem>
250 </varlistentry>
251 </variablelist>
252 </refsect2>
253 <refsect2 id="vboxmanage-natnetwork-list">
254 <title>List All NAT Network Services</title>
255 <remark role="help-copy-synopsis"/>
256 <para>
257 The <command>VBoxManage natnetwork list</command> command lists
258 all NAT network services. You can use a pattern to show a subset
259 of the NAT network services.
260 </para>
261 <variablelist>
262 <varlistentry>
263 <term><replaceable>filter-pattern</replaceable></term>
264 <listitem><para>
265 Specifies an optional filtering pattern.
266 </para></listitem>
267 </varlistentry>
268 </variablelist>
269 </refsect2>
270 <refsect2 id="vboxmanage-natnetwork-modify">
271 <title>Modify the Settings of a NAT Network Service</title>
272 <remark role="help-copy-synopsis"/>
273 <para>
274 The <command>VBoxManage natnetwork modify</command> command
275 modifies the settings of an existing internal network interface.
276 </para>
277 <variablelist>
278 <varlistentry>
279 <term><option>--disable</option></term>
280 <listitem><para>
281 Disables the NAT network service.
282 </para></listitem>
283 </varlistentry>
284 <varlistentry>
285 <term><option>--enable</option></term>
286 <listitem><para>
287 Enables the NAT network service.
288 </para></listitem>
289 </varlistentry>
290 <varlistentry>
291 <term><option>--netname=<replaceable>name</replaceable></option></term>
292 <listitem><para>
293 Specifies the name of the new internal network interface
294 on the host OS.
295 </para></listitem>
296 </varlistentry>
297 <varlistentry>
298 <term><option>--network</option></term>
299 <listitem><para>
300 Specifies the static or DHCP network address and mask of
301 the NAT service interface. By default, this value
302 specifies the static network address.
303 </para></listitem>
304 </varlistentry>
305 <varlistentry>
306 <term><option>--dhcp</option></term>
307 <listitem><para>
308 Enables or disables the DHCP server that you specify by
309 using the <option>--netname</option> option.
310 </para></listitem>
311 </varlistentry>
312 <varlistentry>
313 <term><option>--ipv6</option></term>
314 <listitem><para>
315 Enables or disables IPv6. By default, IPv6 is disabled and
316 IPv4 is enabled.
317 </para></listitem>
318 </varlistentry>
319 <varlistentry>
320 <term><option>--loopback-4=<replaceable>rule</replaceable></option></term>
321 <listitem><para>
322 Enables an IPv4 loopback interface by using the specified
323 rule.
324 </para></listitem>
325 </varlistentry>
326 <varlistentry>
327 <term><option>--loopback-6=<replaceable>rule</replaceable></option></term>
328 <listitem><para>
329 Enables an IPv6 loopback interface by using the specified
330 rule.
331 </para></listitem>
332 </varlistentry>
333 <varlistentry>
334 <term><option>--port-forward-4=<replaceable>rule</replaceable></option></term>
335 <listitem><para>
336 Enables IPv4 port forwarding by using the rule specified
337 by <replaceable>rule</replaceable>.
338 </para></listitem>
339 </varlistentry>
340 <varlistentry>
341 <term><option>--port-forward-6=<replaceable>rule</replaceable></option></term>
342 <listitem><para>
343 Enables IPv6 port forwarding by using the rule specified
344 by <replaceable>rule</replaceable>.
345 </para></listitem>
346 </varlistentry>
347 </variablelist>
348 </refsect2>
349 </refsect1>
350
351 <refsect1 id="vboxmanage-natnetwork-examples">
352 <title>Examples</title>
353 <remark role="help-scope" condition="GLOBAL"/>
354 <para>
355 The following command shows how to create a NAT network for the
356 <literal>natnet1</literal> internal network that uses the
357 <literal>192.168.15.0/24</literal> network address and mask of the
358 NAT service interface. In this static configuration, the gateway
359 is assigned the <literal>192.168.15.1</literal> IP address by
360 default. Note that this IP address is the next address after the
361 network address that you specify with the
362 <option>--network</option> option.
363 </para>
364<screen>$ VBoxManage natnetwork add --netname natnet1 --network "192.168.15.0/24" --enable</screen>
365 <para>
366 The following command shows how to add a DHCP server to the
367 <literal>natnet1</literal> NAT network after creation:
368 </para>
369<screen>$ VBoxManage natnetwork modify --netname natnet1 --dhcp on</screen>
370 </refsect1>
371</refentry>
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette