summaryrefslogtreecommitdiffstats
path: root/doc/manual/en_US/man_VBoxManage-hostonlynet.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/manual/en_US/man_VBoxManage-hostonlynet.xml')
-rw-r--r--doc/manual/en_US/man_VBoxManage-hostonlynet.xml163
1 files changed, 163 insertions, 0 deletions
diff --git a/doc/manual/en_US/man_VBoxManage-hostonlynet.xml b/doc/manual/en_US/man_VBoxManage-hostonlynet.xml
new file mode 100644
index 00000000..14a98bb9
--- /dev/null
+++ b/doc/manual/en_US/man_VBoxManage-hostonlynet.xml
@@ -0,0 +1,163 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ manpage, user manual, usage: VBoxManage hostonlynet
+-->
+<!--
+ Copyright (C) 2021-2023 Oracle and/or its affiliates.
+
+ This file is part of VirtualBox base platform packages, as
+ available from https://www.virtualbox.org.
+
+ This program is free software; you can redistribute it and/or
+ modify it under the terms of the GNU General Public License
+ as published by the Free Software Foundation, in version 3 of the
+ License.
+
+ This program is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program; if not, see <https://www.gnu.org/licenses>.
+
+ SPDX-License-Identifier: GPL-3.0-only
+-->
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+ "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"[
+<!ENTITY % all.entities SYSTEM "all-entities.ent">
+%all.entities;
+]>
+<refentry id="vboxmanage-hostonlynet" lang="en">
+ <refentryinfo>
+ <pubdate>$Date: 2023-01-17 15:15:46 +0100 (Tue, 17 Jan 2023) $</pubdate>
+ <title>VBoxManage hostonlynet</title>
+ </refentryinfo>
+
+ <refmeta>
+ <refentrytitle>VBoxManage-hostonlynet</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>VBoxManage-hostonlynet</refname>
+ <refpurpose>Host Only Network management</refpurpose>
+ <refclass>&product-name;</refclass>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis id="synopsis-vboxmanage-hostonlynet-add">
+ <command>VBoxManage hostonlynet add</command>
+ <arg choice="req">--name=<replaceable>netname</replaceable></arg>
+ <arg choice="opt">--id=<replaceable>netid</replaceable></arg>
+ <arg choice="req">--netmask=<replaceable>mask</replaceable></arg>
+ <arg choice="req">--lower-ip=<replaceable>address</replaceable></arg>
+ <arg choice="req">--upper-ip=<replaceable>address</replaceable></arg>
+ <group choice="opt">
+ <arg choice="plain">--enable</arg>
+ <arg choice="plain">--disable</arg>
+ </group>
+ </cmdsynopsis>
+ <cmdsynopsis id="synopsis-vboxmanage-hostonlynet-modify">
+ <command>VBoxManage hostonlynet modify</command>
+ <group choice="req">
+ <arg choice="plain">--name=<replaceable>netname</replaceable></arg>
+ <arg choice="plain">--id=<replaceable>netid</replaceable></arg>
+ </group>
+ <arg choice="opt">--lower-ip=<replaceable>address</replaceable></arg>
+ <arg choice="opt">--upper-ip=<replaceable>address</replaceable></arg>
+ <arg choice="opt">--netmask=<replaceable>mask</replaceable></arg>
+ <group choice="opt">
+ <arg choice="plain">--enable</arg>
+ <arg choice="plain">--disable</arg>
+ </group>
+ </cmdsynopsis>
+ <cmdsynopsis id="synopsis-vboxmanage-hostonlynet-remove">
+ <command>VBoxManage hostonlynet remove</command>
+ <group choice="req">
+ <arg choice="plain">--name=<replaceable>netname</replaceable></arg>
+ <arg choice="plain">--id=<replaceable>netid</replaceable></arg>
+ </group>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+
+ <para>
+ The <command>hostonlynet</command> commands enable you to control
+ host-only networks.
+ </para>
+
+ <refsect2 id="vboxmanage-hostonlynet-common-options">
+ <title>Common options</title>
+ <remark role="help-scope" condition="GLOBAL"/>
+ <para>The subcommands of <command>hostonlynet</command> all operate on an
+ host-only network that can be identified via its name or uuid:</para>
+ <variablelist>
+ <varlistentry>
+ <term>--name=<replaceable>netname</replaceable></term>
+ <listitem><para>The host-only network name. You see it as
+ VBoxNetworkName in the output from
+ <command>VBoxManage list hostonlynets</command>.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>--id=<replaceable>netid</replaceable></term>
+ <listitem><para>The host-only network uuid. If not specified when
+ adding a new network, one will be generated automatically.
+ </para></listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect2>
+
+ <refsect2 id="vboxmanage-hostonlynet-add">
+ <title>hostonlynet add</title>
+ <remark role="help-copy-synopsis"/>
+ <para>
+ Adds a new host-only network.
+ </para>
+ <para>
+ Options configuring the host-only network:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term><option>--netmask=<replaceable>mask</replaceable></option></term>
+ <listitem><para>The network mask. Typically 255.255.255.0.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--lower-ip=<replaceable>address</replaceable></option>, <option>--upper-ip=<replaceable>address</replaceable></option></term>
+ <listitem><para>The IP address range for handing out via DHCP. The upper
+ boundrary is inclusive while the lower one is not, so the upper address
+ will be handed out to a client, while the lower
+ address will be used by the host itself.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--enable</option>, --disable</term>
+ <listitem><para>Whether to enable the host-only network or disable it. If not specified,
+ the network will be created in enabled state.</para></listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect2>
+
+ <refsect2 id="vboxmanage-hostonlynet-modify">
+ <title>hostonlynet modify</title>
+ <remark role="help-copy-synopsis"/>
+ <para>
+ This modifies an existing host-only network configuration. It takes the same
+ options as the <command>add</command> command.
+ </para>
+ </refsect2>
+
+ <refsect2 id="vboxmanage-hostonlynet-remove">
+ <title>hostonlynet remove</title>
+ <remark role="help-copy-synopsis"/>
+ <para>
+ Removes the specified host-only network.
+ </para>
+ </refsect2>
+
+ </refsect1>
+
+</refentry>
+