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> | B<--add image>
  88
  89 Add a block device or virtual machine image.
  90
  91 The format of the disk image is auto-detected.  To override this and
  92 force a particular format use the I<--format=..> option.
  93
  94 =item B<-c URI> | B<--connect URI>
  95
  96 When used in conjunction with the I<-d> option, this specifies
  97 the libvirt URI to use.  The default is to use the default libvirt
  98 connection.
  99
 100 =item B<-d libvirt-domain> | B<--domain libvirt-domain>
 101
 102 Add disks from the named libvirt domain.  If the I<--ro> option is
 103 also used, then any libvirt domain can be used.  However in write
 104 mode, only libvirt domains which are shut down can be named here.
 105
 106 =item B<--dir-cache-timeout N>
 107
 108 Set the readdir cache timeout to I<N> seconds, the default being 60
 109 seconds.  The readdir cache [actually, there are several
 110 semi-independent caches] is populated after a readdir(2) call with the
 111 stat and extended attributes of the files in the directory, in
 112 anticipation that they will be requested soon after.
 113
 114 There is also a different attribute cache implemented by FUSE
 115 (see the FUSE option I<-o attr_timeout>), but the FUSE cache
 116 does not anticipate future requests, only cache existing ones.
 117
 118 =item B<--echo-keys>
 119
 120 When prompting for keys and passphrases, guestfish normally turns
 121 echoing off so you cannot see what you are typing.  If you are not
 122 worried about Tempest attacks and there is no one else in the room
 123 you can specify this flag to see what you are typing.
 124
 125 =item B<--format=raw|qcow2|..> | B<--format>
 126
 127 The default for the I<-a> option is to auto-detect the format of the
 128 disk image.  Using this forces the disk format for I<-a> options which
 129 follow on the command line.  Using I<--format> with no argument
 130 switches back to auto-detection for subsequent I<-a> options.
 131
 132 If you have untrusted raw-format guest disk images, you should use
 133 this option to specify the disk format.  This avoids a possible
 134 security problem with malicious guests (CVE-2010-3851).  See also
 135 L<guestfs(3)/guestfs_add_drive_opts>.
 136
 137 =item B<--fuse-help>
 138
 139 Display help on special FUSE options (see I<-o> below).
 140
 141 =item B<--help>
 142
 143 Display brief help and exit.
 144
 145 =item B<-i> | B<--inspector>
 146
 147 Using L<virt-inspector(1)> code, inspect the disks looking for
 148 an operating system and mount filesystems as they would be
 149 mounted on the real virtual machine.
 150
 151 =item B<--keys-from-stdin>
 152
 153 Read key or passphrase parameters from stdin.  The default is
 154 to try to read passphrases from the user by opening C</dev/tty>.
 155
 156 =item B<--live>
 157
 158 Connect to a live virtual machine.
 159 (Experimental, see L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>).
 160
 161 =item B<-m dev[:mountpoint[:options]]>
 162
 163 =item B<--mount dev[:mountpoint[:options]]>
 164
 165 Mount the named partition or logical volume on the given mountpoint
 166 B<in the guest> (this has nothing to do with mountpoints in the host).
 167
 168 If the mountpoint is omitted, it defaults to C</>.  You have to mount
 169 something on C</>.
 170
 171 The third (and rarely used) part of the mount parameter is the list of
 172 mount options used to mount the underlying filesystem.  If this is not
 173 given, then the mount options are either the empty string or C<ro>
 174 (the latter if the I<--ro> flag is used).  By specifying the mount
 175 options, you override this default choice.  Probably the only time you
 176 would use this is to enable ACLs and/or extended attributes if the
 177 filesystem can support them:
 178
 179  -m /dev/sda1:/:acl,user_xattr
 180
 181 =item B<-n> | B<--no-sync>
 182
 183 By default, we attempt to sync the guest disk when the FUSE mountpoint
 184 is unmounted.  If you specify this option, then we don't attempt to
 185 sync the disk.  See the discussion of autosync in the L<guestfs(3)>
 186 manpage.
 187
 188 =item B<-o option> | B<--option option>
 189
 190 Pass extra options to FUSE.
 191
 192 To get a list of all the extra options supported by FUSE, use the
 193 command below.  Note that only the FUSE I<-o> options can be passed,
 194 and only some of them are a good idea.
 195
 196  guestmount --fuse-help
 197
 198 Some potentially useful FUSE options:
 199
 200 =over 4
 201
 202 =item B<-o allow_other>
 203
 204 Allow other users to see the filesystem.
 205
 206 =item B<-o attr_timeout=N>
 207
 208 Enable attribute caching by FUSE, and set the timeout to I<N> seconds.
 209
 210 =item B<-o kernel_cache>
 211
 212 Allow the kernel to cache files (reduces the number of reads
 213 that have to go through the L<guestfs(3)> API).  This is generally
 214 a good idea if you can afford the extra memory usage.
 215
 216 =item B<-o uid=N> B<-o gid=N>
 217
 218 Use these options to map all UIDs and GIDs inside the guest filesystem
 219 to the chosen values.
 220
 221 =back
 222
 223 =item B<-r> | B<--ro>
 224
 225 Add devices and mount everything read-only.  Also disallow writes and
 226 make the disk appear read-only to FUSE.
 227
 228 This is highly recommended if you are not going to edit the guest
 229 disk.  If the guest is running and this option is I<not> supplied,
 230 then there is a strong risk of disk corruption in the guest.  We try
 231 to prevent this from happening, but it is not always possible.
 232
 233 See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>.
 234
 235 =item B<--selinux>
 236
 237 Enable SELinux support for the guest.
 238
 239 =item B<-v> | B<--verbose>
 240
 241 Enable verbose messages from underlying libguestfs.
 242
 243 =item B<-V> | B<--version>
 244
 245 Display the program version and exit.
 246
 247 =item B<-w> | B<--rw>
 248
 249 This changes the I<-a>, I<-d> and I<-m> options so that disks are
 250 added and mounts are done read-write.
 251
 252 See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>.
 253
 254 =item B<-x> | B<--trace>
 255
 256 Trace libguestfs calls and entry into each FUSE function.
 257
 258 This also stops the daemon from forking into the background.
 259
 260 =back
 261
 262 =head1 FILES
 263
 264 =over 4
 265
 266 =item $HOME/.libguestfs-tools.rc
 267
 268 =item /etc/libguestfs-tools.conf
 269
 270 This configuration file controls the default read-only or read-write
 271 mode (I<--ro> or I<--rw>).
 272
 273 See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>.
 274
 275 =back
 276
 277 =head1 SEE ALSO
 278
 279 L<guestfish(1)>,
 280 L<virt-inspector(1)>,
 281 L<virt-cat(1)>,
 282 L<virt-edit(1)>,
 283 L<virt-tar(1)>,
 284 L<guestfs(3)>,
 285 L<http://libguestfs.org/>,
 286 L<http://fuse.sf.net/>.
 287
 288 =head1 AUTHORS
 289
 290 Richard W.M. Jones (C<rjones at redhat dot com>)
 291
 292 =head1 COPYRIGHT
 293
 294 Copyright (C) 2009-2010 Red Hat Inc.
 295 L<http://libguestfs.org/>
 296
 297 This program is free software; you can redistribute it and/or modify
 298 it under the terms of the GNU General Public License as published by
 299 the Free Software Foundation; either version 2 of the License, or
 300 (at your option) any later version.
 301
 302 This program is distributed in the hope that it will be useful,
 303 but WITHOUT ANY WARRANTY; without even the implied warranty of
 304 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 305 GNU General Public License for more details.
 306
 307 You should have received a copy of the GNU General Public License
 308 along with this program; if not, write to the Free Software
 309 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.