VirtualBox

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

Last change on this file since 93707 was 93707, checked in by vboxsync, 3 years ago

doc/manual: Some metadata cleanup and a bit of consistency.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 5.8 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3 manpage, user manual, usage: VBoxManage hostonlynet
4
5 Copyright (C) 2021 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" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
16<refentry id="vboxmanage-hostonlynet" lang="en">
17
18 <refentryinfo>
19 <pubdate>$Date: 2022-02-11 20:10:19 +0000 (Fri, 11 Feb 2022) $</pubdate>
20 <title>VBoxManage hostonlynet</title>
21 </refentryinfo>
22
23 <refmeta>
24 <refentrytitle>VBoxManage-hostonlynet</refentrytitle>
25 <manvolnum>1</manvolnum>
26 </refmeta>
27
28 <refnamediv>
29 <refname>VBoxManage-hostonlynet</refname>
30 <refpurpose>Host Only Network management</refpurpose>
31 <refclass>&product-name;</refclass>
32 </refnamediv>
33
34 <refsynopsisdiv>
35 <cmdsynopsis id="synopsis-vboxmanage-hostonlynet-add">
36 <command>VBoxManage hostonlynet add</command>
37 <arg choice="req">--name=<replaceable>netname</replaceable></arg>
38 <arg choice="opt">--id=<replaceable>netid</replaceable></arg>
39 <arg choice="req">--netmask=<replaceable>mask</replaceable></arg>
40 <arg choice="req">--lower-ip=<replaceable>address</replaceable></arg>
41 <arg choice="req">--upper-ip=<replaceable>address</replaceable></arg>
42 <group choice="opt">
43 <arg choice="plain">--enable</arg>
44 <arg choice="plain">--disable</arg>
45 </group>
46 </cmdsynopsis>
47 <cmdsynopsis id="synopsis-vboxmanage-hostonlynet-modify">
48 <command>VBoxManage hostonlynet modify</command>
49 <group choice="req">
50 <arg choice="plain">--name=<replaceable>netname</replaceable></arg>
51 <arg choice="plain">--id=<replaceable>netid</replaceable></arg>
52 </group>
53 <arg choice="opt">--lower-ip=<replaceable>address</replaceable></arg>
54 <arg choice="opt">--upper-ip=<replaceable>address</replaceable></arg>
55 <arg choice="opt">--netmask=<replaceable>mask</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-remove">
62 <command>VBoxManage hostonlynet remove</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 </cmdsynopsis>
68 </refsynopsisdiv>
69
70 <refsect1>
71 <title>Description</title>
72
73 <para>
74 The <command>hostonlynet</command> commands enable you to control
75 host-only networks.
76 </para>
77
78 <refsect2 id="vboxmanage-hostonlynet-common-options">
79 <title>Common options</title>
80 <remark role="help-scope" condition="GLOBAL"/>
81 <para>The subcommands of <command>hostonlynet</command> all operate on an
82 host-only network that can be identified via its name or uuid:</para>
83 <variablelist>
84 <varlistentry>
85 <term>--name=<replaceable>netname</replaceable></term>
86 <listitem><para>The host-only network name. You see it as
87 VBoxNetworkName in the output from
88 <command>VBoxManage list hostonlynets</command>.
89 </para></listitem>
90 </varlistentry>
91 <varlistentry>
92 <term>--id=<replaceable>netid</replaceable></term>
93 <listitem><para>The host-only network uuid. If not specified when
94 adding a new network, one will be generated automatically.
95 </para></listitem>
96 </varlistentry>
97 </variablelist>
98 </refsect2>
99
100 <refsect2 id="vboxmanage-hostonlynet-add">
101 <title>hostonlynet add</title>
102 <remark role="help-copy-synopsis"/>
103 <para>
104 Adds a new host-only network.
105 </para>
106 <para>
107 Options configuring the host-only network:
108 </para>
109 <variablelist>
110 <varlistentry>
111 <term><option>--netmask=<replaceable>mask</replaceable></option></term>
112 <listitem><para>The network mask. Typically 255.255.255.0.</para></listitem>
113 </varlistentry>
114 <varlistentry>
115 <term><option>--lower-ip=<replaceable>address</replaceable></option>, <option>--upper-ip=<replaceable>address</replaceable></option></term>
116 <listitem><para>The IP address range for handing out via DHCP. The upper
117 boundrary is inclusive while the lower one is not, so the upper address
118 will be handed out to a client, while the lower
119 address will be used by the host itself.</para></listitem>
120 </varlistentry>
121 <varlistentry>
122 <term><option>--enable</option>, --disable</term>
123 <listitem><para>Whether to enable the host-only network or disable it. If not specified,
124 the network will be created in enabled state.</para></listitem>
125 </varlistentry>
126 </variablelist>
127 </refsect2>
128
129 <refsect2 id="vboxmanage-hostonlynet-modify">
130 <title>hostonlynet modify</title>
131 <remark role="help-copy-synopsis"/>
132 <para>
133 This modifies an existing host-only network configuration. It takes the same
134 options as the <command>add</command> command.
135 </para>
136 </refsect2>
137
138 <refsect2 id="vboxmanage-hostonlynet-remove">
139 <title>hostonlynet remove</title>
140 <remark role="help-copy-synopsis"/>
141 <para>
142 Removes the specified host-only network.
143 </para>
144 </refsect2>
145
146 </refsect1>
147
148</refentry>
149
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