298 lines
12 KiB
XML
298 lines
12 KiB
XML
<?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>
|