guestfs-actions.pod

   1 =head2 guestfs_cat
   2
   3  char *guestfs_cat (guestfs_h *handle,
   4                 const char *path);
   5
   6 Return the contents of the file named C<path>.
   7
   8 Note that this function cannot correctly handle binary files
   9 (specifically, files containing C<\0> character which is treated
  10 as end of string).  For those you need to use the C<guestfs_read_file>
  11 function which has a more complex interface.
  12
  13 This function returns a string or NULL on error.
  14 I<The caller must free the returned string after use>.
  15
  16 Because of the message protocol, there is a transfer limit
  17 of somewhere between 2MB and 4MB.  To transfer large files you should use
  18 FTP.
  19
  20 =head2 guestfs_list_devices
  21
  22  char **guestfs_list_devices (guestfs_h *handle);
  23
  24 List all the block devices.
  25
  26 The full block device names are returned, eg. C</dev/sda>
  27
  28
  29 This function returns a NULL-terminated array of strings
  30 (like L<environ(3)>), or NULL if there was an error.
  31 I<The caller must free the strings and the array after use>.
  32
  33 =head2 guestfs_list_partitions
  34
  35  char **guestfs_list_partitions (guestfs_h *handle);
  36
  37 List all the partitions detected on all block devices.
  38
  39 The full partition device names are returned, eg. C</dev/sda1>
  40
  41 This does not return logical volumes.  For that you will need to
  42 call C<guestfs_lvs>.
  43
  44 This function returns a NULL-terminated array of strings
  45 (like L<environ(3)>), or NULL if there was an error.
  46 I<The caller must free the strings and the array after use>.
  47
  48 =head2 guestfs_ll
  49
  50  char *guestfs_ll (guestfs_h *handle,
  51                 const char *directory);
  52
  53 List the files in C<directory> (relative to the root directory,
  54 there is no cwd) in the format of 'ls -la'.
  55
  56 This command is mostly useful for interactive sessions.  It
  57 is I<not> intended that you try to parse the output string.
  58
  59 This function returns a string or NULL on error.
  60 I<The caller must free the returned string after use>.
  61
  62 =head2 guestfs_ls
  63
  64  char **guestfs_ls (guestfs_h *handle,
  65                 const char *directory);
  66
  67 List the files in C<directory> (relative to the root directory,
  68 there is no cwd).  The '.' and '..' entries are not returned, but
  69 hidden files are shown.
  70
  71 This command is mostly useful for interactive sessions.  Programs
  72 should probably use C<guestfs_readdir> instead.
  73
  74 This function returns a NULL-terminated array of strings
  75 (like L<environ(3)>), or NULL if there was an error.
  76 I<The caller must free the strings and the array after use>.
  77
  78 =head2 guestfs_mount
  79
  80  int guestfs_mount (guestfs_h *handle,
  81                 const char *device,
  82                 const char *mountpoint);
  83
  84 Mount a guest disk at a position in the filesystem.  Block devices
  85 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
  86 the guest.  If those block devices contain partitions, they will have
  87 the usual names (eg. C</dev/sda1>).  Also LVM C</dev/VG/LV>-style
  88 names can be used.
  89
  90 The rules are the same as for L<mount(2)>:  A filesystem must
  91 first be mounted on C</> before others can be mounted.  Other
  92 filesystems can only be mounted on directories which already
  93 exist.
  94
  95 The mounted filesystem is writable, if we have sufficient permissions
  96 on the underlying device.
  97
  98 The filesystem options C<sync> and C<noatime> are set with this
  99 call, in order to improve reliability.
 100
 101 This function returns 0 on success or -1 on error.
 102
 103 =head2 guestfs_sync
 104
 105  int guestfs_sync (guestfs_h *handle);
 106
 107 This syncs the disk, so that any writes are flushed through to the
 108 underlying disk image.
 109
 110 You should always call this if you have modified a disk image, before
 111 calling C<guestfs_close>.
 112
 113 This function returns 0 on success or -1 on error.
 114
 115 =head2 guestfs_touch
 116
 117  int guestfs_touch (guestfs_h *handle,
 118                 const char *path);
 119
 120 Touch acts like the L<touch(1)> command.  It can be used to
 121 update the timestamps on a file, or, if the file does not exist,
 122 to create a new zero-length file.
 123
 124 This function returns 0 on success or -1 on error.
 125