VirtualBox

source: vbox/trunk/doc/manual/en_US/man_VBoxManage-hostonlynet.xml@ 103068

Last change on this file since 103068 was 99513, checked in by vboxsync, 20 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: 6.2 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3 manpage, user manual, usage: VBoxManage hostonlynet
4-->
5<!--
6 Copyright (C) 2021-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-hostonlynet" lang="en">
32 <refentryinfo>
33 <pubdate>$Date: 2023-04-21 21:59:02 +0000 (Fri, 21 Apr 2023) $</pubdate>
34 <title>VBoxManage hostonlynet</title>
35 </refentryinfo>
36
37 <refmeta>
38 <refentrytitle>VBoxManage-hostonlynet</refentrytitle>
39 <manvolnum>1</manvolnum>
40 </refmeta>
41
42 <refnamediv>
43 <refname>VBoxManage-hostonlynet</refname>
44 <refpurpose>Host Only Network management</refpurpose>
45 <refclass>&product-name;</refclass>
46 </refnamediv>
47
48 <refsynopsisdiv>
49 <cmdsynopsis id="synopsis-vboxmanage-hostonlynet-add">
50 <command>VBoxManage hostonlynet add</command>
51 <arg choice="req">--name=<replaceable>netname</replaceable></arg>
52 <arg choice="opt">--id=<replaceable>netid</replaceable></arg>
53 <arg choice="req">--netmask=<replaceable>mask</replaceable></arg>
54 <arg choice="req">--lower-ip=<replaceable>address</replaceable></arg>
55 <arg choice="req">--upper-ip=<replaceable>address</replaceable></arg>
56 <group choice="opt">
57 <arg choice="plain">--enable</arg>
58 <arg choice="plain">--disable</arg>
59 </group>
60 </cmdsynopsis>
61 <cmdsynopsis id="synopsis-vboxmanage-hostonlynet-modify">
62 <command>VBoxManage hostonlynet modify</command>
63 <group choice="req">
64 <arg choice="plain">--name=<replaceable>netname</replaceable></arg>
65 <arg choice="plain">--id=<replaceable>netid</replaceable></arg>
66 </group>
67 <arg choice="opt">--lower-ip=<replaceable>address</replaceable></arg>
68 <arg choice="opt">--upper-ip=<replaceable>address</replaceable></arg>
69 <arg choice="opt">--netmask=<replaceable>mask</replaceable></arg>
70 <group choice="opt">
71 <arg choice="plain">--enable</arg>
72 <arg choice="plain">--disable</arg>
73 </group>
74 </cmdsynopsis>
75 <cmdsynopsis id="synopsis-vboxmanage-hostonlynet-remove">
76 <command>VBoxManage hostonlynet remove</command>
77 <group choice="req">
78 <arg choice="plain">--name=<replaceable>netname</replaceable></arg>
79 <arg choice="plain">--id=<replaceable>netid</replaceable></arg>
80 </group>
81 </cmdsynopsis>
82 </refsynopsisdiv>
83
84 <refsect1 id="vboxmanage-hostonlynet-description">
85 <title>Description</title>
86
87 <para>
88 The <command>hostonlynet</command> commands enable you to control
89 host-only networks.
90 </para>
91
92 <refsect2 id="vboxmanage-hostonlynet-common-options">
93 <title>Common options</title>
94 <remark role="help-scope" condition="GLOBAL"/>
95 <para>The subcommands of <command>hostonlynet</command> all operate on an
96 host-only network that can be identified via its name or uuid:</para>
97 <variablelist>
98 <varlistentry>
99 <term>--name=<replaceable>netname</replaceable></term>
100 <listitem><para>The host-only network name. You see it as
101 VBoxNetworkName in the output from
102 <command>VBoxManage list hostonlynets</command>.
103 </para></listitem>
104 </varlistentry>
105 <varlistentry>
106 <term>--id=<replaceable>netid</replaceable></term>
107 <listitem><para>The host-only network uuid. If not specified when
108 adding a new network, one will be generated automatically.
109 </para></listitem>
110 </varlistentry>
111 </variablelist>
112 </refsect2>
113
114 <refsect2 id="vboxmanage-hostonlynet-add">
115 <title>hostonlynet add</title>
116 <remark role="help-copy-synopsis"/>
117 <para>
118 Adds a new host-only network.
119 </para>
120 <para>
121 Options configuring the host-only network:
122 </para>
123 <variablelist>
124 <varlistentry>
125 <term><option>--netmask=<replaceable>mask</replaceable></option></term>
126 <listitem><para>The network mask. Typically 255.255.255.0.</para></listitem>
127 </varlistentry>
128 <varlistentry>
129 <term><option>--lower-ip=<replaceable>address</replaceable></option>, <option>--upper-ip=<replaceable>address</replaceable></option></term>
130 <listitem><para>The IP address range for handing out via DHCP. The upper
131 boundrary is inclusive while the lower one is not, so the upper address
132 will be handed out to a client, while the lower
133 address will be used by the host itself.</para></listitem>
134 </varlistentry>
135 <varlistentry>
136 <term><option>--enable</option>, --disable</term>
137 <listitem><para>Whether to enable the host-only network or disable it. If not specified,
138 the network will be created in enabled state.</para></listitem>
139 </varlistentry>
140 </variablelist>
141 </refsect2>
142
143 <refsect2 id="vboxmanage-hostonlynet-modify">
144 <title>hostonlynet modify</title>
145 <remark role="help-copy-synopsis"/>
146 <para>
147 This modifies an existing host-only network configuration. It takes the same
148 options as the <command>add</command> command.
149 </para>
150 </refsect2>
151
152 <refsect2 id="vboxmanage-hostonlynet-remove">
153 <title>hostonlynet remove</title>
154 <remark role="help-copy-synopsis"/>
155 <para>
156 Removes the specified host-only network.
157 </para>
158 </refsect2>
159
160 </refsect1>
161
162</refentry>
163
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