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.
200 Change the mode (permissions) of C<path> to C<mode>. Only
201 numeric modes are supported.
205 chown owner group path
207 Change the file owner to C<owner> and group to C<group>.
209 Only numeric uid and gid are supported. If you want to use
210 names, you will need to locate and parse the password file
211 yourself (Augeas support makes this relatively easy).
215 config qemuparam qemuvalue
217 This can be used to add arbitrary qemu command line parameters
218 of the form C<-param value>. Actually it's not quite arbitrary - we
219 prevent you from setting some parameters which would interfere with
220 parameters that we use.
222 The first character of C<param> string must be a C<-> (dash).
224 C<value> can be NULL.
230 Get the autosync flag.
236 Return the current search path.
238 This is always non-NULL. If it wasn't set already, then this will
239 return the default path.
245 This returns the verbose messages flag.
247 =head2 kill-subprocess
251 This kills the qemu subprocess. You should never need to call this.
257 Internally libguestfs is implemented by running a virtual machine
260 You should call this after configuring the handle
261 (eg. adding drives) but before performing any actions.
267 List all the block devices.
269 The full block device names are returned, eg. C</dev/sda>
271 =head2 list-partitions
275 List all the partitions detected on all block devices.
277 The full partition device names are returned, eg. C</dev/sda1>
279 This does not return logical volumes. For that you will need to
286 List the files in C<directory> (relative to the root directory,
287 there is no cwd) in the format of 'ls -la'.
289 This command is mostly useful for interactive sessions. It
290 is I<not> intended that you try to parse the output string.
296 List the files in C<directory> (relative to the root directory,
297 there is no cwd). The '.' and '..' entries are not returned, but
298 hidden files are shown.
300 This command is mostly useful for interactive sessions. Programs
301 should probably use C<readdir> instead.
307 List all the logical volumes detected. This is the equivalent
308 of the L<lvs(8)> command.
310 This returns a list of the logical volume device names
311 (eg. C</dev/VolGroup00/LogVol00>).
313 See also C<lvs_full>.
319 List all the logical volumes detected. This is the equivalent
320 of the L<lvs(8)> command. The "full" version includes all fields.
326 Create a directory named C<path>.
332 Create a directory named C<path>, creating any parent directories
333 as necessary. This is like the C<mkdir -p> shell command.
337 mount device mountpoint
339 Mount a guest disk at a position in the filesystem. Block devices
340 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
341 the guest. If those block devices contain partitions, they will have
342 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
345 The rules are the same as for L<mount(2)>: A filesystem must
346 first be mounted on C</> before others can be mounted. Other
347 filesystems can only be mounted on directories which already
350 The mounted filesystem is writable, if we have sufficient permissions
351 on the underlying device.
353 The filesystem options C<sync> and C<noatime> are set with this
354 call, in order to improve reliability.
360 List all the physical volumes detected. This is the equivalent
361 of the L<pvs(8)> command.
363 This returns a list of just the device names that contain
364 PVs (eg. C</dev/sda2>).
366 See also C<pvs_full>.
372 List all the physical volumes detected. This is the equivalent
373 of the L<pvs(8)> command. The "full" version includes all fields.
379 Return the contents of the file named C<path>.
381 The file contents are returned as a list of lines. Trailing
382 C<LF> and C<CRLF> character sequences are I<not> returned.
384 Note that this function cannot correctly handle binary files
385 (specifically, files containing C<\0> character which is treated
386 as end of line). For those you need to use the C<read_file>
387 function which has a more complex interface.
393 Remove the single file C<path>.
399 Remove the file or directory C<path>, recursively removing the
400 contents if its a directory. This is like the C<rm -rf> shell
407 Remove the single directory C<path>.
409 =head2 set-autosync | autosync
411 set-autosync true|false
413 If C<autosync> is true, this enables autosync. Libguestfs will make a
414 best effort attempt to run C<sync> when the handle is closed
415 (also if the program exits without closing handles).
417 =head2 set-path | path
421 Set the path that libguestfs searches for kernel and initrd.img.
423 The default is C<$libdir/guestfs> unless overridden by setting
424 C<LIBGUESTFS_PATH> environment variable.
426 The string C<path> is stashed in the libguestfs handle, so the caller
427 must make sure it remains valid for the lifetime of the handle.
429 Setting C<path> to C<NULL> restores the default path.
431 =head2 set-verbose | verbose
433 set-verbose true|false
435 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
437 Verbose messages are disabled unless the environment variable
438 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.
444 This syncs the disk, so that any writes are flushed through to the
445 underlying disk image.
447 You should always call this if you have modified a disk image, before
454 Touch acts like the L<touch(1)> command. It can be used to
455 update the timestamps on a file, or, if the file does not exist,
456 to create a new zero-length file.
462 List all the volumes groups detected. This is the equivalent
463 of the L<vgs(8)> command.
465 This returns a list of just the volume group names that were
466 detected (eg. C<VolGroup00>).
468 See also C<vgs_full>.
474 List all the volumes groups detected. This is the equivalent
475 of the L<vgs(8)> command. The "full" version includes all fields.