| 1 | <?xml version="1.0" encoding="UTF-8"?>
|
|---|
| 2 | <!--
|
|---|
| 3 | manpage, user manual, usage: VBoxManage sharedfolder
|
|---|
| 4 |
|
|---|
| 5 | Copyright (C) 2006-2020 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"
|
|---|
| 16 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"[
|
|---|
| 17 | <!ENTITY % all.entities SYSTEM "all-entities.ent">
|
|---|
| 18 | %all.entities;
|
|---|
| 19 | ]>
|
|---|
| 20 | <refentry id="vboxmanage-sharedfolder" lang="en">
|
|---|
| 21 | <refentryinfo>
|
|---|
| 22 | <pubdate>September 2019</pubdate>
|
|---|
| 23 | <title>VBoxManage sharedfolder</title>
|
|---|
| 24 | </refentryinfo>
|
|---|
| 25 |
|
|---|
| 26 | <refmeta>
|
|---|
| 27 | <refentrytitle>VBoxManage-sharedfolder</refentrytitle>
|
|---|
| 28 | <manvolnum>1</manvolnum>
|
|---|
| 29 | </refmeta>
|
|---|
| 30 |
|
|---|
| 31 | <refnamediv>
|
|---|
| 32 | <refname>VBoxManage-sharedfolder</refname>
|
|---|
| 33 | <refpurpose>add and remove shared folders</refpurpose>
|
|---|
| 34 | <refclass>Oracle VM VirtualBox</refclass>
|
|---|
| 35 | </refnamediv>
|
|---|
| 36 |
|
|---|
| 37 | <refsynopsisdiv>
|
|---|
| 38 | <cmdsynopsis id="synopsis-vboxmanage-sharedfolder-add">
|
|---|
| 39 | <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
|
|---|
| 40 | <command>VBoxManage sharedfolder add</command>
|
|---|
| 41 | <group choice="req">
|
|---|
| 42 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 43 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 44 | </group>
|
|---|
| 45 | <arg choice="req">--name=<replaceable>name</replaceable></arg>
|
|---|
| 46 | <arg choice="req">--hostpath=<replaceable>hostpath</replaceable></arg>
|
|---|
| 47 | <arg>--readonly</arg>
|
|---|
| 48 | <arg>--transient</arg>
|
|---|
| 49 | <arg>--automount</arg>
|
|---|
| 50 | <arg>--auto-mount-point=<replaceable>path</replaceable></arg>
|
|---|
| 51 | </cmdsynopsis>
|
|---|
| 52 |
|
|---|
| 53 | <cmdsynopsis id="synopsis-vboxmanage-sharedfolder-remove">
|
|---|
| 54 | <command>VBoxManage sharedfolder remove</command>
|
|---|
| 55 | <group choice="req">
|
|---|
| 56 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 57 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 58 | </group>
|
|---|
| 59 | <arg choice="req">--name=<replaceable>name</replaceable></arg>
|
|---|
| 60 | <arg>--transient</arg>
|
|---|
| 61 | </cmdsynopsis>
|
|---|
| 62 | </refsynopsisdiv>
|
|---|
| 63 |
|
|---|
| 64 | <refsect1>
|
|---|
| 65 | <title>Description</title>
|
|---|
| 66 | <para>
|
|---|
| 67 | Shared folders enable you to share data between the host system
|
|---|
| 68 | and guests. To use shared folders, you must first install the
|
|---|
| 69 | &product-name; Guest Additions software on the guest OS.
|
|---|
| 70 | </para>
|
|---|
| 71 | <para>
|
|---|
| 72 | The shared folder is associated with a share name and the full
|
|---|
| 73 | path name of the folder or directory on the host system. The share
|
|---|
| 74 | name is a unique name within the namespace of the host OS.
|
|---|
| 75 | </para>
|
|---|
| 76 | <refsect2 id="vboxmanage-sharedfolder-add">
|
|---|
| 77 | <title>Add a Shared Folder</title>
|
|---|
| 78 | <remark role="help-copy-synopsis"/>
|
|---|
| 79 | <para>
|
|---|
| 80 | The <command>VBoxManage sharedfolder add</command> command
|
|---|
| 81 | creates a shared folder. The folder you specify is on the host
|
|---|
| 82 | computer. When configured, the contents of the folder on the
|
|---|
| 83 | host system can be shared with the guest OS.
|
|---|
| 84 | </para>
|
|---|
| 85 | <variablelist>
|
|---|
| 86 | <varlistentry>
|
|---|
| 87 | <term><replaceable>uuid</replaceable>|<replaceable>vmname</replaceable></term>
|
|---|
| 88 | <listitem><para>
|
|---|
| 89 | Specifies the name or UUID of the guest VM that shares a
|
|---|
| 90 | folder with the host system.
|
|---|
| 91 | </para></listitem>
|
|---|
| 92 | </varlistentry>
|
|---|
| 93 | <varlistentry>
|
|---|
| 94 | <term>--name=<replaceable>name</replaceable></term>
|
|---|
| 95 | <listitem><para>
|
|---|
| 96 | Specifies the name of the share, which is a unique name
|
|---|
| 97 | within the namespace of the host OS.
|
|---|
| 98 | </para></listitem>
|
|---|
| 99 | </varlistentry>
|
|---|
| 100 | <varlistentry>
|
|---|
| 101 | <term>--hostpath=<replaceable>hostpath</replaceable></term>
|
|---|
| 102 | <listitem><para>
|
|---|
| 103 | Specifies the absolute path of the folder or directory on
|
|---|
| 104 | the host OS to share with the guest OS.
|
|---|
| 105 | </para></listitem>
|
|---|
| 106 | </varlistentry>
|
|---|
| 107 | <varlistentry>
|
|---|
| 108 | <term>--readonly</term>
|
|---|
| 109 | <listitem><para>
|
|---|
| 110 | Specifies that the share has only read-only access to
|
|---|
| 111 | files at the host path.
|
|---|
| 112 | </para><para>
|
|---|
| 113 | By default, shared folders have read-write access to the
|
|---|
| 114 | files at the host path. However on Linux distributions,
|
|---|
| 115 | shared folders are mounted with 770 file permissions with
|
|---|
| 116 | the <literal>root</literal> user and the
|
|---|
| 117 | <literal>vboxsf</literal> group. By using this option, the
|
|---|
| 118 | file permissions become 700.
|
|---|
| 119 | </para></listitem>
|
|---|
| 120 | </varlistentry>
|
|---|
| 121 | <varlistentry>
|
|---|
| 122 | <term>--transient</term>
|
|---|
| 123 | <listitem><para>
|
|---|
| 124 | Specifies that the share is transient, which means that it
|
|---|
| 125 | can be added and removed at runtime and does not persist
|
|---|
| 126 | after the VM stops.
|
|---|
| 127 | </para></listitem>
|
|---|
| 128 | </varlistentry>
|
|---|
| 129 | <varlistentry>
|
|---|
| 130 | <term>--automount</term>
|
|---|
| 131 | <listitem><para>
|
|---|
| 132 | Specifies that the share is automatically mounted.
|
|---|
| 133 | </para></listitem>
|
|---|
| 134 | </varlistentry>
|
|---|
| 135 | <varlistentry>
|
|---|
| 136 | <term>--auto-mount-point=<replaceable>path</replaceable></term>
|
|---|
| 137 | <listitem><para>
|
|---|
| 138 | Specifies the mount point of the share. This guest OS specific.
|
|---|
| 139 | </para><para>
|
|---|
| 140 | For Windows and OS/2 guest this must be an unused drive letter.
|
|---|
| 141 | If left blank (or if the drive letter is already in use), the
|
|---|
| 142 | last unused drive letter is used instead (i.e. searching from
|
|---|
| 143 | <literal>Z:</literal> thru <literal>A:</literal>).
|
|---|
| 144 | </para><para>
|
|---|
| 145 | For Linux, Solaris and other unix guest, it must be an absolute
|
|---|
| 146 | path like <filename>/mnt/mysharedfolder</filename>. If left
|
|---|
| 147 | empty the default location is
|
|---|
| 148 | <filename>/media/sf_<replaceable>sharename</replaceable></filename>.
|
|---|
| 149 | </para></listitem>
|
|---|
| 150 | </varlistentry>
|
|---|
| 151 | </variablelist>
|
|---|
| 152 | </refsect2>
|
|---|
| 153 | <refsect2 id="vboxmanage-sharedfolder-remove">
|
|---|
| 154 | <title>Remove a Shared Folder</title>
|
|---|
| 155 | <remark role="help-copy-synopsis"/>
|
|---|
| 156 | <para>
|
|---|
| 157 | The <command>VBoxManage sharedfolder remove</command> command
|
|---|
| 158 | removes a shared folder.
|
|---|
| 159 | </para>
|
|---|
| 160 | <variablelist>
|
|---|
| 161 | <varlistentry>
|
|---|
| 162 | <term><replaceable>uuid</replaceable>|<replaceable>vmname</replaceable></term>
|
|---|
| 163 | <listitem><para>
|
|---|
| 164 | Specifies the name or UUID of the guest VM that shares a
|
|---|
| 165 | folder with the host system.
|
|---|
| 166 | </para></listitem>
|
|---|
| 167 | </varlistentry>
|
|---|
| 168 | <varlistentry>
|
|---|
| 169 | <term>--name=<replaceable>name</replaceable></term>
|
|---|
| 170 | <listitem><para>
|
|---|
| 171 | Specifies the name of the share to remove.
|
|---|
| 172 | </para></listitem>
|
|---|
| 173 | </varlistentry>
|
|---|
| 174 | <varlistentry>
|
|---|
| 175 | <term>--transient</term>
|
|---|
| 176 | <listitem><para>
|
|---|
| 177 | Specifies that the share is transient, which means that it
|
|---|
| 178 | can be added and removed at runtime and does not persist
|
|---|
| 179 | after the VM stops.
|
|---|
| 180 | </para></listitem>
|
|---|
| 181 | </varlistentry>
|
|---|
| 182 | </variablelist>
|
|---|
| 183 | </refsect2>
|
|---|
| 184 | </refsect1>
|
|---|
| 185 |
|
|---|
| 186 | <refsect1>
|
|---|
| 187 | <title>Examples</title>
|
|---|
| 188 | <remark role="help-scope" condition="GLOBAL" />
|
|---|
| 189 | <para>
|
|---|
| 190 | The following command creates a shared folder called
|
|---|
| 191 | <filename>o7share</filename> for the <filename>ol7</filename> VM.
|
|---|
| 192 | The share is mounted automatically when the VM is started.
|
|---|
| 193 | </para>
|
|---|
| 194 | <screen>$ VBoxManage sharedfolder add ol7 --name ol7share --hostpath "/home/user/ol7share" --automount</screen>
|
|---|
| 195 | <para>
|
|---|
| 196 | The following command removes the shared folder called
|
|---|
| 197 | <filename>o7share</filename> for the <filename>ol7</filename> VM.
|
|---|
| 198 | </para>
|
|---|
| 199 | <screen>$ VBoxManage sharedfolder remove ol7 --name ol7share</screen>
|
|---|
| 200 | </refsect1>
|
|---|
| 201 | </refentry>
|
|---|
