VirtualBox

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

Last change on this file since 85770 was 82969, checked in by vboxsync, 5 years ago

Copyright year updates - manual ones.

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