1 =head2 add-cdrom | cdrom
5 This function adds a virtual CD-ROM disk image to the guest.
7 This is equivalent to the qemu parameter C<-cdrom filename>.
13 This function adds a virtual machine disk image C<filename> to the
14 guest. The first time you call this function, the disk appears as IDE
15 disk 0 (C</dev/sda>) in the guest, the second time as C</dev/sdb>, and
18 You don't necessarily need to be root when using libguestfs. However
19 you obviously do need sufficient permissions to access the filename
20 for whatever operations you want to perform (ie. read access if you
21 just want to read the image or write access if you want to modify the
24 This is equivalent to the qemu parameter C<-drive file=filename>.
30 Close the current Augeas handle and free up any resources
31 used by it. After calling this, you have to call
32 C<aug_init> again before you can use any other
37 aug-defnode name expr val
39 Defines a variable C<name> whose value is the result of
42 If C<expr> evaluates to an empty nodeset, a node is created,
43 equivalent to calling C<aug_set> C<expr>, C<value>.
44 C<name> will be the nodeset containing that single node.
46 On success this returns a pair containing the
47 number of nodes in the nodeset, and a boolean flag
48 if a node was created.
54 Defines an Augeas variable C<name> whose value is the result
55 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
58 On success this returns the number of nodes in C<expr>, or
59 C<0> if C<expr> evaluates to something which is not a nodeset.
65 Look up the value associated with C<path>. If C<path>
66 matches exactly one node, the C<value> is returned.
72 Create a new Augeas handle for editing configuration files.
73 If there was any previous Augeas handle associated with this
74 guestfs session, then it is closed.
76 You must call this before using any other C<aug_*>
79 C<root> is the filesystem root. C<root> must not be NULL,
82 The flags are the same as the flags defined in
83 E<lt>augeas.hE<gt>, the logical I<or> of the following
88 =item C<AUG_SAVE_BACKUP> = 1
90 Keep the original file with a C<.augsave> extension.
92 =item C<AUG_SAVE_NEWFILE> = 2
94 Save changes into a file with extension C<.augnew>, and
95 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
97 =item C<AUG_TYPE_CHECK> = 4
99 Typecheck lenses (can be expensive).
101 =item C<AUG_NO_STDINC> = 8
103 Do not use standard load path for modules.
105 =item C<AUG_SAVE_NOOP> = 16
107 Make save a no-op, just record what would have been changed.
109 =item C<AUG_NO_LOAD> = 32
111 Do not load the tree in C<aug_init>.
115 To close the handle, you can call C<aug_close>.
117 To find out more about Augeas, see L<http://augeas.net/>.
121 aug-insert path label true|false
123 Create a new sibling C<label> for C<path>, inserting it into
124 the tree before or after C<path> (depending on the boolean
127 C<path> must match exactly one existing node in the tree, and
128 C<label> must be a label, ie. not contain C</>, C<*> or end
129 with a bracketed index C<[N]>.
135 Load files into the tree.
137 See C<aug_load> in the Augeas documentation for the full gory
144 This is just a shortcut for listing C<aug_match>
145 C<path/*> and sorting the resulting nodes into alphabetical order.
151 Returns a list of paths which match the path expression C<path>.
152 The returned paths are sufficiently qualified so that they match
153 exactly one node in the current tree.
159 Move the node C<src> to C<dest>. C<src> must match exactly
160 one node. C<dest> is overwritten if it exists.
166 Remove C<path> and all of its children.
168 On success this returns the number of entries which were removed.
174 This writes all pending changes to disk.
176 The flags which were passed to C<aug_init> affect exactly
183 Set the value associated with C<path> to C<value>.
185 =head2 blockdev-flushbufs
187 blockdev-flushbufs device
189 This tells the kernel to flush internal buffers associated
192 This uses the L<blockdev(8)> command.
194 =head2 blockdev-getbsz
196 blockdev-getbsz device
198 This returns the block size of a device.
200 (Note this is different from both I<size in blocks> and
201 I<filesystem block size>).
203 This uses the L<blockdev(8)> command.
205 =head2 blockdev-getro
207 blockdev-getro device
209 Returns a boolean indicating if the block device is read-only
210 (true if read-only, false if not).
212 This uses the L<blockdev(8)> command.
214 =head2 blockdev-getsize64
216 blockdev-getsize64 device
218 This returns the size of the device in bytes.
220 See also C<blockdev_getsz>.
222 This uses the L<blockdev(8)> command.
224 =head2 blockdev-getss
226 blockdev-getss device
228 This returns the size of sectors on a block device.
229 Usually 512, but can be larger for modern devices.
231 (Note, this is not the size in sectors, use C<blockdev_getsz>
234 This uses the L<blockdev(8)> command.
236 =head2 blockdev-getsz
238 blockdev-getsz device
240 This returns the size of the device in units of 512-byte sectors
241 (even if the sectorsize isn't 512 bytes ... weird).
243 See also C<blockdev_getss> for the real sector size of
244 the device, and C<blockdev_getsize64> for the more
245 useful I<size in bytes>.
247 This uses the L<blockdev(8)> command.
249 =head2 blockdev-rereadpt
251 blockdev-rereadpt device
253 Reread the partition table on C<device>.
255 This uses the L<blockdev(8)> command.
257 =head2 blockdev-setbsz
259 blockdev-setbsz device blocksize
261 This sets the block size of a device.
263 (Note this is different from both I<size in blocks> and
264 I<filesystem block size>).
266 This uses the L<blockdev(8)> command.
268 =head2 blockdev-setro
270 blockdev-setro device
272 Sets the block device named C<device> to read-only.
274 This uses the L<blockdev(8)> command.
276 =head2 blockdev-setrw
278 blockdev-setrw device
280 Sets the block device named C<device> to read-write.
282 This uses the L<blockdev(8)> command.
288 Return the contents of the file named C<path>.
290 Note that this function cannot correctly handle binary files
291 (specifically, files containing C<\0> character which is treated
292 as end of string). For those you need to use the C<download>
293 function which has a more complex interface.
295 Because of the message protocol, there is a transfer limit
296 of somewhere between 2MB and 4MB. To transfer large files you should use
303 Change the mode (permissions) of C<path> to C<mode>. Only
304 numeric modes are supported.
308 chown owner group path
310 Change the file owner to C<owner> and group to C<group>.
312 Only numeric uid and gid are supported. If you want to use
313 names, you will need to locate and parse the password file
314 yourself (Augeas support makes this relatively easy).
318 command arguments,...
320 This call runs a command from the guest filesystem. The
321 filesystem must be mounted, and must contain a compatible
322 operating system (ie. something Linux, with the same
323 or compatible processor architecture).
325 The single parameter is an argv-style list of arguments.
326 The first element is the name of the program to run.
327 Subsequent elements are parameters. The list must be
328 non-empty (ie. must contain a program name).
330 The C<$PATH> environment variable will contain at least
331 C</usr/bin> and C</bin>. If you require a program from
332 another location, you should provide the full path in the
335 Shared libraries and data files required by the program
336 must be available on filesystems which are mounted in the
337 correct places. It is the caller's responsibility to ensure
338 all filesystems that are needed are mounted at the right
343 command-lines arguments,...
345 This is the same as C<command>, but splits the
346 result into a list of lines.
350 config qemuparam qemuvalue
352 This can be used to add arbitrary qemu command line parameters
353 of the form C<-param value>. Actually it's not quite arbitrary - we
354 prevent you from setting some parameters which would interfere with
355 parameters that we use.
357 The first character of C<param> string must be a C<-> (dash).
359 C<value> can be NULL.
363 download remotefilename (filename|-)
365 Download file C<remotefilename> and save it as C<filename>
366 on the local machine.
368 C<filename> can also be a named pipe.
370 See also C<upload>, C<cat>.
372 Use C<-> instead of a filename to read/write from stdin/stdout.
378 This returns C<true> if and only if there is a file, directory
379 (or anything) with the given C<path> name.
381 See also C<is_file>, C<is_dir>, C<stat>.
387 This call uses the standard L<file(1)> command to determine
388 the type or contents of the file. This also works on devices,
389 for example to find out whether a partition contains a filesystem.
391 The exact command which runs is C<file -bsL path>. Note in
392 particular that the filename is not prepended to the output
399 Get the autosync flag.
405 Return the current search path.
407 This is always non-NULL. If it wasn't set already, then this will
408 return the default path.
414 This returns the current state as an opaque integer. This is
415 only useful for printing debug and internal error messages.
417 For more information on states, see L<guestfs(3)>.
423 This returns the verbose messages flag.
429 This returns true iff this handle is busy processing a command
430 (in the C<BUSY> state).
432 For more information on states, see L<guestfs(3)>.
438 This returns true iff this handle is being configured
439 (in the C<CONFIG> state).
441 For more information on states, see L<guestfs(3)>.
447 This returns C<true> if and only if there is a directory
448 with the given C<path> name. Note that it returns false for
449 other objects like files.
457 This returns C<true> if and only if there is a file
458 with the given C<path> name. Note that it returns false for
459 other objects like directories.
467 This returns true iff this handle is launching the subprocess
468 (in the C<LAUNCHING> state).
470 For more information on states, see L<guestfs(3)>.
476 This returns true iff this handle is ready to accept commands
477 (in the C<READY> state).
479 For more information on states, see L<guestfs(3)>.
481 =head2 kill-subprocess
485 This kills the qemu subprocess. You should never need to call this.
491 Internally libguestfs is implemented by running a virtual machine
494 You should call this after configuring the handle
495 (eg. adding drives) but before performing any actions.
501 List all the block devices.
503 The full block device names are returned, eg. C</dev/sda>
505 =head2 list-partitions
509 List all the partitions detected on all block devices.
511 The full partition device names are returned, eg. C</dev/sda1>
513 This does not return logical volumes. For that you will need to
520 List the files in C<directory> (relative to the root directory,
521 there is no cwd) in the format of 'ls -la'.
523 This command is mostly useful for interactive sessions. It
524 is I<not> intended that you try to parse the output string.
530 List the files in C<directory> (relative to the root directory,
531 there is no cwd). The '.' and '..' entries are not returned, but
532 hidden files are shown.
534 This command is mostly useful for interactive sessions. Programs
535 should probably use C<readdir> instead.
541 Returns file information for the given C<path>.
543 This is the same as C<stat> except that if C<path>
544 is a symbolic link, then the link is stat-ed, not the file it
547 This is the same as the C<lstat(2)> system call.
551 lvcreate logvol volgroup mbytes
553 This creates an LVM volume group called C<logvol>
554 on the volume group C<volgroup>, with C<size> megabytes.
556 =head2 lvm-remove-all
560 This command removes all LVM logical volumes, volume groups
561 and physical volumes.
563 B<This command is dangerous. Without careful use you
564 can easily destroy all your data>.
570 List all the logical volumes detected. This is the equivalent
571 of the L<lvs(8)> command.
573 This returns a list of the logical volume device names
574 (eg. C</dev/VolGroup00/LogVol00>).
576 See also C<lvs_full>.
582 List all the logical volumes detected. This is the equivalent
583 of the L<lvs(8)> command. The "full" version includes all fields.
589 Create a directory named C<path>.
595 Create a directory named C<path>, creating any parent directories
596 as necessary. This is like the C<mkdir -p> shell command.
602 This creates a filesystem on C<device> (usually a partition
603 of LVM logical volume). The filesystem type is C<fstype>, for
608 mount device mountpoint
610 Mount a guest disk at a position in the filesystem. Block devices
611 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
612 the guest. If those block devices contain partitions, they will have
613 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
616 The rules are the same as for L<mount(2)>: A filesystem must
617 first be mounted on C</> before others can be mounted. Other
618 filesystems can only be mounted on directories which already
621 The mounted filesystem is writable, if we have sufficient permissions
622 on the underlying device.
624 The filesystem options C<sync> and C<noatime> are set with this
625 call, in order to improve reliability.
631 This returns the list of currently mounted filesystems. It returns
632 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
634 Some internal mounts are not shown.
640 This creates an LVM physical volume on the named C<device>,
641 where C<device> should usually be a partition name such
648 List all the physical volumes detected. This is the equivalent
649 of the L<pvs(8)> command.
651 This returns a list of just the device names that contain
652 PVs (eg. C</dev/sda2>).
654 See also C<pvs_full>.
660 List all the physical volumes detected. This is the equivalent
661 of the L<pvs(8)> command. The "full" version includes all fields.
667 Return the contents of the file named C<path>.
669 The file contents are returned as a list of lines. Trailing
670 C<LF> and C<CRLF> character sequences are I<not> returned.
672 Note that this function cannot correctly handle binary files
673 (specifically, files containing C<\0> character which is treated
674 as end of line). For those you need to use the C<read_file>
675 function which has a more complex interface.
681 Remove the single file C<path>.
687 Remove the file or directory C<path>, recursively removing the
688 contents if its a directory. This is like the C<rm -rf> shell
695 Remove the single directory C<path>.
697 =head2 set-autosync | autosync
699 set-autosync true|false
701 If C<autosync> is true, this enables autosync. Libguestfs will make a
702 best effort attempt to run C<sync> when the handle is closed
703 (also if the program exits without closing handles).
705 =head2 set-path | path
709 Set the path that libguestfs searches for kernel and initrd.img.
711 The default is C<$libdir/guestfs> unless overridden by setting
712 C<LIBGUESTFS_PATH> environment variable.
714 The string C<path> is stashed in the libguestfs handle, so the caller
715 must make sure it remains valid for the lifetime of the handle.
717 Setting C<path> to C<NULL> restores the default path.
719 =head2 set-verbose | verbose
721 set-verbose true|false
723 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
725 Verbose messages are disabled unless the environment variable
726 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.
730 sfdisk device cyls heads sectors lines,...
732 This is a direct interface to the L<sfdisk(8)> program for creating
733 partitions on block devices.
735 C<device> should be a block device, for example C</dev/sda>.
737 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
738 and sectors on the device, which are passed directly to sfdisk as
739 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
740 of these, then the corresponding parameter is omitted. Usually for
741 'large' disks, you can just pass C<0> for these, but for small
742 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
743 out the right geometry and you will need to tell it.
745 C<lines> is a list of lines that we feed to C<sfdisk>. For more
746 information refer to the L<sfdisk(8)> manpage.
748 To create a single partition occupying the whole disk, you would
749 pass C<lines> as a single element list, when the single element being
750 the string C<,> (comma).
752 B<This command is dangerous. Without careful use you
753 can easily destroy all your data>.
759 Returns file information for the given C<path>.
761 This is the same as the C<stat(2)> system call.
767 Returns file system statistics for any mounted file system.
768 C<path> should be a file or directory in the mounted file system
769 (typically it is the mount point itself, but it doesn't need to be).
771 This is the same as the C<statvfs(2)> system call.
777 This syncs the disk, so that any writes are flushed through to the
778 underlying disk image.
780 You should always call this if you have modified a disk image, before
787 Touch acts like the L<touch(1)> command. It can be used to
788 update the timestamps on a file, or, if the file does not exist,
789 to create a new zero-length file.
795 This returns the contents of the ext2 or ext3 filesystem superblock
798 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
799 manpage for more details. The list of fields returned isn't
800 clearly defined, and depends on both the version of C<tune2fs>
801 that libguestfs was built against, and the filesystem itself.
803 =head2 umount | unmount
807 This unmounts the given filesystem. The filesystem may be
808 specified either by its mountpoint (path) or the device which
809 contains the filesystem.
811 =head2 umount-all | unmount-all
815 This unmounts all mounted filesystems.
817 Some internal mounts are not unmounted by this call.
821 upload (filename|-) remotefilename
823 Upload local file C<filename> to C<remotefilename> on the
826 C<filename> can also be a named pipe.
828 See also C<download>.
830 Use C<-> instead of a filename to read/write from stdin/stdout.
834 vgcreate volgroup physvols,...
836 This creates an LVM volume group called C<volgroup>
837 from the non-empty list of physical volumes C<physvols>.
843 List all the volumes groups detected. This is the equivalent
844 of the L<vgs(8)> command.
846 This returns a list of just the volume group names that were
847 detected (eg. C<VolGroup00>).
849 See also C<vgs_full>.
855 List all the volumes groups detected. This is the equivalent
856 of the L<vgs(8)> command. The "full" version includes all fields.
860 write-file path content size
862 This call creates a file called C<path>. The contents of the
863 file is the string C<content> (which can contain any 8 bit data),
866 As a special case, if C<size> is C<0>
867 then the length is calculated using C<strlen> (so in this case
868 the content cannot contain embedded ASCII NULs).
870 Because of the message protocol, there is a transfer limit
871 of somewhere between 2MB and 4MB. To transfer large files you should use