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>.
189 Return the contents of the file named C<path>.
191 Note that this function cannot correctly handle binary files
192 (specifically, files containing C<\0> character which is treated
193 as end of string). For those you need to use the C<read_file>
194 function which has a more complex interface.
196 Because of the message protocol, there is a transfer limit
197 of somewhere between 2MB and 4MB. To transfer large files you should use
204 Change the mode (permissions) of C<path> to C<mode>. Only
205 numeric modes are supported.
209 chown owner group path
211 Change the file owner to C<owner> and group to C<group>.
213 Only numeric uid and gid are supported. If you want to use
214 names, you will need to locate and parse the password file
215 yourself (Augeas support makes this relatively easy).
219 command arguments,...
221 This call runs a command from the guest filesystem. The
222 filesystem must be mounted, and must contain a compatible
223 operating system (ie. something Linux, with the same
224 or compatible processor architecture).
226 The single parameter is an argv-style list of arguments.
227 The first element is the name of the program to run.
228 Subsequent elements are parameters. The list must be
229 non-empty (ie. must contain a program name).
231 The C<$PATH> environment variable will contain at least
232 C</usr/bin> and C</bin>. If you require a program from
233 another location, you should provide the full path in the
236 Shared libraries and data files required by the program
237 must be available on filesystems which are mounted in the
238 correct places. It is the caller's responsibility to ensure
239 all filesystems that are needed are mounted at the right
244 command-lines arguments,...
246 This is the same as C<command>, but splits the
247 result into a list of lines.
251 config qemuparam qemuvalue
253 This can be used to add arbitrary qemu command line parameters
254 of the form C<-param value>. Actually it's not quite arbitrary - we
255 prevent you from setting some parameters which would interfere with
256 parameters that we use.
258 The first character of C<param> string must be a C<-> (dash).
260 C<value> can be NULL.
266 This returns C<true> if and only if there is a file, directory
267 (or anything) with the given C<path> name.
269 See also C<is_file>, C<is_dir>, C<stat>.
275 This call uses the standard L<file(1)> command to determine
276 the type or contents of the file. This also works on devices,
277 for example to find out whether a partition contains a filesystem.
279 The exact command which runs is C<file -bsL path>. Note in
280 particular that the filename is not prepended to the output
287 Get the autosync flag.
293 Return the current search path.
295 This is always non-NULL. If it wasn't set already, then this will
296 return the default path.
302 This returns the verbose messages flag.
308 This returns C<true> if and only if there is a directory
309 with the given C<path> name. Note that it returns false for
310 other objects like files.
318 This returns C<true> if and only if there is a file
319 with the given C<path> name. Note that it returns false for
320 other objects like directories.
324 =head2 kill-subprocess
328 This kills the qemu subprocess. You should never need to call this.
334 Internally libguestfs is implemented by running a virtual machine
337 You should call this after configuring the handle
338 (eg. adding drives) but before performing any actions.
344 List all the block devices.
346 The full block device names are returned, eg. C</dev/sda>
348 =head2 list-partitions
352 List all the partitions detected on all block devices.
354 The full partition device names are returned, eg. C</dev/sda1>
356 This does not return logical volumes. For that you will need to
363 List the files in C<directory> (relative to the root directory,
364 there is no cwd) in the format of 'ls -la'.
366 This command is mostly useful for interactive sessions. It
367 is I<not> intended that you try to parse the output string.
373 List the files in C<directory> (relative to the root directory,
374 there is no cwd). The '.' and '..' entries are not returned, but
375 hidden files are shown.
377 This command is mostly useful for interactive sessions. Programs
378 should probably use C<readdir> instead.
384 Returns file information for the given C<path>.
386 This is the same as C<stat> except that if C<path>
387 is a symbolic link, then the link is stat-ed, not the file it
390 This is the same as the C<lstat(2)> system call.
394 lvcreate logvol volgroup mbytes
396 This creates an LVM volume group called C<logvol>
397 on the volume group C<volgroup>, with C<size> megabytes.
399 =head2 lvm-remove-all
403 This command removes all LVM logical volumes, volume groups
404 and physical volumes.
406 B<This command is dangerous. Without careful use you
407 can easily destroy all your data>.
413 List all the logical volumes detected. This is the equivalent
414 of the L<lvs(8)> command.
416 This returns a list of the logical volume device names
417 (eg. C</dev/VolGroup00/LogVol00>).
419 See also C<lvs_full>.
425 List all the logical volumes detected. This is the equivalent
426 of the L<lvs(8)> command. The "full" version includes all fields.
432 Create a directory named C<path>.
438 Create a directory named C<path>, creating any parent directories
439 as necessary. This is like the C<mkdir -p> shell command.
445 This creates a filesystem on C<device> (usually a partition
446 of LVM logical volume). The filesystem type is C<fstype>, for
451 mount device mountpoint
453 Mount a guest disk at a position in the filesystem. Block devices
454 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
455 the guest. If those block devices contain partitions, they will have
456 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
459 The rules are the same as for L<mount(2)>: A filesystem must
460 first be mounted on C</> before others can be mounted. Other
461 filesystems can only be mounted on directories which already
464 The mounted filesystem is writable, if we have sufficient permissions
465 on the underlying device.
467 The filesystem options C<sync> and C<noatime> are set with this
468 call, in order to improve reliability.
474 This returns the list of currently mounted filesystems. It returns
475 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
477 Some internal mounts are not shown.
483 This creates an LVM physical volume on the named C<device>,
484 where C<device> should usually be a partition name such
491 List all the physical volumes detected. This is the equivalent
492 of the L<pvs(8)> command.
494 This returns a list of just the device names that contain
495 PVs (eg. C</dev/sda2>).
497 See also C<pvs_full>.
503 List all the physical volumes detected. This is the equivalent
504 of the L<pvs(8)> command. The "full" version includes all fields.
510 Return the contents of the file named C<path>.
512 The file contents are returned as a list of lines. Trailing
513 C<LF> and C<CRLF> character sequences are I<not> returned.
515 Note that this function cannot correctly handle binary files
516 (specifically, files containing C<\0> character which is treated
517 as end of line). For those you need to use the C<read_file>
518 function which has a more complex interface.
524 Remove the single file C<path>.
530 Remove the file or directory C<path>, recursively removing the
531 contents if its a directory. This is like the C<rm -rf> shell
538 Remove the single directory C<path>.
540 =head2 set-autosync | autosync
542 set-autosync true|false
544 If C<autosync> is true, this enables autosync. Libguestfs will make a
545 best effort attempt to run C<sync> when the handle is closed
546 (also if the program exits without closing handles).
548 =head2 set-path | path
552 Set the path that libguestfs searches for kernel and initrd.img.
554 The default is C<$libdir/guestfs> unless overridden by setting
555 C<LIBGUESTFS_PATH> environment variable.
557 The string C<path> is stashed in the libguestfs handle, so the caller
558 must make sure it remains valid for the lifetime of the handle.
560 Setting C<path> to C<NULL> restores the default path.
562 =head2 set-verbose | verbose
564 set-verbose true|false
566 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
568 Verbose messages are disabled unless the environment variable
569 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.
573 sfdisk device cyls heads sectors lines,...
575 This is a direct interface to the L<sfdisk(8)> program for creating
576 partitions on block devices.
578 C<device> should be a block device, for example C</dev/sda>.
580 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
581 and sectors on the device, which are passed directly to sfdisk as
582 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
583 of these, then the corresponding parameter is omitted. Usually for
584 'large' disks, you can just pass C<0> for these, but for small
585 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
586 out the right geometry and you will need to tell it.
588 C<lines> is a list of lines that we feed to C<sfdisk>. For more
589 information refer to the L<sfdisk(8)> manpage.
591 To create a single partition occupying the whole disk, you would
592 pass C<lines> as a single element list, when the single element being
593 the string C<,> (comma).
595 B<This command is dangerous. Without careful use you
596 can easily destroy all your data>.
602 Returns file information for the given C<path>.
604 This is the same as the C<stat(2)> system call.
610 Returns file system statistics for any mounted file system.
611 C<path> should be a file or directory in the mounted file system
612 (typically it is the mount point itself, but it doesn't need to be).
614 This is the same as the C<statvfs(2)> system call.
620 This syncs the disk, so that any writes are flushed through to the
621 underlying disk image.
623 You should always call this if you have modified a disk image, before
630 Touch acts like the L<touch(1)> command. It can be used to
631 update the timestamps on a file, or, if the file does not exist,
632 to create a new zero-length file.
634 =head2 umount | unmount
638 This unmounts the given filesystem. The filesystem may be
639 specified either by its mountpoint (path) or the device which
640 contains the filesystem.
642 =head2 umount-all | unmount-all
646 This unmounts all mounted filesystems.
648 Some internal mounts are not unmounted by this call.
652 vgcreate volgroup physvols,...
654 This creates an LVM volume group called C<volgroup>
655 from the non-empty list of physical volumes C<physvols>.
661 List all the volumes groups detected. This is the equivalent
662 of the L<vgs(8)> command.
664 This returns a list of just the volume group names that were
665 detected (eg. C<VolGroup00>).
667 See also C<vgs_full>.
673 List all the volumes groups detected. This is the equivalent
674 of the L<vgs(8)> command. The "full" version includes all fields.
678 write-file path content size
680 This call creates a file called C<path>. The contents of the
681 file is the string C<content> (which can contain any 8 bit data),
684 As a special case, if C<size> is C<0>
685 then the length is calculated using C<strlen> (so in this case
686 the content cannot contain embedded ASCII NULs).
688 Because of the message protocol, there is a transfer limit
689 of somewhere between 2MB and 4MB. To transfer large files you should use