fuse/guestmount.pod

   1 =encoding utf8
   2
   3 =head1 NAME
   4
   5 guestmount - Mount a guest filesystem on the host using FUSE and libguestfs
   6
   7 =head1 SYNOPSIS
   8
   9  guestmount [--options] -a disk.img -m device [--ro] mountpoint
  10
  11  guestmount [--options] -a disk.img -i [--ro] mountpoint
  12
  13  guestmount [--options] -d Guest -i [--ro] mountpoint
  14
  15 =head1 WARNING
  16
  17 You must I<not> use C<guestmount> in read-write mode on live virtual
  18 machines.  If you do this, you risk disk corruption in the VM.
  19
  20 =head1 DESCRIPTION
  21
  22 The guestmount program can be used to mount virtual machine
  23 filesystems and other disk images on the host.  It uses libguestfs for
  24 access to the guest filesystem, and FUSE (the "filesystem in
  25 userspace") to make it appear as a mountable device.
  26
  27 Along with other options, you have to give at least one device (I<-a>
  28 option) or libvirt domain (I<-d> option), and at least one mountpoint
  29 (I<-m> option) or use the I<-i> inspection option.  How this works is
  30 better explained in the L<guestfish(1)> manual page, or by looking at
  31 the examples below.
  32
  33 FUSE lets you mount filesystems as non-root.  The mountpoint must be
  34 owned by you, and the filesystem will not be visible to any other
  35 users unless you make certain global configuration changes to
  36 C</etc/fuse.conf>.  To unmount the filesystem, use the C<fusermount -u>
  37 command.
  38
  39 =head1 EXAMPLES
  40
  41 For a typical Windows guest which has its main filesystem on the
  42 first partition:
  43
  44  guestmount -a windows.img -m /dev/sda1 --ro /mnt
  45
  46 For a typical Linux guest which has a /boot filesystem on the first
  47 partition, and the root filesystem on a logical volume:
  48
  49  guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt
  50
  51 To get libguestfs to detect guest mountpoints for you:
  52
  53  guestmount -a guest.img -i --ro /mnt
  54
  55 For a libvirt guest called "Guest" you could do:
  56
  57  guestmount -d Guest -i --ro /mnt
  58
  59 If you don't know what filesystems are contained in a guest or
  60 disk image, use L<virt-filesystems(1)> first:
  61
  62  virt-filesystems MyGuest
  63
  64 If you want to trace the libguestfs calls but without excessive
  65 debugging information, we recommend:
  66
  67  guestmount [...] --trace /mnt
  68
  69 If you want to debug the program, we recommend:
  70
  71  guestmount [...] --trace --verbose /mnt
  72
  73 =head1 NOTES
  74
  75 =head2 Other users cannot see the filesystem by default
  76
  77 If you mount a filesystem as one user (eg. root), then other users
  78 will not be able to see it by default.  The fix is to add the FUSE
  79 C<allow_other> option when mounting:
  80
  81  sudo guestmount [...] -o allow_other /mnt
  82
  83 =head1 OPTIONS
  84
  85 =over 4
  86
  87 =item B<-a image>
  88
  89 =item B<--add image>
  90
  91 Add a block device or virtual machine image.
  92
  93 The format of the disk image is auto-detected.  To override this and
  94 force a particular format use the I<--format=..> option.
  95
  96 =item B<-c URI>
  97
  98 =item B<--connect URI>
  99
 100 When used in conjunction with the I<-d> option, this specifies
 101 the libvirt URI to use.  The default is to use the default libvirt
 102 connection.
 103
 104 =item B<-d libvirt-domain>
 105
 106 =item B<--domain libvirt-domain>
 107
 108 Add disks from the named libvirt domain.  If the I<--ro> option is
 109 also used, then any libvirt domain can be used.  However in write
 110 mode, only libvirt domains which are shut down can be named here.
 111
 112 Domain UUIDs can be used instead of names.
 113
 114 =item B<--dir-cache-timeout N>
 115
 116 Set the readdir cache timeout to I<N> seconds, the default being 60
 117 seconds.  The readdir cache [actually, there are several
 118 semi-independent caches] is populated after a readdir(2) call with the
 119 stat and extended attributes of the files in the directory, in
 120 anticipation that they will be requested soon after.
 121
 122 There is also a different attribute cache implemented by FUSE
 123 (see the FUSE option I<-o attr_timeout>), but the FUSE cache
 124 does not anticipate future requests, only cache existing ones.
 125
 126 =item B<--echo-keys>
 127
 128 When prompting for keys and passphrases, guestfish normally turns
 129 echoing off so you cannot see what you are typing.  If you are not
 130 worried about Tempest attacks and there is no one else in the room
 131 you can specify this flag to see what you are typing.
 132
 133 =item B<--format=raw|qcow2|..>
 134
 135 =item B<--format>
 136
 137 The default for the I<-a> option is to auto-detect the format of the
 138 disk image.  Using this forces the disk format for I<-a> options which
 139 follow on the command line.  Using I<--format> with no argument
 140 switches back to auto-detection for subsequent I<-a> options.
 141
 142 If you have untrusted raw-format guest disk images, you should use
 143 this option to specify the disk format.  This avoids a possible
 144 security problem with malicious guests (CVE-2010-3851).  See also
 145 L<guestfs(3)/guestfs_add_drive_opts>.
 146
 147 =item B<--fuse-help>
 148
 149 Display help on special FUSE options (see I<-o> below).
 150
 151 =item B<--help>
 152
 153 Display brief help and exit.
 154
 155 =item B<-i>
 156
 157 =item B<--inspector>
 158
 159 Using L<virt-inspector(1)> code, inspect the disks looking for
 160 an operating system and mount filesystems as they would be
 161 mounted on the real virtual machine.
 162
 163 =item B<--keys-from-stdin>
 164
 165 Read key or passphrase parameters from stdin.  The default is
 166 to try to read passphrases from the user by opening C</dev/tty>.
 167
 168 =item B<--live>
 169
 170 Connect to a live virtual machine.
 171 (Experimental, see L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>).
 172
 173 =item B<-m dev[:mountpoint[:options]]>
 174
 175 =item B<--mount dev[:mountpoint[:options]]>
 176
 177 Mount the named partition or logical volume on the given mountpoint
 178 B<in the guest> (this has nothing to do with mountpoints in the host).
 179
 180 If the mountpoint is omitted, it defaults to C</>.  You have to mount
 181 something on C</>.
 182
 183 The third (and rarely used) part of the mount parameter is the list of
 184 mount options used to mount the underlying filesystem.  If this is not
 185 given, then the mount options are either the empty string or C<ro>
 186 (the latter if the I<--ro> flag is used).  By specifying the mount
 187 options, you override this default choice.  Probably the only time you
 188 would use this is to enable ACLs and/or extended attributes if the
 189 filesystem can support them:
 190
 191  -m /dev/sda1:/:acl,user_xattr
 192
 193 =item B<-n>
 194
 195 =item B<--no-sync>
 196
 197 By default, we attempt to sync the guest disk when the FUSE mountpoint
 198 is unmounted.  If you specify this option, then we don't attempt to
 199 sync the disk.  See the discussion of autosync in the L<guestfs(3)>
 200 manpage.
 201
 202 =item B<-o option>
 203
 204 =item B<--option option>
 205
 206 Pass extra options to FUSE.
 207
 208 To get a list of all the extra options supported by FUSE, use the
 209 command below.  Note that only the FUSE I<-o> options can be passed,
 210 and only some of them are a good idea.
 211
 212  guestmount --fuse-help
 213
 214 Some potentially useful FUSE options:
 215
 216 =over 4
 217
 218 =item B<-o allow_other>
 219
 220 Allow other users to see the filesystem.
 221
 222 =item B<-o attr_timeout=N>
 223
 224 Enable attribute caching by FUSE, and set the timeout to I<N> seconds.
 225
 226 =item B<-o kernel_cache>
 227
 228 Allow the kernel to cache files (reduces the number of reads
 229 that have to go through the L<guestfs(3)> API).  This is generally
 230 a good idea if you can afford the extra memory usage.
 231
 232 =item B<-o uid=N> B<-o gid=N>
 233
 234 Use these options to map all UIDs and GIDs inside the guest filesystem
 235 to the chosen values.
 236
 237 =back
 238
 239 =item B<-r>
 240
 241 =item B<--ro>
 242
 243 Add devices and mount everything read-only.  Also disallow writes and
 244 make the disk appear read-only to FUSE.
 245
 246 This is highly recommended if you are not going to edit the guest
 247 disk.  If the guest is running and this option is I<not> supplied,
 248 then there is a strong risk of disk corruption in the guest.  We try
 249 to prevent this from happening, but it is not always possible.
 250
 251 See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>.
 252
 253 =item B<--selinux>
 254
 255 Enable SELinux support for the guest.
 256
 257 =item B<-v>
 258
 259 =item B<--verbose>
 260
 261 Enable verbose messages from underlying libguestfs.
 262
 263 =item B<-V>
 264
 265 =item B<--version>
 266
 267 Display the program version and exit.
 268
 269 =item B<-w>
 270
 271 =item B<--rw>
 272
 273 This changes the I<-a>, I<-d> and I<-m> options so that disks are
 274 added and mounts are done read-write.
 275
 276 See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>.
 277
 278 =item B<-x>
 279
 280 =item B<--trace>
 281
 282 Trace libguestfs calls and entry into each FUSE function.
 283
 284 This also stops the daemon from forking into the background.
 285
 286 =back
 287
 288 =head1 FILES
 289
 290 =over 4
 291
 292 =item $HOME/.libguestfs-tools.rc
 293
 294 =item /etc/libguestfs-tools.conf
 295
 296 This configuration file controls the default read-only or read-write
 297 mode (I<--ro> or I<--rw>).
 298
 299 See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>.
 300
 301 =back
 302
 303 =head1 SEE ALSO
 304
 305 L<guestfish(1)>,
 306 L<virt-inspector(1)>,
 307 L<virt-cat(1)>,
 308 L<virt-edit(1)>,
 309 L<virt-tar(1)>,
 310 L<guestfs(3)>,
 311 L<http://libguestfs.org/>,
 312 L<http://fuse.sf.net/>.
 313
 314 =head1 AUTHORS
 315
 316 Richard W.M. Jones (C<rjones at redhat dot com>)
 317
 318 =head1 COPYRIGHT
 319
 320 Copyright (C) 2009-2010 Red Hat Inc.
 321 L<http://libguestfs.org/>
 322
 323 This program is free software; you can redistribute it and/or modify
 324 it under the terms of the GNU General Public License as published by
 325 the Free Software Foundation; either version 2 of the License, or
 326 (at your option) any later version.
 327
 328 This program is distributed in the hope that it will be useful,
 329 but WITHOUT ANY WARRANTY; without even the implied warranty of
 330 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 331 GNU General Public License for more details.
 332
 333 You should have received a copy of the GNU General Public License
 334 along with this program; if not, write to the Free Software
 335 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.