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 config qemuparam qemuvalue
221 This can be used to add arbitrary qemu command line parameters
222 of the form C<-param value>. Actually it's not quite arbitrary - we
223 prevent you from setting some parameters which would interfere with
224 parameters that we use.
226 The first character of C<param> string must be a C<-> (dash).
228 C<value> can be NULL.
234 This returns C<true> if and only if there is a file, directory
235 (or anything) with the given C<path> name.
237 See also C<is_file>, C<is_dir>, C<stat>.
243 Get the autosync flag.
249 Return the current search path.
251 This is always non-NULL. If it wasn't set already, then this will
252 return the default path.
258 This returns the verbose messages flag.
264 This returns C<true> if and only if there is a directory
265 with the given C<path> name. Note that it returns false for
266 other objects like files.
274 This returns C<true> if and only if there is a file
275 with the given C<path> name. Note that it returns false for
276 other objects like directories.
280 =head2 kill-subprocess
284 This kills the qemu subprocess. You should never need to call this.
290 Internally libguestfs is implemented by running a virtual machine
293 You should call this after configuring the handle
294 (eg. adding drives) but before performing any actions.
300 List all the block devices.
302 The full block device names are returned, eg. C</dev/sda>
304 =head2 list-partitions
308 List all the partitions detected on all block devices.
310 The full partition device names are returned, eg. C</dev/sda1>
312 This does not return logical volumes. For that you will need to
319 List the files in C<directory> (relative to the root directory,
320 there is no cwd) in the format of 'ls -la'.
322 This command is mostly useful for interactive sessions. It
323 is I<not> intended that you try to parse the output string.
329 List the files in C<directory> (relative to the root directory,
330 there is no cwd). The '.' and '..' entries are not returned, but
331 hidden files are shown.
333 This command is mostly useful for interactive sessions. Programs
334 should probably use C<readdir> instead.
338 lvcreate logvol volgroup mbytes
340 This creates an LVM volume group called C<logvol>
341 on the volume group C<volgroup>, with C<size> megabytes.
343 =head2 lvm-remove-all
347 This command removes all LVM logical volumes, volume groups
348 and physical volumes.
350 B<This command is dangerous. Without careful use you
351 can easily destroy all your data>.
357 List all the logical volumes detected. This is the equivalent
358 of the L<lvs(8)> command.
360 This returns a list of the logical volume device names
361 (eg. C</dev/VolGroup00/LogVol00>).
363 See also C<lvs_full>.
369 List all the logical volumes detected. This is the equivalent
370 of the L<lvs(8)> command. The "full" version includes all fields.
376 Create a directory named C<path>.
382 Create a directory named C<path>, creating any parent directories
383 as necessary. This is like the C<mkdir -p> shell command.
389 This creates a filesystem on C<device> (usually a partition
390 of LVM logical volume). The filesystem type is C<fstype>, for
395 mount device mountpoint
397 Mount a guest disk at a position in the filesystem. Block devices
398 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
399 the guest. If those block devices contain partitions, they will have
400 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
403 The rules are the same as for L<mount(2)>: A filesystem must
404 first be mounted on C</> before others can be mounted. Other
405 filesystems can only be mounted on directories which already
408 The mounted filesystem is writable, if we have sufficient permissions
409 on the underlying device.
411 The filesystem options C<sync> and C<noatime> are set with this
412 call, in order to improve reliability.
418 This returns the list of currently mounted filesystems. It returns
419 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
421 Some internal mounts are not shown.
427 This creates an LVM physical volume on the named C<device>,
428 where C<device> should usually be a partition name such
435 List all the physical volumes detected. This is the equivalent
436 of the L<pvs(8)> command.
438 This returns a list of just the device names that contain
439 PVs (eg. C</dev/sda2>).
441 See also C<pvs_full>.
447 List all the physical volumes detected. This is the equivalent
448 of the L<pvs(8)> command. The "full" version includes all fields.
454 Return the contents of the file named C<path>.
456 The file contents are returned as a list of lines. Trailing
457 C<LF> and C<CRLF> character sequences are I<not> returned.
459 Note that this function cannot correctly handle binary files
460 (specifically, files containing C<\0> character which is treated
461 as end of line). For those you need to use the C<read_file>
462 function which has a more complex interface.
468 Remove the single file C<path>.
474 Remove the file or directory C<path>, recursively removing the
475 contents if its a directory. This is like the C<rm -rf> shell
482 Remove the single directory C<path>.
484 =head2 set-autosync | autosync
486 set-autosync true|false
488 If C<autosync> is true, this enables autosync. Libguestfs will make a
489 best effort attempt to run C<sync> when the handle is closed
490 (also if the program exits without closing handles).
492 =head2 set-path | path
496 Set the path that libguestfs searches for kernel and initrd.img.
498 The default is C<$libdir/guestfs> unless overridden by setting
499 C<LIBGUESTFS_PATH> environment variable.
501 The string C<path> is stashed in the libguestfs handle, so the caller
502 must make sure it remains valid for the lifetime of the handle.
504 Setting C<path> to C<NULL> restores the default path.
506 =head2 set-verbose | verbose
508 set-verbose true|false
510 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
512 Verbose messages are disabled unless the environment variable
513 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.
517 sfdisk device cyls heads sectors lines,...
519 This is a direct interface to the L<sfdisk(8)> program for creating
520 partitions on block devices.
522 C<device> should be a block device, for example C</dev/sda>.
524 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
525 and sectors on the device, which are passed directly to sfdisk as
526 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
527 of these, then the corresponding parameter is omitted. Usually for
528 'large' disks, you can just pass C<0> for these, but for small
529 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
530 out the right geometry and you will need to tell it.
532 C<lines> is a list of lines that we feed to C<sfdisk>. For more
533 information refer to the L<sfdisk(8)> manpage.
535 To create a single partition occupying the whole disk, you would
536 pass C<lines> as a single element list, when the single element being
537 the string C<,> (comma).
539 B<This command is dangerous. Without careful use you
540 can easily destroy all your data>.
546 This syncs the disk, so that any writes are flushed through to the
547 underlying disk image.
549 You should always call this if you have modified a disk image, before
556 Touch acts like the L<touch(1)> command. It can be used to
557 update the timestamps on a file, or, if the file does not exist,
558 to create a new zero-length file.
560 =head2 umount | unmount
564 This unmounts the given filesystem. The filesystem may be
565 specified either by its mountpoint (path) or the device which
566 contains the filesystem.
568 =head2 umount-all | unmount-all
572 This unmounts all mounted filesystems.
574 Some internal mounts are not unmounted by this call.
578 vgcreate volgroup physvols,...
580 This creates an LVM volume group called C<volgroup>
581 from the non-empty list of physical volumes C<physvols>.
587 List all the volumes groups detected. This is the equivalent
588 of the L<vgs(8)> command.
590 This returns a list of just the volume group names that were
591 detected (eg. C<VolGroup00>).
593 See also C<vgs_full>.
599 List all the volumes groups detected. This is the equivalent
600 of the L<vgs(8)> command. The "full" version includes all fields.
604 write-file path content size
606 This call creates a file called C<path>. The contents of the
607 file is the string C<content> (which can contain any 8 bit data),
610 As a special case, if C<size> is C<0>
611 then the length is calculated using C<strlen> (so in this case
612 the content cannot contain embedded ASCII NULs).
614 Because of the message protocol, there is a transfer limit
615 of somewhere between 2MB and 4MB. To transfer large files you should use