1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
manpage, user manual, usage: VBoxManage sharedfolder
-->
<!--
Copyright (C) 2006-2024 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-sharedfolder" lang="en">
<refentryinfo>
<pubdate>$Date: 2024-09-16 16:03:52 +0200 (Mon, 16 Sep 2024) $</pubdate>
<title>VBoxManage sharedfolder</title>
</refentryinfo>
<refmeta>
<refentrytitle>VBoxManage-sharedfolder</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>VBoxManage-sharedfolder</refname>
<refpurpose>add and remove shared folders, configure security policy for shared folders</refpurpose>
<refclass>&product-name;</refclass>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis id="synopsis-vboxmanage-sharedfolder-add">
<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
<command>VBoxManage sharedfolder add</command>
<group choice="req">
<arg choice="plain"><replaceable>uuid</replaceable></arg>
<arg choice="plain"><replaceable>vmname</replaceable></arg>
</group>
<arg choice="req">--name=<replaceable>share-name</replaceable></arg>
<arg choice="req">--hostpath=<replaceable>hostpath</replaceable></arg>
<arg>--readonly</arg>
<arg>--transient</arg>
<arg>--automount</arg>
<arg>--auto-mount-point=<replaceable>path</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis id="synopsis-vboxmanage-sharedfolder-remove">
<command>VBoxManage sharedfolder remove</command>
<group choice="req">
<arg choice="plain"><replaceable>uuid</replaceable></arg>
<arg choice="plain"><replaceable>vmname</replaceable></arg>
</group>
<arg choice="req">--name=<replaceable>share-name</replaceable></arg>
<arg>--transient</arg>
</cmdsynopsis>
<cmdsynopsis id="synopsis-vboxmanage-sharedfolder-modify">
<command>VBoxManage sharedfolder modify</command>
<group choice="req">
<arg choice="plain"><replaceable>uuid</replaceable></arg>
<arg choice="plain"><replaceable>vmname</replaceable></arg>
</group>
<arg choice="req">--name=<replaceable>share-name</replaceable></arg>
<arg choice="req">--readonly=
<group choice="plain">
<arg choice="plain">true</arg>
<arg choice="plain">false</arg>
</group>
</arg>
<arg choice="req">--automount=
<group choice="plain">
<arg choice="plain">true</arg>
<arg choice="plain">false</arg>
</group>
</arg>
<arg choice="req">--auto-mount-point=<replaceable>path</replaceable></arg>
<arg choice="req">--symlink-policy=
<group choice="plain">
<arg choice="plain">forbidden</arg>
<arg choice="plain">subtree</arg>
<arg choice="plain">relative</arg>
<arg choice="plain">any</arg>
</group>
</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="vboxmanage-sharedfolder-description">
<title>Description</title>
<para>
Shared folders enable you to share data between the host system
and guest VMs. To use shared folders you must first install the
&product-name; Guest Additions software in the guest VM.
</para>
<para>
The shared folder is associated with a share name and the full
path name of the folder or directory on the host system. The share
name is a unique name within the namespace of the host OS.
</para>
<refsect2 id="vboxmanage-sharedfolder-add">
<title>Add a Shared Folder</title>
<remark role="help-copy-synopsis"/>
<para>
The <command>VBoxManage sharedfolder add</command> command
creates a shared folder. The folder you specify is on the host
computer. Once created the contents of the folder on the
host system can be accessed from within the guest OS.
</para>
<variablelist>
<varlistentry>
<term><option><replaceable>uuid</replaceable> | <replaceable>vmname</replaceable></option></term>
<listitem><para>
Specifies the name or UUID of the guest VM that shares a
folder with the host system.
</para></listitem>
</varlistentry>
<varlistentry>
<term>--name=<replaceable>share-name</replaceable></term>
<listitem><para>
Specifies the name of the share, which is a unique name
within the namespace of the host OS.
</para></listitem>
</varlistentry>
<varlistentry>
<term>--hostpath=<replaceable>hostpath</replaceable></term>
<listitem><para>
Specifies the absolute path of the folder or directory on
the host OS to share with the guest OS.
</para></listitem>
</varlistentry>
<varlistentry>
<term>--readonly</term>
<listitem><para>
Specifies that the share has only read-only access to
files at the host path.
</para><para>
By default, shared folders have read-write access to the
files mounted from the host. However on Solaris and Linux
distributions shared folders are mounted with 770 file
permissions with the files owned by the <literal>root</literal>
user and the <literal>vboxsf</literal> group which means the
files are restricted to members of the <literal>vboxsf</literal>
group and the <literal>root</literal> user. If the --readonly
option is specified the file permissions become 700 and the
files are accessible only to the <literal>root</literal> user.
</para></listitem>
</varlistentry>
<varlistentry>
<term>--transient</term>
<listitem><para>
Specifies that the share is transient which means that it
is added and removed to a running VM and does not persist
after the VM stops.
</para></listitem>
</varlistentry>
<varlistentry>
<term>--automount</term>
<listitem><para>
Specifies that the share is automatically mounted.
</para></listitem>
</varlistentry>
<varlistentry>
<term>--auto-mount-point=<replaceable>path</replaceable></term>
<listitem><para>
Specifies the mount point of the share. This is guest OS specific.
</para><para>
For Windows and OS/2 guests this must be an unused drive letter.
If left blank (or if the drive letter is already in use), the
last unused drive letter is used instead (i.e. searching from
<literal>Z:</literal> through <literal>A:</literal>).
</para><para>
For Linux, Solaris and other Unix guests, it must be an absolute
path such as <filename>/mnt/mysharedfolder</filename>. If left
empty the default location is
<filename>/media/sf_<replaceable>sharename</replaceable></filename>.
</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="vboxmanage-sharedfolder-remove">
<title>Remove a Shared Folder</title>
<remark role="help-copy-synopsis"/>
<para>
The <command>VBoxManage sharedfolder remove</command> command
removes a shared folder.
</para>
<variablelist>
<varlistentry>
<term><option><replaceable>uuid</replaceable> | <replaceable>vmname</replaceable></option></term>
<listitem><para>
Specifies the name or UUID of the guest VM that shares a
folder with the host system.
</para></listitem>
</varlistentry>
<varlistentry>
<term>--name=<replaceable>share-name</replaceable></term>
<listitem><para>
Specifies the name of the share to remove.
</para></listitem>
</varlistentry>
<varlistentry>
<term>--transient</term>
<listitem><para>
Specifies that the share is transient which means that it
is added and removed to a running VM and does not persist
after the VM stops.
</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="vboxmanage-sharedfolder-modify">
<title>Modify a Shared Folder's Configuration</title>
<remark role="help-copy-synopsis"/>
<para>
The <command>VBoxManage sharedfolder modify</command> command
modifies the configuration of a Shared Folder.
</para>
<variablelist>
<varlistentry>
<term><option><replaceable>uuid</replaceable> | <replaceable>vmname</replaceable></option></term>
<listitem><para>
Specifies the name or UUID of the guest VM that shares a
folder with the host system.
</para></listitem>
</varlistentry>
<varlistentry>
<term>--name=<replaceable>share-name</replaceable></term>
<listitem><para>
Specifies the name of the shared folder to modify.
</para></listitem>
</varlistentry>
<varlistentry>
<term>--readonly=<replaceable>true | false</replaceable></term>
<listitem><para>
Specifies whether the shared folder is to be mounted as read-only.
</para></listitem>
</varlistentry>
<varlistentry>
<term>--automount=<replaceable>true | false</replaceable></term>
<listitem><para>
Specifies whether the shared folder is to be mounted automatically
when the VM boots.
</para></listitem>
</varlistentry>
<varlistentry>
<term>--auto-mount-point=<replaceable>path</replaceable></term>
<listitem><para>
Specifies where to mount the shared folder if it is configured to be
be mounted automatically when the VM boots.
</para></listitem>
</varlistentry>
<varlistentry>
<term>--symlink-policy=<replaceable>policy-name</replaceable></term>
<listitem><para>
Specifies the symbolic link security policy of the shared folder.
Valid symlink security policies are:
<literal>forbidden</literal>, <literal>subtree</literal>,
<literal>relative</literal>, and <literal>any</literal>.
</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<refsect1 id="vboxmanage-sharedfolder-examples">
<title>Examples</title>
<remark role="help-scope" condition="GLOBAL" />
<para>
The following command creates a shared folder named
<filename>o7share</filename> for the <filename>ol7</filename> VM
and configures the share to be mounted automatically when the VM
is started.
</para>
<screen>$ VBoxManage sharedfolder add ol7 --name ol7share --hostpath "/home/user/ol7share" --automount</screen>
<para>
The following command removes the shared folder named
<filename>o7share</filename> from the <filename>ol7</filename> VM.
</para>
<screen>$ VBoxManage sharedfolder remove ol7 --name ol7share</screen>
</refsect1>
</refentry>
|
