VirtualBox

source: vbox/trunk/doc/manual/en_US/man_VBoxManage-hostonlyif.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: 8.1 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3 manpage, user manual, usage: VBoxManage hostonlyif
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-hostonlyif" lang="en">
32 <refentryinfo>
33 <pubdate>$Date: 2023-04-21 21:59:02 +0000 (Fri, 21 Apr 2023) $</pubdate>
34 <title>VBoxManage hostonlyif</title>
35 </refentryinfo>
36
37 <refmeta>
38 <refentrytitle>VBoxManage-hostonlyif</refentrytitle>
39 <manvolnum>1</manvolnum>
40 </refmeta>
41
42 <refnamediv>
43 <refname>VBoxManage-hostonlyif</refname>
44 <refpurpose>manage host-only network interfaces</refpurpose>
45 <refclass>&product-name;</refclass>
46 </refnamediv>
47
48 <refsynopsisdiv>
49<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
50 <cmdsynopsis id="synopsis-vboxmanage-hostonlyif-ipconfig">
51 <command>VBoxManage hostonlyif ipconfig</command>
52 <arg choice="req"><replaceable>ifname</replaceable></arg>
53 <group>
54 <arg choice="plain">--dhcp</arg>
55 <arg choice="plain">
56 <arg choice="req">--ip=<replaceable>IPv4-address</replaceable></arg>
57 <arg>--netmask=<replaceable>IPv4-netmask</replaceable></arg>
58 </arg>
59 <arg choice="plain">
60 <arg choice="req">--ipv6=<replaceable>IPv6-address</replaceable></arg>
61 <arg>--netmasklengthv6=<replaceable>length</replaceable></arg>
62 </arg>
63 </group>
64 </cmdsynopsis>
65
66 <cmdsynopsis id="synopsis-vboxmanage-hostonlyif-create">
67 <command>VBoxManage hostonlyif create</command>
68 </cmdsynopsis>
69
70 <cmdsynopsis id="synopsis-vboxmanage-hostonlyif-remove">
71 <command>VBoxManage hostonlyif remove</command>
72 <arg choice="req"><replaceable>ifname</replaceable></arg>
73 </cmdsynopsis>
74 </refsynopsisdiv>
75
76 <refsect1 id="vboxmanage-hostonlyif-description">
77 <title>Description</title>
78 <para>
79 The <command>VBoxManage hostonlyif</command> command enables you
80 to change the IP configuration of a host-only network interface.
81 For a description of host-only networking, see
82 <xref linkend="network_hostonly" />. Each host-only network
83 interface is identified by a name and can either use the internal
84 DHCP server or a manual IP configuration, both IPv4 and IPv6.
85 </para>
86 <refsect2 id="vboxmanage-hostonlyif-ipconfig">
87 <title>Configure a Host-Only Interface</title>
88 <remark role="help-copy-synopsis"/>
89 <para>
90 The <command>VBoxManage hostonlyif ipconfig</command> command
91 configures a host-only interface.
92 </para>
93 <variablelist>
94 <varlistentry>
95 <term><replaceable>ifname</replaceable></term>
96 <listitem><para>
97 Specifies the name of the network interface. The name is
98 of the form
99 <literal>vboxnet</literal><replaceable>N</replaceable>
100 where <replaceable>N</replaceable> is the interface
101 instance.
102 </para></listitem>
103 </varlistentry>
104 <varlistentry>
105 <term><option>--dhcp</option></term>
106 <listitem><para>
107 Uses DHCP for the network interface.
108 </para><para>
109 You cannot use this option with the <option>--ip</option>,
110 <option>--ipv6</option>, <option>--netmask</option>, and
111 <option>--netmasklengthv6</option> options.
112 </para></listitem>
113 </varlistentry>
114 <varlistentry>
115 <term><option>--ip=<replaceable>IPv4-address</replaceable></option></term>
116 <listitem><para>
117 Specifies the IPv4 IP address for the network interface.
118 </para><para>
119 You cannot use this option with the
120 <option>--dhcp</option>, <option>--ipv6</option>, and
121 <option>--netmasklengthv6</option> options.
122 </para></listitem>
123 </varlistentry>
124 <varlistentry>
125 <term><option>--netmask=<replaceable>IPv4-netmask</replaceable></option></term>
126 <listitem><para>
127 Specifies the IPv4 netmask of the network interface. The
128 default value is <literal>255.255.255.0</literal>.
129 </para><para>
130 You can use this option only with the
131 <option>--ip</option> option.
132 </para></listitem>
133 </varlistentry>
134 <varlistentry>
135 <term><option>--ipv6=<replaceable>IPv6-address</replaceable></option></term>
136 <listitem><para>
137 Specifies the IPv6 IP address for the network interface.
138 </para><para>
139 You cannot use this option with the
140 <option>--dhcp</option>, <option>--ip</option>, and
141 <option>--netmask</option> options.
142 </para></listitem>
143 </varlistentry>
144 <varlistentry>
145 <term><option>--netmasklengthv6=<replaceable>length</replaceable></option></term>
146 <listitem><para>
147 Specifies the length of the IPv6 network interface. The
148 default value is <literal>64</literal>.
149 </para><para>
150 You can use this option only with the
151 <option>--ipv6</option> option.
152 </para></listitem>
153 </varlistentry>
154 </variablelist>
155 </refsect2>
156 <refsect2 id="vboxmanage-hostonlyif-create">
157 <title>Create a Network Interface on the Host System</title>
158 <remark role="help-copy-synopsis"/>
159 <para>
160 The <command>VBoxManage hostonlyif create</command> command
161 creates a new host-only network interface on the host operating
162 system (OS). The network interface name is of the form
163 <literal>vboxnet</literal><replaceable>N</replaceable> where
164 <replaceable>N</replaceable> is the interface instance. You must
165 run this command before you can attach virtual machines (VMs) to
166 the host-only network.
167 </para>
168 </refsect2>
169 <refsect2 id="vboxmanage-hostonlyif-remove">
170 <title>Remove a Network Interface From the Host System</title>
171 <remark role="help-copy-synopsis"/>
172 <para>
173 The <command>VBoxManage hostonlyif remove</command> command
174 removes the specified host-only network interface from the host
175 OS.
176 </para>
177 <variablelist>
178 <varlistentry>
179 <term><replaceable>ifname</replaceable></term>
180 <listitem><para>
181 Specifies the name of the network interface. The name is
182 of the form
183 <literal>vboxnet</literal><replaceable>N</replaceable>
184 where <replaceable>N</replaceable> is the interface
185 instance.
186 </para></listitem>
187 </varlistentry>
188 </variablelist>
189 </refsect2>
190 </refsect1>
191
192 <refsect1 id="vboxmanage-hostonlyif-examples">
193 <title>Examples</title>
194 <remark role="help-scope" condition="GLOBAL" />
195 <para>
196 The following command creates a new host-only network interface.
197 </para>
198<screen>$ VBoxManage hostonlyif create
1990%...10%...20%...30%...40%...50%...60%...70%...80%...90%...100%
200Interface 'vboxnet2' was successfully created</screen>
201 <para>
202 The following command configures the IPv4 address for the
203 <literal>vboxnet2</literal> host-only network interface.
204 </para>
205<screen>$ VBoxManage hostonlyif ipconfig vboxnet2 --ip 10.0.2.18</screen>
206 </refsect1>
207</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