X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=guestfs-actions.pod;h=551b3e32f3b37def172568ec645d8eb280c15be3;hp=89aa96883ac8af2ef5f36837d52c2dabc2263910;hb=5365ebd501850ea10d9a5b28fc6480ea34dbe16d;hpb=01c26253a12ed1e6b1199f8c85f049a7fc4aef28;ds=sidebyside diff --git a/guestfs-actions.pod b/guestfs-actions.pod index 89aa968..551b3e3 100644 --- a/guestfs-actions.pod +++ b/guestfs-actions.pod @@ -59,7 +59,7 @@ number of nodes in the nodeset, and a boolean flag if a node was created. This function returns a C. -I after use.>. +I after use>. =head2 guestfs_aug_defvar @@ -176,7 +176,7 @@ This function returns 0 on success or -1 on error. const char *path); This is just a shortcut for listing C -C and sorting the files into alphabetical order. +C and sorting the resulting nodes into alphabetical order. This function returns a NULL-terminated array of strings (like L), or NULL if there was an error. @@ -257,6 +257,73 @@ Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. To transfer large files you should use FTP. +=head2 guestfs_chmod + + int guestfs_chmod (guestfs_h *handle, + int mode, + const char *path); + +Change the mode (permissions) of C to C. Only +numeric modes are supported. + +This function returns 0 on success or -1 on error. + +=head2 guestfs_chown + + int guestfs_chown (guestfs_h *handle, + int owner, + int group, + const char *path); + +Change the file owner to C and group to C. + +Only numeric uid and gid are supported. If you want to use +names, you will need to locate and parse the password file +yourself (Augeas support makes this relatively easy). + +This function returns 0 on success or -1 on error. + +=head2 guestfs_command + + char *guestfs_command (guestfs_h *handle, + char * const* const arguments); + +This calls runs a command from the guest filesystem. The +filesystem must be mounted, and must contain a compatible +operating system (ie. something Linux, with the same +or compatible processor architecture). + +The single parameter is an argv-style list of arguments. +The first element is the name of the program to run. +Subsequent elements are parameters. The list must be +non-empty (ie. must contain a program name). + +The C<$PATH> environment variable will contain at least +C and C. If you require a program from +another location, you should provide the full path in the +first parameter. + +Shared libraries and data files required by the program +must be available on filesystems which are mounted in the +correct places. It is the caller's responsibility to ensure +all filesystems that are needed are mounted at the right +locations. + +This function returns a string or NULL on error. +I. + +=head2 guestfs_command_lines + + char **guestfs_command_lines (guestfs_h *handle, + char * const* const arguments); + +This is the same as C, but splits the +result into a list of lines. + +This function returns a NULL-terminated array of strings +(like L), or NULL if there was an error. +I. + =head2 guestfs_config int guestfs_config (guestfs_h *handle, @@ -274,6 +341,34 @@ C can be NULL. This function returns 0 on success or -1 on error. +=head2 guestfs_exists + + int guestfs_exists (guestfs_h *handle, + const char *path); + +This returns C if and only if there is a file, directory +(or anything) with the given C name. + +See also C, C, C. + +This function returns a C truth value on success or -1 on error. + +=head2 guestfs_file + + char *guestfs_file (guestfs_h *handle, + const char *path); + +This call uses the standard L command to determine +the type or contents of the file. This also works on devices, +for example to find out whether a partition contains a filesystem. + +The exact command which runs is C. Note in +particular that the filename is not prepended to the output +(the C<-b> option). + +This function returns a string or NULL on error. +I. + =head2 guestfs_get_autosync int guestfs_get_autosync (guestfs_h *handle); @@ -302,6 +397,32 @@ This returns the verbose messages flag. This function returns a C truth value on success or -1 on error. +=head2 guestfs_is_dir + + int guestfs_is_dir (guestfs_h *handle, + const char *path); + +This returns C if and only if there is a directory +with the given C name. Note that it returns false for +other objects like files. + +See also C. + +This function returns a C truth value on success or -1 on error. + +=head2 guestfs_is_file + + int guestfs_is_file (guestfs_h *handle, + const char *path); + +This returns C if and only if there is a file +with the given C name. Note that it returns false for +other objects like directories. + +See also C. + +This function returns a C truth value on success or -1 on error. + =head2 guestfs_kill_subprocess int guestfs_kill_subprocess (guestfs_h *handle); @@ -379,6 +500,30 @@ This function returns a NULL-terminated array of strings (like L), or NULL if there was an error. I. +=head2 guestfs_lvcreate + + int guestfs_lvcreate (guestfs_h *handle, + const char *logvol, + const char *volgroup, + int mbytes); + +This creates an LVM volume group called C +on the volume group C, with C megabytes. + +This function returns 0 on success or -1 on error. + +=head2 guestfs_lvm_remove_all + + int guestfs_lvm_remove_all (guestfs_h *handle); + +This command removes all LVM logical volumes, volume groups +and physical volumes. + +This function returns 0 on success or -1 on error. + +B. + =head2 guestfs_lvs char **guestfs_lvs (guestfs_h *handle); @@ -403,7 +548,38 @@ List all the logical volumes detected. This is the equivalent of the L command. The "full" version includes all fields. This function returns a C. -I after use.>. +I after use>. + +=head2 guestfs_mkdir + + int guestfs_mkdir (guestfs_h *handle, + const char *path); + +Create a directory named C. + +This function returns 0 on success or -1 on error. + +=head2 guestfs_mkdir_p + + int guestfs_mkdir_p (guestfs_h *handle, + const char *path); + +Create a directory named C, creating any parent directories +as necessary. This is like the C shell command. + +This function returns 0 on success or -1 on error. + +=head2 guestfs_mkfs + + int guestfs_mkfs (guestfs_h *handle, + const char *fstype, + const char *device); + +This creates a filesystem on C (usually a partition +of LVM logical volume). The filesystem type is C, for +example C. + +This function returns 0 on success or -1 on error. =head2 guestfs_mount @@ -430,6 +606,30 @@ call, in order to improve reliability. This function returns 0 on success or -1 on error. +=head2 guestfs_mounts + + char **guestfs_mounts (guestfs_h *handle); + +This returns the list of currently mounted filesystems. It returns +the list of devices (eg. C, C). + +Some internal mounts are not shown. + +This function returns a NULL-terminated array of strings +(like L), or NULL if there was an error. +I. + +=head2 guestfs_pvcreate + + int guestfs_pvcreate (guestfs_h *handle, + const char *device); + +This creates an LVM physical volume on the named C, +where C should usually be a partition name such +as C. + +This function returns 0 on success or -1 on error. + =head2 guestfs_pvs char **guestfs_pvs (guestfs_h *handle); @@ -454,7 +654,7 @@ List all the physical volumes detected. This is the equivalent of the L command. The "full" version includes all fields. This function returns a C. -I after use.>. +I after use>. =head2 guestfs_read_lines @@ -475,6 +675,35 @@ This function returns a NULL-terminated array of strings (like L), or NULL if there was an error. I. +=head2 guestfs_rm + + int guestfs_rm (guestfs_h *handle, + const char *path); + +Remove the single file C. + +This function returns 0 on success or -1 on error. + +=head2 guestfs_rm_rf + + int guestfs_rm_rf (guestfs_h *handle, + const char *path); + +Remove the file or directory C, recursively removing the +contents if its a directory. This is like the C shell +command. + +This function returns 0 on success or -1 on error. + +=head2 guestfs_rmdir + + int guestfs_rmdir (guestfs_h *handle, + const char *path); + +Remove the single directory C. + +This function returns 0 on success or -1 on error. + =head2 guestfs_set_autosync int guestfs_set_autosync (guestfs_h *handle, @@ -515,6 +744,40 @@ C is defined and set to C<1>. This function returns 0 on success or -1 on error. +=head2 guestfs_sfdisk + + int guestfs_sfdisk (guestfs_h *handle, + const char *device, + int cyls, + int heads, + int sectors, + char * const* const lines); + +This is a direct interface to the L program for creating +partitions on block devices. + +C should be a block device, for example C. + +C, C and C are the number of cylinders, heads +and sectors on the device, which are passed directly to sfdisk as +the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any +of these, then the corresponding parameter is omitted. Usually for +'large' disks, you can just pass C<0> for these, but for small +(floppy-sized) disks, sfdisk (or rather, the kernel) cannot work +out the right geometry and you will need to tell it. + +C is a list of lines that we feed to C. For more +information refer to the L manpage. + +To create a single partition occupying the whole disk, you would +pass C as a single element list, when the single element being +the string C<,> (comma). + +This function returns 0 on success or -1 on error. + +B. + =head2 guestfs_sync int guestfs_sync (guestfs_h *handle); @@ -538,6 +801,38 @@ to create a new zero-length file. This function returns 0 on success or -1 on error. +=head2 guestfs_umount + + int guestfs_umount (guestfs_h *handle, + const char *pathordevice); + +This unmounts the given filesystem. The filesystem may be +specified either by its mountpoint (path) or the device which +contains the filesystem. + +This function returns 0 on success or -1 on error. + +=head2 guestfs_umount_all + + int guestfs_umount_all (guestfs_h *handle); + +This unmounts all mounted filesystems. + +Some internal mounts are not unmounted by this call. + +This function returns 0 on success or -1 on error. + +=head2 guestfs_vgcreate + + int guestfs_vgcreate (guestfs_h *handle, + const char *volgroup, + char * const* const physvols); + +This creates an LVM volume group called C +from the non-empty list of physical volumes C. + +This function returns 0 on success or -1 on error. + =head2 guestfs_vgs char **guestfs_vgs (guestfs_h *handle); @@ -562,7 +857,7 @@ List all the volumes groups detected. This is the equivalent of the L command. The "full" version includes all fields. This function returns a C. -I after use.>. +I after use>. =head2 guestfs_wait_ready @@ -576,3 +871,24 @@ to complete. This function returns 0 on success or -1 on error. +=head2 guestfs_write_file + + int guestfs_write_file (guestfs_h *handle, + const char *path, + const char *content, + int size); + +This call creates a file called C. The contents of the +file is the string C (which can contain any 8 bit data), +with length C. + +As a special case, if C is C<0> +then the length is calculated using C (so in this case +the content cannot contain embedded ASCII NULs). + +This function returns 0 on success or -1 on error. + +Because of the message protocol, there is a transfer limit +of somewhere between 2MB and 4MB. To transfer large files you should use +FTP. +