484599019cce936872ab1a64117978c13adcb0cb
[libguestfs.git] / guestfish-actions.pod
1 =head2 add-cdrom | cdrom
2
3  add-cdrom filename
4
5 This function adds a virtual CD-ROM disk image to the guest.
6
7 This is equivalent to the qemu parameter C<-cdrom filename>.
8
9 Note that this call checks for the existence of C<filename>.  This
10 stops you from specifying other types of drive which are supported
11 by qemu such as C<nbd:> and C<http:> URLs.  To specify those, use
12 the general C<config> call instead.
13
14 =head2 add-drive | add
15
16  add-drive filename
17
18 This function adds a virtual machine disk image C<filename> to the
19 guest.  The first time you call this function, the disk appears as IDE
20 disk 0 (C</dev/sda>) in the guest, the second time as C</dev/sdb>, and
21 so on.
22
23 You don't necessarily need to be root when using libguestfs.  However
24 you obviously do need sufficient permissions to access the filename
25 for whatever operations you want to perform (ie. read access if you
26 just want to read the image or write access if you want to modify the
27 image).
28
29 This is equivalent to the qemu parameter C<-drive file=filename>.
30
31 Note that this call checks for the existence of C<filename>.  This
32 stops you from specifying other types of drive which are supported
33 by qemu such as C<nbd:> and C<http:> URLs.  To specify those, use
34 the general C<config> call instead.
35
36 =head2 add-drive-ro | add-ro
37
38  add-drive-ro filename
39
40 This adds a drive in snapshot mode, making it effectively
41 read-only.
42
43 Note that writes to the device are allowed, and will be seen for
44 the duration of the guestfs handle, but they are written
45 to a temporary file which is discarded as soon as the guestfs
46 handle is closed.  We don't currently have any method to enable
47 changes to be committed, although qemu can support this.
48
49 This is equivalent to the qemu parameter
50 C<-drive file=filename,snapshot=on>.
51
52 Note that this call checks for the existence of C<filename>.  This
53 stops you from specifying other types of drive which are supported
54 by qemu such as C<nbd:> and C<http:> URLs.  To specify those, use
55 the general C<config> call instead.
56
57 =head2 aug-close
58
59  aug-close
60
61 Close the current Augeas handle and free up any resources
62 used by it.  After calling this, you have to call
63 C<aug-init> again before you can use any other
64 Augeas functions.
65
66 =head2 aug-defnode
67
68  aug-defnode name expr val
69
70 Defines a variable C<name> whose value is the result of
71 evaluating C<expr>.
72
73 If C<expr> evaluates to an empty nodeset, a node is created,
74 equivalent to calling C<aug-set> C<expr>, C<value>.
75 C<name> will be the nodeset containing that single node.
76
77 On success this returns a pair containing the
78 number of nodes in the nodeset, and a boolean flag
79 if a node was created.
80
81 =head2 aug-defvar
82
83  aug-defvar name expr
84
85 Defines an Augeas variable C<name> whose value is the result
86 of evaluating C<expr>.  If C<expr> is NULL, then C<name> is
87 undefined.
88
89 On success this returns the number of nodes in C<expr>, or
90 C<0> if C<expr> evaluates to something which is not a nodeset.
91
92 =head2 aug-get
93
94  aug-get path
95
96 Look up the value associated with C<path>.  If C<path>
97 matches exactly one node, the C<value> is returned.
98
99 =head2 aug-init
100
101  aug-init root flags
102
103 Create a new Augeas handle for editing configuration files.
104 If there was any previous Augeas handle associated with this
105 guestfs session, then it is closed.
106
107 You must call this before using any other C<aug-*>
108 commands.
109
110 C<root> is the filesystem root.  C<root> must not be NULL,
111 use C</> instead.
112
113 The flags are the same as the flags defined in
114 E<lt>augeas.hE<gt>, the logical I<or> of the following
115 integers:
116
117 =over 4
118
119 =item C<AUG_SAVE_BACKUP> = 1
120
121 Keep the original file with a C<.augsave> extension.
122
123 =item C<AUG_SAVE_NEWFILE> = 2
124
125 Save changes into a file with extension C<.augnew>, and
126 do not overwrite original.  Overrides C<AUG_SAVE_BACKUP>.
127
128 =item C<AUG_TYPE_CHECK> = 4
129
130 Typecheck lenses (can be expensive).
131
132 =item C<AUG_NO_STDINC> = 8
133
134 Do not use standard load path for modules.
135
136 =item C<AUG_SAVE_NOOP> = 16
137
138 Make save a no-op, just record what would have been changed.
139
140 =item C<AUG_NO_LOAD> = 32
141
142 Do not load the tree in C<aug-init>.
143
144 =back
145
146 To close the handle, you can call C<aug-close>.
147
148 To find out more about Augeas, see L<http://augeas.net/>.
149
150 =head2 aug-insert
151
152  aug-insert path label true|false
153
154 Create a new sibling C<label> for C<path>, inserting it into
155 the tree before or after C<path> (depending on the boolean
156 flag C<before>).
157
158 C<path> must match exactly one existing node in the tree, and
159 C<label> must be a label, ie. not contain C</>, C<*> or end
160 with a bracketed index C<[N]>.
161
162 =head2 aug-load
163
164  aug-load
165
166 Load files into the tree.
167
168 See C<aug_load> in the Augeas documentation for the full gory
169 details.
170
171 =head2 aug-ls
172
173  aug-ls path
174
175 This is just a shortcut for listing C<aug-match>
176 C<path/*> and sorting the resulting nodes into alphabetical order.
177
178 =head2 aug-match
179
180  aug-match path
181
182 Returns a list of paths which match the path expression C<path>.
183 The returned paths are sufficiently qualified so that they match
184 exactly one node in the current tree.
185
186 =head2 aug-mv
187
188  aug-mv src dest
189
190 Move the node C<src> to C<dest>.  C<src> must match exactly
191 one node.  C<dest> is overwritten if it exists.
192
193 =head2 aug-rm
194
195  aug-rm path
196
197 Remove C<path> and all of its children.
198
199 On success this returns the number of entries which were removed.
200
201 =head2 aug-save
202
203  aug-save
204
205 This writes all pending changes to disk.
206
207 The flags which were passed to C<aug-init> affect exactly
208 how files are saved.
209
210 =head2 aug-set
211
212  aug-set path val
213
214 Set the value associated with C<path> to C<value>.
215
216 =head2 blockdev-flushbufs
217
218  blockdev-flushbufs device
219
220 This tells the kernel to flush internal buffers associated
221 with C<device>.
222
223 This uses the L<blockdev(8)> command.
224
225 =head2 blockdev-getbsz
226
227  blockdev-getbsz device
228
229 This returns the block size of a device.
230
231 (Note this is different from both I<size in blocks> and
232 I<filesystem block size>).
233
234 This uses the L<blockdev(8)> command.
235
236 =head2 blockdev-getro
237
238  blockdev-getro device
239
240 Returns a boolean indicating if the block device is read-only
241 (true if read-only, false if not).
242
243 This uses the L<blockdev(8)> command.
244
245 =head2 blockdev-getsize64
246
247  blockdev-getsize64 device
248
249 This returns the size of the device in bytes.
250
251 See also C<blockdev-getsz>.
252
253 This uses the L<blockdev(8)> command.
254
255 =head2 blockdev-getss
256
257  blockdev-getss device
258
259 This returns the size of sectors on a block device.
260 Usually 512, but can be larger for modern devices.
261
262 (Note, this is not the size in sectors, use C<blockdev-getsz>
263 for that).
264
265 This uses the L<blockdev(8)> command.
266
267 =head2 blockdev-getsz
268
269  blockdev-getsz device
270
271 This returns the size of the device in units of 512-byte sectors
272 (even if the sectorsize isn't 512 bytes ... weird).
273
274 See also C<blockdev-getss> for the real sector size of
275 the device, and C<blockdev-getsize64> for the more
276 useful I<size in bytes>.
277
278 This uses the L<blockdev(8)> command.
279
280 =head2 blockdev-rereadpt
281
282  blockdev-rereadpt device
283
284 Reread the partition table on C<device>.
285
286 This uses the L<blockdev(8)> command.
287
288 =head2 blockdev-setbsz
289
290  blockdev-setbsz device blocksize
291
292 This sets the block size of a device.
293
294 (Note this is different from both I<size in blocks> and
295 I<filesystem block size>).
296
297 This uses the L<blockdev(8)> command.
298
299 =head2 blockdev-setro
300
301  blockdev-setro device
302
303 Sets the block device named C<device> to read-only.
304
305 This uses the L<blockdev(8)> command.
306
307 =head2 blockdev-setrw
308
309  blockdev-setrw device
310
311 Sets the block device named C<device> to read-write.
312
313 This uses the L<blockdev(8)> command.
314
315 =head2 cat
316
317  cat path
318
319 Return the contents of the file named C<path>.
320
321 Note that this function cannot correctly handle binary files
322 (specifically, files containing C<\0> character which is treated
323 as end of string).  For those you need to use the C<download>
324 function which has a more complex interface.
325
326 Because of the message protocol, there is a transfer limit 
327 of somewhere between 2MB and 4MB.  To transfer large files you should use
328 FTP.
329
330 =head2 checksum
331
332  checksum csumtype path
333
334 This call computes the MD5, SHAx or CRC checksum of the
335 file named C<path>.
336
337 The type of checksum to compute is given by the C<csumtype>
338 parameter which must have one of the following values:
339
340 =over 4
341
342 =item C<crc>
343
344 Compute the cyclic redundancy check (CRC) specified by POSIX
345 for the C<cksum> command.
346
347 =item C<md5>
348
349 Compute the MD5 hash (using the C<md5sum> program).
350
351 =item C<sha1>
352
353 Compute the SHA1 hash (using the C<sha1sum> program).
354
355 =item C<sha224>
356
357 Compute the SHA224 hash (using the C<sha224sum> program).
358
359 =item C<sha256>
360
361 Compute the SHA256 hash (using the C<sha256sum> program).
362
363 =item C<sha384>
364
365 Compute the SHA384 hash (using the C<sha384sum> program).
366
367 =item C<sha512>
368
369 Compute the SHA512 hash (using the C<sha512sum> program).
370
371 =back
372
373 The checksum is returned as a printable string.
374
375 =head2 chmod
376
377  chmod mode path
378
379 Change the mode (permissions) of C<path> to C<mode>.  Only
380 numeric modes are supported.
381
382 =head2 chown
383
384  chown owner group path
385
386 Change the file owner to C<owner> and group to C<group>.
387
388 Only numeric uid and gid are supported.  If you want to use
389 names, you will need to locate and parse the password file
390 yourself (Augeas support makes this relatively easy).
391
392 =head2 command
393
394  command 'arguments ...'
395
396 This call runs a command from the guest filesystem.  The
397 filesystem must be mounted, and must contain a compatible
398 operating system (ie. something Linux, with the same
399 or compatible processor architecture).
400
401 The single parameter is an argv-style list of arguments.
402 The first element is the name of the program to run.
403 Subsequent elements are parameters.  The list must be
404 non-empty (ie. must contain a program name).  Note that
405 the command runs directly, and is I<not> invoked via
406 the shell (see C<sh>).
407
408 The return value is anything printed to I<stdout> by
409 the command.
410
411 If the command returns a non-zero exit status, then
412 this function returns an error message.  The error message
413 string is the content of I<stderr> from the command.
414
415 The C<$PATH> environment variable will contain at least
416 C</usr/bin> and C</bin>.  If you require a program from
417 another location, you should provide the full path in the
418 first parameter.
419
420 Shared libraries and data files required by the program
421 must be available on filesystems which are mounted in the
422 correct places.  It is the caller's responsibility to ensure
423 all filesystems that are needed are mounted at the right
424 locations.
425
426 Because of the message protocol, there is a transfer limit 
427 of somewhere between 2MB and 4MB.  To transfer large files you should use
428 FTP.
429
430 =head2 command-lines
431
432  command-lines 'arguments ...'
433
434 This is the same as C<command>, but splits the
435 result into a list of lines.
436
437 See also: C<sh-lines>
438
439 Because of the message protocol, there is a transfer limit 
440 of somewhere between 2MB and 4MB.  To transfer large files you should use
441 FTP.
442
443 =head2 config
444
445  config qemuparam qemuvalue
446
447 This can be used to add arbitrary qemu command line parameters
448 of the form C<-param value>.  Actually it's not quite arbitrary - we
449 prevent you from setting some parameters which would interfere with
450 parameters that we use.
451
452 The first character of C<param> string must be a C<-> (dash).
453
454 C<value> can be NULL.
455
456 =head2 cp
457
458  cp src dest
459
460 This copies a file from C<src> to C<dest> where C<dest> is
461 either a destination filename or destination directory.
462
463 =head2 cp-a
464
465  cp-a src dest
466
467 This copies a file or directory from C<src> to C<dest>
468 recursively using the C<cp -a> command.
469
470 =head2 debug
471
472  debug subcmd 'extraargs ...'
473
474 The C<debug> command exposes some internals of
475 C<guestfsd> (the guestfs daemon) that runs inside the
476 qemu subprocess.
477
478 There is no comprehensive help for this command.  You have
479 to look at the file C<daemon/debug.c> in the libguestfs source
480 to find out what you can do.
481
482 =head2 dmesg
483
484  dmesg
485
486 This returns the kernel messages (C<dmesg> output) from
487 the guest kernel.  This is sometimes useful for extended
488 debugging of problems.
489
490 Another way to get the same information is to enable
491 verbose messages with C<set-verbose> or by setting
492 the environment variable C<LIBGUESTFS_DEBUG=1> before
493 running the program.
494
495 =head2 download
496
497  download remotefilename (filename|-)
498
499 Download file C<remotefilename> and save it as C<filename>
500 on the local machine.
501
502 C<filename> can also be a named pipe.
503
504 See also C<upload>, C<cat>.
505
506 Use C<-> instead of a filename to read/write from stdin/stdout.
507
508 =head2 drop-caches
509
510  drop-caches whattodrop
511
512 This instructs the guest kernel to drop its page cache,
513 and/or dentries and inode caches.  The parameter C<whattodrop>
514 tells the kernel what precisely to drop, see
515 L<http://linux-mm.org/Drop_Caches>
516
517 Setting C<whattodrop> to 3 should drop everything.
518
519 This automatically calls L<sync(2)> before the operation,
520 so that the maximum guest memory is freed.
521
522 =head2 e2fsck-f
523
524  e2fsck-f device
525
526 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
527 filesystem checker on C<device>, noninteractively (C<-p>),
528 even if the filesystem appears to be clean (C<-f>).
529
530 This command is only needed because of C<resize2fs>
531 (q.v.).  Normally you should use C<fsck>.
532
533 =head2 equal
534
535  equal file1 file2
536
537 This compares the two files C<file1> and C<file2> and returns
538 true if their content is exactly equal, or false otherwise.
539
540 The external L<cmp(1)> program is used for the comparison.
541
542 =head2 exists
543
544  exists path
545
546 This returns C<true> if and only if there is a file, directory
547 (or anything) with the given C<path> name.
548
549 See also C<is-file>, C<is-dir>, C<stat>.
550
551 =head2 file
552
553  file path
554
555 This call uses the standard L<file(1)> command to determine
556 the type or contents of the file.  This also works on devices,
557 for example to find out whether a partition contains a filesystem.
558
559 The exact command which runs is C<file -bsL path>.  Note in
560 particular that the filename is not prepended to the output
561 (the C<-b> option).
562
563 =head2 find
564
565  find directory
566
567 This command lists out all files and directories, recursively,
568 starting at C<directory>.  It is essentially equivalent to
569 running the shell command C<find directory -print> but some
570 post-processing happens on the output, described below.
571
572 This returns a list of strings I<without any prefix>.  Thus
573 if the directory structure was:
574
575  /tmp/a
576  /tmp/b
577  /tmp/c/d
578
579 then the returned list from C<find> C</tmp> would be
580 4 elements:
581
582  a
583  b
584  c
585  c/d
586
587 If C<directory> is not a directory, then this command returns
588 an error.
589
590 The returned list is sorted.
591
592 =head2 fsck
593
594  fsck fstype device
595
596 This runs the filesystem checker (fsck) on C<device> which
597 should have filesystem type C<fstype>.
598
599 The returned integer is the status.  See L<fsck(8)> for the
600 list of status codes from C<fsck>.
601
602 Notes:
603
604 =over 4
605
606 =item *
607
608 Multiple status codes can be summed together.
609
610 =item *
611
612 A non-zero return code can mean "success", for example if
613 errors have been corrected on the filesystem.
614
615 =item *
616
617 Checking or repairing NTFS volumes is not supported
618 (by linux-ntfs).
619
620 =back
621
622 This command is entirely equivalent to running C<fsck -a -t fstype device>.
623
624 =head2 get-append
625
626  get-append
627
628 Return the additional kernel options which are added to the
629 guest kernel command line.
630
631 If C<NULL> then no options are added.
632
633 =head2 get-autosync
634
635  get-autosync
636
637 Get the autosync flag.
638
639 =head2 get-e2label
640
641  get-e2label device
642
643 This returns the ext2/3/4 filesystem label of the filesystem on
644 C<device>.
645
646 =head2 get-e2uuid
647
648  get-e2uuid device
649
650 This returns the ext2/3/4 filesystem UUID of the filesystem on
651 C<device>.
652
653 =head2 get-path
654
655  get-path
656
657 Return the current search path.
658
659 This is always non-NULL.  If it wasn't set already, then this will
660 return the default path.
661
662 =head2 get-qemu
663
664  get-qemu
665
666 Return the current qemu binary.
667
668 This is always non-NULL.  If it wasn't set already, then this will
669 return the default qemu binary name.
670
671 =head2 get-state
672
673  get-state
674
675 This returns the current state as an opaque integer.  This is
676 only useful for printing debug and internal error messages.
677
678 For more information on states, see L<guestfs(3)>.
679
680 =head2 get-verbose
681
682  get-verbose
683
684 This returns the verbose messages flag.
685
686 =head2 glob-expand
687
688  glob-expand pattern
689
690 This command searches for all the pathnames matching
691 C<pattern> according to the wildcard expansion rules
692 used by the shell.
693
694 If no paths match, then this returns an empty list
695 (note: not an error).
696
697 It is just a wrapper around the C L<glob(3)> function
698 with flags C<GLOB_MARK|GLOB_BRACE>.
699 See that manual page for more details.
700
701 =head2 grub-install
702
703  grub-install root device
704
705 This command installs GRUB (the Grand Unified Bootloader) on
706 C<device>, with the root directory being C<root>.
707
708 =head2 hexdump
709
710  hexdump path
711
712 This runs C<hexdump -C> on the given C<path>.  The result is
713 the human-readable, canonical hex dump of the file.
714
715 Because of the message protocol, there is a transfer limit 
716 of somewhere between 2MB and 4MB.  To transfer large files you should use
717 FTP.
718
719 =head2 is-busy
720
721  is-busy
722
723 This returns true iff this handle is busy processing a command
724 (in the C<BUSY> state).
725
726 For more information on states, see L<guestfs(3)>.
727
728 =head2 is-config
729
730  is-config
731
732 This returns true iff this handle is being configured
733 (in the C<CONFIG> state).
734
735 For more information on states, see L<guestfs(3)>.
736
737 =head2 is-dir
738
739  is-dir path
740
741 This returns C<true> if and only if there is a directory
742 with the given C<path> name.  Note that it returns false for
743 other objects like files.
744
745 See also C<stat>.
746
747 =head2 is-file
748
749  is-file path
750
751 This returns C<true> if and only if there is a file
752 with the given C<path> name.  Note that it returns false for
753 other objects like directories.
754
755 See also C<stat>.
756
757 =head2 is-launching
758
759  is-launching
760
761 This returns true iff this handle is launching the subprocess
762 (in the C<LAUNCHING> state).
763
764 For more information on states, see L<guestfs(3)>.
765
766 =head2 is-ready
767
768  is-ready
769
770 This returns true iff this handle is ready to accept commands
771 (in the C<READY> state).
772
773 For more information on states, see L<guestfs(3)>.
774
775 =head2 kill-subprocess
776
777  kill-subprocess
778
779 This kills the qemu subprocess.  You should never need to call this.
780
781 =head2 launch | run
782
783  launch
784
785 Internally libguestfs is implemented by running a virtual machine
786 using L<qemu(1)>.
787
788 You should call this after configuring the handle
789 (eg. adding drives) but before performing any actions.
790
791 =head2 list-devices
792
793  list-devices
794
795 List all the block devices.
796
797 The full block device names are returned, eg. C</dev/sda>
798
799 =head2 list-partitions
800
801  list-partitions
802
803 List all the partitions detected on all block devices.
804
805 The full partition device names are returned, eg. C</dev/sda1>
806
807 This does not return logical volumes.  For that you will need to
808 call C<lvs>.
809
810 =head2 ll
811
812  ll directory
813
814 List the files in C<directory> (relative to the root directory,
815 there is no cwd) in the format of 'ls -la'.
816
817 This command is mostly useful for interactive sessions.  It
818 is I<not> intended that you try to parse the output string.
819
820 =head2 ls
821
822  ls directory
823
824 List the files in C<directory> (relative to the root directory,
825 there is no cwd).  The '.' and '..' entries are not returned, but
826 hidden files are shown.
827
828 This command is mostly useful for interactive sessions.  Programs
829 should probably use C<readdir> instead.
830
831 =head2 lstat
832
833  lstat path
834
835 Returns file information for the given C<path>.
836
837 This is the same as C<stat> except that if C<path>
838 is a symbolic link, then the link is stat-ed, not the file it
839 refers to.
840
841 This is the same as the C<lstat(2)> system call.
842
843 =head2 lvcreate
844
845  lvcreate logvol volgroup mbytes
846
847 This creates an LVM volume group called C<logvol>
848 on the volume group C<volgroup>, with C<size> megabytes.
849
850 =head2 lvm-remove-all
851
852  lvm-remove-all
853
854 This command removes all LVM logical volumes, volume groups
855 and physical volumes.
856
857 B<This command is dangerous.  Without careful use you
858 can easily destroy all your data>.
859
860 =head2 lvremove
861
862  lvremove device
863
864 Remove an LVM logical volume C<device>, where C<device> is
865 the path to the LV, such as C</dev/VG/LV>.
866
867 You can also remove all LVs in a volume group by specifying
868 the VG name, C</dev/VG>.
869
870 =head2 lvresize
871
872  lvresize device mbytes
873
874 This resizes (expands or shrinks) an existing LVM logical
875 volume to C<mbytes>.  When reducing, data in the reduced part
876 is lost.
877
878 =head2 lvs
879
880  lvs
881
882 List all the logical volumes detected.  This is the equivalent
883 of the L<lvs(8)> command.
884
885 This returns a list of the logical volume device names
886 (eg. C</dev/VolGroup00/LogVol00>).
887
888 See also C<lvs-full>.
889
890 =head2 lvs-full
891
892  lvs-full
893
894 List all the logical volumes detected.  This is the equivalent
895 of the L<lvs(8)> command.  The "full" version includes all fields.
896
897 =head2 mkdir
898
899  mkdir path
900
901 Create a directory named C<path>.
902
903 =head2 mkdir-p
904
905  mkdir-p path
906
907 Create a directory named C<path>, creating any parent directories
908 as necessary.  This is like the C<mkdir -p> shell command.
909
910 =head2 mkfs
911
912  mkfs fstype device
913
914 This creates a filesystem on C<device> (usually a partition
915 or LVM logical volume).  The filesystem type is C<fstype>, for
916 example C<ext3>.
917
918 =head2 mount
919
920  mount device mountpoint
921
922 Mount a guest disk at a position in the filesystem.  Block devices
923 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
924 the guest.  If those block devices contain partitions, they will have
925 the usual names (eg. C</dev/sda1>).  Also LVM C</dev/VG/LV>-style
926 names can be used.
927
928 The rules are the same as for L<mount(2)>:  A filesystem must
929 first be mounted on C</> before others can be mounted.  Other
930 filesystems can only be mounted on directories which already
931 exist.
932
933 The mounted filesystem is writable, if we have sufficient permissions
934 on the underlying device.
935
936 The filesystem options C<sync> and C<noatime> are set with this
937 call, in order to improve reliability.
938
939 =head2 mount-options
940
941  mount-options options device mountpoint
942
943 This is the same as the C<mount> command, but it
944 allows you to set the mount options as for the
945 L<mount(8)> I<-o> flag.
946
947 =head2 mount-ro
948
949  mount-ro device mountpoint
950
951 This is the same as the C<mount> command, but it
952 mounts the filesystem with the read-only (I<-o ro>) flag.
953
954 =head2 mount-vfs
955
956  mount-vfs options vfstype device mountpoint
957
958 This is the same as the C<mount> command, but it
959 allows you to set both the mount options and the vfstype
960 as for the L<mount(8)> I<-o> and I<-t> flags.
961
962 =head2 mounts
963
964  mounts
965
966 This returns the list of currently mounted filesystems.  It returns
967 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
968
969 Some internal mounts are not shown.
970
971 =head2 mv
972
973  mv src dest
974
975 This moves a file from C<src> to C<dest> where C<dest> is
976 either a destination filename or destination directory.
977
978 =head2 ntfs-3g-probe
979
980  ntfs-3g-probe true|false device
981
982 This command runs the L<ntfs-3g.probe(8)> command which probes
983 an NTFS C<device> for mountability.  (Not all NTFS volumes can
984 be mounted read-write, and some cannot be mounted at all).
985
986 C<rw> is a boolean flag.  Set it to true if you want to test
987 if the volume can be mounted read-write.  Set it to false if
988 you want to test if the volume can be mounted read-only.
989
990 The return value is an integer which C<0> if the operation
991 would succeed, or some non-zero value documented in the
992 L<ntfs-3g.probe(8)> manual page.
993
994 =head2 ping-daemon
995
996  ping-daemon
997
998 This is a test probe into the guestfs daemon running inside
999 the qemu subprocess.  Calling this function checks that the
1000 daemon responds to the ping message, without affecting the daemon
1001 or attached block device(s) in any other way.
1002
1003 =head2 pvcreate
1004
1005  pvcreate device
1006
1007 This creates an LVM physical volume on the named C<device>,
1008 where C<device> should usually be a partition name such
1009 as C</dev/sda1>.
1010
1011 =head2 pvremove
1012
1013  pvremove device
1014
1015 This wipes a physical volume C<device> so that LVM will no longer
1016 recognise it.
1017
1018 The implementation uses the C<pvremove> command which refuses to
1019 wipe physical volumes that contain any volume groups, so you have
1020 to remove those first.
1021
1022 =head2 pvresize
1023
1024  pvresize device
1025
1026 This resizes (expands or shrinks) an existing LVM physical
1027 volume to match the new size of the underlying device.
1028
1029 =head2 pvs
1030
1031  pvs
1032
1033 List all the physical volumes detected.  This is the equivalent
1034 of the L<pvs(8)> command.
1035
1036 This returns a list of just the device names that contain
1037 PVs (eg. C</dev/sda2>).
1038
1039 See also C<pvs-full>.
1040
1041 =head2 pvs-full
1042
1043  pvs-full
1044
1045 List all the physical volumes detected.  This is the equivalent
1046 of the L<pvs(8)> command.  The "full" version includes all fields.
1047
1048 =head2 read-lines
1049
1050  read-lines path
1051
1052 Return the contents of the file named C<path>.
1053
1054 The file contents are returned as a list of lines.  Trailing
1055 C<LF> and C<CRLF> character sequences are I<not> returned.
1056
1057 Note that this function cannot correctly handle binary files
1058 (specifically, files containing C<\0> character which is treated
1059 as end of line).  For those you need to use the C<read-file>
1060 function which has a more complex interface.
1061
1062 =head2 resize2fs
1063
1064  resize2fs device
1065
1066 This resizes an ext2 or ext3 filesystem to match the size of
1067 the underlying device.
1068
1069 I<Note:> It is sometimes required that you run C<e2fsck-f>
1070 on the C<device> before calling this command.  For unknown reasons
1071 C<resize2fs> sometimes gives an error about this and sometimes not.
1072 In any case, it is always safe to call C<e2fsck-f> before
1073 calling this function.
1074
1075 =head2 rm
1076
1077  rm path
1078
1079 Remove the single file C<path>.
1080
1081 =head2 rm-rf
1082
1083  rm-rf path
1084
1085 Remove the file or directory C<path>, recursively removing the
1086 contents if its a directory.  This is like the C<rm -rf> shell
1087 command.
1088
1089 =head2 rmdir
1090
1091  rmdir path
1092
1093 Remove the single directory C<path>.
1094
1095 =head2 set-append | append
1096
1097  set-append append
1098
1099 This function is used to add additional options to the
1100 guest kernel command line.
1101
1102 The default is C<NULL> unless overridden by setting
1103 C<LIBGUESTFS_APPEND> environment variable.
1104
1105 Setting C<append> to C<NULL> means I<no> additional options
1106 are passed (libguestfs always adds a few of its own).
1107
1108 =head2 set-autosync | autosync
1109
1110  set-autosync true|false
1111
1112 If C<autosync> is true, this enables autosync.  Libguestfs will make a
1113 best effort attempt to run C<umount-all> followed by
1114 C<sync> when the handle is closed
1115 (also if the program exits without closing handles).
1116
1117 This is disabled by default (except in guestfish where it is
1118 enabled by default).
1119
1120 =head2 set-e2label
1121
1122  set-e2label device label
1123
1124 This sets the ext2/3/4 filesystem label of the filesystem on
1125 C<device> to C<label>.  Filesystem labels are limited to
1126 16 characters.
1127
1128 You can use either C<tune2fs-l> or C<get-e2label>
1129 to return the existing label on a filesystem.
1130
1131 =head2 set-e2uuid
1132
1133  set-e2uuid device uuid
1134
1135 This sets the ext2/3/4 filesystem UUID of the filesystem on
1136 C<device> to C<uuid>.  The format of the UUID and alternatives
1137 such as C<clear>, C<random> and C<time> are described in the
1138 L<tune2fs(8)> manpage.
1139
1140 You can use either C<tune2fs-l> or C<get-e2uuid>
1141 to return the existing UUID of a filesystem.
1142
1143 =head2 set-path | path
1144
1145  set-path path
1146
1147 Set the path that libguestfs searches for kernel and initrd.img.
1148
1149 The default is C<$libdir/guestfs> unless overridden by setting
1150 C<LIBGUESTFS_PATH> environment variable.
1151
1152 Setting C<path> to C<NULL> restores the default path.
1153
1154 =head2 set-qemu | qemu
1155
1156  set-qemu qemu
1157
1158 Set the qemu binary that we will use.
1159
1160 The default is chosen when the library was compiled by the
1161 configure script.
1162
1163 You can also override this by setting the C<LIBGUESTFS_QEMU>
1164 environment variable.
1165
1166 Setting C<qemu> to C<NULL> restores the default qemu binary.
1167
1168 =head2 set-verbose | verbose
1169
1170  set-verbose true|false
1171
1172 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
1173
1174 Verbose messages are disabled unless the environment variable
1175 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.
1176
1177 =head2 sfdisk
1178
1179  sfdisk device cyls heads sectors 'lines ...'
1180
1181 This is a direct interface to the L<sfdisk(8)> program for creating
1182 partitions on block devices.
1183
1184 C<device> should be a block device, for example C</dev/sda>.
1185
1186 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1187 and sectors on the device, which are passed directly to sfdisk as
1188 the I<-C>, I<-H> and I<-S> parameters.  If you pass C<0> for any
1189 of these, then the corresponding parameter is omitted.  Usually for
1190 'large' disks, you can just pass C<0> for these, but for small
1191 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1192 out the right geometry and you will need to tell it.
1193
1194 C<lines> is a list of lines that we feed to C<sfdisk>.  For more
1195 information refer to the L<sfdisk(8)> manpage.
1196
1197 To create a single partition occupying the whole disk, you would
1198 pass C<lines> as a single element list, when the single element being
1199 the string C<,> (comma).
1200
1201 See also: C<sfdisk-l>, C<sfdisk-N>
1202
1203 B<This command is dangerous.  Without careful use you
1204 can easily destroy all your data>.
1205
1206 =head2 sfdisk-N
1207
1208  sfdisk-N device n cyls heads sectors line
1209
1210 This runs L<sfdisk(8)> option to modify just the single
1211 partition C<n> (note: C<n> counts from 1).
1212
1213 For other parameters, see C<sfdisk>.  You should usually
1214 pass C<0> for the cyls/heads/sectors parameters.
1215
1216 B<This command is dangerous.  Without careful use you
1217 can easily destroy all your data>.
1218
1219 =head2 sfdisk-disk-geometry
1220
1221  sfdisk-disk-geometry device
1222
1223 This displays the disk geometry of C<device> read from the
1224 partition table.  Especially in the case where the underlying
1225 block device has been resized, this can be different from the
1226 kernel's idea of the geometry (see C<sfdisk-kernel-geometry>).
1227
1228 The result is in human-readable format, and not designed to
1229 be parsed.
1230
1231 =head2 sfdisk-kernel-geometry
1232
1233  sfdisk-kernel-geometry device
1234
1235 This displays the kernel's idea of the geometry of C<device>.
1236
1237 The result is in human-readable format, and not designed to
1238 be parsed.
1239
1240 =head2 sfdisk-l
1241
1242  sfdisk-l device
1243
1244 This displays the partition table on C<device>, in the
1245 human-readable output of the L<sfdisk(8)> command.  It is
1246 not intended to be parsed.
1247
1248 =head2 sh
1249
1250  sh command
1251
1252 This call runs a command from the guest filesystem via the
1253 guest's C</bin/sh>.
1254
1255 This is like C<command>, but passes the command to:
1256
1257  /bin/sh -c "command"
1258
1259 Depending on the guest's shell, this usually results in
1260 wildcards being expanded, shell expressions being interpolated
1261 and so on.
1262
1263 All the provisos about C<command> apply to this call.
1264
1265 =head2 sh-lines
1266
1267  sh-lines command
1268
1269 This is the same as C<sh>, but splits the result
1270 into a list of lines.
1271
1272 See also: C<command-lines>
1273
1274 =head2 sleep
1275
1276  sleep secs
1277
1278 Sleep for C<secs> seconds.
1279
1280 =head2 stat
1281
1282  stat path
1283
1284 Returns file information for the given C<path>.
1285
1286 This is the same as the C<stat(2)> system call.
1287
1288 =head2 statvfs
1289
1290  statvfs path
1291
1292 Returns file system statistics for any mounted file system.
1293 C<path> should be a file or directory in the mounted file system
1294 (typically it is the mount point itself, but it doesn't need to be).
1295
1296 This is the same as the C<statvfs(2)> system call.
1297
1298 =head2 strings
1299
1300  strings path
1301
1302 This runs the L<strings(1)> command on a file and returns
1303 the list of printable strings found.
1304
1305 Because of the message protocol, there is a transfer limit 
1306 of somewhere between 2MB and 4MB.  To transfer large files you should use
1307 FTP.
1308
1309 =head2 strings-e
1310
1311  strings-e encoding path
1312
1313 This is like the C<strings> command, but allows you to
1314 specify the encoding.
1315
1316 See the L<strings(1)> manpage for the full list of encodings.
1317
1318 Commonly useful encodings are C<l> (lower case L) which will
1319 show strings inside Windows/x86 files.
1320
1321 The returned strings are transcoded to UTF-8.
1322
1323 Because of the message protocol, there is a transfer limit 
1324 of somewhere between 2MB and 4MB.  To transfer large files you should use
1325 FTP.
1326
1327 =head2 sync
1328
1329  sync
1330
1331 This syncs the disk, so that any writes are flushed through to the
1332 underlying disk image.
1333
1334 You should always call this if you have modified a disk image, before
1335 closing the handle.
1336
1337 =head2 tar-in
1338
1339  tar-in (tarfile|-) directory
1340
1341 This command uploads and unpacks local file C<tarfile> (an
1342 I<uncompressed> tar file) into C<directory>.
1343
1344 To upload a compressed tarball, use C<tgz-in>.
1345
1346 Use C<-> instead of a filename to read/write from stdin/stdout.
1347
1348 =head2 tar-out
1349
1350  tar-out directory (tarfile|-)
1351
1352 This command packs the contents of C<directory> and downloads
1353 it to local file C<tarfile>.
1354
1355 To download a compressed tarball, use C<tgz-out>.
1356
1357 Use C<-> instead of a filename to read/write from stdin/stdout.
1358
1359 =head2 tgz-in
1360
1361  tgz-in (tarball|-) directory
1362
1363 This command uploads and unpacks local file C<tarball> (a
1364 I<gzip compressed> tar file) into C<directory>.
1365
1366 To upload an uncompressed tarball, use C<tar-in>.
1367
1368 Use C<-> instead of a filename to read/write from stdin/stdout.
1369
1370 =head2 tgz-out
1371
1372  tgz-out directory (tarball|-)
1373
1374 This command packs the contents of C<directory> and downloads
1375 it to local file C<tarball>.
1376
1377 To download an uncompressed tarball, use C<tar-out>.
1378
1379 Use C<-> instead of a filename to read/write from stdin/stdout.
1380
1381 =head2 touch
1382
1383  touch path
1384
1385 Touch acts like the L<touch(1)> command.  It can be used to
1386 update the timestamps on a file, or, if the file does not exist,
1387 to create a new zero-length file.
1388
1389 =head2 tune2fs-l
1390
1391  tune2fs-l device
1392
1393 This returns the contents of the ext2, ext3 or ext4 filesystem
1394 superblock on C<device>.
1395
1396 It is the same as running C<tune2fs -l device>.  See L<tune2fs(8)>
1397 manpage for more details.  The list of fields returned isn't
1398 clearly defined, and depends on both the version of C<tune2fs>
1399 that libguestfs was built against, and the filesystem itself.
1400
1401 =head2 umount | unmount
1402
1403  umount pathordevice
1404
1405 This unmounts the given filesystem.  The filesystem may be
1406 specified either by its mountpoint (path) or the device which
1407 contains the filesystem.
1408
1409 =head2 umount-all | unmount-all
1410
1411  umount-all
1412
1413 This unmounts all mounted filesystems.
1414
1415 Some internal mounts are not unmounted by this call.
1416
1417 =head2 upload
1418
1419  upload (filename|-) remotefilename
1420
1421 Upload local file C<filename> to C<remotefilename> on the
1422 filesystem.
1423
1424 C<filename> can also be a named pipe.
1425
1426 See also C<download>.
1427
1428 Use C<-> instead of a filename to read/write from stdin/stdout.
1429
1430 =head2 vg-activate
1431
1432  vg-activate true|false 'volgroups ...'
1433
1434 This command activates or (if C<activate> is false) deactivates
1435 all logical volumes in the listed volume groups C<volgroups>.
1436 If activated, then they are made known to the
1437 kernel, ie. they appear as C</dev/mapper> devices.  If deactivated,
1438 then those devices disappear.
1439
1440 This command is the same as running C<vgchange -a y|n volgroups...>
1441
1442 Note that if C<volgroups> is an empty list then B<all> volume groups
1443 are activated or deactivated.
1444
1445 =head2 vg-activate-all
1446
1447  vg-activate-all true|false
1448
1449 This command activates or (if C<activate> is false) deactivates
1450 all logical volumes in all volume groups.
1451 If activated, then they are made known to the
1452 kernel, ie. they appear as C</dev/mapper> devices.  If deactivated,
1453 then those devices disappear.
1454
1455 This command is the same as running C<vgchange -a y|n>
1456
1457 =head2 vgcreate
1458
1459  vgcreate volgroup 'physvols ...'
1460
1461 This creates an LVM volume group called C<volgroup>
1462 from the non-empty list of physical volumes C<physvols>.
1463
1464 =head2 vgremove
1465
1466  vgremove vgname
1467
1468 Remove an LVM volume group C<vgname>, (for example C<VG>).
1469
1470 This also forcibly removes all logical volumes in the volume
1471 group (if any).
1472
1473 =head2 vgs
1474
1475  vgs
1476
1477 List all the volumes groups detected.  This is the equivalent
1478 of the L<vgs(8)> command.
1479
1480 This returns a list of just the volume group names that were
1481 detected (eg. C<VolGroup00>).
1482
1483 See also C<vgs-full>.
1484
1485 =head2 vgs-full
1486
1487  vgs-full
1488
1489 List all the volumes groups detected.  This is the equivalent
1490 of the L<vgs(8)> command.  The "full" version includes all fields.
1491
1492 =head2 write-file
1493
1494  write-file path content size
1495
1496 This call creates a file called C<path>.  The contents of the
1497 file is the string C<content> (which can contain any 8 bit data),
1498 with length C<size>.
1499
1500 As a special case, if C<size> is C<0>
1501 then the length is calculated using C<strlen> (so in this case
1502 the content cannot contain embedded ASCII NULs).
1503
1504 I<NB.> Owing to a bug, writing content containing ASCII NUL
1505 characters does I<not> work, even if the length is specified.
1506 We hope to resolve this bug in a future version.  In the meantime
1507 use C<upload>.
1508
1509 Because of the message protocol, there is a transfer limit 
1510 of somewhere between 2MB and 4MB.  To transfer large files you should use
1511 FTP.
1512
1513 =head2 zero
1514
1515  zero device
1516
1517 This command writes zeroes over the first few blocks of C<device>.
1518
1519 How many blocks are zeroed isn't specified (but it's I<not> enough
1520 to securely wipe the device).  It should be sufficient to remove
1521 any partition tables, filesystem superblocks and so on.
1522
1523 =head2 zerofree
1524
1525  zerofree device
1526
1527 This runs the I<zerofree> program on C<device>.  This program
1528 claims to zero unused inodes and disk blocks on an ext2/3
1529 filesystem, thus making it possible to compress the filesystem
1530 more effectively.
1531
1532 You should B<not> run this program if the filesystem is
1533 mounted.
1534
1535 It is possible that using this program can damage the filesystem
1536 or data on the filesystem.
1537