|
|
|
Libguestfs GObject Bindings Reference Manual | |
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Signals | ||||
#include <guestfs-gobject.h> struct GuestfsSession; struct GuestfsSessionClass; enum GuestfsSessionEvent; struct GuestfsSessionEventParams; gboolean guestfs_session_add_cdrom (GuestfsSession *session,const gchar *filename,GError **err); gint32 guestfs_session_add_domain (GuestfsSession *session,const gchar *dom,GuestfsAddDomain *optargs,GError **err); gboolean guestfs_session_add_drive (GuestfsSession *session,const gchar *filename,GError **err); gboolean guestfs_session_add_drive_opts (GuestfsSession *session,const gchar *filename,GuestfsAddDriveOpts *optargs,GError **err); gboolean guestfs_session_add_drive_ro (GuestfsSession *session,const gchar *filename,GError **err); gboolean guestfs_session_add_drive_ro_with_if (GuestfsSession *session,const gchar *filename,const gchar *iface,GError **err); gboolean guestfs_session_add_drive_with_if (GuestfsSession *session,const gchar *filename,const gchar *iface,GError **err); gboolean guestfs_session_aug_clear (GuestfsSession *session,const gchar *augpath,GError **err); gboolean guestfs_session_aug_close (GuestfsSession *session,GError **err); GuestfsIntBool * guestfs_session_aug_defnode (GuestfsSession *session,const gchar *name,const gchar *expr,const gchar *val,GError **err); gint32 guestfs_session_aug_defvar (GuestfsSession *session,const gchar *name,const gchar *expr,GError **err); gchar * guestfs_session_aug_get (GuestfsSession *session,const gchar *augpath,GError **err); gboolean guestfs_session_aug_init (GuestfsSession *session,const gchar *root,gint32 flags,GError **err); gboolean guestfs_session_aug_insert (GuestfsSession *session,const gchar *augpath,const gchar *label,gboolean before,GError **err); gboolean guestfs_session_aug_load (GuestfsSession *session,GError **err); gchar ** guestfs_session_aug_ls (GuestfsSession *session,const gchar *augpath,GError **err); gchar ** guestfs_session_aug_match (GuestfsSession *session,const gchar *augpath,GError **err); gboolean guestfs_session_aug_mv (GuestfsSession *session,const gchar *src,const gchar *dest,GError **err); gint32 guestfs_session_aug_rm (GuestfsSession *session,const gchar *augpath,GError **err); gboolean guestfs_session_aug_save (GuestfsSession *session,GError **err); gboolean guestfs_session_aug_set (GuestfsSession *session,const gchar *augpath,const gchar *val,GError **err); gboolean guestfs_session_available (GuestfsSession *session,gchar *const *groups,GError **err); gchar ** guestfs_session_available_all_groups (GuestfsSession *session,GError **err); gboolean guestfs_session_base64_in (GuestfsSession *session,const gchar *base64file,const gchar *filename,GCancellable *cancellable,GError **err); gboolean guestfs_session_base64_out (GuestfsSession *session,const gchar *filename,const gchar *base64file,GCancellable *cancellable,GError **err); GHashTable * guestfs_session_blkid (GuestfsSession *session,const gchar *device,GError **err); gboolean guestfs_session_blockdev_flushbufs (GuestfsSession *session,const gchar *device,GError **err); gint32 guestfs_session_blockdev_getbsz (GuestfsSession *session,const gchar *device,GError **err); gint8 guestfs_session_blockdev_getro (GuestfsSession *session,const gchar *device,GError **err); gint64 guestfs_session_blockdev_getsize64 (GuestfsSession *session,const gchar *device,GError **err); gint32 guestfs_session_blockdev_getss (GuestfsSession *session,const gchar *device,GError **err); gint64 guestfs_session_blockdev_getsz (GuestfsSession *session,const gchar *device,GError **err); gboolean guestfs_session_blockdev_rereadpt (GuestfsSession *session,const gchar *device,GError **err); gboolean guestfs_session_blockdev_setbsz (GuestfsSession *session,const gchar *device,gint32 blocksize,GError **err); gboolean guestfs_session_blockdev_setro (GuestfsSession *session,const gchar *device,GError **err); gboolean guestfs_session_blockdev_setrw (GuestfsSession *session,const gchar *device,GError **err); gboolean guestfs_session_btrfs_device_add (GuestfsSession *session,gchar *const *devices,const gchar *fs,GError **err); gboolean guestfs_session_btrfs_device_delete (GuestfsSession *session,gchar *const *devices,const gchar *fs,GError **err); gboolean guestfs_session_btrfs_filesystem_balance (GuestfsSession *session,const gchar *fs,GError **err); gboolean guestfs_session_btrfs_filesystem_resize (GuestfsSession *session,const gchar *mountpoint,GuestfsBTRFSFilesystemResize *optargs,GError **err); gboolean guestfs_session_btrfs_filesystem_sync (GuestfsSession *session,const gchar *fs,GError **err); gboolean guestfs_session_btrfs_fsck (GuestfsSession *session,const gchar *device,GuestfsBtrfsFsck *optargs,GError **err); gboolean guestfs_session_btrfs_set_seeding (GuestfsSession *session,const gchar *device,gboolean seeding,GError **err); gboolean guestfs_session_btrfs_subvolume_create (GuestfsSession *session,const gchar *dest,GError **err); gboolean guestfs_session_btrfs_subvolume_delete (GuestfsSession *session,const gchar *subvolume,GError **err); GuestfsBTRFSSubvolume ** guestfs_session_btrfs_subvolume_list (GuestfsSession *session,const gchar *fs,GError **err); gboolean guestfs_session_btrfs_subvolume_set_default (GuestfsSession *session,gint64 id,const gchar *fs,GError **err); gboolean guestfs_session_btrfs_subvolume_snapshot (GuestfsSession *session,const gchar *source,const gchar *dest,GError **err); gchar * guestfs_session_case_sensitive_path (GuestfsSession *session,const gchar *path,GError **err); gchar * guestfs_session_cat (GuestfsSession *session,const gchar *path,GError **err); gchar * guestfs_session_checksum (GuestfsSession *session,const gchar *csumtype,const gchar *path,GError **err); gchar * guestfs_session_checksum_device (GuestfsSession *session,const gchar *csumtype,const gchar *device,GError **err); gboolean guestfs_session_checksums_out (GuestfsSession *session,const gchar *csumtype,const gchar *directory,const gchar *sumsfile,GCancellable *cancellable,GError **err); gboolean guestfs_session_chmod (GuestfsSession *session,gint32 mode,const gchar *path,GError **err); gboolean guestfs_session_chown (GuestfsSession *session,gint32 owner,gint32 group,const gchar *path,GError **err); gboolean guestfs_session_close (GuestfsSession *session,GError **err); gchar * guestfs_session_command (GuestfsSession *session,gchar *const *arguments,GError **err); gchar ** guestfs_session_command_lines (GuestfsSession *session,gchar *const *arguments,GError **err); gboolean guestfs_session_compress_device_out (GuestfsSession *session,const gchar *ctype,const gchar *device,const gchar *zdevice,GuestfsCompressDeviceOut *optargs,GCancellable *cancellable,GError **err); gboolean guestfs_session_compress_out (GuestfsSession *session,const gchar *ctype,const gchar *file,const gchar *zfile,GuestfsCompressOut *optargs,GCancellable *cancellable,GError **err); gboolean guestfs_session_config (GuestfsSession *session,const gchar *qemuparam,const gchar *qemuvalue,GError **err); gboolean guestfs_session_copy_device_to_device (GuestfsSession *session,const gchar *src,const gchar *dest,GuestfsCopyDeviceToDevice *optargs,GError **err); gboolean guestfs_session_copy_device_to_file (GuestfsSession *session,const gchar *src,const gchar *dest,GuestfsCopyDeviceToFile *optargs,GError **err); gboolean guestfs_session_copy_file_to_device (GuestfsSession *session,const gchar *src,const gchar *dest,GuestfsCopyFileToDevice *optargs,GError **err); gboolean guestfs_session_copy_file_to_file (GuestfsSession *session,const gchar *src,const gchar *dest,GuestfsCopyFileToFile *optargs,GError **err); gboolean guestfs_session_copy_size (GuestfsSession *session,const gchar *src,const gchar *dest,gint64 size,GError **err); gboolean guestfs_session_cp (GuestfsSession *session,const gchar *src,const gchar *dest,GError **err); gboolean guestfs_session_cp_a (GuestfsSession *session,const gchar *src,const gchar *dest,GError **err); gboolean guestfs_session_dd (GuestfsSession *session,const gchar *src,const gchar *dest,GError **err); gchar * guestfs_session_debug (GuestfsSession *session,const gchar *subcmd,gchar *const *extraargs,GError **err); gchar ** guestfs_session_debug_cmdline (GuestfsSession *session,GError **err); gchar ** guestfs_session_debug_drives (GuestfsSession *session,GError **err); gboolean guestfs_session_debug_upload (GuestfsSession *session,const gchar *filename,const gchar *tmpname,gint32 mode,GCancellable *cancellable,GError **err); gchar * guestfs_session_df (GuestfsSession *session,GError **err); gchar * guestfs_session_df_h (GuestfsSession *session,GError **err); gchar * guestfs_session_dmesg (GuestfsSession *session,GError **err); gboolean guestfs_session_download (GuestfsSession *session,const gchar *remotefilename,const gchar *filename,GCancellable *cancellable,GError **err); gboolean guestfs_session_download_offset (GuestfsSession *session,const gchar *remotefilename,const gchar *filename,gint64 offset,gint64 size,GCancellable *cancellable,GError **err); gboolean guestfs_session_drop_caches (GuestfsSession *session,gint32 whattodrop,GError **err); gint64 guestfs_session_du (GuestfsSession *session,const gchar *path,GError **err); gboolean guestfs_session_e2fsck (GuestfsSession *session,const gchar *device,GuestfsE2fsck *optargs,GError **err); gboolean guestfs_session_e2fsck_f (GuestfsSession *session,const gchar *device,GError **err); gchar * guestfs_session_echo_daemon (GuestfsSession *session,gchar *const *words,GError **err); gchar ** guestfs_session_egrep (GuestfsSession *session,const gchar *regex,const gchar *path,GError **err); gchar ** guestfs_session_egrepi (GuestfsSession *session,const gchar *regex,const gchar *path,GError **err); gint8 guestfs_session_equal (GuestfsSession *session,const gchar *file1,const gchar *file2,GError **err); gint8 guestfs_session_exists (GuestfsSession *session,const gchar *path,GError **err); gboolean guestfs_session_fallocate (GuestfsSession *session,const gchar *path,gint32 len,GError **err); gboolean guestfs_session_fallocate64 (GuestfsSession *session,const gchar *path,gint64 len,GError **err); gchar ** guestfs_session_fgrep (GuestfsSession *session,const gchar *pattern,const gchar *path,GError **err); gchar ** guestfs_session_fgrepi (GuestfsSession *session,const gchar *pattern,const gchar *path,GError **err); gchar * guestfs_session_file (GuestfsSession *session,const gchar *path,GError **err); gchar * guestfs_session_file_architecture (GuestfsSession *session,const gchar *filename,GError **err); gint64 guestfs_session_filesize (GuestfsSession *session,const gchar *file,GError **err); gboolean guestfs_session_fill (GuestfsSession *session,gint32 c,gint32 len,const gchar *path,GError **err); gboolean guestfs_session_fill_pattern (GuestfsSession *session,const gchar *pattern,gint32 len,const gchar *path,GError **err); gchar ** guestfs_session_find (GuestfsSession *session,const gchar *directory,GError **err); gboolean guestfs_session_find0 (GuestfsSession *session,const gchar *directory,const gchar *files,GCancellable *cancellable,GError **err); gchar * guestfs_session_findfs_label (GuestfsSession *session,const gchar *label,GError **err); gchar * guestfs_session_findfs_uuid (GuestfsSession *session,const gchar *uuid,GError **err); gint32 guestfs_session_fsck (GuestfsSession *session,const gchar *fstype,const gchar *device,GError **err); const gchar * guestfs_session_get_append (GuestfsSession *session,GError **err); gchar * guestfs_session_get_attach_method (GuestfsSession *session,GError **err); gint8 guestfs_session_get_autosync (GuestfsSession *session,GError **err); gint8 guestfs_session_get_direct (GuestfsSession *session,GError **err); gchar * guestfs_session_get_e2attrs (GuestfsSession *session,const gchar *file,GError **err); gint64 guestfs_session_get_e2generation (GuestfsSession *session,const gchar *file,GError **err); gchar * guestfs_session_get_e2label (GuestfsSession *session,const gchar *device,GError **err); gchar * guestfs_session_get_e2uuid (GuestfsSession *session,const gchar *device,GError **err); gint32 guestfs_session_get_memsize (GuestfsSession *session,GError **err); gint8 guestfs_session_get_network (GuestfsSession *session,GError **err); const gchar * guestfs_session_get_path (GuestfsSession *session,GError **err); gint8 guestfs_session_get_pgroup (GuestfsSession *session,GError **err); gint32 guestfs_session_get_pid (GuestfsSession *session,GError **err); const gchar * guestfs_session_get_qemu (GuestfsSession *session,GError **err); gint8 guestfs_session_get_recovery_proc (GuestfsSession *session,GError **err); gint8 guestfs_session_get_selinux (GuestfsSession *session,GError **err); gint32 guestfs_session_get_smp (GuestfsSession *session,GError **err); gint32 guestfs_session_get_state (GuestfsSession *session,GError **err); gint8 guestfs_session_get_trace (GuestfsSession *session,GError **err); gint32 guestfs_session_get_umask (GuestfsSession *session,GError **err); gint8 guestfs_session_get_verbose (GuestfsSession *session,GError **err); gchar * guestfs_session_getcon (GuestfsSession *session,GError **err); guint8 * guestfs_session_getxattr (GuestfsSession *session,const gchar *path,const gchar *name,gsize *size_r,GError **err); GuestfsXAttr ** guestfs_session_getxattrs (GuestfsSession *session,const gchar *path,GError **err); gchar ** guestfs_session_glob_expand (GuestfsSession *session,const gchar *pattern,GError **err); gchar ** guestfs_session_grep (GuestfsSession *session,const gchar *regex,const gchar *path,GError **err); gchar ** guestfs_session_grepi (GuestfsSession *session,const gchar *regex,const gchar *path,GError **err); gboolean guestfs_session_grub_install (GuestfsSession *session,const gchar *root,const gchar *device,GError **err); gchar ** guestfs_session_head (GuestfsSession *session,const gchar *path,GError **err); gchar ** guestfs_session_head_n (GuestfsSession *session,gint32 nrlines,const gchar *path,GError **err); gchar * guestfs_session_hexdump (GuestfsSession *session,const gchar *path,GError **err); guint8 * guestfs_session_initrd_cat (GuestfsSession *session,const gchar *initrdpath,const gchar *filename,gsize *size_r,GError **err); gchar ** guestfs_session_initrd_list (GuestfsSession *session,const gchar *path,GError **err); gint64 guestfs_session_inotify_add_watch (GuestfsSession *session,const gchar *path,gint32 mask,GError **err); gboolean guestfs_session_inotify_close (GuestfsSession *session,GError **err); gchar ** guestfs_session_inotify_files (GuestfsSession *session,GError **err); gboolean guestfs_session_inotify_init (GuestfsSession *session,gint32 maxevents,GError **err); GuestfsINotifyEvent ** guestfs_session_inotify_read (GuestfsSession *session,GError **err); gboolean guestfs_session_inotify_rm_watch (GuestfsSession *session,gint32 wd,GError **err); gchar * guestfs_session_inspect_get_arch (GuestfsSession *session,const gchar *root,GError **err); gchar * guestfs_session_inspect_get_distro (GuestfsSession *session,const gchar *root,GError **err); GHashTable * guestfs_session_inspect_get_drive_mappings (GuestfsSession *session,const gchar *root,GError **err); gchar ** guestfs_session_inspect_get_filesystems (GuestfsSession *session,const gchar *root,GError **err); gchar * guestfs_session_inspect_get_format (GuestfsSession *session,const gchar *root,GError **err); gchar * guestfs_session_inspect_get_hostname (GuestfsSession *session,const gchar *root,GError **err); guint8 * guestfs_session_inspect_get_icon (GuestfsSession *session,const gchar *root,GuestfsInspectGetIcon *optargs,gsize *size_r,GError **err); gint32 guestfs_session_inspect_get_major_version (GuestfsSession *session,const gchar *root,GError **err); gint32 guestfs_session_inspect_get_minor_version (GuestfsSession *session,const gchar *root,GError **err); GHashTable * guestfs_session_inspect_get_mountpoints (GuestfsSession *session,const gchar *root,GError **err); gchar * guestfs_session_inspect_get_package_format (GuestfsSession *session,const gchar *root,GError **err); gchar * guestfs_session_inspect_get_package_management (GuestfsSession *session,const gchar *root,GError **err); gchar * guestfs_session_inspect_get_product_name (GuestfsSession *session,const gchar *root,GError **err); gchar * guestfs_session_inspect_get_product_variant (GuestfsSession *session,const gchar *root,GError **err); gchar ** guestfs_session_inspect_get_roots (GuestfsSession *session,GError **err); gchar * guestfs_session_inspect_get_windows_current_control_set (GuestfsSession *session,const gchar *root,GError **err); gchar * guestfs_session_inspect_get_windows_systemroot (GuestfsSession *session,const gchar *root,GError **err); gint8 guestfs_session_inspect_is_live (GuestfsSession *session,const gchar *root,GError **err); gint8 guestfs_session_inspect_is_multipart (GuestfsSession *session,const gchar *root,GError **err); gint8 guestfs_session_inspect_is_netinst (GuestfsSession *session,const gchar *root,GError **err); GuestfsApplication ** guestfs_session_inspect_list_applications (GuestfsSession *session,const gchar *root,GError **err); gchar ** guestfs_session_inspect_os (GuestfsSession *session,GError **err); gboolean guestfs_session_internal_autosync (GuestfsSession *session,GError **err); gint8 guestfs_session_is_blockdev (GuestfsSession *session,const gchar *path,GError **err); gint8 guestfs_session_is_busy (GuestfsSession *session,GError **err); gint8 guestfs_session_is_chardev (GuestfsSession *session,const gchar *path,GError **err); gint8 guestfs_session_is_config (GuestfsSession *session,GError **err); gint8 guestfs_session_is_dir (GuestfsSession *session,const gchar *path,GError **err); gint8 guestfs_session_is_fifo (GuestfsSession *session,const gchar *path,GError **err); gint8 guestfs_session_is_file (GuestfsSession *session,const gchar *path,GError **err); gint8 guestfs_session_is_launching (GuestfsSession *session,GError **err); gint8 guestfs_session_is_lv (GuestfsSession *session,const gchar *device,GError **err); gint8 guestfs_session_is_ready (GuestfsSession *session,GError **err); gint8 guestfs_session_is_socket (GuestfsSession *session,const gchar *path,GError **err); gint8 guestfs_session_is_symlink (GuestfsSession *session,const gchar *path,GError **err); gint8 guestfs_session_is_zero (GuestfsSession *session,const gchar *path,GError **err); gint8 guestfs_session_is_zero_device (GuestfsSession *session,const gchar *device,GError **err); GuestfsISOInfo * guestfs_session_isoinfo (GuestfsSession *session,const gchar *isofile,GError **err); GuestfsISOInfo * guestfs_session_isoinfo_device (GuestfsSession *session,const gchar *device,GError **err); gboolean guestfs_session_kill_subprocess (GuestfsSession *session,GError **err); gboolean guestfs_session_launch (GuestfsSession *session,GError **err); gboolean guestfs_session_lchown (GuestfsSession *session,gint32 owner,gint32 group,const gchar *path,GError **err); guint8 * guestfs_session_lgetxattr (GuestfsSession *session,const gchar *path,const gchar *name,gsize *size_r,GError **err); GuestfsXAttr ** guestfs_session_lgetxattrs (GuestfsSession *session,const gchar *path,GError **err); gchar ** guestfs_session_list_9p (GuestfsSession *session,GError **err); gchar ** guestfs_session_list_devices (GuestfsSession *session,GError **err); gchar ** guestfs_session_list_dm_devices (GuestfsSession *session,GError **err); GHashTable * guestfs_session_list_filesystems (GuestfsSession *session,GError **err); gchar ** guestfs_session_list_md_devices (GuestfsSession *session,GError **err); gchar ** guestfs_session_list_partitions (GuestfsSession *session,GError **err); gchar * guestfs_session_ll (GuestfsSession *session,const gchar *directory,GError **err); gchar * guestfs_session_llz (GuestfsSession *session,const gchar *directory,GError **err); gboolean guestfs_session_ln (GuestfsSession *session,const gchar *target,const gchar *linkname,GError **err); gboolean guestfs_session_ln_f (GuestfsSession *session,const gchar *target,const gchar *linkname,GError **err); gboolean guestfs_session_ln_s (GuestfsSession *session,const gchar *target,const gchar *linkname,GError **err); gboolean guestfs_session_ln_sf (GuestfsSession *session,const gchar *target,const gchar *linkname,GError **err); gboolean guestfs_session_lremovexattr (GuestfsSession *session,const gchar *xattr,const gchar *path,GError **err); gchar ** guestfs_session_ls (GuestfsSession *session,const gchar *directory,GError **err); gboolean guestfs_session_lsetxattr (GuestfsSession *session,const gchar *xattr,const gchar *val,gint32 vallen,const gchar *path,GError **err); GuestfsStat * guestfs_session_lstat (GuestfsSession *session,const gchar *path,GError **err); GuestfsStat ** guestfs_session_lstatlist (GuestfsSession *session,const gchar *path,gchar *const *names,GError **err); gboolean guestfs_session_luks_add_key (GuestfsSession *session,const gchar *device,const gchar *key,const gchar *newkey,gint32 keyslot,GError **err); gboolean guestfs_session_luks_close (GuestfsSession *session,const gchar *device,GError **err); gboolean guestfs_session_luks_format (GuestfsSession *session,const gchar *device,const gchar *key,gint32 keyslot,GError **err); gboolean guestfs_session_luks_format_cipher (GuestfsSession *session,const gchar *device,const gchar *key,gint32 keyslot,const gchar *cipher,GError **err); gboolean guestfs_session_luks_kill_slot (GuestfsSession *session,const gchar *device,const gchar *key,gint32 keyslot,GError **err); gboolean guestfs_session_luks_open (GuestfsSession *session,const gchar *device,const gchar *key,const gchar *mapname,GError **err); gboolean guestfs_session_luks_open_ro (GuestfsSession *session,const gchar *device,const gchar *key,const gchar *mapname,GError **err); gboolean guestfs_session_lvcreate (GuestfsSession *session,const gchar *logvol,const gchar *volgroup,gint32 mbytes,GError **err); gboolean guestfs_session_lvcreate_free (GuestfsSession *session,const gchar *logvol,const gchar *volgroup,gint32 percent,GError **err); gchar * guestfs_session_lvm_canonical_lv_name (GuestfsSession *session,const gchar *lvname,GError **err); gboolean guestfs_session_lvm_clear_filter (GuestfsSession *session,GError **err); gboolean guestfs_session_lvm_remove_all (GuestfsSession *session,GError **err); gboolean guestfs_session_lvm_set_filter (GuestfsSession *session,gchar *const *devices,GError **err); gboolean guestfs_session_lvremove (GuestfsSession *session,const gchar *device,GError **err); gboolean guestfs_session_lvrename (GuestfsSession *session,const gchar *logvol,const gchar *newlogvol,GError **err); gboolean guestfs_session_lvresize (GuestfsSession *session,const gchar *device,gint32 mbytes,GError **err); gboolean guestfs_session_lvresize_free (GuestfsSession *session,const gchar *lv,gint32 percent,GError **err); gchar ** guestfs_session_lvs (GuestfsSession *session,GError **err); GuestfsLV ** guestfs_session_lvs_full (GuestfsSession *session,GError **err); gchar * guestfs_session_lvuuid (GuestfsSession *session,const gchar *device,GError **err); GuestfsXAttr ** guestfs_session_lxattrlist (GuestfsSession *session,const gchar *path,gchar *const *names,GError **err); gboolean guestfs_session_md_create (GuestfsSession *session,const gchar *name,gchar *const *devices,GuestfsMDCreate *optargs,GError **err); GHashTable * guestfs_session_md_detail (GuestfsSession *session,const gchar *md,GError **err); GuestfsMDStat ** guestfs_session_md_stat (GuestfsSession *session,const gchar *md,GError **err); gboolean guestfs_session_md_stop (GuestfsSession *session,const gchar *md,GError **err); gboolean guestfs_session_mkdir (GuestfsSession *session,const gchar *path,GError **err); gboolean guestfs_session_mkdir_mode (GuestfsSession *session,const gchar *path,gint32 mode,GError **err); gboolean guestfs_session_mkdir_p (GuestfsSession *session,const gchar *path,GError **err); gchar * guestfs_session_mkdtemp (GuestfsSession *session,const gchar *tmpl,GError **err); gboolean guestfs_session_mke2fs_J (GuestfsSession *session,const gchar *fstype,gint32 blocksize,const gchar *device,const gchar *journal,GError **err); gboolean guestfs_session_mke2fs_JL (GuestfsSession *session,const gchar *fstype,gint32 blocksize,const gchar *device,const gchar *label,GError **err); gboolean guestfs_session_mke2fs_JU (GuestfsSession *session,const gchar *fstype,gint32 blocksize,const gchar *device,const gchar *uuid,GError **err); gboolean guestfs_session_mke2journal (GuestfsSession *session,gint32 blocksize,const gchar *device,GError **err); gboolean guestfs_session_mke2journal_L (GuestfsSession *session,gint32 blocksize,const gchar *label,const gchar *device,GError **err); gboolean guestfs_session_mke2journal_U (GuestfsSession *session,gint32 blocksize,const gchar *uuid,const gchar *device,GError **err); gboolean guestfs_session_mkfifo (GuestfsSession *session,gint32 mode,const gchar *path,GError **err); gboolean guestfs_session_mkfs (GuestfsSession *session,const gchar *fstype,const gchar *device,GError **err); gboolean guestfs_session_mkfs_b (GuestfsSession *session,const gchar *fstype,gint32 blocksize,const gchar *device,GError **err); gboolean guestfs_session_mkfs_btrfs (GuestfsSession *session,gchar *const *devices,GuestfsMkfsBtrfs *optargs,GError **err); gboolean guestfs_session_mkfs_opts (GuestfsSession *session,const gchar *fstype,const gchar *device,GuestfsMkfsOpts *optargs,GError **err); gboolean guestfs_session_mkmountpoint (GuestfsSession *session,const gchar *exemptpath,GError **err); gboolean guestfs_session_mknod (GuestfsSession *session,gint32 mode,gint32 devmajor,gint32 devminor,const gchar *path,GError **err); gboolean guestfs_session_mknod_b (GuestfsSession *session,gint32 mode,gint32 devmajor,gint32 devminor,const gchar *path,GError **err); gboolean guestfs_session_mknod_c (GuestfsSession *session,gint32 mode,gint32 devmajor,gint32 devminor,const gchar *path,GError **err); gboolean guestfs_session_mkswap (GuestfsSession *session,const gchar *device,GError **err); gboolean guestfs_session_mkswap_L (GuestfsSession *session,const gchar *label,const gchar *device,GError **err); gboolean guestfs_session_mkswap_U (GuestfsSession *session,const gchar *uuid,const gchar *device,GError **err); gboolean guestfs_session_mkswap_file (GuestfsSession *session,const gchar *path,GError **err); gboolean guestfs_session_modprobe (GuestfsSession *session,const gchar *modulename,GError **err); gboolean guestfs_session_mount (GuestfsSession *session,const gchar *device,const gchar *mountpoint,GError **err); gboolean guestfs_session_mount_9p (GuestfsSession *session,const gchar *mounttag,const gchar *mountpoint,GuestfsMount9P *optargs,GError **err); gboolean guestfs_session_mount_local (GuestfsSession *session,const gchar *localmountpoint,GuestfsMountLocal *optargs,GError **err); gboolean guestfs_session_mount_local_run (GuestfsSession *session,GCancellable *cancellable,GError **err); gboolean guestfs_session_mount_loop (GuestfsSession *session,const gchar *file,const gchar *mountpoint,GError **err); gboolean guestfs_session_mount_options (GuestfsSession *session,const gchar *options,const gchar *device,const gchar *mountpoint,GError **err); gboolean guestfs_session_mount_ro (GuestfsSession *session,const gchar *device,const gchar *mountpoint,GError **err); gboolean guestfs_session_mount_vfs (GuestfsSession *session,const gchar *options,const gchar *vfstype,const gchar *device,const gchar *mountpoint,GError **err); GHashTable * guestfs_session_mountpoints (GuestfsSession *session,GError **err); gchar ** guestfs_session_mounts (GuestfsSession *session,GError **err); gboolean guestfs_session_mv (GuestfsSession *session,const gchar *src,const gchar *dest,GError **err); GuestfsSession * guestfs_session_new (void); gint32 guestfs_session_ntfs_3g_probe (GuestfsSession *session,gboolean rw,const gchar *device,GError **err); gboolean guestfs_session_ntfsclone_in (GuestfsSession *session,const gchar *backupfile,const gchar *device,GCancellable *cancellable,GError **err); gboolean guestfs_session_ntfsclone_out (GuestfsSession *session,const gchar *device,const gchar *backupfile,GuestfsNtfscloneOut *optargs,GCancellable *cancellable,GError **err); gboolean guestfs_session_ntfsfix (GuestfsSession *session,const gchar *device,GuestfsNtfsfix *optargs,GError **err); gboolean guestfs_session_ntfsresize (GuestfsSession *session,const gchar *device,GError **err); gboolean guestfs_session_ntfsresize_opts (GuestfsSession *session,const gchar *device,GuestfsNTFSResizeOpts *optargs,GError **err); gboolean guestfs_session_ntfsresize_size (GuestfsSession *session,const gchar *device,gint64 size,GError **err); gboolean guestfs_session_part_add (GuestfsSession *session,const gchar *device,const gchar *prlogex,gint64 startsect,gint64 endsect,GError **err); gboolean guestfs_session_part_del (GuestfsSession *session,const gchar *device,gint32 partnum,GError **err); gboolean guestfs_session_part_disk (GuestfsSession *session,const gchar *device,const gchar *parttype,GError **err); gint8 guestfs_session_part_get_bootable (GuestfsSession *session,const gchar *device,gint32 partnum,GError **err); gint32 guestfs_session_part_get_mbr_id (GuestfsSession *session,const gchar *device,gint32 partnum,GError **err); gchar * guestfs_session_part_get_parttype (GuestfsSession *session,const gchar *device,GError **err); gboolean guestfs_session_part_init (GuestfsSession *session,const gchar *device,const gchar *parttype,GError **err); GuestfsPartition ** guestfs_session_part_list (GuestfsSession *session,const gchar *device,GError **err); gboolean guestfs_session_part_set_bootable (GuestfsSession *session,const gchar *device,gint32 partnum,gboolean bootable,GError **err); gboolean guestfs_session_part_set_mbr_id (GuestfsSession *session,const gchar *device,gint32 partnum,gint32 idbyte,GError **err); gboolean guestfs_session_part_set_name (GuestfsSession *session,const gchar *device,gint32 partnum,const gchar *name,GError **err); gchar * guestfs_session_part_to_dev (GuestfsSession *session,const gchar *partition,GError **err); gint32 guestfs_session_part_to_partnum (GuestfsSession *session,const gchar *partition,GError **err); gboolean guestfs_session_ping_daemon (GuestfsSession *session,GError **err); guint8 * guestfs_session_pread (GuestfsSession *session,const gchar *path,gint32 count,gint64 offset,gsize *size_r,GError **err); guint8 * guestfs_session_pread_device (GuestfsSession *session,const gchar *device,gint32 count,gint64 offset,gsize *size_r,GError **err); gboolean guestfs_session_pvcreate (GuestfsSession *session,const gchar *device,GError **err); gboolean guestfs_session_pvremove (GuestfsSession *session,const gchar *device,GError **err); gboolean guestfs_session_pvresize (GuestfsSession *session,const gchar *device,GError **err); gboolean guestfs_session_pvresize_size (GuestfsSession *session,const gchar *device,gint64 size,GError **err); gchar ** guestfs_session_pvs (GuestfsSession *session,GError **err); GuestfsPV ** guestfs_session_pvs_full (GuestfsSession *session,GError **err); gchar * guestfs_session_pvuuid (GuestfsSession *session,const gchar *device,GError **err); gint32 guestfs_session_pwrite (GuestfsSession *session,const gchar *path,const guint8 *content,gsize content_size,gint64 offset,GError **err); gint32 guestfs_session_pwrite_device (GuestfsSession *session,const gchar *device,const guint8 *content,gsize content_size,gint64 offset,GError **err); guint8 * guestfs_session_read_file (GuestfsSession *session,const gchar *path,gsize *size_r,GError **err); gchar ** guestfs_session_read_lines (GuestfsSession *session,const gchar *path,GError **err); GuestfsDirent ** guestfs_session_readdir (GuestfsSession *session,const gchar *dir,GError **err); gchar * guestfs_session_readlink (GuestfsSession *session,const gchar *path,GError **err); gchar ** guestfs_session_readlinklist (GuestfsSession *session,const gchar *path,gchar *const *names,GError **err); gchar * guestfs_session_realpath (GuestfsSession *session,const gchar *path,GError **err); gboolean guestfs_session_removexattr (GuestfsSession *session,const gchar *xattr,const gchar *path,GError **err); gboolean guestfs_session_resize2fs (GuestfsSession *session,const gchar *device,GError **err); gboolean guestfs_session_resize2fs_M (GuestfsSession *session,const gchar *device,GError **err); gboolean guestfs_session_resize2fs_size (GuestfsSession *session,const gchar *device,gint64 size,GError **err); gboolean guestfs_session_rm (GuestfsSession *session,const gchar *path,GError **err); gboolean guestfs_session_rm_rf (GuestfsSession *session,const gchar *path,GError **err); gboolean guestfs_session_rmdir (GuestfsSession *session,const gchar *path,GError **err); gboolean guestfs_session_rmmountpoint (GuestfsSession *session,const gchar *exemptpath,GError **err); gboolean guestfs_session_scrub_device (GuestfsSession *session,const gchar *device,GError **err); gboolean guestfs_session_scrub_file (GuestfsSession *session,const gchar *file,GError **err); gboolean guestfs_session_scrub_freespace (GuestfsSession *session,const gchar *dir,GError **err); gboolean guestfs_session_set_append (GuestfsSession *session,const gchar *append,GError **err); gboolean guestfs_session_set_attach_method (GuestfsSession *session,const gchar *attachmethod,GError **err); gboolean guestfs_session_set_autosync (GuestfsSession *session,gboolean autosync,GError **err); gboolean guestfs_session_set_direct (GuestfsSession *session,gboolean direct,GError **err); gboolean guestfs_session_set_e2attrs (GuestfsSession *session,const gchar *file,const gchar *attrs,GuestfsSetE2attrs *optargs,GError **err); gboolean guestfs_session_set_e2generation (GuestfsSession *session,const gchar *file,gint64 generation,GError **err); gboolean guestfs_session_set_e2label (GuestfsSession *session,const gchar *device,const gchar *label,GError **err); gboolean guestfs_session_set_e2uuid (GuestfsSession *session,const gchar *device,const gchar *uuid,GError **err); gboolean guestfs_session_set_label (GuestfsSession *session,const gchar *device,const gchar *label,GError **err); gboolean guestfs_session_set_memsize (GuestfsSession *session,gint32 memsize,GError **err); gboolean guestfs_session_set_network (GuestfsSession *session,gboolean network,GError **err); gboolean guestfs_session_set_path (GuestfsSession *session,const gchar *searchpath,GError **err); gboolean guestfs_session_set_pgroup (GuestfsSession *session,gboolean pgroup,GError **err); gboolean guestfs_session_set_qemu (GuestfsSession *session,const gchar *qemu,GError **err); gboolean guestfs_session_set_recovery_proc (GuestfsSession *session,gboolean recoveryproc,GError **err); gboolean guestfs_session_set_selinux (GuestfsSession *session,gboolean selinux,GError **err); gboolean guestfs_session_set_smp (GuestfsSession *session,gint32 smp,GError **err); gboolean guestfs_session_set_trace (GuestfsSession *session,gboolean trace,GError **err); gboolean guestfs_session_set_verbose (GuestfsSession *session,gboolean verbose,GError **err); gboolean guestfs_session_setcon (GuestfsSession *session,const gchar *context,GError **err); gboolean guestfs_session_setxattr (GuestfsSession *session,const gchar *xattr,const gchar *val,gint32 vallen,const gchar *path,GError **err); gboolean guestfs_session_sfdisk (GuestfsSession *session,const gchar *device,gint32 cyls,gint32 heads,gint32 sectors,gchar *const *lines,GError **err); gboolean guestfs_session_sfdiskM (GuestfsSession *session,const gchar *device,gchar *const *lines,GError **err); gboolean guestfs_session_sfdisk_N (GuestfsSession *session,const gchar *device,gint32 partnum,gint32 cyls,gint32 heads,gint32 sectors,const gchar *line,GError **err); gchar * guestfs_session_sfdisk_disk_geometry (GuestfsSession *session,const gchar *device,GError **err); gchar * guestfs_session_sfdisk_kernel_geometry (GuestfsSession *session,const gchar *device,GError **err); gchar * guestfs_session_sfdisk_l (GuestfsSession *session,const gchar *device,GError **err); gchar * guestfs_session_sh (GuestfsSession *session,const gchar *command,GError **err); gchar ** guestfs_session_sh_lines (GuestfsSession *session,const gchar *command,GError **err); gboolean guestfs_session_sleep (GuestfsSession *session,gint32 secs,GError **err); GuestfsStat * guestfs_session_stat (GuestfsSession *session,const gchar *path,GError **err); GuestfsStatVFS * guestfs_session_statvfs (GuestfsSession *session,const gchar *path,GError **err); gchar ** guestfs_session_strings (GuestfsSession *session,const gchar *path,GError **err); gchar ** guestfs_session_strings_e (GuestfsSession *session,const gchar *encoding,const gchar *path,GError **err); gboolean guestfs_session_swapoff_device (GuestfsSession *session,const gchar *device,GError **err); gboolean guestfs_session_swapoff_file (GuestfsSession *session,const gchar *file,GError **err); gboolean guestfs_session_swapoff_label (GuestfsSession *session,const gchar *label,GError **err); gboolean guestfs_session_swapoff_uuid (GuestfsSession *session,const gchar *uuid,GError **err); gboolean guestfs_session_swapon_device (GuestfsSession *session,const gchar *device,GError **err); gboolean guestfs_session_swapon_file (GuestfsSession *session,const gchar *file,GError **err); gboolean guestfs_session_swapon_label (GuestfsSession *session,const gchar *label,GError **err); gboolean guestfs_session_swapon_uuid (GuestfsSession *session,const gchar *uuid,GError **err); gboolean guestfs_session_sync (GuestfsSession *session,GError **err); gchar ** guestfs_session_tail (GuestfsSession *session,const gchar *path,GError **err); gchar ** guestfs_session_tail_n (GuestfsSession *session,gint32 nrlines,const gchar *path,GError **err); gboolean guestfs_session_tar_in (GuestfsSession *session,const gchar *tarfile,const gchar *directory,GCancellable *cancellable,GError **err); gboolean guestfs_session_tar_out (GuestfsSession *session,const gchar *directory,const gchar *tarfile,GCancellable *cancellable,GError **err); gboolean guestfs_session_test0 (GuestfsSession *session,const gchar *str,const gchar *optstr,gchar *const *strlist,gboolean b,gint32 integer,gint64 integer64,const gchar *filein,const gchar *fileout,const guint8 *bufferin,gsize bufferin_size,GuestfsTest0 *optargs,GCancellable *cancellable,GError **err); gint8 guestfs_session_test0rbool (GuestfsSession *session,const gchar *val,GError **err); gint8 guestfs_session_test0rboolerr (GuestfsSession *session,GError **err); guint8 * guestfs_session_test0rbufferout (GuestfsSession *session,const gchar *val,gsize *size_r,GError **err); guint8 * guestfs_session_test0rbufferouterr (GuestfsSession *session,gsize *size_r,GError **err); const gchar * guestfs_session_test0rconstoptstring (GuestfsSession *session,const gchar *val,GError **err); const gchar * guestfs_session_test0rconstoptstringerr (GuestfsSession *session,GError **err); const gchar * guestfs_session_test0rconststring (GuestfsSession *session,const gchar *val,GError **err); const gchar * guestfs_session_test0rconststringerr (GuestfsSession *session,GError **err); GHashTable * guestfs_session_test0rhashtable (GuestfsSession *session,const gchar *val,GError **err); GHashTable * guestfs_session_test0rhashtableerr (GuestfsSession *session,GError **err); gint32 guestfs_session_test0rint (GuestfsSession *session,const gchar *val,GError **err); gint64 guestfs_session_test0rint64 (GuestfsSession *session,const gchar *val,GError **err); gint64 guestfs_session_test0rint64err (GuestfsSession *session,GError **err); gint32 guestfs_session_test0rinterr (GuestfsSession *session,GError **err); gchar * guestfs_session_test0rstring (GuestfsSession *session,const gchar *val,GError **err); gchar * guestfs_session_test0rstringerr (GuestfsSession *session,GError **err); gchar ** guestfs_session_test0rstringlist (GuestfsSession *session,const gchar *val,GError **err); gchar ** guestfs_session_test0rstringlisterr (GuestfsSession *session,GError **err); GuestfsPV * guestfs_session_test0rstruct (GuestfsSession *session,const gchar *val,GError **err); GuestfsPV * guestfs_session_test0rstructerr (GuestfsSession *session,GError **err); GuestfsPV ** guestfs_session_test0rstructlist (GuestfsSession *session,const gchar *val,GError **err); GuestfsPV ** guestfs_session_test0rstructlisterr (GuestfsSession *session,GError **err); gboolean guestfs_session_tgz_in (GuestfsSession *session,const gchar *tarball,const gchar *directory,GCancellable *cancellable,GError **err); gboolean guestfs_session_tgz_out (GuestfsSession *session,const gchar *directory,const gchar *tarball,GCancellable *cancellable,GError **err); gboolean guestfs_session_touch (GuestfsSession *session,const gchar *path,GError **err); gboolean guestfs_session_truncate (GuestfsSession *session,const gchar *path,GError **err); gboolean guestfs_session_truncate_size (GuestfsSession *session,const gchar *path,gint64 size,GError **err); gboolean guestfs_session_tune2fs (GuestfsSession *session,const gchar *device,GuestfsTune2FS *optargs,GError **err); GHashTable * guestfs_session_tune2fs_l (GuestfsSession *session,const gchar *device,GError **err); gboolean guestfs_session_txz_in (GuestfsSession *session,const gchar *tarball,const gchar *directory,GCancellable *cancellable,GError **err); gboolean guestfs_session_txz_out (GuestfsSession *session,const gchar *directory,const gchar *tarball,GCancellable *cancellable,GError **err); gint32 guestfs_session_umask (GuestfsSession *session,gint32 mask,GError **err); gboolean guestfs_session_umount (GuestfsSession *session,const gchar *pathordevice,GError **err); gboolean guestfs_session_umount_all (GuestfsSession *session,GError **err); gboolean guestfs_session_umount_local (GuestfsSession *session,GuestfsUmountLocal *optargs,GError **err); gboolean guestfs_session_upload (GuestfsSession *session,const gchar *filename,const gchar *remotefilename,GCancellable *cancellable,GError **err); gboolean guestfs_session_upload_offset (GuestfsSession *session,const gchar *filename,const gchar *remotefilename,gint64 offset,GCancellable *cancellable,GError **err); gboolean guestfs_session_utimens (GuestfsSession *session,const gchar *path,gint64 atsecs,gint64 atnsecs,gint64 mtsecs,gint64 mtnsecs,GError **err); GuestfsVersion * guestfs_session_version (GuestfsSession *session,GError **err); gchar * guestfs_session_vfs_label (GuestfsSession *session,const gchar *device,GError **err); gchar * guestfs_session_vfs_type (GuestfsSession *session,const gchar *device,GError **err); gchar * guestfs_session_vfs_uuid (GuestfsSession *session,const gchar *device,GError **err); gboolean guestfs_session_vg_activate (GuestfsSession *session,gboolean activate,gchar *const *volgroups,GError **err); gboolean guestfs_session_vg_activate_all (GuestfsSession *session,gboolean activate,GError **err); gboolean guestfs_session_vgcreate (GuestfsSession *session,const gchar *volgroup,gchar *const *physvols,GError **err); gchar ** guestfs_session_vglvuuids (GuestfsSession *session,const gchar *vgname,GError **err); guint8 * guestfs_session_vgmeta (GuestfsSession *session,const gchar *vgname,gsize *size_r,GError **err); gchar ** guestfs_session_vgpvuuids (GuestfsSession *session,const gchar *vgname,GError **err); gboolean guestfs_session_vgremove (GuestfsSession *session,const gchar *vgname,GError **err); gboolean guestfs_session_vgrename (GuestfsSession *session,const gchar *volgroup,const gchar *newvolgroup,GError **err); gchar ** guestfs_session_vgs (GuestfsSession *session,GError **err); GuestfsVG ** guestfs_session_vgs_full (GuestfsSession *session,GError **err); gboolean guestfs_session_vgscan (GuestfsSession *session,GError **err); gchar * guestfs_session_vguuid (GuestfsSession *session,const gchar *vgname,GError **err); gboolean guestfs_session_wait_ready (GuestfsSession *session,GError **err); gint32 guestfs_session_wc_c (GuestfsSession *session,const gchar *path,GError **err); gint32 guestfs_session_wc_l (GuestfsSession *session,const gchar *path,GError **err); gint32 guestfs_session_wc_w (GuestfsSession *session,const gchar *path,GError **err); gboolean guestfs_session_wipefs (GuestfsSession *session,const gchar *device,GError **err); gboolean guestfs_session_write (GuestfsSession *session,const gchar *path,const guint8 *content,gsize content_size,GError **err); gboolean guestfs_session_write_append (GuestfsSession *session,const gchar *path,const guint8 *content,gsize content_size,GError **err); gboolean guestfs_session_write_file (GuestfsSession *session,const gchar *path,const gchar *content,gint32 size,GError **err); gchar ** guestfs_session_zegrep (GuestfsSession *session,const gchar *regex,const gchar *path,GError **err); gchar ** guestfs_session_zegrepi (GuestfsSession *session,const gchar *regex,const gchar *path,GError **err); gboolean guestfs_session_zero (GuestfsSession *session,const gchar *device,GError **err); gboolean guestfs_session_zero_device (GuestfsSession *session,const gchar *device,GError **err); gboolean guestfs_session_zero_free_space (GuestfsSession *session,const gchar *directory,GError **err); gboolean guestfs_session_zerofree (GuestfsSession *session,const gchar *device,GError **err); gchar ** guestfs_session_zfgrep (GuestfsSession *session,const gchar *pattern,const gchar *path,GError **err); gchar ** guestfs_session_zfgrepi (GuestfsSession *session,const gchar *pattern,const gchar *path,GError **err); gchar * guestfs_session_zfile (GuestfsSession *session,const gchar *meth,const gchar *path,GError **err); gchar ** guestfs_session_zgrep (GuestfsSession *session,const gchar *regex,const gchar *path,GError **err); gchar ** guestfs_session_zgrepi (GuestfsSession *session,const gchar *regex,const gchar *path,GError **err);
GObject +----GuestfsSession
GEnum +----GuestfsSessionEvent
GBoxed +----GuestfsSessionEventParams
"appliance" :Run Last"close" :Run Last"enter" :Run Last"launch-done" :Run Last"library" :Run Last"progress" :Run Last"subprocess-quit" :Run Last"trace" :Run Last
struct GuestfsSession;
A libguestfs session, encapsulating a single libguestfs handle.
struct GuestfsSessionClass {
GObjectClass parent_class;
};
A class metadata object for GuestfsSession.
GObjectClass |
The superclass of GuestfsSession |
typedef enum {
GUESTFS_SESSION_EVENT_CLOSE,
GUESTFS_SESSION_EVENT_SUBPROCESS_QUIT,
GUESTFS_SESSION_EVENT_LAUNCH_DONE,
GUESTFS_SESSION_EVENT_PROGRESS,
GUESTFS_SESSION_EVENT_APPLIANCE,
GUESTFS_SESSION_EVENT_LIBRARY,
GUESTFS_SESSION_EVENT_TRACE,
GUESTFS_SESSION_EVENT_ENTER,
} GuestfsSessionEvent;
For more detail on libguestfs events, see "SETTING CALLBACKS TO HANDLE EVENTS" in guestfs(3).
| The close event | |
| The subprocess_quit event | |
| The launch_done event | |
| The progress event | |
| The appliance event | |
| The library event | |
| The trace event | |
| The enter event |
struct GuestfsSessionEventParams {
GuestfsSessionEvent event;
guint flags;
GByteArray *buf;
/* The libguestfs array has no fixed length, although it is currently only
* ever empty or length 4. We fix the length of the array here as there is
* currently no way for an arbitrary length array to be introspected in a
* boxed object.
*/
guint64 array[16];
size_t array_len;
};
GuestfsSessionEvent |
The event |
guint |
Unused |
GByteArray * |
A message buffer. This buffer can contain arbitrary 8 bit data, including NUL bytes |
guint64 |
An array of 64-bit unsigned integers |
The length of array
|
gboolean guestfs_session_add_cdrom (GuestfsSession *session,const gchar *filename,GError **err);
add a CD-ROM disk image to examine
This function adds a virtual CD-ROM disk image to the guest.
This is equivalent to the qemu parameter *-cdrom filename*.
Notes:
* This call checks for the existence of filename. This stops you from
specifying other types of drive which are supported by qemu such as
"nbd:" and "http:" URLs. To specify those, use the general
guestfs_session_config() call instead.
* If you just want to add an ISO file (often you use this as an
efficient way to transfer large files into the guest), then you
should probably use guestfs_session_add_drive_ro() instead.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gint32 guestfs_session_add_domain (GuestfsSession *session,const gchar *dom,GuestfsAddDomain *optargs,GError **err);
add the disk(s) from a named libvirt domain
This function adds the disk(s) attached to the named libvirt domain
dom. It works by connecting to libvirt, requesting the domain and
domain XML from libvirt, parsing it for disks, and calling
guestfs_session_add_drive_opts() on each one.
The number of disks added is returned. This operation is atomic: if an error is returned, then no disks are added.
This function does some minimal checks to make sure the libvirt domain
is not running (unless readonly is true). In a future version we will
try to acquire the libvirt lock on each disk.
Disks must be accessible locally. This often means that adding disks from a remote libvirt connection (see http://libvirt.org/remote.html ) will fail unless those disks are accessible via the same device path locally too.
The optional libvirturi parameter sets the libvirt URI (see http://libvirt.org/uri.html
). If this is not set then we connect to the default libvirt URI
(or one set through an environment variable, see the libvirt
documentation for full details).
The optional live flag controls whether this call will try to connect
to a running virtual machine guestfsd process if it sees a suitable
<channel> element in the libvirt XML definition. The default (if
the flag is omitted) is never to try. See "ATTACHING TO RUNNING DAEMONS"
in guestfs(3) for more information.
If the allowuuid flag is true (default is false) then a UUID *may* be
passed instead of the domain name. The dom string is treated as a UUID
first and looked up, and if that lookup fails then we treat dom as a
name as usual.
The optional readonlydisk parameter controls what we do for disks which
are marked <readonly/> in the libvirt XML. Possible values are:
readonlydisk = "error"
If readonly is false:
The whole call is aborted with an error if any disk with the <readonly/> flag is found.
If readonly is true:
Disks with the <readonly/> flag are added read-only.
readonlydisk = "read"
If readonly is false:
Disks with the <readonly/> flag are added read-only. Other disks are added read/write.
If readonly is true:
Disks with the <readonly/> flag are added read-only.
readonlydisk = "write" (default)
If readonly is false:
Disks with the <readonly/> flag are added read/write.
If readonly is true:
Disks with the <readonly/> flag are added read-only.
readonlydisk = "ignore"
If readonly is true or false:
Disks with the <readonly/> flag are skipped.
The other optional parameters are passed directly through to
guestfs_session_add_drive_opts().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
a GuestfsAddDomain containing optional arguments. [transfer none][allow-none] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gboolean guestfs_session_add_drive (GuestfsSession *session,const gchar *filename,GError **err);
add an image to examine or modify
This function is the equivalent of calling
guestfs_session_add_drive_opts() with no optional parameters, so the
disk is added writable, with the format being detected automatically.
Automatic detection of the format opens you up to a potential security
hole when dealing with untrusted raw-format images. See
CVE-2010-3851 and
RHBZ#642934 . Specifying the format closes this security
hole. Therefore you should think about replacing calls to this function
with calls to guestfs_session_add_drive_opts(), and specifying the
format.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_add_drive_opts (GuestfsSession *session,const gchar *filename,GuestfsAddDriveOpts *optargs,GError **err);
add an image to examine or modify
This function adds a virtual machine disk image filename to libguestfs.
The first time you call this function, the disk appears as "/dev/sda",
the second time as "/dev/sdb", and so on.
You don't necessarily need to be root when using libguestfs. However you obviously do need sufficient permissions to access the filename for whatever operations you want to perform (ie. read access if you just want to read the image or write access if you want to modify the image).
This call checks that filename exists.
The optional arguments are:
readonly
If true then the image is treated as read-only. Writes are still
allowed, but they are stored in a temporary snapshot overlay which
is discarded at the end. The disk that you add is not modified.
format
This forces the image format. If you omit this (or use
guestfs_session_add_drive() or guestfs_session_add_drive_ro()) then
the format is automatically detected. Possible formats include raw
and qcow2.
Automatic detection of the format opens you up to a potential security hole when dealing with untrusted raw-format images. See CVE-2010-3851 and RHBZ#642934 . Specifying the format closes this security hole.
iface
This rarely-used option lets you emulate the behaviour of the
deprecated guestfs_session_add_drive_with_if() call (q.v.)
name
The name the drive had in the original guest, e.g. /dev/sdb. This is
used as a hint to the guest inspection process if it is available.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
a GuestfsAddDriveOpts containing optional arguments. [transfer none][allow-none] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_add_drive_ro (GuestfsSession *session,const gchar *filename,GError **err);
add a drive in snapshot mode (read-only)
This function is the equivalent of calling
guestfs_session_add_drive_opts() with the optional parameter
GUESTFS_ADD_DRIVE_OPTS_READONLY set to 1, so the disk is added
read-only, with the format being detected automatically.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_add_drive_ro_with_if (GuestfsSession *session,const gchar *filename,const gchar *iface,GError **err);
add a drive read-only specifying the QEMU block emulation to use
This is the same as guestfs_session_add_drive_ro() but it allows you to
specify the QEMU interface emulation to use at run time.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_add_drive_with_if (GuestfsSession *session,const gchar *filename,const gchar *iface,GError **err);
add a drive specifying the QEMU block emulation to use
This is the same as guestfs_session_add_drive() but it allows you to
specify the QEMU interface emulation to use at run time.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_aug_clear (GuestfsSession *session,const gchar *augpath,GError **err);
clear Augeas path
Set the value associated with path to NULL. This is the same as the
augtool(1) clear command.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_aug_close (GuestfsSession *session,GError **err);
close the current Augeas handle
Close the current Augeas handle and free up any resources used by it.
After calling this, you have to call guestfs_session_aug_init() again
before you can use any other Augeas functions.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
GuestfsIntBool * guestfs_session_aug_defnode (GuestfsSession *session,const gchar *name,const gchar *expr,const gchar *val,GError **err);
define an Augeas node
Defines a variable name whose value is the result of evaluating expr.
If expr evaluates to an empty nodeset, a node is created, equivalent to
calling guestfs_session_aug_set() expr, value. name will be the
nodeset containing that single node.
On success this returns a pair containing the number of nodes in the nodeset, and a boolean flag if a node was created.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type utf8] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
a IntBool object, or NULL on error. [transfer full] |
gint32 guestfs_session_aug_defvar (GuestfsSession *session,const gchar *name,const gchar *expr,GError **err);
define an Augeas variable
Defines an Augeas variable name whose value is the result of evaluating
expr. If expr is NULL, then name is undefined.
On success this returns the number of nodes in expr, or 0 if expr
evaluates to something which is not a nodeset.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type utf8][allow-none] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gchar * guestfs_session_aug_get (GuestfsSession *session,const gchar *augpath,GError **err);
look up the value of an Augeas path
Look up the value associated with path. If path matches exactly one
node, the value is returned.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gboolean guestfs_session_aug_init (GuestfsSession *session,const gchar *root,gint32 flags,GError **err);
create a new Augeas handle
Create a new Augeas handle for editing configuration files. If there was any previous Augeas handle associated with this guestfs session, then it is closed.
You must call this before using any other "guestfs_aug_*" commands.
root is the filesystem root. root must not be NULL, use "/" instead.
The flags are the same as the flags defined in <augeas.h>, the logical *or* of the following integers:
AUG_SAVE_BACKUP = 1
Keep the original file with a ".augsave" extension.
AUG_SAVE_NEWFILE = 2
Save changes into a file with extension ".augnew", and do not
overwrite original. Overrides AUG_SAVE_BACKUP.
AUG_TYPE_CHECK = 4
Typecheck lenses.
This option is only useful when debugging Augeas lenses. Use of this
option may require additional memory for the libguestfs appliance.
You may need to set the LIBGUESTFS_MEMSIZE environment variable or
call guestfs_session_set_memsize().
AUG_NO_STDINC = 8
Do not use standard load path for modules.
AUG_SAVE_NOOP = 16
Make save a no-op, just record what would have been changed.
AUG_NO_LOAD = 32
Do not load the tree in guestfs_session_aug_init().
To close the handle, you can call guestfs_session_aug_close().
To find out more about Augeas, see http://augeas.net/ .
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [type gint32] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_aug_insert (GuestfsSession *session,const gchar *augpath,const gchar *label,gboolean before,GError **err);
insert a sibling Augeas node
Create a new sibling label for path, inserting it into the tree before
or after path (depending on the boolean flag before).
path must match exactly one existing node in the tree, and label must
be a label, ie. not contain "/", "*" or end with a bracketed index
"[N]".
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type utf8] |
|
. [type gboolean] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_aug_load (GuestfsSession *session,GError **err);
load files into the tree
Load files into the tree.
See aug_load in the Augeas documentation for the full gory details.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gchar ** guestfs_session_aug_ls (GuestfsSession *session,const gchar *augpath,GError **err);
list Augeas nodes under augpath
This is just a shortcut for listing guestfs_session_aug_match() "path/*"
and sorting the resulting nodes into alphabetical order.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
gchar ** guestfs_session_aug_match (GuestfsSession *session,const gchar *augpath,GError **err);
return Augeas nodes which match augpath
Returns a list of paths which match the path expression path. The
returned paths are sufficiently qualified so that they match exactly one
node in the current tree.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
gboolean guestfs_session_aug_mv (GuestfsSession *session,const gchar *src,const gchar *dest,GError **err);
move Augeas node
Move the node src to dest. src must match exactly one node. dest is
overwritten if it exists.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gint32 guestfs_session_aug_rm (GuestfsSession *session,const gchar *augpath,GError **err);
remove an Augeas path
Remove path and all of its children.
On success this returns the number of entries which were removed.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gboolean guestfs_session_aug_save (GuestfsSession *session,GError **err);
write all pending Augeas changes to disk
This writes all pending changes to disk.
The flags which were passed to guestfs_session_aug_init() affect exactly
how files are saved.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_aug_set (GuestfsSession *session,const gchar *augpath,const gchar *val,GError **err);
set Augeas path to value
Set the value associated with path to val.
In the Augeas API, it is possible to clear a node by setting the value
to NULL. Due to an oversight in the libguestfs API you cannot do that
with this call. Instead you must use the guestfs_session_aug_clear()
call.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_available (GuestfsSession *session,gchar *const *groups,GError **err);
test availability of some parts of the API
This command is used to check the availability of some groups of functionality in the appliance, which not all builds of the libguestfs appliance will be able to provide.
The libguestfs groups, and the functions that those groups correspond
to, are listed in "AVAILABILITY" in guestfs(3). You can also fetch this
list at runtime by calling guestfs_session_available_all_groups().
The argument groups is a list of group names, eg: "["inotify",
"augeas"]" would check for the availability of the Linux inotify
functions and Augeas (configuration file editing) functions.
The command returns no error if *all* requested groups are available.
It fails with an error if one or more of the requested groups is unavailable in the appliance.
If an unknown group name is included in the list of groups then an error is always returned.
*Notes:*
* You must call guestfs_session_launch() before calling this function.
The reason is because we don't know what groups are supported by the appliance/daemon until it is running and can be queried.
* If a group of functions is available, this does not necessarily mean that they will work. You still have to check for errors when calling individual API functions even if they are available.
* It is usually the job of distro packagers to build complete functionality into the libguestfs appliance. Upstream libguestfs, if built from source with all requirements satisfied, will support everything.
* This call was added in version 1.0.80. In previous versions of
libguestfs all you could do would be to speculatively execute a
command to find out if the daemon implemented it. See also
guestfs_session_version().
|
A GuestfsSession object. [transfer none] |
|
an array of strings. [transfer none][array zero-terminated=1][element-type utf8] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gchar ** guestfs_session_available_all_groups (GuestfsSession *session,GError **err);
return a list of all optional groups
This command returns a list of all optional groups that this daemon
knows about. Note this returns both supported and unsupported groups. To
find out which ones the daemon can actually support you have to call
guestfs_session_available() on each member of the returned list.
See also guestfs_session_available() and "AVAILABILITY" in guestfs(3).
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
gboolean guestfs_session_base64_in (GuestfsSession *session,const gchar *base64file,const gchar *filename,GCancellable *cancellable,GError **err);
upload base64-encoded data to file
This command uploads base64-encoded data from base64file to filename.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type filename] |
|
A GCancellable object |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_base64_out (GuestfsSession *session,const gchar *filename,const gchar *base64file,GCancellable *cancellable,GError **err);
download file and encode as base64
This command downloads the contents of filename, writing it out to
local file base64file encoded as base64.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type filename] |
|
A GCancellable object |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
GHashTable * guestfs_session_blkid (GuestfsSession *session,const gchar *device,GError **err);
print block device attributes
This command returns block device attributes for device. The following
fields are usually present in the returned hash. Other fields may also
be present.
UUID
The uuid of this device.
LABEL
The label of this device.
VERSION
The version of blkid command.
TYPE
The filesystem type or RAID of this device.
USAGE
The usage of this device, for example filesystem or raid.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
a GHashTable of results, or NULL on error. [transfer full][element-type utf8 utf8] |
gboolean guestfs_session_blockdev_flushbufs (GuestfsSession *session,const gchar *device,GError **err);
flush device buffers
This tells the kernel to flush internal buffers associated with device.
This uses the blockdev(8) command.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gint32 guestfs_session_blockdev_getbsz (GuestfsSession *session,const gchar *device,GError **err);
get blocksize of block device
This returns the block size of a device.
(Note this is different from both *size in blocks* and *filesystem block size*).
This uses the blockdev(8) command.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gint8 guestfs_session_blockdev_getro (GuestfsSession *session,const gchar *device,GError **err);
is block device set to read-only
Returns a boolean indicating if the block device is read-only (true if read-only, false if not).
This uses the blockdev(8) command.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gint64 guestfs_session_blockdev_getsize64 (GuestfsSession *session,const gchar *device,GError **err);
get total size of device in bytes
This returns the size of the device in bytes.
See also guestfs_session_blockdev_getsz().
This uses the blockdev(8) command.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gint32 guestfs_session_blockdev_getss (GuestfsSession *session,const gchar *device,GError **err);
get sectorsize of block device
This returns the size of sectors on a block device. Usually 512, but can be larger for modern devices.
(Note, this is not the size in sectors, use
guestfs_session_blockdev_getsz() for that).
This uses the blockdev(8) command.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gint64 guestfs_session_blockdev_getsz (GuestfsSession *session,const gchar *device,GError **err);
get total size of device in 512-byte sectors
This returns the size of the device in units of 512-byte sectors (even if the sectorsize isn't 512 bytes ... weird).
See also guestfs_session_blockdev_getss() for the real sector size of
the device, and guestfs_session_blockdev_getsize64() for the more useful
*size in bytes*.
This uses the blockdev(8) command.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gboolean guestfs_session_blockdev_rereadpt (GuestfsSession *session,const gchar *device,GError **err);
reread partition table
Reread the partition table on device.
This uses the blockdev(8) command.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_blockdev_setbsz (GuestfsSession *session,const gchar *device,gint32 blocksize,GError **err);
set blocksize of block device
This sets the block size of a device.
(Note this is different from both *size in blocks* and *filesystem block size*).
This uses the blockdev(8) command.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [type gint32] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_blockdev_setro (GuestfsSession *session,const gchar *device,GError **err);
set block device to read-only
Sets the block device named device to read-only.
This uses the blockdev(8) command.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_blockdev_setrw (GuestfsSession *session,const gchar *device,GError **err);
set block device to read-write
Sets the block device named device to read-write.
This uses the blockdev(8) command.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_btrfs_device_add (GuestfsSession *session,gchar *const *devices,const gchar *fs,GError **err);
add devices to a btrfs filesystem
Add the list of device(s) in devices to the btrfs filesystem mounted at
fs. If devices is an empty list, this does nothing.
|
A GuestfsSession object. [transfer none] |
|
an array of strings. [transfer none][array zero-terminated=1][element-type filename] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_btrfs_device_delete (GuestfsSession *session,gchar *const *devices,const gchar *fs,GError **err);
remove devices from a btrfs filesystem
Remove the devices from the btrfs filesystem mounted at fs. If
devices is an empty list, this does nothing.
|
A GuestfsSession object. [transfer none] |
|
an array of strings. [transfer none][array zero-terminated=1][element-type filename] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_btrfs_filesystem_balance (GuestfsSession *session,const gchar *fs,GError **err);
balance a btrfs filesystem
Balance the chunks in the btrfs filesystem mounted at fs across the
underlying devices.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_btrfs_filesystem_resize (GuestfsSession *session,const gchar *mountpoint,GuestfsBTRFSFilesystemResize *optargs,GError **err);
resize a btrfs filesystem
This command resizes a btrfs filesystem.
Note that unlike other resize calls, the filesystem has to be mounted and the parameter is the mountpoint not the device (this is a requirement of btrfs itself).
The optional parameters are:
size
The new size (in bytes) of the filesystem. If omitted, the
filesystem is resized to the maximum size.
See also btrfs(8).
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
a GuestfsBTRFSFilesystemResize containing optional arguments. [transfer none][allow-none] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_btrfs_filesystem_sync (GuestfsSession *session,const gchar *fs,GError **err);
sync a btrfs filesystem
Force sync on the btrfs filesystem mounted at fs.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_btrfs_fsck (GuestfsSession *session,const gchar *device,GuestfsBtrfsFsck *optargs,GError **err);
check a btrfs filesystem
Used to check a btrfs filesystem, device is the device file where the
filesystem is stored.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
a GuestfsBtrfsFsck containing optional arguments. [transfer none][allow-none] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_btrfs_set_seeding (GuestfsSession *session,const gchar *device,gboolean seeding,GError **err);
enable or disable the seeding feature of device
Enable or disable the seeding feature of a device that contains a btrfs filesystem.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [type gboolean] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_btrfs_subvolume_create (GuestfsSession *session,const gchar *dest,GError **err);
create a btrfs snapshot
Create a btrfs subvolume. The dest argument is the destination
directory and the name of the snapshot, in the form
"/path/to/dest/name".
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_btrfs_subvolume_delete (GuestfsSession *session,const gchar *subvolume,GError **err);
delete a btrfs snapshot
Delete the named btrfs subvolume.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
GuestfsBTRFSSubvolume ** guestfs_session_btrfs_subvolume_list (GuestfsSession *session,const gchar *fs,GError **err);
list btrfs snapshots and subvolumes
List the btrfs snapshots and subvolumes of the btrfs filesystem which is
mounted at fs.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
an array of BTRFSSubvolume objects, or NULL on error. [transfer full][array zero-terminated=1][element-type GuestfsBTRFSSubvolume] |
gboolean guestfs_session_btrfs_subvolume_set_default (GuestfsSession *session,gint64 id,const gchar *fs,GError **err);
set default btrfs subvolume
Set the subvolume of the btrfs filesystem fs which will be mounted by
default. See guestfs_session_btrfs_subvolume_list() to get a list of
subvolumes.
|
A GuestfsSession object. [transfer none] |
|
. [type gint64] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_btrfs_subvolume_snapshot (GuestfsSession *session,const gchar *source,const gchar *dest,GError **err);
create a writable btrfs snapshot
Create a writable snapshot of the btrfs subvolume source. The dest
argument is the destination directory and the name of the snapshot, in
the form "/path/to/dest/name".
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gchar * guestfs_session_case_sensitive_path (GuestfsSession *session,const gchar *path,GError **err);
return true path on case-insensitive filesystem
This can be used to resolve case insensitive paths on a filesystem which is case sensitive. The use case is to resolve paths which you have read from Windows configuration files or the Windows Registry, to the true path.
The command handles a peculiarity of the Linux ntfs-3g filesystem driver (and probably others), which is that although the underlying filesystem is case-insensitive, the driver exports the filesystem to Linux as case-sensitive.
One consequence of this is that special directories such as "c:\windows" may appear as "/WINDOWS" or "/windows" (or other things) depending on the precise details of how they were created. In Windows itself this would not be a problem.
Bug or feature? You decide: http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1
This function resolves the true case of each element in the path and returns the case-sensitive path.
Thus guestfs_session_case_sensitive_path() ("/Windows/System32") might
return "/WINDOWS/system32" (the exact return value would depend on
details of how the directories were originally created under Windows).
*Note*: This function does not handle drive names, backslashes etc.
See also guestfs_session_realpath().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gchar * guestfs_session_cat (GuestfsSession *session,const gchar *path,GError **err);
list the contents of a file
Return the contents of the file named path.
Note that this function cannot correctly handle binary files
(specifically, files containing "\0" character which is treated as end
of string). For those you need to use the guestfs_session_read_file() or
guestfs_session_download() functions which have a more complex
interface.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gchar * guestfs_session_checksum (GuestfsSession *session,const gchar *csumtype,const gchar *path,GError **err);
compute MD5, SHAx or CRC checksum of file
This call computes the MD5, SHAx or CRC checksum of the file named
path.
The type of checksum to compute is given by the csumtype parameter
which must have one of the following values:
crc
Compute the cyclic redundancy check (CRC) specified by POSIX for the
cksum command.
md5
Compute the MD5 hash (using the md5sum program).
sha1
Compute the SHA1 hash (using the sha1sum program).
sha224
Compute the SHA224 hash (using the sha224sum program).
sha256
Compute the SHA256 hash (using the sha256sum program).
sha384
Compute the SHA384 hash (using the sha384sum program).
sha512
Compute the SHA512 hash (using the sha512sum program).
The checksum is returned as a printable string.
To get the checksum for a device, use guestfs_session_checksum_device().
To get the checksums for many files, use
guestfs_session_checksums_out().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gchar * guestfs_session_checksum_device (GuestfsSession *session,const gchar *csumtype,const gchar *device,GError **err);
compute MD5, SHAx or CRC checksum of the contents of a device
This call computes the MD5, SHAx or CRC checksum of the contents of the
device named device. For the types of checksums supported see the
guestfs_session_checksum() command.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gboolean guestfs_session_checksums_out (GuestfsSession *session,const gchar *csumtype,const gchar *directory,const gchar *sumsfile,GCancellable *cancellable,GError **err);
compute MD5, SHAx or CRC checksum of files in a directory
This command computes the checksums of all regular files in directory
and then emits a list of those checksums to the local output file
sumsfile.
This can be used for verifying the integrity of a virtual machine. However to be properly secure you should pay attention to the output of the checksum command (it uses the ones from GNU coreutils). In particular when the filename is not printable, coreutils uses a special backslash syntax. For more information, see the GNU coreutils info file.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type filename] |
|
. [transfer none][type filename] |
|
A GCancellable object |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_chmod (GuestfsSession *session,gint32 mode,const gchar *path,GError **err);
change file mode
Change the mode (permissions) of path to mode. Only numeric modes are
supported.
*Note*: When using this command from guestfish, mode by default would
be decimal, unless you prefix it with 0 to get octal, ie. use 0700 not
700.
The mode actually set is affected by the umask.
|
A GuestfsSession object. [transfer none] |
|
. [type gint32] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_chown (GuestfsSession *session,gint32 owner,gint32 group,const gchar *path,GError **err);
change file owner and group
Change the file owner to owner and group to group.
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).
|
A GuestfsSession object. [transfer none] |
|
. [type gint32] |
|
. [type gint32] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_close (GuestfsSession *session,GError **err);
Close a libguestfs session.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gchar * guestfs_session_command (GuestfsSession *session,gchar *const *arguments,GError **err);
run a command from the guest filesystem
This call 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). Note that the command runs directly, and is *not* invoked via the
shell (see guestfs_session_sh()).
The return value is anything printed to *stdout* by the command.
If the command returns a non-zero exit status, then this function returns an error message. The error message string is the content of *stderr* from the command.
The $PATH environment variable will contain at least "/usr/bin" and "/bin". 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.
|
A GuestfsSession object. [transfer none] |
|
an array of strings. [transfer none][array zero-terminated=1][element-type utf8] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gchar ** guestfs_session_command_lines (GuestfsSession *session,gchar *const *arguments,GError **err);
run a command, returning lines
This is the same as guestfs_session_command(), but splits the result
into a list of lines.
See also: guestfs_session_sh_lines()
|
A GuestfsSession object. [transfer none] |
|
an array of strings. [transfer none][array zero-terminated=1][element-type utf8] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
gboolean guestfs_session_compress_device_out (GuestfsSession *session,const gchar *ctype,const gchar *device,const gchar *zdevice,GuestfsCompressDeviceOut *optargs,GCancellable *cancellable,GError **err);
output compressed device
This command compresses device and writes it out to the local file
zdevice.
The ctype and optional level parameters have the same meaning as in
guestfs_session_compress_out().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type filename] |
|
. [transfer none][type filename] |
|
a GuestfsCompressDeviceOut containing optional arguments. [transfer none][allow-none] |
|
A GCancellable object |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_compress_out (GuestfsSession *session,const gchar *ctype,const gchar *file,const gchar *zfile,GuestfsCompressOut *optargs,GCancellable *cancellable,GError **err);
output compressed file
This command compresses file and writes it out to the local file
zfile.
The compression program used is controlled by the ctype parameter.
Currently this includes: compress, gzip, bzip2, xz or lzop. Some
compression types may not be supported by particular builds of
libguestfs, in which case you will get an error containing the substring
"not supported".
The optional level parameter controls compression level. The meaning
and default for this parameter depends on the compression program being
used.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type filename] |
|
. [transfer none][type filename] |
|
a GuestfsCompressOut containing optional arguments. [transfer none][allow-none] |
|
A GCancellable object |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_config (GuestfsSession *session,const gchar *qemuparam,const gchar *qemuvalue,GError **err);
add qemu parameters
This can be used to add arbitrary qemu command line parameters of the form *-param value*. Actually it's not quite arbitrary - we prevent you from setting some parameters which would interfere with parameters that we use.
The first character of param string must be a @- (dash).
value can be NULL.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type utf8][allow-none] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_copy_device_to_device (GuestfsSession *session,const gchar *src,const gchar *dest,GuestfsCopyDeviceToDevice *optargs,GError **err);
copy from source device to destination device
The four calls guestfs_session_copy_device_to_device(),
guestfs_session_copy_device_to_file(),
guestfs_session_copy_file_to_device(), and
guestfs_session_copy_file_to_file() let you copy from a source
(device|file) to a destination (device|file).
Partial copies can be made since you can specify optionally the source offset, destination offset and size to copy. These values are all specified in bytes. If not given, the offsets both default to zero, and the size defaults to copying as much as possible until we hit the end of the source.
The source and destination may be the same object. However overlapping regions may not be copied correctly.
If the destination is a file, it is created if required. If the destination file is not large enough, it is extended.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type filename] |
|
a GuestfsCopyDeviceToDevice containing optional arguments. [transfer none][allow-none] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_copy_device_to_file (GuestfsSession *session,const gchar *src,const gchar *dest,GuestfsCopyDeviceToFile *optargs,GError **err);
copy from source device to destination file
See guestfs_session_copy_device_to_device() for a general overview of
this call.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type filename] |
|
a GuestfsCopyDeviceToFile containing optional arguments. [transfer none][allow-none] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_copy_file_to_device (GuestfsSession *session,const gchar *src,const gchar *dest,GuestfsCopyFileToDevice *optargs,GError **err);
copy from source file to destination device
See guestfs_session_copy_device_to_device() for a general overview of
this call.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type filename] |
|
a GuestfsCopyFileToDevice containing optional arguments. [transfer none][allow-none] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_copy_file_to_file (GuestfsSession *session,const gchar *src,const gchar *dest,GuestfsCopyFileToFile *optargs,GError **err);
copy from source file to destination file
See guestfs_session_copy_device_to_device() for a general overview of
this call.
This is not the function you want for copying files. This is for copying
blocks within existing files. See guestfs_session_cp(),
guestfs_session_cp_a() and guestfs_session_mv() for general file copying
and moving functions.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type filename] |
|
a GuestfsCopyFileToFile containing optional arguments. [transfer none][allow-none] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_copy_size (GuestfsSession *session,const gchar *src,const gchar *dest,gint64 size,GError **err);
copy size bytes from source to destination using dd
This command copies exactly size bytes from one source device or file
src to another destination device or file dest.
Note this will fail if the source is too short or if the destination is not large enough.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type filename] |
|
. [type gint64] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_cp (GuestfsSession *session,const gchar *src,const gchar *dest,GError **err);
copy a file
This copies a file from src to dest where dest is either a
destination filename or destination directory.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_cp_a (GuestfsSession *session,const gchar *src,const gchar *dest,GError **err);
copy a file or directory recursively
This copies a file or directory from src to dest recursively using the
"cp -a" command.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_dd (GuestfsSession *session,const gchar *src,const gchar *dest,GError **err);
copy from source to destination using dd
This command copies from one source device or file src to another
destination device or file dest. Normally you would use this to copy to
or from a device or partition, for example to duplicate a filesystem.
If the destination is a device, it must be as large or larger than the
source file or device, otherwise the copy will fail. This command cannot
do partial copies (see guestfs_session_copy_device_to_device()).
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gchar * guestfs_session_debug (GuestfsSession *session,const gchar *subcmd,gchar *const *extraargs,GError **err);
debugging and internals
The guestfs_session_debug() command exposes some internals of guestfsd
(the guestfs daemon) that runs inside the qemu subprocess.
There is no comprehensive help for this command. You have to look at the file "daemon/debug.c" in the libguestfs source to find out what you can do.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
an array of strings. [transfer none][array zero-terminated=1][element-type utf8] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gchar ** guestfs_session_debug_cmdline (GuestfsSession *session,GError **err);
debug the QEMU command line (internal use only)
This returns the internal QEMU command line. 'debug' commands are not part of the formal API and can be removed or changed at any time.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
gchar ** guestfs_session_debug_drives (GuestfsSession *session,GError **err);
debug the drives (internal use only)
This returns the internal list of drives. 'debug' commands are not part of the formal API and can be removed or changed at any time.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
gboolean guestfs_session_debug_upload (GuestfsSession *session,const gchar *filename,const gchar *tmpname,gint32 mode,GCancellable *cancellable,GError **err);
upload a file to the appliance (internal use only)
The guestfs_session_debug_upload() command uploads a file to the
libguestfs appliance.
There is no comprehensive help for this command. You have to look at the file "daemon/debug.c" in the libguestfs source to find out what it is for.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type utf8] |
|
. [type gint32] |
|
A GCancellable object |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gchar * guestfs_session_df (GuestfsSession *session,GError **err);
report file system disk space usage
This command runs the df command to report disk space used.
This command is mostly useful for interactive sessions. It is *not*
intended that you try to parse the output string. Use
guestfs_session_statvfs() from programs.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gchar * guestfs_session_df_h (GuestfsSession *session,GError **err);
report file system disk space usage (human readable)
This command runs the "df -h" command to report disk space used in human-readable format.
This command is mostly useful for interactive sessions. It is *not*
intended that you try to parse the output string. Use
guestfs_session_statvfs() from programs.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gchar * guestfs_session_dmesg (GuestfsSession *session,GError **err);
return kernel messages
This returns the kernel messages (dmesg output) from the guest kernel.
This is sometimes useful for extended debugging of problems.
Another way to get the same information is to enable verbose messages
with guestfs_session_set_verbose() or by setting the environment
variable "LIBGUESTFS_DEBUG=1" before running the program.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gboolean guestfs_session_download (GuestfsSession *session,const gchar *remotefilename,const gchar *filename,GCancellable *cancellable,GError **err);
download a file to the local machine
Download file remotefilename and save it as filename on the local
machine.
filename can also be a named pipe.
See also guestfs_session_upload(), guestfs_session_cat().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type filename] |
|
A GCancellable object |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_download_offset (GuestfsSession *session,const gchar *remotefilename,const gchar *filename,gint64 offset,gint64 size,GCancellable *cancellable,GError **err);
download a file to the local machine with offset and size
Download file remotefilename and save it as filename on the local
machine.
remotefilename is read for size bytes starting at offset (this region
must be within the file or device).
Note that there is no limit on the amount of data that can be downloaded
with this call, unlike with guestfs_session_pread(), and this call
always reads the full amount unless an error occurs.
See also guestfs_session_download(), guestfs_session_pread().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type filename] |
|
. [type gint64] |
|
. [type gint64] |
|
A GCancellable object |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_drop_caches (GuestfsSession *session,gint32 whattodrop,GError **err);
drop kernel page cache, dentries and inodes
This instructs the guest kernel to drop its page cache, and/or dentries
and inode caches. The parameter whattodrop tells the kernel what
precisely to drop, see
http://linux-mm.org/Drop_Caches
Setting whattodrop to 3 should drop everything.
This automatically calls sync(2) before the operation, so that the maximum guest memory is freed.
|
A GuestfsSession object. [transfer none] |
|
. [type gint32] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gint64 guestfs_session_du (GuestfsSession *session,const gchar *path,GError **err);
estimate file space usage
This command runs the "du -s" command to estimate file space usage for
path.
path can be a file or a directory. If path is a directory then the
estimate includes the contents of the directory and all subdirectories
(recursively).
The result is the estimated size in *kilobytes* (ie. units of 1024 bytes).
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gboolean guestfs_session_e2fsck (GuestfsSession *session,const gchar *device,GuestfsE2fsck *optargs,GError **err);
check an ext2/ext3 filesystem
This runs the ext2/ext3 filesystem checker on device. It can take the
following optional arguments:
correct
Automatically repair the file system. This option will cause e2fsck
to automatically fix any filesystem problems that can be safely
fixed without human intervention.
This option may not be specified at the same time as the forceall
option.
forceall
Assume an answer of 'yes' to all questions; allows e2fsck to be used
non-interactively.
This option may not be specified at the same time as the correct
option.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
a GuestfsE2fsck containing optional arguments. [transfer none][allow-none] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_e2fsck_f (GuestfsSession *session,const gchar *device,GError **err);
check an ext2/ext3 filesystem
This runs "e2fsck -p -f device", ie. runs the ext2/ext3 filesystem
checker on device, noninteractively (*-p*), even if the filesystem
appears to be clean (*-f*).
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gchar * guestfs_session_echo_daemon (GuestfsSession *session,gchar *const *words,GError **err);
echo arguments back to the client
This command concatenates the list of words passed with single spaces
between them and returns the resulting string.
You can use this command to test the connection through to the daemon.
See also guestfs_session_ping_daemon().
|
A GuestfsSession object. [transfer none] |
|
an array of strings. [transfer none][array zero-terminated=1][element-type utf8] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gchar ** guestfs_session_egrep (GuestfsSession *session,const gchar *regex,const gchar *path,GError **err);
return lines matching a pattern
This calls the external egrep program and returns the matching lines.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
gchar ** guestfs_session_egrepi (GuestfsSession *session,const gchar *regex,const gchar *path,GError **err);
return lines matching a pattern
This calls the external "egrep -i" program and returns the matching lines.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
gint8 guestfs_session_equal (GuestfsSession *session,const gchar *file1,const gchar *file2,GError **err);
test if two files have equal contents
This compares the two files file1 and file2 and returns true if their
content is exactly equal, or false otherwise.
The external cmp(1) program is used for the comparison.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gint8 guestfs_session_exists (GuestfsSession *session,const gchar *path,GError **err);
test if file or directory exists
This returns true if and only if there is a file, directory (or
anything) with the given path name.
See also guestfs_session_is_file(), guestfs_session_is_dir(),
guestfs_session_stat().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gboolean guestfs_session_fallocate (GuestfsSession *session,const gchar *path,gint32 len,GError **err);
preallocate a file in the guest filesystem
This command preallocates a file (containing zero bytes) named path of
size len bytes. If the file exists already, it is overwritten.
Do not confuse this with the guestfish-specific alloc command which
allocates a file in the host and attaches it as a device.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [type gint32] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_fallocate64 (GuestfsSession *session,const gchar *path,gint64 len,GError **err);
preallocate a file in the guest filesystem
This command preallocates a file (containing zero bytes) named path of
size len bytes. If the file exists already, it is overwritten.
Note that this call allocates disk blocks for the file. To create a
sparse file use guestfs_session_truncate_size() instead.
The deprecated call guestfs_session_fallocate() does the same, but owing
to an oversight it only allowed 30 bit lengths to be specified,
effectively limiting the maximum size of files created through that call
to 1GB.
Do not confuse this with the guestfish-specific alloc and sparse
commands which create a file in the host and attach it as a device.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [type gint64] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gchar ** guestfs_session_fgrep (GuestfsSession *session,const gchar *pattern,const gchar *path,GError **err);
return lines matching a pattern
This calls the external fgrep program and returns the matching lines.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
gchar ** guestfs_session_fgrepi (GuestfsSession *session,const gchar *pattern,const gchar *path,GError **err);
return lines matching a pattern
This calls the external "fgrep -i" program and returns the matching lines.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
gchar * guestfs_session_file (GuestfsSession *session,const gchar *path,GError **err);
determine file type
This call uses the standard file(1) command to determine the type or contents of the file.
This call will also transparently look inside various types of compressed file.
The exact command which runs is "file -zb path". Note in particular that the filename is not prepended to the output (the *-b* option).
The output depends on the output of the underlying file(1) command and it can change in future in ways beyond our control. In other words, the output is not guaranteed by the ABI.
See also: file(1), guestfs_session_vfs_type(), guestfs_session_lstat(),
guestfs_session_is_file(), guestfs_session_is_blockdev() (etc),
guestfs_session_is_zero().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gchar * guestfs_session_file_architecture (GuestfsSession *session,const gchar *filename,GError **err);
detect the architecture of a binary file
This detects the architecture of the binary filename, and returns it if
known.
Currently defined architectures are:
"i386" This string is returned for all 32 bit i386, i486, i586, i686 binaries irrespective of the precise processor requirements of the binary.
"x86_64" 64 bit x86-64.
"sparc" 32 bit SPARC.
"sparc64" 64 bit SPARC V9 and above.
"ia64" Intel Itanium.
"ppc" 32 bit Power PC.
"ppc64" 64 bit Power PC.
Libguestfs may return other architecture strings in future.
The function works on at least the following types of files:
* many types of Un*x and Linux binary
* many types of Un*x and Linux shared library
* Windows Win32 and Win64 binaries
* Windows Win32 and Win64 DLLs
Win32 binaries and DLLs return i386.
Win64 binaries and DLLs return x86_64.
* Linux kernel modules
* Linux new-style initrd images
* some non-x86 Linux vmlinuz kernels
What it can't do currently:
* static libraries (libfoo.a)
* Linux old-style initrd as compressed ext2 filesystem (RHEL 3)
* x86 Linux vmlinuz kernels
x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and compressed code, and are horribly hard to unpack. If you want to find the architecture of a kernel, use the architecture of the associated initrd or kernel module(s) instead.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gint64 guestfs_session_filesize (GuestfsSession *session,const gchar *file,GError **err);
return the size of the file in bytes
This command returns the size of file in bytes.
To get other stats about a file, use guestfs_session_stat(),
guestfs_session_lstat(), guestfs_session_is_dir(),
guestfs_session_is_file() etc. To get the size of block devices, use
guestfs_session_blockdev_getsize64().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gboolean guestfs_session_fill (GuestfsSession *session,gint32 c,gint32 len,const gchar *path,GError **err);
fill a file with octets
This command creates a new file called path. The initial content of the
file is len octets of c, where c must be a number in the range
"[0..255]".
To fill a file with zero bytes (sparsely), it is much more efficient to
use guestfs_session_truncate_size(). To create a file with a pattern of
repeating bytes use guestfs_session_fill_pattern().
|
A GuestfsSession object. [transfer none] |
|
. [type gint32] |
|
. [type gint32] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_fill_pattern (GuestfsSession *session,const gchar *pattern,gint32 len,const gchar *path,GError **err);
fill a file with a repeating pattern of bytes
This function is like guestfs_session_fill() except that it creates a
new file of length len containing the repeating pattern of bytes in
pattern. The pattern is truncated if necessary to ensure the length of
the file is exactly len bytes.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [type gint32] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gchar ** guestfs_session_find (GuestfsSession *session,const gchar *directory,GError **err);
find all files and directories
This command lists out all files and directories, recursively, starting
at directory. It is essentially equivalent to running the shell command
"find directory -print" but some post-processing happens on the output,
described below.
This returns a list of strings *without any prefix*. Thus if the directory structure was:
/tmp/a
/tmp/b
/tmp/c/d
then the returned list from guestfs_session_find() "/tmp" would be 4
elements:
a
b
c
c/d
If directory is not a directory, then this command returns an error.
The returned list is sorted.
See also guestfs_session_find0().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
gboolean guestfs_session_find0 (GuestfsSession *session,const gchar *directory,const gchar *files,GCancellable *cancellable,GError **err);
find all files and directories, returning NUL-separated list
This command lists out all files and directories, recursively, starting
at directory, placing the resulting list in the external file called
files.
This command works the same way as guestfs_session_find() with the
following exceptions:
* The resulting list is written to an external file.
* Items (filenames) in the result are separated by "\0" characters. See find(1) option *-print0*.
* This command is not limited in the number of names that it can return.
* The result list is not sorted.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type filename] |
|
A GCancellable object |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gchar * guestfs_session_findfs_label (GuestfsSession *session,const gchar *label,GError **err);
find a filesystem by label
This command searches the filesystems and returns the one which has the given label. An error is returned if no such filesystem can be found.
To find the label of a filesystem, use guestfs_session_vfs_label().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gchar * guestfs_session_findfs_uuid (GuestfsSession *session,const gchar *uuid,GError **err);
find a filesystem by UUID
This command searches the filesystems and returns the one which has the given UUID. An error is returned if no such filesystem can be found.
To find the UUID of a filesystem, use guestfs_session_vfs_uuid().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gint32 guestfs_session_fsck (GuestfsSession *session,const gchar *fstype,const gchar *device,GError **err);
run the filesystem checker
This runs the filesystem checker (fsck) on device which should have
filesystem type fstype.
The returned integer is the status. See fsck(8) for the list of status
codes from fsck.
Notes:
* Multiple status codes can be summed together.
* A non-zero return code can mean "success", for example if errors have been corrected on the filesystem.
* Checking or repairing NTFS volumes is not supported (by linux-ntfs).
This command is entirely equivalent to running "fsck -a -t fstype device".
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
const gchar * guestfs_session_get_append (GuestfsSession *session,GError **err);
get the additional kernel options
Return the additional kernel options which are added to the guest kernel command line.
If NULL then no options are added.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
the returned string. Note that NULL does not indicate error. [transfer none] |
gchar * guestfs_session_get_attach_method (GuestfsSession *session,GError **err);
get the attach method
Return the current attach method. See
guestfs_session_set_attach_method().
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gint8 guestfs_session_get_autosync (GuestfsSession *session,GError **err);
get autosync mode
Get the autosync flag.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gint8 guestfs_session_get_direct (GuestfsSession *session,GError **err);
get direct appliance mode flag
Return the direct appliance mode flag.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gchar * guestfs_session_get_e2attrs (GuestfsSession *session,const gchar *file,GError **err);
get ext2 file attributes of a file
This returns the file attributes associated with file.
The attributes are a set of bits associated with each inode which affect the behaviour of the file. The attributes are returned as a string of letters (described below). The string may be empty, indicating that no file attributes are set for this file.
These attributes are only present when the file is located on an ext2/3/4 filesystem. Using this call on other filesystem types will result in an error.
The characters (file attributes) in the returned string are currently:
'A' When the file is accessed, its atime is not modified.
'a' The file is append-only.
'c' The file is compressed on-disk.
'D' (Directories only.) Changes to this directory are written synchronously to disk.
'd' The file is not a candidate for backup (see dump(8)).
'E' The file has compression errors.
'e' The file is using extents.
'h' The file is storing its blocks in units of the filesystem blocksize instead of sectors.
'I' (Directories only.) The directory is using hashed trees.
'i' The file is immutable. It cannot be modified, deleted or renamed. No link can be created to this file.
'j' The file is data-journaled.
's' When the file is deleted, all its blocks will be zeroed.
'S' Changes to this file are written synchronously to disk.
'T' (Directories only.) This is a hint to the block allocator that subdirectories contained in this directory should be spread across blocks. If not present, the block allocator will try to group subdirectories together.
't' For a file, this disables tail-merging. (Not used by upstream implementations of ext2.)
'u' When the file is deleted, its blocks will be saved, allowing the file to be undeleted.
'X' The raw contents of the compressed file may be accessed.
'Z' The compressed file is dirty.
More file attributes may be added to this list later. Not all file attributes may be set for all kinds of files. For detailed information, consult the chattr(1) man page.
See also guestfs_session_set_e2attrs().
Don't confuse these attributes with extended attributes (see
guestfs_session_getxattr()).
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gint64 guestfs_session_get_e2generation (GuestfsSession *session,const gchar *file,GError **err);
get ext2 file generation of a file
This returns the ext2 file generation of a file. The generation (which used to be called the "version") is a number associated with an inode. This is most commonly used by NFS servers.
The generation is only present when the file is located on an ext2/3/4 filesystem. Using this call on other filesystem types will result in an error.
See guestfs_session_set_e2generation().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gchar * guestfs_session_get_e2label (GuestfsSession *session,const gchar *device,GError **err);
get the ext2/3/4 filesystem label
This returns the ext2/3/4 filesystem label of the filesystem on device.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gchar * guestfs_session_get_e2uuid (GuestfsSession *session,const gchar *device,GError **err);
get the ext2/3/4 filesystem UUID
This returns the ext2/3/4 filesystem UUID of the filesystem on device.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gint32 guestfs_session_get_memsize (GuestfsSession *session,GError **err);
get memory allocated to the qemu subprocess
This gets the memory size in megabytes allocated to the qemu subprocess.
If guestfs_session_set_memsize() was not called on this handle, and if
LIBGUESTFS_MEMSIZE was not set, then this returns the compiled-in
default value for memsize.
For more information on the architecture of libguestfs, see guestfs(3).
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gint8 guestfs_session_get_network (GuestfsSession *session,GError **err);
get enable network flag
This returns the enable network flag.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
const gchar * guestfs_session_get_path (GuestfsSession *session,GError **err);
get the search path
Return the current search path.
This is always non-NULL. If it wasn't set already, then this will return the default path.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer none] |
gint8 guestfs_session_get_pgroup (GuestfsSession *session,GError **err);
get process group flag
This returns the process group flag.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gint32 guestfs_session_get_pid (GuestfsSession *session,GError **err);
get PID of qemu subprocess
Return the process ID of the qemu subprocess. If there is no qemu subprocess, then this will return an error.
This is an internal call used for debugging and testing.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
const gchar * guestfs_session_get_qemu (GuestfsSession *session,GError **err);
get the qemu binary
Return the current qemu binary.
This is always non-NULL. If it wasn't set already, then this will return the default qemu binary name.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer none] |
gint8 guestfs_session_get_recovery_proc (GuestfsSession *session,GError **err);
get recovery process enabled flag
Return the recovery process enabled flag.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gint8 guestfs_session_get_selinux (GuestfsSession *session,GError **err);
get SELinux enabled flag
This returns the current setting of the selinux flag which is passed to
the appliance at boot time. See guestfs_session_set_selinux().
For more information on the architecture of libguestfs, see guestfs(3).
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gint32 guestfs_session_get_smp (GuestfsSession *session,GError **err);
get number of virtual CPUs in appliance
This returns the number of virtual CPUs assigned to the appliance.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gint32 guestfs_session_get_state (GuestfsSession *session,GError **err);
get the current state
This returns the current state as an opaque integer. This is only useful for printing debug and internal error messages.
For more information on states, see guestfs(3).
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gint8 guestfs_session_get_trace (GuestfsSession *session,GError **err);
get command trace enabled flag
Return the command trace flag.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gint32 guestfs_session_get_umask (GuestfsSession *session,GError **err);
get the current umask
Return the current umask. By default the umask is 022 unless it has
been set by calling guestfs_session_umask().
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gint8 guestfs_session_get_verbose (GuestfsSession *session,GError **err);
get verbose mode
This returns the verbose messages flag.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gchar * guestfs_session_getcon (GuestfsSession *session,GError **err);
get SELinux security context
This gets the SELinux security context of the daemon.
See the documentation about SELINUX in guestfs(3), and
guestfs_session_setcon()
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
guint8 * guestfs_session_getxattr (GuestfsSession *session,const gchar *path,const gchar *name,gsize *size_r,GError **err);
get a single extended attribute
Get a single extended attribute from file path named name. This call
follows symlinks. If you want to lookup an extended attribute for the
symlink itself, use guestfs_session_lgetxattr().
Normally it is better to get all extended attributes from a file in one
go by calling guestfs_session_getxattrs(). However some Linux filesystem
implementations are buggy and do not provide a way to list out
attributes. For these filesystems (notably ntfs-3g) you have to know the
names of the extended attributes you want in advance and call this
function.
Extended attribute values are blobs of binary data. If there is no
extended attribute named name, this returns an error.
See also: guestfs_session_getxattrs(), guestfs_session_lgetxattr(),
attr(5).
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type utf8] |
|
The size of the returned buffer, in bytes |
|
A GError object to receive any generated errors |
Returns : |
an array of binary data, or NULL on error. [transfer full][array length=size_r][element-type guint8] |
GuestfsXAttr ** guestfs_session_getxattrs (GuestfsSession *session,const gchar *path,GError **err);
list extended attributes of a file or directory
This call lists the extended attributes of the file or directory path.
At the system call level, this is a combination of the listxattr(2) and getxattr(2) calls.
See also: guestfs_session_lgetxattrs(), attr(5).
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
an array of XAttr objects, or NULL on error. [transfer full][array zero-terminated=1][element-type GuestfsXAttr] |
gchar ** guestfs_session_glob_expand (GuestfsSession *session,const gchar *pattern,GError **err);
expand a wildcard path
This command searches for all the pathnames matching pattern according
to the wildcard expansion rules used by the shell.
If no paths match, then this returns an empty list (note: not an error).
It is just a wrapper around the C glob(3) function with flags "GLOB_MARK|GLOB_BRACE". See that manual page for more details.
Notice that there is no equivalent command for expanding a device name
(eg. "/dev/sd*"). Use guestfs_session_list_devices(),
guestfs_session_list_partitions() etc functions instead.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
gchar ** guestfs_session_grep (GuestfsSession *session,const gchar *regex,const gchar *path,GError **err);
return lines matching a pattern
This calls the external grep program and returns the matching lines.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
gchar ** guestfs_session_grepi (GuestfsSession *session,const gchar *regex,const gchar *path,GError **err);
return lines matching a pattern
This calls the external "grep -i" program and returns the matching lines.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
gboolean guestfs_session_grub_install (GuestfsSession *session,const gchar *root,const gchar *device,GError **err);
install GRUB 1
This command installs GRUB 1 (the Grand Unified Bootloader) on device,
with the root directory being root.
Notes:
* There is currently no way in the API to install grub2, which is used by most modern Linux guests. It is possible to run the grub2 command from the guest, although see the caveats in "RUNNING COMMANDS" in guestfs(3).
* This uses grub-install from the host. Unfortunately grub is not
always compatible with itself, so this only works in rather narrow
circumstances. Careful testing with each guest version is advisable.
* If grub-install reports the error "No suitable drive was found in the generated device map." it may be that you need to create a "/boot/grub/device.map" file first that contains the mapping between grub device names and Linux device names. It is usually sufficient to create a file containing:
(hd0) /dev/vda
replacing "/dev/vda" with the name of the installation device.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gchar ** guestfs_session_head (GuestfsSession *session,const gchar *path,GError **err);
return first 10 lines of a file
This command returns up to the first 10 lines of a file as a list of strings.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
gchar ** guestfs_session_head_n (GuestfsSession *session,gint32 nrlines,const gchar *path,GError **err);
return first N lines of a file
If the parameter nrlines is a positive number, this returns the first
nrlines lines of the file path.
If the parameter nrlines is a negative number, this returns lines from
the file path, excluding the last nrlines lines.
If the parameter nrlines is zero, this returns an empty list.
|
A GuestfsSession object. [transfer none] |
|
. [type gint32] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
gchar * guestfs_session_hexdump (GuestfsSession *session,const gchar *path,GError **err);
dump a file in hexadecimal
This runs "hexdump -C" on the given path. The result is the
human-readable, canonical hex dump of the file.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
guint8 * guestfs_session_initrd_cat (GuestfsSession *session,const gchar *initrdpath,const gchar *filename,gsize *size_r,GError **err);
list the contents of a single file in an initrd
This command unpacks the file filename from the initrd file called
initrdpath. The filename must be given *without* the initial "/"
character.
For example, in guestfish you could use the following command to examine the boot script (usually called "/init") contained in a Linux initrd or initramfs image:
initrd-cat /boot/initrd-<version>.img init
See also guestfs_session_initrd_list().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type utf8] |
|
The size of the returned buffer, in bytes |
|
A GError object to receive any generated errors |
Returns : |
an array of binary data, or NULL on error. [transfer full][array length=size_r][element-type guint8] |
gchar ** guestfs_session_initrd_list (GuestfsSession *session,const gchar *path,GError **err);
list files in an initrd
This command lists out files contained in an initrd.
The files are listed without any initial "/" character. The files are listed in the order they appear (not necessarily alphabetical). Directory names are listed as separate items.
Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as initrd. We *only* support the newer initramfs format (compressed cpio files).
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
gint64 guestfs_session_inotify_add_watch (GuestfsSession *session,const gchar *path,gint32 mask,GError **err);
add an inotify watch
Watch path for the events listed in mask.
Note that if path is a directory then events within that directory are
watched, but this does *not* happen recursively (in subdirectories).
Note for non-C or non-Linux callers: the inotify events are defined by the Linux kernel ABI and are listed in "/usr/include/sys/inotify.h".
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [type gint32] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gboolean guestfs_session_inotify_close (GuestfsSession *session,GError **err);
close the inotify handle
This closes the inotify handle which was previously opened by inotify_init. It removes all watches, throws away any pending events, and deallocates all resources.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gchar ** guestfs_session_inotify_files (GuestfsSession *session,GError **err);
return list of watched files that had events
This function is a helpful wrapper around guestfs_session_inotify_read()
which just returns a list of pathnames of objects that were touched. The
returned pathnames are sorted and deduplicated.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
gboolean guestfs_session_inotify_init (GuestfsSession *session,gint32 maxevents,GError **err);
create an inotify handle
This command creates a new inotify handle. The inotify subsystem can be used to notify events which happen to objects in the guest filesystem.
maxevents is the maximum number of events which will be queued up
between calls to guestfs_session_inotify_read() or
guestfs_session_inotify_files(). If this is passed as 0, then the
kernel (or previously set) default is used. For Linux 2.6.29 the default
was 16384 events. Beyond this limit, the kernel throws away events, but
records the fact that it threw them away by setting a flag
IN_Q_OVERFLOW in the returned structure list (see
guestfs_session_inotify_read()).
Before any events are generated, you have to add some watches to the
internal watch list. See: guestfs_session_inotify_add_watch() and
guestfs_session_inotify_rm_watch().
Queued up events should be read periodically by calling
guestfs_session_inotify_read() (or guestfs_session_inotify_files() which
is just a helpful wrapper around guestfs_session_inotify_read()). If you
don't read the events out often enough then you risk the internal queue
overflowing.
The handle should be closed after use by calling
guestfs_session_inotify_close(). This also removes any watches
automatically.
See also inotify(7) for an overview of the inotify interface as exposed by the Linux kernel, which is roughly what we expose via libguestfs. Note that there is one global inotify handle per libguestfs instance.
|
A GuestfsSession object. [transfer none] |
|
. [type gint32] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
GuestfsINotifyEvent ** guestfs_session_inotify_read (GuestfsSession *session,GError **err);
return list of inotify events
Return the complete queue of events that have happened since the previous read call.
If no events have happened, this returns an empty list.
*Note*: In order to make sure that all events have been read, you must call this function repeatedly until it returns an empty list. The reason is that the call will read events up to the maximum appliance-to-host message size and leave remaining events in the queue.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
an array of INotifyEvent objects, or NULL on error. [transfer full][array zero-terminated=1][element-type GuestfsINotifyEvent] |
gboolean guestfs_session_inotify_rm_watch (GuestfsSession *session,gint32 wd,GError **err);
remove an inotify watch
Remove a previously defined inotify watch. See
guestfs_session_inotify_add_watch().
|
A GuestfsSession object. [transfer none] |
|
. [type gint32] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gchar * guestfs_session_inspect_get_arch (GuestfsSession *session,const gchar *root,GError **err);
get architecture of inspected operating system
This returns the architecture of the inspected operating system. The
possible return values are listed under
guestfs_session_file_architecture().
If the architecture could not be determined, then the string unknown is
returned.
Please read "INSPECTION" in guestfs(3) for more details.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gchar * guestfs_session_inspect_get_distro (GuestfsSession *session,const gchar *root,GError **err);
get distro of inspected operating system
This returns the distro (distribution) of the inspected operating system.
Currently defined distros are:
"archlinux" Arch Linux.
"buildroot" Buildroot-derived distro, but not one we specifically recognize.
"centos" CentOS.
"cirros" Cirros.
"debian" Debian.
"fedora" Fedora.
"freedos" FreeDOS.
"gentoo" Gentoo.
"linuxmint" Linux Mint.
"mageia" Mageia.
"mandriva" Mandriva.
"meego" MeeGo.
"opensuse" OpenSUSE.
"pardus" Pardus.
"redhat-based" Some Red Hat-derived distro.
"rhel" Red Hat Enterprise Linux.
"scientificlinux" Scientific Linux.
"slackware" Slackware.
"ttylinux" ttylinux.
"ubuntu" Ubuntu.
"unknown" The distro could not be determined.
"windows" Windows does not have distributions. This string is returned if the OS type is Windows.
Future versions of libguestfs may return other strings here. The caller should be prepared to handle any string.
Please read "INSPECTION" in guestfs(3) for more details.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
GHashTable * guestfs_session_inspect_get_drive_mappings (GuestfsSession *session,const gchar *root,GError **err);
get drive letter mappings
This call is useful for Windows which uses a primitive system of assigning drive letters (like "C:") to partitions. This inspection API examines the Windows Registry to find out how disks/partitions are mapped to drive letters, and returns a hash table as in the example below:
C => /dev/vda2
E => /dev/vdb1
F => /dev/vdc1
Note that keys are drive letters. For Windows, the key is case insensitive and just contains the drive letter, without the customary colon separator character.
In future we may support other operating systems that also used drive
letters, but the keys for those might not be case insensitive and might
be longer than 1 character. For example in OS-9, hard drives were named
h0, h1 etc.
For Windows guests, currently only hard drive mappings are returned. Removable disks (eg. DVD-ROMs) are ignored.
For guests that do not use drive mappings, or if the drive mappings could not be determined, this returns an empty hash table.
Please read "INSPECTION" in guestfs(3) for more details. See also
guestfs_session_inspect_get_mountpoints(),
guestfs_session_inspect_get_filesystems().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
a GHashTable of results, or NULL on error. [transfer full][element-type utf8 utf8] |
gchar ** guestfs_session_inspect_get_filesystems (GuestfsSession *session,const gchar *root,GError **err);
get filesystems associated with inspected operating system
This returns a list of all the filesystems that we think are associated with this operating system. This includes the root filesystem, other ordinary filesystems, and non-mounted devices like swap partitions.
In the case of a multi-boot virtual machine, it is possible for a filesystem to be shared between operating systems.
Please read "INSPECTION" in guestfs(3) for more details. See also
guestfs_session_inspect_get_mountpoints().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
gchar * guestfs_session_inspect_get_format (GuestfsSession *session,const gchar *root,GError **err);
get format of inspected operating system
This returns the format of the inspected operating system. You can use it to detect install images, live CDs and similar.
Currently defined formats are:
"installed" This is an installed operating system.
"installer" The disk image being inspected is not an installed operating system, but a *bootable* install disk, live CD, or similar.
"unknown" The format of this disk image is not known.
Future versions of libguestfs may return other strings here. The caller should be prepared to handle any string.
Please read "INSPECTION" in guestfs(3) for more details.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gchar * guestfs_session_inspect_get_hostname (GuestfsSession *session,const gchar *root,GError **err);
get hostname of the operating system
This function returns the hostname of the operating system as found by inspection of the guest's configuration files.
If the hostname could not be determined, then the string unknown is
returned.
Please read "INSPECTION" in guestfs(3) for more details.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
guint8 * guestfs_session_inspect_get_icon (GuestfsSession *session,const gchar *root,GuestfsInspectGetIcon *optargs,gsize *size_r,GError **err);
get the icon corresponding to this operating system
This function returns an icon corresponding to the inspected operating system. The icon is returned as a buffer containing a PNG image (re-encoded to PNG if necessary).
If it was not possible to get an icon this function returns a zero-length (non-NULL) buffer. *Callers must check for this case*.
Libguestfs will start by looking for a file called "/etc/favicon.png" or
"C:\etc\favicon.png" and if it has the correct format, the contents of
this file will be returned. You can disable favicons by passing the
optional favicon boolean as false (default is true).
If finding the favicon fails, then we look in other places in the guest for a suitable icon.
If the optional highquality boolean is true then only high quality
icons are returned, which means only icons of high resolution with an
alpha channel. The default (false) is to return any icon we can, even if
it is of substandard quality.
Notes:
* Unlike most other inspection API calls, the guest's disks must be mounted up before you call this, since it needs to read information from the guest filesystem during the call.
* Security: The icon data comes from the untrusted guest, and should be treated with caution. PNG files have been known to contain exploits. Ensure that libpng (or other relevant libraries) are fully up to date before trying to process or display the icon.
* The PNG image returned can be any size. It might not be square. Libguestfs tries to return the largest, highest quality icon available. The application must scale the icon to the required size.
* Extracting icons from Windows guests requires the external wrestool
program from the icoutils package, and several programs (bmptopnm,
pnmtopng, pamcut) from the netpbm package. These must be
installed separately.
* Operating system icons are usually trademarks. Seek legal advice before using trademarks in applications.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
a GuestfsInspectGetIcon containing optional arguments. [transfer none][allow-none] |
|
The size of the returned buffer, in bytes |
|
A GError object to receive any generated errors |
Returns : |
an array of binary data, or NULL on error. [transfer full][array length=size_r][element-type guint8] |
gint32 guestfs_session_inspect_get_major_version (GuestfsSession *session,const gchar *root,GError **err);
get major version of inspected operating system
This returns the major version number of the inspected operating system.
Windows uses a consistent versioning scheme which is *not* reflected in the popular public names used by the operating system. Notably the operating system known as "Windows 7" is really version 6.1 (ie. major = 6, minor = 1). You can find out the real versions corresponding to releases of Windows by consulting Wikipedia or MSDN.
If the version could not be determined, then 0 is returned.
Please read "INSPECTION" in guestfs(3) for more details.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gint32 guestfs_session_inspect_get_minor_version (GuestfsSession *session,const gchar *root,GError **err);
get minor version of inspected operating system
This returns the minor version number of the inspected operating system.
If the version could not be determined, then 0 is returned.
Please read "INSPECTION" in guestfs(3) for more details. See also
guestfs_session_inspect_get_major_version().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
GHashTable * guestfs_session_inspect_get_mountpoints (GuestfsSession *session,const gchar *root,GError **err);
get mountpoints of inspected operating system
This returns a hash of where we think the filesystems associated with this operating system should be mounted. Callers should note that this is at best an educated guess made by reading configuration files such as "/etc/fstab". *In particular note* that this may return filesystems which are non-existent or not mountable and callers should be prepared to handle or ignore failures if they try to mount them.
Each element in the returned hashtable has a key which is the path of the mountpoint (eg. "/boot") and a value which is the filesystem that would be mounted there (eg. "/dev/sda1").
Non-mounted devices such as swap devices are *not* returned in this list.
For operating systems like Windows which still use drive letters, this
call will only return an entry for the first drive "mounted on" "/". For
information about the mapping of drive letters to partitions, see
guestfs_session_inspect_get_drive_mappings().
Please read "INSPECTION" in guestfs(3) for more details. See also
guestfs_session_inspect_get_filesystems().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
a GHashTable of results, or NULL on error. [transfer full][element-type utf8 utf8] |
gchar * guestfs_session_inspect_get_package_format (GuestfsSession *session,const gchar *root,GError **err);
get package format used by the operating system
This function and guestfs_session_inspect_get_package_management()
return the package format and package management tool used by the
inspected operating system. For example for Fedora these functions would
return rpm (package format) and yum (package management).
This returns the string unknown if we could not determine the package
format *or* if the operating system does not have a real packaging
system (eg. Windows).
Possible strings include: rpm, deb, ebuild, pisi, pacman, pkgsrc.
Future versions of libguestfs may return other strings.
Please read "INSPECTION" in guestfs(3) for more details.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gchar * guestfs_session_inspect_get_package_management (GuestfsSession *session,const gchar *root,GError **err);
get package management tool used by the operating system
guestfs_session_inspect_get_package_format() and this function return
the package format and package management tool used by the inspected
operating system. For example for Fedora these functions would return
rpm (package format) and yum (package management).
This returns the string unknown if we could not determine the package
management tool *or* if the operating system does not have a real
packaging system (eg. Windows).
Possible strings include: yum, up2date, apt (for all Debian
derivatives), portage, pisi, pacman, urpmi, zypper. Future versions
of libguestfs may return other strings.
Please read "INSPECTION" in guestfs(3) for more details.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gchar * guestfs_session_inspect_get_product_name (GuestfsSession *session,const gchar *root,GError **err);
get product name of inspected operating system
This returns the product name of the inspected operating system. The product name is generally some freeform string which can be displayed to the user, but should not be parsed by programs.
If the product name could not be determined, then the string unknown is
returned.
Please read "INSPECTION" in guestfs(3) for more details.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gchar * guestfs_session_inspect_get_product_variant (GuestfsSession *session,const gchar *root,GError **err);
get product variant of inspected operating system
This returns the product variant of the inspected operating system.
For Windows guests, this returns the contents of the Registry key
"HKLM\Software\Microsoft\Windows NT\CurrentVersion" InstallationType
which is usually a string such as Client or Server (other values are
possible). This can be used to distinguish consumer and enterprise
versions of Windows that have the same version number (for example,
Windows 7 and Windows 2008 Server are both version 6.1, but the former
is Client and the latter is Server).
For enterprise Linux guests, in future we intend this to return the
product variant such as Desktop, Server and so on. But this is not
implemented at present.
If the product variant could not be determined, then the string unknown
is returned.
Please read "INSPECTION" in guestfs(3) for more details. See also
guestfs_session_inspect_get_product_name(),
guestfs_session_inspect_get_major_version().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gchar ** guestfs_session_inspect_get_roots (GuestfsSession *session,GError **err);
return list of operating systems found by last inspection
This function is a convenient way to get the list of root devices, as
returned from a previous call to guestfs_session_inspect_os(), but
without redoing the whole inspection process.
This returns an empty list if either no root devices were found or the
caller has not called guestfs_session_inspect_os().
Please read "INSPECTION" in guestfs(3) for more details.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
gchar * guestfs_session_inspect_get_windows_current_control_set (GuestfsSession *session,const gchar *root,GError **err);
get Windows CurrentControlSet of inspected operating system
This returns the Windows CurrentControlSet of the inspected guest. The
CurrentControlSet is a registry key name such as ControlSet001.
This call assumes that the guest is Windows and that the Registry could be examined by inspection. If this is not the case then an error is returned.
Please read "INSPECTION" in guestfs(3) for more details.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gchar * guestfs_session_inspect_get_windows_systemroot (GuestfsSession *session,const gchar *root,GError **err);
get Windows systemroot of inspected operating system
This returns the Windows systemroot of the inspected guest. The systemroot is a directory path such as "/WINDOWS".
This call assumes that the guest is Windows and that the systemroot could be determined by inspection. If this is not the case then an error is returned.
Please read "INSPECTION" in guestfs(3) for more details.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gint8 guestfs_session_inspect_is_live (GuestfsSession *session,const gchar *root,GError **err);
get live flag for install disk
If guestfs_session_inspect_get_format() returns installer (this is an
install disk), then this returns true if a live image was detected on
the disk.
Please read "INSPECTION" in guestfs(3) for more details.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gint8 guestfs_session_inspect_is_multipart (GuestfsSession *session,const gchar *root,GError **err);
get multipart flag for install disk
If guestfs_session_inspect_get_format() returns installer (this is an
install disk), then this returns true if the disk is part of a set.
Please read "INSPECTION" in guestfs(3) for more details.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gint8 guestfs_session_inspect_is_netinst (GuestfsSession *session,const gchar *root,GError **err);
get netinst (network installer) flag for install disk
If guestfs_session_inspect_get_format() returns installer (this is an
install disk), then this returns true if the disk is a network
installer, ie. not a self-contained install CD but one which is likely
to require network access to complete the install.
Please read "INSPECTION" in guestfs(3) for more details.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
GuestfsApplication ** guestfs_session_inspect_list_applications (GuestfsSession *session,const gchar *root,GError **err);
get list of applications installed in the operating system
Return the list of applications installed in the operating system.
*Note:* This call works differently from other parts of the inspection
API. You have to call guestfs_session_inspect_os(), then
guestfs_session_inspect_get_mountpoints(), then mount up the disks,
before calling this. Listing applications is a significantly more
difficult operation which requires access to the full filesystem. Also
note that unlike the other "guestfs_inspect_get_*" calls which are just
returning data cached in the libguestfs handle, this call actually reads
parts of the mounted filesystems during the call.
This returns an empty list if the inspection code was not able to determine the list of applications.
The application structure contains the following fields:
app_name
The name of the application. For Red Hat-derived and Debian-derived
Linux guests, this is the package name.
app_display_name
The display name of the application, sometimes localized to the
install language of the guest operating system.
If unavailable this is returned as an empty string "". Callers
needing to display something can use app_name instead.
app_epoch
For package managers which use epochs, this contains the epoch of
the package (an integer). If unavailable, this is returned as 0.
app_version
The version string of the application or package. If unavailable
this is returned as an empty string "".
app_release
The release string of the application or package, for package
managers that use this. If unavailable this is returned as an empty
string "".
app_install_path
The installation path of the application (on operating systems such
as Windows which use installation paths). This path is in the format
used by the guest operating system, it is not a libguestfs path.
If unavailable this is returned as an empty string "".
app_trans_path
The install path translated into a libguestfs path. If unavailable
this is returned as an empty string "".
app_publisher
The name of the publisher of the application, for package managers
that use this. If unavailable this is returned as an empty string
"".
app_url
The URL (eg. upstream URL) of the application. If unavailable this
is returned as an empty string "".
app_source_package
For packaging systems which support this, the name of the source
package. If unavailable this is returned as an empty string "".
app_summary
A short (usually one line) description of the application or
package. If unavailable this is returned as an empty string "".
app_description
A longer description of the application or package. If unavailable
this is returned as an empty string "".
Please read "INSPECTION" in guestfs(3) for more details.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
an array of Application objects, or NULL on error. [transfer full][array zero-terminated=1][element-type GuestfsApplication] |
gchar ** guestfs_session_inspect_os (GuestfsSession *session,GError **err);
inspect disk and return list of operating systems found
This function uses other libguestfs functions and certain heuristics to inspect the disk(s) (usually disks belonging to a virtual machine), looking for operating systems.
The list returned is empty if no operating systems were found.
If one operating system was found, then this returns a list with a single element, which is the name of the root filesystem of this operating system. It is also possible for this function to return a list containing more than one element, indicating a dual-boot or multi-boot virtual machine, with each element being the root filesystem of one of the operating systems.
You can pass the root string(s) returned to other "guestfs_inspect_get_*" functions in order to query further information about each operating system, such as the name and version.
This function uses other libguestfs features such as
guestfs_session_mount_ro() and guestfs_session_umount_all() in order to
mount and unmount filesystems and look at the contents. This should be
called with no disks currently mounted. The function may also use
Augeas, so any existing Augeas handle will be closed.
This function cannot decrypt encrypted disks. The caller must do that first (supplying the necessary keys) if the disk is encrypted.
Please read "INSPECTION" in guestfs(3) for more details.
See also guestfs_session_list_filesystems().
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
gboolean guestfs_session_internal_autosync (GuestfsSession *session,GError **err);
internal autosync operation
This command performs the autosync operation just before the handle is
closed. You should not call this command directly. Instead, use the
autosync flag (guestfs_session_set_autosync()) to control whether or not
this operation is performed when the handle is closed.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gint8 guestfs_session_is_blockdev (GuestfsSession *session,const gchar *path,GError **err);
test if block device
This returns true if and only if there is a block device with the given
path name.
See also guestfs_session_stat().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gint8 guestfs_session_is_busy (GuestfsSession *session,GError **err);
is busy processing a command
This always returns false. Do not use this function.
For more information on states, see guestfs(3).
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gint8 guestfs_session_is_chardev (GuestfsSession *session,const gchar *path,GError **err);
test if character device
This returns true if and only if there is a character device with the
given path name.
See also guestfs_session_stat().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gint8 guestfs_session_is_config (GuestfsSession *session,GError **err);
is in configuration state
This returns true iff this handle is being configured (in the CONFIG
state).
For more information on states, see guestfs(3).
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gint8 guestfs_session_is_dir (GuestfsSession *session,const gchar *path,GError **err);
test if a directory
This returns true if and only if there is a directory with the given
path name. Note that it returns false for other objects like files.
See also guestfs_session_stat().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gint8 guestfs_session_is_fifo (GuestfsSession *session,const gchar *path,GError **err);
test if FIFO (named pipe)
This returns true if and only if there is a FIFO (named pipe) with the
given path name.
See also guestfs_session_stat().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gint8 guestfs_session_is_file (GuestfsSession *session,const gchar *path,GError **err);
test if a regular file
This returns true if and only if there is a regular file with the given
path name. Note that it returns false for other objects like
directories.
See also guestfs_session_stat().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gint8 guestfs_session_is_launching (GuestfsSession *session,GError **err);
is launching subprocess
This returns true iff this handle is launching the subprocess (in the
LAUNCHING state).
For more information on states, see guestfs(3).
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gint8 guestfs_session_is_lv (GuestfsSession *session,const gchar *device,GError **err);
test if device is a logical volume
This command tests whether device is a logical volume, and returns true
iff this is the case.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gint8 guestfs_session_is_ready (GuestfsSession *session,GError **err);
is ready to accept commands
This returns true iff this handle is ready to accept commands (in the
READY state).
For more information on states, see guestfs(3).
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gint8 guestfs_session_is_socket (GuestfsSession *session,const gchar *path,GError **err);
test if socket
This returns true if and only if there is a Unix domain socket with the
given path name.
See also guestfs_session_stat().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gint8 guestfs_session_is_symlink (GuestfsSession *session,const gchar *path,GError **err);
test if symbolic link
This returns true if and only if there is a symbolic link with the
given path name.
See also guestfs_session_stat().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gint8 guestfs_session_is_zero (GuestfsSession *session,const gchar *path,GError **err);
test if a file contains all zero bytes
This returns true iff the file exists and the file is empty or it contains all zero bytes.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gint8 guestfs_session_is_zero_device (GuestfsSession *session,const gchar *device,GError **err);
test if a device contains all zero bytes
This returns true iff the device exists and contains all zero bytes.
Note that for large devices this can take a long time to run.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
GuestfsISOInfo * guestfs_session_isoinfo (GuestfsSession *session,const gchar *isofile,GError **err);
get ISO information from primary volume descriptor of ISO file
This is the same as guestfs_session_isoinfo_device() except that it
works for an ISO file located inside some other mounted filesystem. Note
that in the common case where you have added an ISO file as a libguestfs
device, you would *not* call this. Instead you would call
guestfs_session_isoinfo_device().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
a ISOInfo object, or NULL on error. [transfer full] |
GuestfsISOInfo * guestfs_session_isoinfo_device (GuestfsSession *session,const gchar *device,GError **err);
get ISO information from primary volume descriptor of device
device is an ISO device. This returns a struct of information read from
the primary volume descriptor (the ISO equivalent of the superblock) of
the device.
Usually it is more efficient to use the isoinfo(1) command with the *-d* option on the host to analyze ISO files, instead of going through libguestfs.
For information on the primary volume descriptor fields, see http://wiki.osdev.org/ISO_9660#The_Primary_Volume_Descriptor
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
a ISOInfo object, or NULL on error. [transfer full] |
gboolean guestfs_session_kill_subprocess (GuestfsSession *session,GError **err);
kill the qemu subprocess
This kills the qemu subprocess. You should never need to call this.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_launch (GuestfsSession *session,GError **err);
launch the qemu subprocess
Internally libguestfs is implemented by running a virtual machine using qemu(1).
You should call this after configuring the handle (eg. adding drives) but before performing any actions.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_lchown (GuestfsSession *session,gint32 owner,gint32 group,const gchar *path,GError **err);
change file owner and group
Change the file owner to owner and group to group. This is like
guestfs_session_chown() but if path is a symlink then the link itself
is changed, not the target.
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).
|
A GuestfsSession object. [transfer none] |
|
. [type gint32] |
|
. [type gint32] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
guint8 * guestfs_session_lgetxattr (GuestfsSession *session,const gchar *path,const gchar *name,gsize *size_r,GError **err);
get a single extended attribute
Get a single extended attribute from file path named name. If path is
a symlink, then this call returns an extended attribute from the
symlink.
Normally it is better to get all extended attributes from a file in one
go by calling guestfs_session_getxattrs(). However some Linux filesystem
implementations are buggy and do not provide a way to list out
attributes. For these filesystems (notably ntfs-3g) you have to know the
names of the extended attributes you want in advance and call this
function.
Extended attribute values are blobs of binary data. If there is no
extended attribute named name, this returns an error.
See also: guestfs_session_lgetxattrs(), guestfs_session_getxattr(),
attr(5).
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type utf8] |
|
The size of the returned buffer, in bytes |
|
A GError object to receive any generated errors |
Returns : |
an array of binary data, or NULL on error. [transfer full][array length=size_r][element-type guint8] |
GuestfsXAttr ** guestfs_session_lgetxattrs (GuestfsSession *session,const gchar *path,GError **err);
list extended attributes of a file or directory
This is the same as guestfs_session_getxattrs(), but if path is a
symbolic link, then it returns the extended attributes of the link
itself.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
an array of XAttr objects, or NULL on error. [transfer full][array zero-terminated=1][element-type GuestfsXAttr] |
gchar ** guestfs_session_list_9p (GuestfsSession *session,GError **err);
list 9p filesystems
List all 9p filesystems attached to the guest. A list of mount tags is returned.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
gchar ** guestfs_session_list_devices (GuestfsSession *session,GError **err);
list the block devices
List all the block devices.
The full block device names are returned, eg. "/dev/sda".
See also guestfs_session_list_filesystems().
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
gchar ** guestfs_session_list_dm_devices (GuestfsSession *session,GError **err);
list device mapper devices
List all device mapper devices.
The returned list contains "/dev/mapper/*" devices, eg. ones created by
a previous call to guestfs_session_luks_open().
Device mapper devices which correspond to logical volumes are *not*
returned in this list. Call guestfs_session_lvs() if you want to list
logical volumes.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
GHashTable * guestfs_session_list_filesystems (GuestfsSession *session,GError **err);
list filesystems
This inspection command looks for filesystems on partitions, block devices and logical volumes, returning a list of devices containing filesystems and their type.
The return value is a hash, where the keys are the devices containing filesystems, and the values are the filesystem types. For example:
"/dev/sda1" => "ntfs"
"/dev/sda2" => "ext2"
"/dev/vg_guest/lv_root" => "ext4"
"/dev/vg_guest/lv_swap" => "swap"
The value can have the special value "unknown", meaning the content of the device is undetermined or empty. "swap" means a Linux swap partition.
This command runs other libguestfs commands, which might include
guestfs_session_mount() and guestfs_session_umount(), and therefore you
should use this soon after launch and only when nothing is mounted.
Not all of the filesystems returned will be mountable. In particular,
swap partitions are returned in the list. Also this command does not
check that each filesystem found is valid and mountable, and some
filesystems might be mountable but require special options. Filesystems
may not all belong to a single logical operating system (use
guestfs_session_inspect_os() to look for OSes).
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
a GHashTable of results, or NULL on error. [transfer full][element-type utf8 utf8] |
gchar ** guestfs_session_list_md_devices (GuestfsSession *session,GError **err);
list Linux md (RAID) devices
List all Linux md devices.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
gchar ** guestfs_session_list_partitions (GuestfsSession *session,GError **err);
list the partitions
List all the partitions detected on all block devices.
The full partition device names are returned, eg. "/dev/sda1"
This does not return logical volumes. For that you will need to call
guestfs_session_lvs().
See also guestfs_session_list_filesystems().
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
gchar * guestfs_session_ll (GuestfsSession *session,const gchar *directory,GError **err);
list the files in a directory (long format)
List the files in directory (relative to the root directory, there is
no cwd) in the format of 'ls -la'.
This command is mostly useful for interactive sessions. It is *not* intended that you try to parse the output string.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gchar * guestfs_session_llz (GuestfsSession *session,const gchar *directory,GError **err);
list the files in a directory (long format with SELinux contexts)
List the files in directory in the format of 'ls -laZ'.
This command is mostly useful for interactive sessions. It is *not* intended that you try to parse the output string.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gboolean guestfs_session_ln (GuestfsSession *session,const gchar *target,const gchar *linkname,GError **err);
create a hard link
This command creates a hard link using the ln command.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_ln_f (GuestfsSession *session,const gchar *target,const gchar *linkname,GError **err);
create a hard link
This command creates a hard link using the "ln -f" command. The *-f*
option removes the link (linkname) if it exists already.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_ln_s (GuestfsSession *session,const gchar *target,const gchar *linkname,GError **err);
create a symbolic link
This command creates a symbolic link using the "ln -s" command.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_ln_sf (GuestfsSession *session,const gchar *target,const gchar *linkname,GError **err);
create a symbolic link
This command creates a symbolic link using the "ln -sf" command, The
*-f* option removes the link (linkname) if it exists already.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_lremovexattr (GuestfsSession *session,const gchar *xattr,const gchar *path,GError **err);
remove extended attribute of a file or directory
This is the same as guestfs_session_removexattr(), but if path is a
symbolic link, then it removes an extended attribute of the link itself.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gchar ** guestfs_session_ls (GuestfsSession *session,const gchar *directory,GError **err);
list the files in a directory
List the files in directory (relative to the root directory, there is
no cwd). The '.' and '..' entries are not returned, but hidden files are
shown.
This command is mostly useful for interactive sessions. Programs should
probably use guestfs_session_readdir() instead.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
gboolean guestfs_session_lsetxattr (GuestfsSession *session,const gchar *xattr,const gchar *val,gint32 vallen,const gchar *path,GError **err);
set extended attribute of a file or directory
This is the same as guestfs_session_setxattr(), but if path is a
symbolic link, then it sets an extended attribute of the link itself.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type utf8] |
|
. [type gint32] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
GuestfsStat * guestfs_session_lstat (GuestfsSession *session,const gchar *path,GError **err);
get file information for a symbolic link
Returns file information for the given path.
This is the same as guestfs_session_stat() except that if path is a
symbolic link, then the link is stat-ed, not the file it refers to.
This is the same as the lstat(2) system call.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
a Stat object, or NULL on error. [transfer full] |
GuestfsStat ** guestfs_session_lstatlist (GuestfsSession *session,const gchar *path,gchar *const *names,GError **err);
lstat on multiple files
This call allows you to perform the guestfs_session_lstat() operation on
multiple files, where all files are in the directory path. names is
the list of files from this directory.
On return you get a list of stat structs, with a one-to-one
correspondence to the names list. If any name did not exist or could
not be lstat'd, then the ino field of that structure is set to @-1.
This call is intended for programs that want to efficiently list a
directory contents without making many round-trips. See also
guestfs_session_lxattrlist() for a similarly efficient call for getting
extended attributes. Very long directory listings might cause the
protocol message size to be exceeded, causing this call to fail. The
caller must split up such requests into smaller groups of names.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
an array of strings. [transfer none][array zero-terminated=1][element-type utf8] |
|
A GError object to receive any generated errors |
Returns : |
an array of Stat objects, or NULL on error. [transfer full][array zero-terminated=1][element-type GuestfsStat] |
gboolean guestfs_session_luks_add_key (GuestfsSession *session,const gchar *device,const gchar *key,const gchar *newkey,gint32 keyslot,GError **err);
add a key on a LUKS encrypted device
This command adds a new key on LUKS device device. key is any existing
key, and is used to access the device. newkey is the new key to add.
keyslot is the key slot that will be replaced.
Note that if keyslot already contains a key, then this command will
fail. You have to use guestfs_session_luks_kill_slot() first to remove
that key.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type utf8] |
|
. [transfer none][type utf8] |
|
. [type gint32] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_luks_close (GuestfsSession *session,const gchar *device,GError **err);
close a LUKS device
This closes a LUKS device that was created earlier by
guestfs_session_luks_open() or guestfs_session_luks_open_ro(). The
device parameter must be the name of the LUKS mapping device (ie.
"/dev/mapper/mapname") and *not* the name of the underlying block
device.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_luks_format (GuestfsSession *session,const gchar *device,const gchar *key,gint32 keyslot,GError **err);
format a block device as a LUKS encrypted device
This command erases existing data on device and formats the device as a
LUKS encrypted device. key is the initial key, which is added to key
slot slot. (LUKS supports 8 key slots, numbered 0-7).
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type utf8] |
|
. [type gint32] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_luks_format_cipher (GuestfsSession *session,const gchar *device,const gchar *key,gint32 keyslot,const gchar *cipher,GError **err);
format a block device as a LUKS encrypted device
This command is the same as guestfs_session_luks_format() but it also
allows you to set the cipher used.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type utf8] |
|
. [type gint32] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_luks_kill_slot (GuestfsSession *session,const gchar *device,const gchar *key,gint32 keyslot,GError **err);
remove a key from a LUKS encrypted device
This command deletes the key in key slot keyslot from the encrypted
LUKS device device. key must be one of the *other* keys.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type utf8] |
|
. [type gint32] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_luks_open (GuestfsSession *session,const gchar *device,const gchar *key,const gchar *mapname,GError **err);
open a LUKS-encrypted block device
This command opens a block device which has been encrypted according to the Linux Unified Key Setup (LUKS) standard.
device is the encrypted block device or partition.
The caller must supply one of the keys associated with the LUKS block
device, in the key parameter.
This creates a new block device called "/dev/mapper/mapname". Reads and
writes to this block device are decrypted from and encrypted to the
underlying device respectively.
If this block device contains LVM volume groups, then calling
guestfs_session_vgscan() followed by guestfs_session_vg_activate_all()
will make them visible.
Use guestfs_session_list_dm_devices() to list all device mapper devices.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type utf8] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_luks_open_ro (GuestfsSession *session,const gchar *device,const gchar *key,const gchar *mapname,GError **err);
open a LUKS-encrypted block device read-only
This is the same as guestfs_session_luks_open() except that a read-only
mapping is created.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type utf8] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_lvcreate (GuestfsSession *session,const gchar *logvol,const gchar *volgroup,gint32 mbytes,GError **err);
create an LVM logical volume
This creates an LVM logical volume called logvol on the volume group
volgroup, with size megabytes.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type utf8] |
|
. [type gint32] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_lvcreate_free (GuestfsSession *session,const gchar *logvol,const gchar *volgroup,gint32 percent,GError **err);
create an LVM logical volume in % remaining free space
Create an LVM logical volume called "/dev/volgroup/logvol", using
approximately percent % of the free space remaining in the volume
group. Most usefully, when percent is 100 this will create the largest
possible LV.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type utf8] |
|
. [type gint32] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gchar * guestfs_session_lvm_canonical_lv_name (GuestfsSession *session,const gchar *lvname,GError **err);
get canonical name of an LV
This converts alternative naming schemes for LVs that you might find to the canonical name. For example, "/dev/mapper/VG-LV" is converted to "/dev/VG/LV".
This command returns an error if the lvname parameter does not refer to
a logical volume.
See also guestfs_session_is_lv().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gboolean guestfs_session_lvm_clear_filter (GuestfsSession *session,GError **err);
clear LVM device filter
This undoes the effect of guestfs_session_lvm_set_filter(). LVM will be
able to see every block device.
This command also clears the LVM cache and performs a volume group scan.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_lvm_remove_all (GuestfsSession *session,GError **err);
remove all LVM LVs, VGs and PVs
This command removes all LVM logical volumes, volume groups and physical volumes.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_lvm_set_filter (GuestfsSession *session,gchar *const *devices,GError **err);
set LVM device filter
This sets the LVM device filter so that LVM will only be able to "see"
the block devices in the list devices, and will ignore all other
attached block devices.
Where disk image(s) contain duplicate PVs or VGs, this command is useful to get LVM to ignore the duplicates, otherwise LVM can get confused. Note also there are two types of duplication possible: either cloned PVs/VGs which have identical UUIDs; or VGs that are not cloned but just happen to have the same name. In normal operation you cannot create this situation, but you can do it outside LVM, eg. by cloning disk images or by bit twiddling inside the LVM metadata.
This command also clears the LVM cache and performs a volume group scan.
You can filter whole block devices or individual partitions.
You cannot use this if any VG is currently in use (eg. contains a mounted filesystem), even if you are not filtering out that VG.
|
A GuestfsSession object. [transfer none] |
|
an array of strings. [transfer none][array zero-terminated=1][element-type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_lvremove (GuestfsSession *session,const gchar *device,GError **err);
remove an LVM logical volume
Remove an LVM logical volume device, where device is the path to the
LV, such as "/dev/VG/LV".
You can also remove all LVs in a volume group by specifying the VG name, "/dev/VG".
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_lvrename (GuestfsSession *session,const gchar *logvol,const gchar *newlogvol,GError **err);
rename an LVM logical volume
Rename a logical volume logvol with the new name newlogvol.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_lvresize (GuestfsSession *session,const gchar *device,gint32 mbytes,GError **err);
resize an LVM logical volume
This resizes (expands or shrinks) an existing LVM logical volume to
mbytes. When reducing, data in the reduced part is lost.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [type gint32] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_lvresize_free (GuestfsSession *session,const gchar *lv,gint32 percent,GError **err);
expand an LV to fill free space
This expands an existing logical volume lv so that it fills pc% of the
remaining free space in the volume group. Commonly you would call this
with pc = 100 which expands the logical volume as much as possible,
using all remaining free space in the volume group.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [type gint32] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gchar ** guestfs_session_lvs (GuestfsSession *session,GError **err);
list the LVM logical volumes (LVs)
List all the logical volumes detected. This is the equivalent of the lvs(8) command.
This returns a list of the logical volume device names (eg. "/dev/VolGroup00/LogVol00").
See also guestfs_session_lvs_full(), guestfs_session_list_filesystems().
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
GuestfsLV ** guestfs_session_lvs_full (GuestfsSession *session,GError **err);
list the LVM logical volumes (LVs)
List all the logical volumes detected. This is the equivalent of the lvs(8) command. The "full" version includes all fields.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
an array of LV objects, or NULL on error. [transfer full][array zero-terminated=1][element-type GuestfsLV] |
gchar * guestfs_session_lvuuid (GuestfsSession *session,const gchar *device,GError **err);
get the UUID of a logical volume
This command returns the UUID of the LVM LV device.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
GuestfsXAttr ** guestfs_session_lxattrlist (GuestfsSession *session,const gchar *path,gchar *const *names,GError **err);
lgetxattr on multiple files
This call allows you to get the extended attributes of multiple files,
where all files are in the directory path. names is the list of files
from this directory.
On return you get a flat list of xattr structs which must be interpreted
sequentially. The first xattr struct always has a zero-length attrname.
attrval in this struct is zero-length to indicate there was an error
doing lgetxattr for this file, *or* is a C string which is a decimal
number (the number of following attributes for this file, which could be
"0"). Then after the first xattr struct are the zero or more attributes
for the first named file. This repeats for the second and subsequent
files.
This call is intended for programs that want to efficiently list a
directory contents without making many round-trips. See also
guestfs_session_lstatlist() for a similarly efficient call for getting
standard stats. Very long directory listings might cause the protocol
message size to be exceeded, causing this call to fail. The caller must
split up such requests into smaller groups of names.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
an array of strings. [transfer none][array zero-terminated=1][element-type utf8] |
|
A GError object to receive any generated errors |
Returns : |
an array of XAttr objects, or NULL on error. [transfer full][array zero-terminated=1][element-type GuestfsXAttr] |
gboolean guestfs_session_md_create (GuestfsSession *session,const gchar *name,gchar *const *devices,GuestfsMDCreate *optargs,GError **err);
create a Linux md (RAID) device
Create a Linux md (RAID) device named name on the devices in the list
devices.
The optional parameters are:
missingbitmap
A bitmap of missing devices. If a bit is set it means that a missing
device is added to the array. The least significant bit corresponds
to the first device in the array.
As examples:
If "devices = ["/dev/sda"]" and "missingbitmap = 0x1" then the resulting array would be "[<missing>, "/dev/sda"]".
If "devices = ["/dev/sda"]" and "missingbitmap = 0x2" then the resulting array would be "["/dev/sda", <missing>]".
This defaults to 0 (no missing devices).
The length of devices + the number of bits set in missingbitmap
must equal nrdevices + spare.
nrdevices
The number of active RAID devices.
If not set, this defaults to the length of devices plus the number
of bits set in missingbitmap.
spare
The number of spare devices.
If not set, this defaults to 0.
chunk
The chunk size in bytes.
level
The RAID level, which can be one of: *linear*, *raid0*, *0*,
*stripe*, *raid1*, *1*, *mirror*, *raid4*, *4*, *raid5*, *5*,
*raid6*, *6*, *raid10*, *10*. Some of these are synonymous, and more
levels may be added in future.
If not set, this defaults to raid1.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
an array of strings. [transfer none][array zero-terminated=1][element-type filename] |
|
a GuestfsMDCreate containing optional arguments. [transfer none][allow-none] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
GHashTable * guestfs_session_md_detail (GuestfsSession *session,const gchar *md,GError **err);
obtain metadata for an MD device
This command exposes the output of 'mdadm -DY <md>'. The following fields are usually present in the returned hash. Other fields may also be present.
level
The raid level of the MD device.
devices
The number of underlying devices in the MD device.
metadata
The metadata version used.
uuid
The UUID of the MD device.
name
The name of the MD device.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
a GHashTable of results, or NULL on error. [transfer full][element-type utf8 utf8] |
GuestfsMDStat ** guestfs_session_md_stat (GuestfsSession *session,const gchar *md,GError **err);
get underlying devices from an MD device
This call returns a list of the underlying devices which make up the
single software RAID array device md.
To get a list of software RAID devices, call
guestfs_session_list_md_devices().
Each structure returned corresponds to one device along with additional status information:
mdstat_device
The name of the underlying device.
mdstat_index
The index of this device within the array.
mdstat_flags
Flags associated with this device. This is a string containing (in
no specific order) zero or more of the following flags:
W write-mostly
F device is faulty
S device is a RAID spare
R replacement
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
an array of MDStat objects, or NULL on error. [transfer full][array zero-terminated=1][element-type GuestfsMDStat] |
gboolean guestfs_session_md_stop (GuestfsSession *session,const gchar *md,GError **err);
stop a Linux md (RAID) device
This command deactivates the MD array named md. The device is stopped,
but it is not destroyed or zeroed.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_mkdir (GuestfsSession *session,const gchar *path,GError **err);
create a directory
Create a directory named path.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_mkdir_mode (GuestfsSession *session,const gchar *path,gint32 mode,GError **err);
create a directory with a particular mode
This command creates a directory, setting the initial permissions of the
directory to mode.
For common Linux filesystems, the actual mode which is set will be "mode & ~umask & 01777". Non-native-Linux filesystems may interpret the mode in other ways.
See also guestfs_session_mkdir(), guestfs_session_umask()
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [type gint32] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_mkdir_p (GuestfsSession *session,const gchar *path,GError **err);
create a directory and parents
Create a directory named path, creating any parent directories as
necessary. This is like the "mkdir -p" shell command.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gchar * guestfs_session_mkdtemp (GuestfsSession *session,const gchar *tmpl,GError **err);
create a temporary directory
This command creates a temporary directory. The tmpl parameter should
be a full pathname for the temporary directory name with the final six
characters being "XXXXXX".
For example: "/tmp/myprogXXXXXX" or "/Temp/myprogXXXXXX", the second one being suitable for Windows filesystems.
The name of the temporary directory that was created is returned.
The temporary directory is created with mode 0700 and is owned by root.
The caller is responsible for deleting the temporary directory and its contents after use.
See also: mkdtemp(3)
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gboolean guestfs_session_mke2fs_J (GuestfsSession *session,const gchar *fstype,gint32 blocksize,const gchar *device,const gchar *journal,GError **err);
make ext2/3/4 filesystem with external journal
This creates an ext2/3/4 filesystem on device with an external journal
on journal. It is equivalent to the command:
mke2fs -t fstype -b blocksize -J device=<journal> <device>
See also guestfs_session_mke2journal().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [type gint32] |
|
. [transfer none][type filename] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_mke2fs_JL (GuestfsSession *session,const gchar *fstype,gint32 blocksize,const gchar *device,const gchar *label,GError **err);
make ext2/3/4 filesystem with external journal
This creates an ext2/3/4 filesystem on device with an external journal
on the journal labeled label.
See also guestfs_session_mke2journal_L().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [type gint32] |
|
. [transfer none][type filename] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_mke2fs_JU (GuestfsSession *session,const gchar *fstype,gint32 blocksize,const gchar *device,const gchar *uuid,GError **err);
make ext2/3/4 filesystem with external journal
This creates an ext2/3/4 filesystem on device with an external journal
on the journal with UUID uuid.
See also guestfs_session_mke2journal_U().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [type gint32] |
|
. [transfer none][type filename] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_mke2journal (GuestfsSession *session,gint32 blocksize,const gchar *device,GError **err);
make ext2/3/4 external journal
This creates an ext2 external journal on device. It is equivalent to
the command:
mke2fs -O journal_dev -b blocksize device
|
A GuestfsSession object. [transfer none] |
|
. [type gint32] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_mke2journal_L (GuestfsSession *session,gint32 blocksize,const gchar *label,const gchar *device,GError **err);
make ext2/3/4 external journal with label
This creates an ext2 external journal on device with label label.
|
A GuestfsSession object. [transfer none] |
|
. [type gint32] |
|
. [transfer none][type utf8] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_mke2journal_U (GuestfsSession *session,gint32 blocksize,const gchar *uuid,const gchar *device,GError **err);
make ext2/3/4 external journal with UUID
This creates an ext2 external journal on device with UUID uuid.
|
A GuestfsSession object. [transfer none] |
|
. [type gint32] |
|
. [transfer none][type utf8] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_mkfifo (GuestfsSession *session,gint32 mode,const gchar *path,GError **err);
make FIFO (named pipe)
This call creates a FIFO (named pipe) called path with mode mode. It
is just a convenient wrapper around guestfs_session_mknod().
The mode actually set is affected by the umask.
|
A GuestfsSession object. [transfer none] |
|
. [type gint32] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_mkfs (GuestfsSession *session,const gchar *fstype,const gchar *device,GError **err);
make a filesystem
This creates a filesystem on device (usually a partition or LVM logical
volume). The filesystem type is fstype, for example ext3.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_mkfs_b (GuestfsSession *session,const gchar *fstype,gint32 blocksize,const gchar *device,GError **err);
make a filesystem with block size
This call is similar to guestfs_session_mkfs(), but it allows you to
control the block size of the resulting filesystem. Supported block
sizes depend on the filesystem type, but typically they are 1024, 2048
or 4096 only.
For VFAT and NTFS the blocksize parameter is treated as the requested
cluster size.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [type gint32] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_mkfs_btrfs (GuestfsSession *session,gchar *const *devices,GuestfsMkfsBtrfs *optargs,GError **err);
create a btrfs filesystem
Create a btrfs filesystem, allowing all configurables to be set. For more information on the optional arguments, see mkfs.btrfs(8).
Since btrfs filesystems can span multiple devices, this takes a non-empty list of devices.
To create general filesystems, use guestfs_session_mkfs_opts().
|
A GuestfsSession object. [transfer none] |
|
an array of strings. [transfer none][array zero-terminated=1][element-type filename] |
|
a GuestfsMkfsBtrfs containing optional arguments. [transfer none][allow-none] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_mkfs_opts (GuestfsSession *session,const gchar *fstype,const gchar *device,GuestfsMkfsOpts *optargs,GError **err);
make a filesystem
This function creates a filesystem on device. The filesystem type is
fstype, for example ext3.
The optional arguments are:
blocksize
The filesystem block size. Supported block sizes depend on the
filesystem type, but typically they are 1024, 2048 or 4096 for
Linux ext2/3 filesystems.
For VFAT and NTFS the blocksize parameter is treated as the
requested cluster size.
For UFS block sizes, please see mkfs.ufs(8).
features
This passes the *-O* parameter to the external mkfs program.
For certain filesystem types, this allows extra filesystem features to be selected. See mke2fs(8) and mkfs.ufs(8) for more details.
You cannot use this optional parameter with the gfs or gfs2
filesystem type.
inode
This passes the *-I* parameter to the external mke2fs(8) program
which sets the inode size (only for ext2/3/4 filesystems at
present).
sectorsize
This passes the *-S* parameter to external mkfs.ufs(8) program,
which sets sector size for ufs filesystem.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type filename] |
|
a GuestfsMkfsOpts containing optional arguments. [transfer none][allow-none] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_mkmountpoint (GuestfsSession *session,const gchar *exemptpath,GError **err);
create a mountpoint
guestfs_session_mkmountpoint() and guestfs_session_rmmountpoint() are
specialized calls that can be used to create extra mountpoints before
mounting the first filesystem.
These calls are *only* necessary in some very limited circumstances, mainly the case where you want to mount a mix of unrelated and/or read-only filesystems together.
For example, live CDs often contain a "Russian doll" nest of filesystems, an ISO outer layer, with a squashfs image inside, with an ext2/3 image inside that. You can unpack this as follows in guestfish:
add-ro Fedora-11-i686-Live.iso
run
mkmountpoint /cd
mkmountpoint /sqsh
mkmountpoint /ext3fs
mount /dev/sda /cd
mount-loop /cd/LiveOS/squashfs.img /sqsh
mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs
The inner filesystem is now unpacked under the /ext3fs mountpoint.
guestfs_session_mkmountpoint() is not compatible with
guestfs_session_umount_all(). You may get unexpected errors if you try
to mix these calls. It is safest to manually unmount filesystems and
remove mountpoints after use.
guestfs_session_umount_all() unmounts filesystems by sorting the paths
longest first, so for this to work for manual mountpoints, you must
ensure that the innermost mountpoints have the longest pathnames, as in
the example code above.
For more details see http://bugzilla.redhat.com/show_bug.cgi?id=599503
Autosync [see guestfs_session_set_autosync(), this is set by default on
handles] can cause guestfs_session_umount_all() to be called when the
handle is closed which can also trigger these issues.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_mknod (GuestfsSession *session,gint32 mode,gint32 devmajor,gint32 devminor,const gchar *path,GError **err);
make block, character or FIFO devices
This call creates block or character special devices, or named pipes (FIFOs).
The mode parameter should be the mode, using the standard constants.
devmajor and devminor are the device major and minor numbers, only
used when creating block and character special devices.
Note that, just like mknod(2), the mode must be bitwise OR'd with
S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates
a regular file). These constants are available in the standard Linux
header files, or you can use guestfs_session_mknod_b(),
guestfs_session_mknod_c() or guestfs_session_mkfifo() which are wrappers
around this command which bitwise OR in the appropriate constant for
you.
The mode actually set is affected by the umask.
|
A GuestfsSession object. [transfer none] |
|
. [type gint32] |
|
. [type gint32] |
|
. [type gint32] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_mknod_b (GuestfsSession *session,gint32 mode,gint32 devmajor,gint32 devminor,const gchar *path,GError **err);
make block device node
This call creates a block device node called path with mode mode and
device major/minor devmajor and devminor. It is just a convenient
wrapper around guestfs_session_mknod().
The mode actually set is affected by the umask.
|
A GuestfsSession object. [transfer none] |
|
. [type gint32] |
|
. [type gint32] |
|
. [type gint32] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_mknod_c (GuestfsSession *session,gint32 mode,gint32 devmajor,gint32 devminor,const gchar *path,GError **err);
make char device node
This call creates a char device node called path with mode mode and
device major/minor devmajor and devminor. It is just a convenient
wrapper around guestfs_session_mknod().
The mode actually set is affected by the umask.
|
A GuestfsSession object. [transfer none] |
|
. [type gint32] |
|
. [type gint32] |
|
. [type gint32] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_mkswap (GuestfsSession *session,const gchar *device,GError **err);
create a swap partition
Create a swap partition on device.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_mkswap_L (GuestfsSession *session,const gchar *label,const gchar *device,GError **err);
create a swap partition with a label
Create a swap partition on device with label label.
Note that you cannot attach a swap label to a block device (eg. "/dev/sda"), just to a partition. This appears to be a limitation of the kernel or swap tools.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_mkswap_U (GuestfsSession *session,const gchar *uuid,const gchar *device,GError **err);
create a swap partition with an explicit UUID
Create a swap partition on device with UUID uuid.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_mkswap_file (GuestfsSession *session,const gchar *path,GError **err);
create a swap file
Create a swap file.
This command just writes a swap file signature to an existing file. To
create the file itself, use something like guestfs_session_fallocate().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_modprobe (GuestfsSession *session,const gchar *modulename,GError **err);
load a kernel module
This loads a kernel module in the appliance.
The kernel module must have been whitelisted when libguestfs was built (see "appliance/kmod.whitelist.in" in the source).
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_mount (GuestfsSession *session,const gchar *device,const gchar *mountpoint,GError **err);
mount a guest disk at a position in the filesystem
Mount a guest disk at a position in the filesystem. Block devices are named "/dev/sda", "/dev/sdb" and so on, as they were added to the guest. If those block devices contain partitions, they will have the usual names (eg. "/dev/sda1"). Also LVM "/dev/VG/LV"-style names can be used.
The rules are the same as for mount(2): A filesystem must first be mounted on "/" before others can be mounted. Other filesystems can only be mounted on directories which already exist.
The mounted filesystem is writable, if we have sufficient permissions on the underlying device.
Before libguestfs 1.13.16, this call implicitly added the options sync
and noatime. The sync option greatly slowed writes and caused many
problems for users. If your program might need to work with older
versions of libguestfs, use guestfs_session_mount_options() instead
(using an empty string for the first parameter if you don't want any
options).
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_mount_9p (GuestfsSession *session,const gchar *mounttag,const gchar *mountpoint,GuestfsMount9P *optargs,GError **err);
mount 9p filesystem
Mount the virtio-9p filesystem with the tag mounttag on the directory
mountpoint.
If required, "trans=virtio" will be automatically added to the options.
Any other options required can be passed in the optional options
parameter.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type utf8] |
|
a GuestfsMount9P containing optional arguments. [transfer none][allow-none] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_mount_local (GuestfsSession *session,const gchar *localmountpoint,GuestfsMountLocal *optargs,GError **err);
mount on the local filesystem
This call exports the libguestfs-accessible filesystem to a local
mountpoint (directory) called localmountpoint. Ordinary reads and
writes to files and directories under localmountpoint are redirected
through libguestfs.
If the optional readonly flag is set to true, then writes to the
filesystem return error EROFS.
options is a comma-separated list of mount options. See guestmount(1)
for some useful options.
cachetimeout sets the timeout (in seconds) for cached directory
entries. The default is 60 seconds. See guestmount(1) for further
information.
If debugcalls is set to true, then additional debugging information is
generated for every FUSE call.
When guestfs_session_mount_local() returns, the filesystem is ready, but
is not processing requests (access to it will block). You have to call
guestfs_session_mount_local_run() to run the main loop.
See "MOUNT LOCAL" in guestfs(3) for full documentation.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
a GuestfsMountLocal containing optional arguments. [transfer none][allow-none] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_mount_local_run (GuestfsSession *session,GCancellable *cancellable,GError **err);
run main loop of mount on the local filesystem
Run the main loop which translates kernel calls to libguestfs calls.
This should only be called after guestfs_session_mount_local() returns
successfully. The call will not return until the filesystem is
unmounted.
Note you must *not* make concurrent libguestfs calls on the same handle
from another thread, with the exception of
guestfs_session_umount_local().
You may call this from a different thread than the one which called
guestfs_session_mount_local(), subject to the usual rules for threads
and libguestfs (see "MULTIPLE HANDLES AND MULTIPLE THREADS" in
guestfs(3)).
See "MOUNT LOCAL" in guestfs(3) for full documentation.
|
A GuestfsSession object. [transfer none] |
|
A GCancellable object |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_mount_loop (GuestfsSession *session,const gchar *file,const gchar *mountpoint,GError **err);
mount a file using the loop device
This command lets you mount file (a filesystem image in a file) on a
mount point. It is entirely equivalent to the command "mount -o loop
file mountpoint".
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_mount_options (GuestfsSession *session,const gchar *options,const gchar *device,const gchar *mountpoint,GError **err);
mount a guest disk with mount options
This is the same as the guestfs_session_mount() command, but it allows
you to set the mount options as for the mount(8) *-o* flag.
If the options parameter is an empty string, then no options are passed
(all options default to whatever the filesystem uses).
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type filename] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_mount_ro (GuestfsSession *session,const gchar *device,const gchar *mountpoint,GError **err);
mount a guest disk, read-only
This is the same as the guestfs_session_mount() command, but it mounts
the filesystem with the read-only (*-o ro*) flag.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_mount_vfs (GuestfsSession *session,const gchar *options,const gchar *vfstype,const gchar *device,const gchar *mountpoint,GError **err);
mount a guest disk with mount options and vfstype
This is the same as the guestfs_session_mount() command, but it allows
you to set both the mount options and the vfstype as for the mount(8)
*-o* and *-t* flags.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type utf8] |
|
. [transfer none][type filename] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
GHashTable * guestfs_session_mountpoints (GuestfsSession *session,GError **err);
show mountpoints
This call is similar to guestfs_session_mounts(). That call returns a
list of devices. This one returns a hash table (map) of device name to
directory where the device is mounted.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
a GHashTable of results, or NULL on error. [transfer full][element-type utf8 utf8] |
gchar ** guestfs_session_mounts (GuestfsSession *session,GError **err);
show mounted filesystems
This returns the list of currently mounted filesystems. It returns the list of devices (eg. "/dev/sda1", "/dev/VG/LV").
Some internal mounts are not shown.
See also: guestfs_session_mountpoints()
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
gboolean guestfs_session_mv (GuestfsSession *session,const gchar *src,const gchar *dest,GError **err);
move a file
This moves a file from src to dest where dest is either a destination
filename or destination directory.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
GuestfsSession * guestfs_session_new (void);
Create a new libguestfs session.
Returns : |
a new guestfs session object. [transfer full] |
gint32 guestfs_session_ntfs_3g_probe (GuestfsSession *session,gboolean rw,const gchar *device,GError **err);
probe NTFS volume
This command runs the ntfs-3g.probe(8) command which probes an NTFS
device for mountability. (Not all NTFS volumes can be mounted
read-write, and some cannot be mounted at all).
rw is a boolean flag. Set it to true if you want to test if the volume
can be mounted read-write. Set it to false if you want to test if the
volume can be mounted read-only.
The return value is an integer which 0 if the operation would succeed,
or some non-zero value documented in the ntfs-3g.probe(8) manual page.
|
A GuestfsSession object. [transfer none] |
|
. [type gboolean] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gboolean guestfs_session_ntfsclone_in (GuestfsSession *session,const gchar *backupfile,const gchar *device,GCancellable *cancellable,GError **err);
restore NTFS from backup file
Restore the backupfile (from a previous call to
guestfs_session_ntfsclone_out()) to device, overwriting any existing
contents of this device.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type filename] |
|
A GCancellable object |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_ntfsclone_out (GuestfsSession *session,const gchar *device,const gchar *backupfile,GuestfsNtfscloneOut *optargs,GCancellable *cancellable,GError **err);
save NTFS to backup file
Stream the NTFS filesystem device to the local file backupfile. The
format used for the backup file is a special format used by the
ntfsclone(8) tool.
If the optional metadataonly flag is true, then *only* the metadata is
saved, losing all the user data (this is useful for diagnosing some
filesystem problems).
The optional rescue, ignorefscheck, preservetimestamps and force
flags have precise meanings detailed in the ntfsclone(8) man page.
Use guestfs_session_ntfsclone_in() to restore the file back to a
libguestfs device.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type filename] |
|
a GuestfsNtfscloneOut containing optional arguments. [transfer none][allow-none] |
|
A GCancellable object |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_ntfsfix (GuestfsSession *session,const gchar *device,GuestfsNtfsfix *optargs,GError **err);
fix common errors and force Windows to check NTFS
This command repairs some fundamental NTFS inconsistencies, resets the NTFS journal file, and schedules an NTFS consistency check for the first boot into Windows.
This is *not* an equivalent of Windows chkdsk. It does *not* scan the
filesystem for inconsistencies.
The optional clearbadsectors flag clears the list of bad sectors. This
is useful after cloning a disk with bad sectors to a new disk.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
a GuestfsNtfsfix containing optional arguments. [transfer none][allow-none] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_ntfsresize (GuestfsSession *session,const gchar *device,GError **err);
resize an NTFS filesystem
This command resizes an NTFS filesystem, expanding or shrinking it to the size of the underlying device.
*Note:* After the resize operation, the filesystem is marked as requiring a consistency check (for safety). You have to boot into Windows to perform this check and clear this condition. Furthermore, ntfsresize refuses to resize filesystems which have been marked in this way. So in effect it is not possible to call ntfsresize multiple times on a single filesystem without booting into Windows between each resize.
See also ntfsresize(8).
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_ntfsresize_opts (GuestfsSession *session,const gchar *device,GuestfsNTFSResizeOpts *optargs,GError **err);
resize an NTFS filesystem
This command resizes an NTFS filesystem, expanding or shrinking it to the size of the underlying device.
The optional parameters are:
size
The new size (in bytes) of the filesystem. If omitted, the
filesystem is resized to fit the container (eg. partition).
force
If this option is true, then force the resize of the filesystem even
if the filesystem is marked as requiring a consistency check.
After the resize operation, the filesystem is always marked as
requiring a consistency check (for safety). You have to boot into
Windows to perform this check and clear this condition. If you
*don't* set the force option then it is not possible to call
guestfs_session_ntfsresize_opts() multiple times on a single
filesystem without booting into Windows between each resize.
See also ntfsresize(8).
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
a GuestfsNTFSResizeOpts containing optional arguments. [transfer none][allow-none] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_ntfsresize_size (GuestfsSession *session,const gchar *device,gint64 size,GError **err);
resize an NTFS filesystem (with size)
This command is the same as guestfs_session_ntfsresize() except that it
allows you to specify the new size (in bytes) explicitly.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [type gint64] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_part_add (GuestfsSession *session,const gchar *device,const gchar *prlogex,gint64 startsect,gint64 endsect,GError **err);
add a partition to the device
This command adds a partition to device. If there is no partition table
on the device, call guestfs_session_part_init() first.
The prlogex parameter is the type of partition. Normally you should
pass p or primary here, but MBR partition tables also support l (or
logical) and e (or extended) partition types.
startsect and endsect are the start and end of the partition in
*sectors*. endsect may be negative, which means it counts backwards
from the end of the disk (@-1 is the last sector).
Creating a partition which covers the whole disk is not so easy. Use
guestfs_session_part_disk() to do that.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type utf8] |
|
. [type gint64] |
|
. [type gint64] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_part_del (GuestfsSession *session,const gchar *device,gint32 partnum,GError **err);
delete a partition
This command deletes the partition numbered partnum on device.
Note that in the case of MBR partitioning, deleting an extended partition also deletes any logical partitions it contains.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [type gint32] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_part_disk (GuestfsSession *session,const gchar *device,const gchar *parttype,GError **err);
partition whole disk with a single primary partition
This command is simply a combination of guestfs_session_part_init()
followed by guestfs_session_part_add() to create a single primary
partition covering the whole disk.
parttype is the partition table type, usually mbr or gpt, but other
possible values are described in guestfs_session_part_init().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gint8 guestfs_session_part_get_bootable (GuestfsSession *session,const gchar *device,gint32 partnum,GError **err);
return true if a partition is bootable
This command returns true if the partition partnum on device has the
bootable flag set.
See also guestfs_session_part_set_bootable().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [type gint32] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gint32 guestfs_session_part_get_mbr_id (GuestfsSession *session,const gchar *device,gint32 partnum,GError **err);
get the MBR type byte (ID byte) from a partition
Returns the MBR type byte (also known as the ID byte) from the numbered
partition partnum.
Note that only MBR (old DOS-style) partitions have type bytes. You will
get undefined results for other partition table types (see
guestfs_session_part_get_parttype()).
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [type gint32] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gchar * guestfs_session_part_get_parttype (GuestfsSession *session,const gchar *device,GError **err);
get the partition table type
This command examines the partition table on device and returns the
partition table type (format) being used.
Common return values include: msdos (a DOS/Windows style MBR partition
table), gpt (a GPT/EFI-style partition table). Other values are
possible, although unusual. See guestfs_session_part_init() for a full
list.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gboolean guestfs_session_part_init (GuestfsSession *session,const gchar *device,const gchar *parttype,GError **err);
create an empty partition table
This creates an empty partition table on device of one of the partition
types listed below. Usually parttype should be either msdos or gpt
(for large disks).
Initially there are no partitions. Following this, you should call
guestfs_session_part_add() for each partition required.
Possible values for parttype are:
efi gpt Intel EFI / GPT partition table.
This is recommended for >= 2 TB partitions that will be accessed
from Linux and Intel-based Mac OS X. It also has limited backwards
compatibility with the mbr format.
mbr
msdos
The standard PC "Master Boot Record" (MBR) format used by MS-DOS and
Windows. This partition type will only work for device sizes up to 2
TB. For large disks we recommend using gpt.
Other partition table types that may work but are not supported include:
aix AIX disk labels.
amiga rdb Amiga "Rigid Disk Block" format.
bsd BSD disk labels.
dasd DASD, used on IBM mainframes.
dvh MIPS/SGI volumes.
mac Old Mac partition format. Modern Macs use gpt.
pc98 NEC PC-98 format, common in Japan apparently.
sun Sun disk labels.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
GuestfsPartition ** guestfs_session_part_list (GuestfsSession *session,const gchar *device,GError **err);
list partitions on a device
This command parses the partition table on device and returns the list
of partitions found.
The fields in the returned structure are:
part_num Partition number, counting from 1.
part_start
Start of the partition *in bytes*. To get sectors you have to divide
by the device's sector size, see guestfs_session_blockdev_getss().
part_end End of the partition in bytes.
part_size Size of the partition in bytes.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
an array of Partition objects, or NULL on error. [transfer full][array zero-terminated=1][element-type GuestfsPartition] |
gboolean guestfs_session_part_set_bootable (GuestfsSession *session,const gchar *device,gint32 partnum,gboolean bootable,GError **err);
make a partition bootable
This sets the bootable flag on partition numbered partnum on device
device. Note that partitions are numbered from 1.
The bootable flag is used by some operating systems (notably Windows) to determine which partition to boot from. It is by no means universally recognized.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [type gint32] |
|
. [type gboolean] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_part_set_mbr_id (GuestfsSession *session,const gchar *device,gint32 partnum,gint32 idbyte,GError **err);
set the MBR type byte (ID byte) of a partition
Sets the MBR type byte (also known as the ID byte) of the numbered
partition partnum to idbyte. Note that the type bytes quoted in most
documentation are in fact hexadecimal numbers, but usually documented
without any leading "0x" which might be confusing.
Note that only MBR (old DOS-style) partitions have type bytes. You will
get undefined results for other partition table types (see
guestfs_session_part_get_parttype()).
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [type gint32] |
|
. [type gint32] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_part_set_name (GuestfsSession *session,const gchar *device,gint32 partnum,const gchar *name,GError **err);
set partition name
This sets the partition name on partition numbered partnum on device
device. Note that partitions are numbered from 1.
The partition name can only be set on certain types of partition table.
This works on gpt but not on mbr partitions.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [type gint32] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gchar * guestfs_session_part_to_dev (GuestfsSession *session,const gchar *partition,GError **err);
convert partition name to device name
This function takes a partition name (eg. "/dev/sdb1") and removes the partition number, returning the device name (eg. "/dev/sdb").
The named partition must exist, for example as a string returned from
guestfs_session_list_partitions().
See also guestfs_session_part_to_partnum().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gint32 guestfs_session_part_to_partnum (GuestfsSession *session,const gchar *partition,GError **err);
convert partition name to partition number
This function takes a partition name (eg. "/dev/sdb1") and returns the
partition number (eg. 1).
The named partition must exist, for example as a string returned from
guestfs_session_list_partitions().
See also guestfs_session_part_to_dev().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gboolean guestfs_session_ping_daemon (GuestfsSession *session,GError **err);
ping the guest daemon
This is a test probe into the guestfs daemon running inside the qemu subprocess. Calling this function checks that the daemon responds to the ping message, without affecting the daemon or attached block device(s) in any other way.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
guint8 * guestfs_session_pread (GuestfsSession *session,const gchar *path,gint32 count,gint64 offset,gsize *size_r,GError **err);
read part of a file
This command lets you read part of a file. It reads count bytes of the
file, starting at offset, from file path.
This may read fewer bytes than requested. For further details see the pread(2) system call.
See also guestfs_session_pwrite(), guestfs_session_pread_device().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [type gint32] |
|
. [type gint64] |
|
The size of the returned buffer, in bytes |
|
A GError object to receive any generated errors |
Returns : |
an array of binary data, or NULL on error. [transfer full][array length=size_r][element-type guint8] |
guint8 * guestfs_session_pread_device (GuestfsSession *session,const gchar *device,gint32 count,gint64 offset,gsize *size_r,GError **err);
read part of a device
This command lets you read part of a file. It reads count bytes of
device, starting at offset.
This may read fewer bytes than requested. For further details see the pread(2) system call.
See also guestfs_session_pread().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [type gint32] |
|
. [type gint64] |
|
The size of the returned buffer, in bytes |
|
A GError object to receive any generated errors |
Returns : |
an array of binary data, or NULL on error. [transfer full][array length=size_r][element-type guint8] |
gboolean guestfs_session_pvcreate (GuestfsSession *session,const gchar *device,GError **err);
create an LVM physical volume
This creates an LVM physical volume on the named device, where device
should usually be a partition name such as "/dev/sda1".
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_pvremove (GuestfsSession *session,const gchar *device,GError **err);
remove an LVM physical volume
This wipes a physical volume device so that LVM will no longer
recognise it.
The implementation uses the pvremove command which refuses to wipe
physical volumes that contain any volume groups, so you have to remove
those first.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_pvresize (GuestfsSession *session,const gchar *device,GError **err);
resize an LVM physical volume
This resizes (expands or shrinks) an existing LVM physical volume to match the new size of the underlying device.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_pvresize_size (GuestfsSession *session,const gchar *device,gint64 size,GError **err);
resize an LVM physical volume (with size)
This command is the same as guestfs_session_pvresize() except that it
allows you to specify the new size (in bytes) explicitly.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [type gint64] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gchar ** guestfs_session_pvs (GuestfsSession *session,GError **err);
list the LVM physical volumes (PVs)
List all the physical volumes detected. This is the equivalent of the pvs(8) command.
This returns a list of just the device names that contain PVs (eg. "/dev/sda2").
See also guestfs_session_pvs_full().
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
GuestfsPV ** guestfs_session_pvs_full (GuestfsSession *session,GError **err);
list the LVM physical volumes (PVs)
List all the physical volumes detected. This is the equivalent of the pvs(8) command. The "full" version includes all fields.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
an array of PV objects, or NULL on error. [transfer full][array zero-terminated=1][element-type GuestfsPV] |
gchar * guestfs_session_pvuuid (GuestfsSession *session,const gchar *device,GError **err);
get the UUID of a physical volume
This command returns the UUID of the LVM PV device.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gint32 guestfs_session_pwrite (GuestfsSession *session,const gchar *path,const guint8 *content,gsize content_size,gint64 offset,GError **err);
write to part of a file
This command writes to part of a file. It writes the data buffer
content to the file path starting at offset offset.
This command implements the pwrite(2) system call, and like that system call it may not write the full data requested. The return value is the number of bytes that were actually written to the file. This could even be 0, although short writes are unlikely for regular files in ordinary circumstances.
See also guestfs_session_pread(), guestfs_session_pwrite_device().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
an array of binary data. [transfer none][array length=content_size][element-type guint8] |
|
The size of content, in bytes |
|
. [type gint64] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gint32 guestfs_session_pwrite_device (GuestfsSession *session,const gchar *device,const guint8 *content,gsize content_size,gint64 offset,GError **err);
write to part of a device
This command writes to part of a device. It writes the data buffer
content to device starting at offset offset.
This command implements the pwrite(2) system call, and like that system call it may not write the full data requested (although short writes to disk devices and partitions are probably impossible with standard Linux kernels).
See also guestfs_session_pwrite().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
an array of binary data. [transfer none][array length=content_size][element-type guint8] |
|
The size of content, in bytes |
|
. [type gint64] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
guint8 * guestfs_session_read_file (GuestfsSession *session,const gchar *path,gsize *size_r,GError **err);
read a file
This calls returns the contents of the file path as a buffer.
Unlike guestfs_session_cat(), this function can correctly handle files
that contain embedded ASCII NUL characters. However unlike
guestfs_session_download(), this function is limited in the total size
of file that can be handled.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
The size of the returned buffer, in bytes |
|
A GError object to receive any generated errors |
Returns : |
an array of binary data, or NULL on error. [transfer full][array length=size_r][element-type guint8] |
gchar ** guestfs_session_read_lines (GuestfsSession *session,const gchar *path,GError **err);
read file as lines
Return the contents of the file named path.
The file contents are returned as a list of lines. Trailing LF and
CRLF character sequences are *not* returned.
Note that this function cannot correctly handle binary files
(specifically, files containing "\0" character which is treated as end
of line). For those you need to use the guestfs_session_read_file()
function which has a more complex interface.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
GuestfsDirent ** guestfs_session_readdir (GuestfsSession *session,const gchar *dir,GError **err);
read directories entries
This returns the list of directory entries in directory dir.
All entries in the directory are returned, including "." and "..". The entries are *not* sorted, but returned in the same order as the underlying filesystem.
Also this call returns basic file type information about each file. The
ftyp field will contain one of the following characters:
'b' Block special
'c' Char special
'd' Directory
'f' FIFO (named pipe)
'l' Symbolic link
'r' Regular file
's' Socket
'u' Unknown file type
'?' The readdir(3) call returned a d_type field with an unexpected
value
This function is primarily intended for use by programs. To get a simple
list of names, use guestfs_session_ls(). To get a printable directory
for human consumption, use guestfs_session_ll().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
an array of Dirent objects, or NULL on error. [transfer full][array zero-terminated=1][element-type GuestfsDirent] |
gchar * guestfs_session_readlink (GuestfsSession *session,const gchar *path,GError **err);
read the target of a symbolic link
This command reads the target of a symbolic link.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gchar ** guestfs_session_readlinklist (GuestfsSession *session,const gchar *path,gchar *const *names,GError **err);
readlink on multiple files
This call allows you to do a readlink operation on multiple files,
where all files are in the directory path. names is the list of files
from this directory.
On return you get a list of strings, with a one-to-one correspondence to
the names list. Each string is the value of the symbolic link.
If the readlink(2) operation fails on any name, then the corresponding result string is the empty string "". However the whole operation is completed even if there were readlink(2) errors, and so you can call this function with names where you don't know if they are symbolic links already (albeit slightly less efficient).
This call is intended for programs that want to efficiently list a directory contents without making many round-trips. Very long directory listings might cause the protocol message size to be exceeded, causing this call to fail. The caller must split up such requests into smaller groups of names.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
an array of strings. [transfer none][array zero-terminated=1][element-type utf8] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
gchar * guestfs_session_realpath (GuestfsSession *session,const gchar *path,GError **err);
canonicalized absolute pathname
Return the canonicalized absolute pathname of path. The returned path
has no ".", ".." or symbolic link path elements.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gboolean guestfs_session_removexattr (GuestfsSession *session,const gchar *xattr,const gchar *path,GError **err);
remove extended attribute of a file or directory
This call removes the extended attribute named xattr of the file path.
See also: guestfs_session_lremovexattr(), attr(5).
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_resize2fs (GuestfsSession *session,const gchar *device,GError **err);
resize an ext2, ext3 or ext4 filesystem
This resizes an ext2, ext3 or ext4 filesystem to match the size of the underlying device.
See also "RESIZE2FS ERRORS" in guestfs(3).
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_resize2fs_M (GuestfsSession *session,const gchar *device,GError **err);
resize an ext2, ext3 or ext4 filesystem to the minimum size
This command is the same as guestfs_session_resize2fs(), but the
filesystem is resized to its minimum size. This works like the *-M*
option to the resize2fs command.
To get the resulting size of the filesystem you should call
guestfs_session_tune2fs_l() and read the "Block size" and "Block count"
values. These two numbers, multiplied together, give the resulting size
of the minimal filesystem in bytes.
See also "RESIZE2FS ERRORS" in guestfs(3).
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_resize2fs_size (GuestfsSession *session,const gchar *device,gint64 size,GError **err);
resize an ext2, ext3 or ext4 filesystem (with size)
This command is the same as guestfs_session_resize2fs() except that it
allows you to specify the new size (in bytes) explicitly.
See also "RESIZE2FS ERRORS" in guestfs(3).
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [type gint64] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_rm (GuestfsSession *session,const gchar *path,GError **err);
remove a file
Remove the single file path.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_rm_rf (GuestfsSession *session,const gchar *path,GError **err);
remove a file or directory recursively
Remove the file or directory path, recursively removing the contents if
its a directory. This is like the "rm -rf" shell command.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_rmdir (GuestfsSession *session,const gchar *path,GError **err);
remove a directory
Remove the single directory path.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_rmmountpoint (GuestfsSession *session,const gchar *exemptpath,GError **err);
remove a mountpoint
This calls removes a mountpoint that was previously created with
guestfs_session_mkmountpoint(). See guestfs_session_mkmountpoint() for
full details.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_scrub_device (GuestfsSession *session,const gchar *device,GError **err);
scrub (securely wipe) a device
This command writes patterns over device to make data retrieval more
difficult.
It is an interface to the scrub(1) program. See that manual page for more details.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_scrub_file (GuestfsSession *session,const gchar *file,GError **err);
scrub (securely wipe) a file
This command writes patterns over a file to make data retrieval more difficult.
The file is *removed* after scrubbing.
It is an interface to the scrub(1) program. See that manual page for more details.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_scrub_freespace (GuestfsSession *session,const gchar *dir,GError **err);
scrub (securely wipe) free space
This command creates the directory dir and then fills it with files
until the filesystem is full, and scrubs the files as for
guestfs_session_scrub_file(), and deletes them. The intention is to
scrub any free space on the partition containing dir.
It is an interface to the scrub(1) program. See that manual page for more details.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_set_append (GuestfsSession *session,const gchar *append,GError **err);
add options to kernel command line
This function is used to add additional options to the guest kernel command line.
The default is NULL unless overridden by setting LIBGUESTFS_APPEND
environment variable.
Setting append to NULL means *no* additional options are passed
(libguestfs always adds a few of its own).
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8][allow-none] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_set_attach_method (GuestfsSession *session,const gchar *attachmethod,GError **err);
set the attach method
Set the method that libguestfs uses to connect to the back end guestfsd daemon. Possible methods are:
appliance
Launch an appliance and connect to it. This is the ordinary method
and the default.
"unix:*path*" Connect to the Unix domain socket *path*.
This method lets you connect to an existing daemon or (using virtio-serial) to a live guest. For more information, see "ATTACHING TO RUNNING DAEMONS" in guestfs(3).
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_set_autosync (GuestfsSession *session,gboolean autosync,GError **err);
set autosync mode
If autosync is true, this enables autosync. Libguestfs will make a best
effort attempt to make filesystems consistent and synchronized when the
handle is closed (also if the program exits without closing handles).
This is enabled by default (since libguestfs 1.5.24, previously it was disabled by default).
|
A GuestfsSession object. [transfer none] |
|
. [type gboolean] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_set_direct (GuestfsSession *session,gboolean direct,GError **err);
enable or disable direct appliance mode
If the direct appliance mode flag is enabled, then stdin and stdout are passed directly through to the appliance once it is launched.
One consequence of this is that log messages aren't caught by the
library and handled by guestfs_session_set_log_message_callback(), but
go straight to stdout.
You probably don't want to use this unless you know what you are doing.
The default is disabled.
|
A GuestfsSession object. [transfer none] |
|
. [type gboolean] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_set_e2attrs (GuestfsSession *session,const gchar *file,const gchar *attrs,GuestfsSetE2attrs *optargs,GError **err);
set ext2 file attributes of a file
This sets or clears the file attributes attrs associated with the inode
file.
attrs is a string of characters representing file attributes. See
guestfs_session_get_e2attrs() for a list of possible attributes. Not all
attributes can be changed.
If optional boolean clear is not present or false, then the attrs
listed are set in the inode.
If clear is true, then the attrs listed are cleared in the inode.
In both cases, other attributes not present in the attrs string are
left unchanged.
These attributes are only present when the file is located on an ext2/3/4 filesystem. Using this call on other filesystem types will result in an error.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type utf8] |
|
a GuestfsSetE2attrs containing optional arguments. [transfer none][allow-none] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_set_e2generation (GuestfsSession *session,const gchar *file,gint64 generation,GError **err);
set ext2 file generation of a file
This sets the ext2 file generation of a file.
See guestfs_session_get_e2generation().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [type gint64] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_set_e2label (GuestfsSession *session,const gchar *device,const gchar *label,GError **err);
set the ext2/3/4 filesystem label
This sets the ext2/3/4 filesystem label of the filesystem on device to
label. Filesystem labels are limited to 16 characters.
You can use either guestfs_session_tune2fs_l() or
guestfs_session_get_e2label() to return the existing label on a
filesystem.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_set_e2uuid (GuestfsSession *session,const gchar *device,const gchar *uuid,GError **err);
set the ext2/3/4 filesystem UUID
This sets the ext2/3/4 filesystem UUID of the filesystem on device to
uuid. The format of the UUID and alternatives such as clear, random
and time are described in the tune2fs(8) manpage.
You can use either guestfs_session_tune2fs_l() or
guestfs_session_get_e2uuid() to return the existing UUID of a
filesystem.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_set_label (GuestfsSession *session,const gchar *device,const gchar *label,GError **err);
set filesystem label
Set the filesystem label on device to label.
Only some filesystem types support labels, and libguestfs supports setting labels on only a subset of these.
On ext2/3/4 filesystems, labels are limited to 16 bytes.
On NTFS filesystems, labels are limited to 128 unicode characters.
To read the label on a filesystem, call guestfs_session_vfs_label().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_set_memsize (GuestfsSession *session,gint32 memsize,GError **err);
set memory allocated to the qemu subprocess
This sets the memory size in megabytes allocated to the qemu subprocess.
This only has any effect if called before guestfs_session_launch().
You can also change this by setting the environment variable
LIBGUESTFS_MEMSIZE before the handle is created.
For more information on the architecture of libguestfs, see guestfs(3).
|
A GuestfsSession object. [transfer none] |
|
. [type gint32] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_set_network (GuestfsSession *session,gboolean network,GError **err);
set enable network flag
If network is true, then the network is enabled in the libguestfs
appliance. The default is false.
This affects whether commands are able to access the network (see "RUNNING COMMANDS" in guestfs(3)).
You must call this before calling guestfs_session_launch(), otherwise it
has no effect.
|
A GuestfsSession object. [transfer none] |
|
. [type gboolean] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_set_path (GuestfsSession *session,const gchar *searchpath,GError **err);
set the search path
Set the path that libguestfs searches for kernel and initrd.img.
The default is "$libdir/guestfs" unless overridden by setting
LIBGUESTFS_PATH environment variable.
Setting path to NULL restores the default path.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8][allow-none] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_set_pgroup (GuestfsSession *session,gboolean pgroup,GError **err);
set process group flag
If pgroup is true, child processes are placed into their own process
group.
The practical upshot of this is that signals like SIGINT (from users
pressing "^C") won't be received by the child process.
The default for this flag is false, because usually you want "^C" to
kill the subprocess. Guestfish sets this flag to true when used
interactively, so that "^C" can cancel long-running commands gracefully
(see guestfs_session_user_cancel()).
|
A GuestfsSession object. [transfer none] |
|
. [type gboolean] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_set_qemu (GuestfsSession *session,const gchar *qemu,GError **err);
set the qemu binary
Set the qemu binary that we will use.
The default is chosen when the library was compiled by the configure script.
You can also override this by setting the LIBGUESTFS_QEMU environment
variable.
Setting qemu to NULL restores the default qemu binary.
Note that you should call this function as early as possible after
creating the handle. This is because some pre-launch operations depend
on testing qemu features (by running "qemu -help"). If the qemu binary
changes, we don't retest features, and so you might see inconsistent
results. Using the environment variable LIBGUESTFS_QEMU is safest of
all since that picks the qemu binary at the same time as the handle is
created.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8][allow-none] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_set_recovery_proc (GuestfsSession *session,gboolean recoveryproc,GError **err);
enable or disable the recovery process
If this is called with the parameter false then
guestfs_session_launch() does not create a recovery process. The purpose
of the recovery process is to stop runaway qemu processes in the case
where the main program aborts abruptly.
This only has any effect if called before guestfs_session_launch(), and
the default is true.
About the only time when you would want to disable this is if the main process will fork itself into the background ("daemonize" itself). In this case the recovery process thinks that the main program has disappeared and so kills qemu, which is not very helpful.
|
A GuestfsSession object. [transfer none] |
|
. [type gboolean] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_set_selinux (GuestfsSession *session,gboolean selinux,GError **err);
set SELinux enabled or disabled at appliance boot
This sets the selinux flag that is passed to the appliance at boot time. The default is "selinux=0" (disabled).
Note that if SELinux is enabled, it is always in Permissive mode ("enforcing=0").
For more information on the architecture of libguestfs, see guestfs(3).
|
A GuestfsSession object. [transfer none] |
|
. [type gboolean] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_set_smp (GuestfsSession *session,gint32 smp,GError **err);
set number of virtual CPUs in appliance
Change the number of virtual CPUs assigned to the appliance. The default
is 1. Increasing this may improve performance, though often it has no
effect.
This function must be called before guestfs_session_launch().
|
A GuestfsSession object. [transfer none] |
|
. [type gint32] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_set_trace (GuestfsSession *session,gboolean trace,GError **err);
enable or disable command traces
If the command trace flag is set to 1, then libguestfs calls, parameters and return values are traced.
If you want to trace C API calls into libguestfs (and other libraries) then possibly a better way is to use the external ltrace(1) command.
Command traces are disabled unless the environment variable
LIBGUESTFS_TRACE is defined and set to 1.
Trace messages are normally sent to stderr, unless you register a
callback to send them somewhere else (see
guestfs_session_set_event_callback()).
|
A GuestfsSession object. [transfer none] |
|
. [type gboolean] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_set_verbose (GuestfsSession *session,gboolean verbose,GError **err);
set verbose mode
If verbose is true, this turns on verbose messages.
Verbose messages are disabled unless the environment variable
LIBGUESTFS_DEBUG is defined and set to 1.
Verbose messages are normally sent to stderr, unless you register a
callback to send them somewhere else (see
guestfs_session_set_event_callback()).
|
A GuestfsSession object. [transfer none] |
|
. [type gboolean] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_setcon (GuestfsSession *session,const gchar *context,GError **err);
set SELinux security context
This sets the SELinux security context of the daemon to the string
context.
See the documentation about SELINUX in guestfs(3).
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_setxattr (GuestfsSession *session,const gchar *xattr,const gchar *val,gint32 vallen,const gchar *path,GError **err);
set extended attribute of a file or directory
This call sets the extended attribute named xattr of the file path to
the value val (of length vallen). The value is arbitrary 8 bit data.
See also: guestfs_session_lsetxattr(), attr(5).
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type utf8] |
|
. [type gint32] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_sfdisk (GuestfsSession *session,const gchar *device,gint32 cyls,gint32 heads,gint32 sectors,gchar *const *lines,GError **err);
create partitions on a block device
This is a direct interface to the sfdisk(8) program for creating partitions on block devices.
device should be a block device, for example "/dev/sda".
cyls, heads and sectors are the number of cylinders, heads and
sectors on the device, which are passed directly to sfdisk as the *-C*,
*-H* and *-S* parameters. If you pass 0 for any of these, then the
corresponding parameter is omitted. Usually for 'large' disks, you can
just pass 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.
lines is a list of lines that we feed to sfdisk. For more information
refer to the sfdisk(8) manpage.
To create a single partition occupying the whole disk, you would pass
lines as a single element list, when the single element being the
string "," (comma).
See also: guestfs_session_sfdisk_l(), guestfs_session_sfdisk_N(),
guestfs_session_part_init()
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [type gint32] |
|
. [type gint32] |
|
. [type gint32] |
|
an array of strings. [transfer none][array zero-terminated=1][element-type utf8] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_sfdiskM (GuestfsSession *session,const gchar *device,gchar *const *lines,GError **err);
create partitions on a block device
This is a simplified interface to the guestfs_session_sfdisk() command,
where partition sizes are specified in megabytes only (rounded to the
nearest cylinder) and you don't need to specify the cyls, heads and
sectors parameters which were rarely if ever used anyway.
See also: guestfs_session_sfdisk(), the sfdisk(8) manpage and
guestfs_session_part_disk()
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
an array of strings. [transfer none][array zero-terminated=1][element-type utf8] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_sfdisk_N (GuestfsSession *session,const gchar *device,gint32 partnum,gint32 cyls,gint32 heads,gint32 sectors,const gchar *line,GError **err);
modify a single partition on a block device
This runs sfdisk(8) option to modify just the single partition n (note:
n counts from 1).
For other parameters, see guestfs_session_sfdisk(). You should usually
pass 0 for the cyls/heads/sectors parameters.
See also: guestfs_session_part_add()
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [type gint32] |
|
. [type gint32] |
|
. [type gint32] |
|
. [type gint32] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gchar * guestfs_session_sfdisk_disk_geometry (GuestfsSession *session,const gchar *device,GError **err);
display the disk geometry from the partition table
This displays the disk geometry of device read from the partition
table. Especially in the case where the underlying block device has been
resized, this can be different from the kernel's idea of the geometry
(see guestfs_session_sfdisk_kernel_geometry()).
The result is in human-readable format, and not designed to be parsed.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gchar * guestfs_session_sfdisk_kernel_geometry (GuestfsSession *session,const gchar *device,GError **err);
display the kernel geometry
This displays the kernel's idea of the geometry of device.
The result is in human-readable format, and not designed to be parsed.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gchar * guestfs_session_sfdisk_l (GuestfsSession *session,const gchar *device,GError **err);
display the partition table
This displays the partition table on device, in the human-readable
output of the sfdisk(8) command. It is not intended to be parsed.
See also: guestfs_session_part_list()
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gchar * guestfs_session_sh (GuestfsSession *session,const gchar *command,GError **err);
run a command via the shell
This call runs a command from the guest filesystem via the guest's "/bin/sh".
This is like guestfs_session_command(), but passes the command to:
/bin/sh -c "command"
Depending on the guest's shell, this usually results in wildcards being expanded, shell expressions being interpolated and so on.
All the provisos about guestfs_session_command() apply to this call.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gchar ** guestfs_session_sh_lines (GuestfsSession *session,const gchar *command,GError **err);
run a command via the shell returning lines
This is the same as guestfs_session_sh(), but splits the result into a
list of lines.
See also: guestfs_session_command_lines()
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
gboolean guestfs_session_sleep (GuestfsSession *session,gint32 secs,GError **err);
sleep for some seconds
Sleep for secs seconds.
|
A GuestfsSession object. [transfer none] |
|
. [type gint32] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
GuestfsStat * guestfs_session_stat (GuestfsSession *session,const gchar *path,GError **err);
get file information
Returns file information for the given path.
This is the same as the stat(2) system call.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
a Stat object, or NULL on error. [transfer full] |
GuestfsStatVFS * guestfs_session_statvfs (GuestfsSession *session,const gchar *path,GError **err);
get file system statistics
Returns file system statistics for any mounted file system. path should
be a file or directory in the mounted file system (typically it is the
mount point itself, but it doesn't need to be).
This is the same as the statvfs(2) system call.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
a StatVFS object, or NULL on error. [transfer full] |
gchar ** guestfs_session_strings (GuestfsSession *session,const gchar *path,GError **err);
print the printable strings in a file
This runs the strings(1) command on a file and returns the list of printable strings found.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
gchar ** guestfs_session_strings_e (GuestfsSession *session,const gchar *encoding,const gchar *path,GError **err);
print the printable strings in a file
This is like the guestfs_session_strings() command, but allows you to
specify the encoding of strings that are looked for in the source file
path.
Allowed encodings are:
s Single 7-bit-byte characters like ASCII and the ASCII-compatible
parts of ISO-8859-X (this is what guestfs_session_strings() uses).
S Single 8-bit-byte characters.
b 16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE.
l (lower case letter L) 16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for examining binaries in Windows guests.
B 32-bit big endian such as UCS-4BE.
L 32-bit little endian such as UCS-4LE.
The returned strings are transcoded to UTF-8.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
gboolean guestfs_session_swapoff_device (GuestfsSession *session,const gchar *device,GError **err);
disable swap on device
This command disables the libguestfs appliance swap device or partition
named device. See guestfs_session_swapon_device().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_swapoff_file (GuestfsSession *session,const gchar *file,GError **err);
disable swap on file
This command disables the libguestfs appliance swap on file.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_swapoff_label (GuestfsSession *session,const gchar *label,GError **err);
disable swap on labeled swap partition
This command disables the libguestfs appliance swap on labeled swap partition.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_swapoff_uuid (GuestfsSession *session,const gchar *uuid,GError **err);
disable swap on swap partition by UUID
This command disables the libguestfs appliance swap partition with the given UUID.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_swapon_device (GuestfsSession *session,const gchar *device,GError **err);
enable swap on device
This command enables the libguestfs appliance to use the swap device or
partition named device. The increased memory is made available for all
commands, for example those run using guestfs_session_command() or
guestfs_session_sh().
Note that you should not swap to existing guest swap partitions unless you know what you are doing. They may contain hibernation information, or other information that the guest doesn't want you to trash. You also risk leaking information about the host to the guest this way. Instead, attach a new host device to the guest and swap on that.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_swapon_file (GuestfsSession *session,const gchar *file,GError **err);
enable swap on file
This command enables swap to a file. See guestfs_session_swapon_device()
for other notes.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_swapon_label (GuestfsSession *session,const gchar *label,GError **err);
enable swap on labeled swap partition
This command enables swap to a labeled swap partition. See
guestfs_session_swapon_device() for other notes.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_swapon_uuid (GuestfsSession *session,const gchar *uuid,GError **err);
enable swap on swap partition by UUID
This command enables swap to a swap partition with the given UUID. See
guestfs_session_swapon_device() for other notes.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_sync (GuestfsSession *session,GError **err);
sync disks, writes are flushed through to the disk image
This syncs the disk, so that any writes are flushed through to the underlying disk image.
You should always call this if you have modified a disk image, before closing the handle.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gchar ** guestfs_session_tail (GuestfsSession *session,const gchar *path,GError **err);
return last 10 lines of a file
This command returns up to the last 10 lines of a file as a list of strings.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
gchar ** guestfs_session_tail_n (GuestfsSession *session,gint32 nrlines,const gchar *path,GError **err);
return last N lines of a file
If the parameter nrlines is a positive number, this returns the last
nrlines lines of the file path.
If the parameter nrlines is a negative number, this returns lines from
the file path, starting with the @-nrlinesth line.
If the parameter nrlines is zero, this returns an empty list.
|
A GuestfsSession object. [transfer none] |
|
. [type gint32] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
gboolean guestfs_session_tar_in (GuestfsSession *session,const gchar *tarfile,const gchar *directory,GCancellable *cancellable,GError **err);
unpack tarfile to directory
This command uploads and unpacks local file tarfile (an *uncompressed*
tar file) into directory.
To upload a compressed tarball, use guestfs_session_tgz_in() or
guestfs_session_txz_in().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type filename] |
|
A GCancellable object |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_tar_out (GuestfsSession *session,const gchar *directory,const gchar *tarfile,GCancellable *cancellable,GError **err);
pack directory into tarfile
This command packs the contents of directory and downloads it to local
file tarfile.
To download a compressed tarball, use guestfs_session_tgz_out() or
guestfs_session_txz_out().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type filename] |
|
A GCancellable object |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_test0 (GuestfsSession *session,const gchar *str,const gchar *optstr,gchar *const *strlist,gboolean b,gint32 integer,gint64 integer64,const gchar *filein,const gchar *fileout,const guint8 *bufferin,gsize bufferin_size,GuestfsTest0 *optargs,GCancellable *cancellable,GError **err);
internal test function - do not use
This is an internal test function which is used to test whether the automatically generated bindings can handle every possible parameter type correctly.
It echos the contents of each parameter to stdout.
You probably don't want to call this function.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type utf8][allow-none] |
|
an array of strings. [transfer none][array zero-terminated=1][element-type utf8] |
|
. [type gboolean] |
|
. [type gint32] |
|
. [type gint64] |
|
. [transfer none][type filename] |
|
. [transfer none][type filename] |
|
an array of binary data. [transfer none][array length=bufferin_size][element-type guint8] |
|
The size of bufferin, in bytes |
|
a GuestfsTest0 containing optional arguments. [transfer none][allow-none] |
|
A GCancellable object |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gint8 guestfs_session_test0rbool (GuestfsSession *session,const gchar *val,GError **err);
internal test function - do not use
This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type correctly.
It converts string val to the return type.
You probably don't want to call this function.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gint8 guestfs_session_test0rboolerr (GuestfsSession *session,GError **err);
internal test function - do not use
This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type correctly.
This function always returns an error.
You probably don't want to call this function.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
guint8 * guestfs_session_test0rbufferout (GuestfsSession *session,const gchar *val,gsize *size_r,GError **err);
internal test function - do not use
This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type correctly.
It converts string val to the return type.
You probably don't want to call this function.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
The size of the returned buffer, in bytes |
|
A GError object to receive any generated errors |
Returns : |
an array of binary data, or NULL on error. [transfer full][array length=size_r][element-type guint8] |
guint8 * guestfs_session_test0rbufferouterr (GuestfsSession *session,gsize *size_r,GError **err);
internal test function - do not use
This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type correctly.
This function always returns an error.
You probably don't want to call this function.
|
A GuestfsSession object. [transfer none] |
|
The size of the returned buffer, in bytes |
|
A GError object to receive any generated errors |
Returns : |
an array of binary data, or NULL on error. [transfer full][array length=size_r][element-type guint8] |
const gchar * guestfs_session_test0rconstoptstring (GuestfsSession *session,const gchar *val,GError **err);
internal test function - do not use
This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type correctly.
It converts string val to the return type.
You probably don't want to call this function.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
the returned string. Note that NULL does not indicate error. [transfer none] |
const gchar * guestfs_session_test0rconstoptstringerr (GuestfsSession *session,GError **err);
internal test function - do not use
This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type correctly.
This function always returns an error.
You probably don't want to call this function.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
the returned string. Note that NULL does not indicate error. [transfer none] |
const gchar * guestfs_session_test0rconststring (GuestfsSession *session,const gchar *val,GError **err);
internal test function - do not use
This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type correctly.
It converts string val to the return type.
You probably don't want to call this function.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer none] |
const gchar * guestfs_session_test0rconststringerr (GuestfsSession *session,GError **err);
internal test function - do not use
This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type correctly.
This function always returns an error.
You probably don't want to call this function.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer none] |
GHashTable * guestfs_session_test0rhashtable (GuestfsSession *session,const gchar *val,GError **err);
internal test function - do not use
This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type correctly.
It converts string val to the return type.
You probably don't want to call this function.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
a GHashTable of results, or NULL on error. [transfer full][element-type utf8 utf8] |
GHashTable * guestfs_session_test0rhashtableerr (GuestfsSession *session,GError **err);
internal test function - do not use
This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type correctly.
This function always returns an error.
You probably don't want to call this function.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
a GHashTable of results, or NULL on error. [transfer full][element-type utf8 utf8] |
gint32 guestfs_session_test0rint (GuestfsSession *session,const gchar *val,GError **err);
internal test function - do not use
This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type correctly.
It converts string val to the return type.
You probably don't want to call this function.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gint64 guestfs_session_test0rint64 (GuestfsSession *session,const gchar *val,GError **err);
internal test function - do not use
This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type correctly.
It converts string val to the return type.
You probably don't want to call this function.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gint64 guestfs_session_test0rint64err (GuestfsSession *session,GError **err);
internal test function - do not use
This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type correctly.
This function always returns an error.
You probably don't want to call this function.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gint32 guestfs_session_test0rinterr (GuestfsSession *session,GError **err);
internal test function - do not use
This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type correctly.
This function always returns an error.
You probably don't want to call this function.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gchar * guestfs_session_test0rstring (GuestfsSession *session,const gchar *val,GError **err);
internal test function - do not use
This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type correctly.
It converts string val to the return type.
You probably don't want to call this function.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gchar * guestfs_session_test0rstringerr (GuestfsSession *session,GError **err);
internal test function - do not use
This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type correctly.
This function always returns an error.
You probably don't want to call this function.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gchar ** guestfs_session_test0rstringlist (GuestfsSession *session,const gchar *val,GError **err);
internal test function - do not use
This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type correctly.
It converts string val to the return type.
You probably don't want to call this function.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
gchar ** guestfs_session_test0rstringlisterr (GuestfsSession *session,GError **err);
internal test function - do not use
This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type correctly.
This function always returns an error.
You probably don't want to call this function.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
GuestfsPV * guestfs_session_test0rstruct (GuestfsSession *session,const gchar *val,GError **err);
internal test function - do not use
This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type correctly.
It converts string val to the return type.
You probably don't want to call this function.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
a PV object, or NULL on error. [transfer full] |
GuestfsPV * guestfs_session_test0rstructerr (GuestfsSession *session,GError **err);
internal test function - do not use
This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type correctly.
This function always returns an error.
You probably don't want to call this function.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
a PV object, or NULL on error. [transfer full] |
GuestfsPV ** guestfs_session_test0rstructlist (GuestfsSession *session,const gchar *val,GError **err);
internal test function - do not use
This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type correctly.
It converts string val to the return type.
You probably don't want to call this function.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
an array of PV objects, or NULL on error. [transfer full][array zero-terminated=1][element-type GuestfsPV] |
GuestfsPV ** guestfs_session_test0rstructlisterr (GuestfsSession *session,GError **err);
internal test function - do not use
This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type correctly.
This function always returns an error.
You probably don't want to call this function.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
an array of PV objects, or NULL on error. [transfer full][array zero-terminated=1][element-type GuestfsPV] |
gboolean guestfs_session_tgz_in (GuestfsSession *session,const gchar *tarball,const gchar *directory,GCancellable *cancellable,GError **err);
unpack compressed tarball to directory
This command uploads and unpacks local file tarball (a *gzip
compressed* tar file) into directory.
To upload an uncompressed tarball, use guestfs_session_tar_in().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type filename] |
|
A GCancellable object |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_tgz_out (GuestfsSession *session,const gchar *directory,const gchar *tarball,GCancellable *cancellable,GError **err);
pack directory into compressed tarball
This command packs the contents of directory and downloads it to local
file tarball.
To download an uncompressed tarball, use guestfs_session_tar_out().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type filename] |
|
A GCancellable object |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_touch (GuestfsSession *session,const gchar *path,GError **err);
update file timestamps or create a new file
Touch acts like the touch(1) command. It can be used to update the timestamps on a file, or, if the file does not exist, to create a new zero-length file.
This command only works on regular files, and will fail on other file types such as directories, symbolic links, block special etc.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_truncate (GuestfsSession *session,const gchar *path,GError **err);
truncate a file to zero size
This command truncates path to a zero-length file. The file must exist
already.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_truncate_size (GuestfsSession *session,const gchar *path,gint64 size,GError **err);
truncate a file to a particular size
This command truncates path to size size bytes. The file must exist
already.
If the current file size is less than size then the file is extended to
the required size with zero bytes. This creates a sparse file (ie. disk
blocks are not allocated for the file until you write to it). To create
a non-sparse file of zeroes, use guestfs_session_fallocate64() instead.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [type gint64] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_tune2fs (GuestfsSession *session,const gchar *device,GuestfsTune2FS *optargs,GError **err);
adjust ext2/ext3/ext4 filesystem parameters
This call allows you to adjust various filesystem parameters of an
ext2/ext3/ext4 filesystem called device.
The optional parameters are:
force
Force tune2fs to complete the operation even in the face of errors.
This is the same as the tune2fs @-f option.
maxmountcount
Set the number of mounts after which the filesystem is checked by
e2fsck(8). If this is 0 then the number of mounts is disregarded.
This is the same as the tune2fs @-c option.
mountcount
Set the number of times the filesystem has been mounted. This is the
same as the tune2fs @-C option.
errorbehavior
Change the behavior of the kernel code when errors are detected.
Possible values currently are: continue, remount-ro, panic. In
practice these options don't really make any difference,
particularly for write errors.
This is the same as the tune2fs @-e option.
group
Set the group which can use reserved filesystem blocks. This is the
same as the tune2fs @-g option except that it can only be specified
as a number.
intervalbetweenchecks
Adjust the maximal time between two filesystem checks (in seconds).
If the option is passed as 0 then time-dependent checking is
disabled.
This is the same as the tune2fs @-i option.
reservedblockspercentage
Set the percentage of the filesystem which may only be allocated by
privileged processes. This is the same as the tune2fs @-m option.
lastmounteddirectory
Set the last mounted directory. This is the same as the tune2fs @-M
option.
reservedblockscount Set the number of reserved filesystem blocks. This
is the same as the tune2fs @-r option.
user
Set the user who can use the reserved filesystem blocks. This is the
same as the tune2fs @-u option except that it can only be specified
as a number.
To get the current values of filesystem parameters, see
guestfs_session_tune2fs_l(). For precise details of how tune2fs works,
see the tune2fs(8) man page.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
a GuestfsTune2FS containing optional arguments. [transfer none][allow-none] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
GHashTable * guestfs_session_tune2fs_l (GuestfsSession *session,const gchar *device,GError **err);
get ext2/ext3/ext4 superblock details
This returns the contents of the ext2, ext3 or ext4 filesystem
superblock on device.
It is the same as running "tune2fs -l device". See tune2fs(8) manpage
for more details. The list of fields returned isn't clearly defined, and
depends on both the version of tune2fs that libguestfs was built
against, and the filesystem itself.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
a GHashTable of results, or NULL on error. [transfer full][element-type utf8 utf8] |
gboolean guestfs_session_txz_in (GuestfsSession *session,const gchar *tarball,const gchar *directory,GCancellable *cancellable,GError **err);
unpack compressed tarball to directory
This command uploads and unpacks local file tarball (an *xz compressed*
tar file) into directory.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type filename] |
|
A GCancellable object |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_txz_out (GuestfsSession *session,const gchar *directory,const gchar *tarball,GCancellable *cancellable,GError **err);
pack directory into compressed tarball
This command packs the contents of directory and downloads it to local
file tarball (as an xz compressed tar archive).
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type filename] |
|
A GCancellable object |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gint32 guestfs_session_umask (GuestfsSession *session,gint32 mask,GError **err);
set file mode creation mask (umask)
This function sets the mask used for creating new files and device nodes to "mask & 0777".
Typical umask values would be 022 which creates new files with
permissions like "-rw-r--r--" or "-rwxr-xr-x", and 002 which creates
new files with permissions like "-rw-rw-r--" or "-rwxrwxr-x".
The default umask is 022. This is important because it means that
directories and device nodes will be created with 0644 or 0755 mode
even if you specify 0777.
See also guestfs_session_get_umask(), umask(2), guestfs_session_mknod(),
guestfs_session_mkdir().
This call returns the previous umask.
|
A GuestfsSession object. [transfer none] |
|
. [type gint32] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gboolean guestfs_session_umount (GuestfsSession *session,const gchar *pathordevice,GError **err);
unmount a filesystem
This unmounts the given filesystem. The filesystem may be specified either by its mountpoint (path) or the device which contains the filesystem.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_umount_all (GuestfsSession *session,GError **err);
unmount all filesystems
This unmounts all mounted filesystems.
Some internal mounts are not unmounted by this call.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_umount_local (GuestfsSession *session,GuestfsUmountLocal *optargs,GError **err);
unmount a locally mounted filesystem
If libguestfs is exporting the filesystem on a local mountpoint, then this unmounts it.
See "MOUNT LOCAL" in guestfs(3) for full documentation.
|
A GuestfsSession object. [transfer none] |
|
a GuestfsUmountLocal containing optional arguments. [transfer none][allow-none] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_upload (GuestfsSession *session,const gchar *filename,const gchar *remotefilename,GCancellable *cancellable,GError **err);
upload a file from the local machine
Upload local file filename to remotefilename on the filesystem.
filename can also be a named pipe.
See also guestfs_session_download().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type filename] |
|
A GCancellable object |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_upload_offset (GuestfsSession *session,const gchar *filename,const gchar *remotefilename,gint64 offset,GCancellable *cancellable,GError **err);
upload a file from the local machine with offset
Upload local file filename to remotefilename on the filesystem.
remotefilename is overwritten starting at the byte offset specified.
The intention is to overwrite parts of existing files or devices,
although if a non-existant file is specified then it is created with a
"hole" before offset. The size of the data written is implicit in the
size of the source filename.
Note that there is no limit on the amount of data that can be uploaded
with this call, unlike with guestfs_session_pwrite(), and this call
always writes the full amount unless an error occurs.
See also guestfs_session_upload(), guestfs_session_pwrite().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type filename] |
|
. [type gint64] |
|
A GCancellable object |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_utimens (GuestfsSession *session,const gchar *path,gint64 atsecs,gint64 atnsecs,gint64 mtsecs,gint64 mtnsecs,GError **err);
set timestamp of a file with nanosecond precision
This command sets the timestamps of a file with nanosecond precision.
"atsecs, atnsecs" are the last access time (atime) in secs and nanoseconds from the epoch.
"mtsecs, mtnsecs" are the last modification time (mtime) in secs and nanoseconds from the epoch.
If the *nsecs field contains the special value @-1 then the corresponding timestamp is set to the current time. (The *secs field is ignored in this case).
If the *nsecs field contains the special value @-2 then the corresponding timestamp is left unchanged. (The *secs field is ignored in this case).
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [type gint64] |
|
. [type gint64] |
|
. [type gint64] |
|
. [type gint64] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
GuestfsVersion * guestfs_session_version (GuestfsSession *session,GError **err);
get the library version number
Return the libguestfs version number that the program is linked against.
Note that because of dynamic linking this is not necessarily the version of libguestfs that you compiled against. You can compile the program, and then at runtime dynamically link against a completely different "libguestfs.so" library.
This call was added in version 1.0.58. In previous versions of libguestfs there was no way to get the version number. From C code you can use dynamic linker functions to find out if this symbol exists (if it doesn't, then it's an earlier version).
The call returns a structure with four elements. The first three
(major, minor and release) are numbers and correspond to the usual
version triplet. The fourth element (extra) is a string and is normally
empty, but may be used for distro-specific information.
To construct the original version string: "$major.$minor.$release$extra"
See also: "LIBGUESTFS VERSION NUMBERS" in guestfs(3).
*Note:* Don't use this call to test for availability of features. In
enterprise distributions we backport features from later versions into
earlier versions, making this an unreliable way to test for features.
Use guestfs_session_available() instead.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
a Version object, or NULL on error. [transfer full] |
gchar * guestfs_session_vfs_label (GuestfsSession *session,const gchar *device,GError **err);
get the filesystem label
This returns the filesystem label of the filesystem on device.
If the filesystem is unlabeled, this returns the empty string.
To find a filesystem from the label, use guestfs_session_findfs_label().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gchar * guestfs_session_vfs_type (GuestfsSession *session,const gchar *device,GError **err);
get the Linux VFS type corresponding to a mounted device
This command gets the filesystem type corresponding to the filesystem on
device.
For most filesystems, the result is the name of the Linux VFS module
which would be used to mount this filesystem if you mounted it without
specifying the filesystem type. For example a string such as ext3 or
ntfs.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gchar * guestfs_session_vfs_uuid (GuestfsSession *session,const gchar *device,GError **err);
get the filesystem UUID
This returns the filesystem UUID of the filesystem on device.
If the filesystem does not have a UUID, this returns the empty string.
To find a filesystem from the UUID, use guestfs_session_findfs_uuid().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gboolean guestfs_session_vg_activate (GuestfsSession *session,gboolean activate,gchar *const *volgroups,GError **err);
activate or deactivate some volume groups
This command activates or (if activate is false) deactivates all
logical volumes in the listed volume groups volgroups.
This command is the same as running "vgchange -a y|n volgroups..."
Note that if volgroups is an empty list then all volume groups are
activated or deactivated.
|
A GuestfsSession object. [transfer none] |
|
. [type gboolean] |
|
an array of strings. [transfer none][array zero-terminated=1][element-type utf8] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_vg_activate_all (GuestfsSession *session,gboolean activate,GError **err);
activate or deactivate all volume groups
This command activates or (if activate is false) deactivates all
logical volumes in all volume groups.
This command is the same as running "vgchange -a y|n"
|
A GuestfsSession object. [transfer none] |
|
. [type gboolean] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_vgcreate (GuestfsSession *session,const gchar *volgroup,gchar *const *physvols,GError **err);
create an LVM volume group
This creates an LVM volume group called volgroup from the non-empty
list of physical volumes physvols.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
an array of strings. [transfer none][array zero-terminated=1][element-type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gchar ** guestfs_session_vglvuuids (GuestfsSession *session,const gchar *vgname,GError **err);
get the LV UUIDs of all LVs in the volume group
Given a VG called vgname, this returns the UUIDs of all the logical
volumes created in this volume group.
You can use this along with guestfs_session_lvs() and
guestfs_session_lvuuid() calls to associate logical volumes and volume
groups.
See also guestfs_session_vgpvuuids().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
guint8 * guestfs_session_vgmeta (GuestfsSession *session,const gchar *vgname,gsize *size_r,GError **err);
get volume group metadata
vgname is an LVM volume group. This command examines the volume group
and returns its metadata.
Note that the metadata is an internal structure used by LVM, subject to change at any time, and is provided for information only.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
The size of the returned buffer, in bytes |
|
A GError object to receive any generated errors |
Returns : |
an array of binary data, or NULL on error. [transfer full][array length=size_r][element-type guint8] |
gchar ** guestfs_session_vgpvuuids (GuestfsSession *session,const gchar *vgname,GError **err);
get the PV UUIDs containing the volume group
Given a VG called vgname, this returns the UUIDs of all the physical
volumes that this volume group resides on.
You can use this along with guestfs_session_pvs() and
guestfs_session_pvuuid() calls to associate physical volumes and volume
groups.
See also guestfs_session_vglvuuids().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
gboolean guestfs_session_vgremove (GuestfsSession *session,const gchar *vgname,GError **err);
remove an LVM volume group
Remove an LVM volume group vgname, (for example VG).
This also forcibly removes all logical volumes in the volume group (if any).
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_vgrename (GuestfsSession *session,const gchar *volgroup,const gchar *newvolgroup,GError **err);
rename an LVM volume group
Rename a volume group volgroup with the new name newvolgroup.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gchar ** guestfs_session_vgs (GuestfsSession *session,GError **err);
list the LVM volume groups (VGs)
List all the volumes groups detected. This is the equivalent of the vgs(8) command.
This returns a list of just the volume group names that were detected
(eg. VolGroup00).
See also guestfs_session_vgs_full().
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
GuestfsVG ** guestfs_session_vgs_full (GuestfsSession *session,GError **err);
list the LVM volume groups (VGs)
List all the volumes groups detected. This is the equivalent of the vgs(8) command. The "full" version includes all fields.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
an array of VG objects, or NULL on error. [transfer full][array zero-terminated=1][element-type GuestfsVG] |
gboolean guestfs_session_vgscan (GuestfsSession *session,GError **err);
rescan for LVM physical volumes, volume groups and logical volumes
This rescans all block devices and rebuilds the list of LVM physical volumes, volume groups and logical volumes.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gchar * guestfs_session_vguuid (GuestfsSession *session,const gchar *vgname,GError **err);
get the UUID of a volume group
This command returns the UUID of the LVM VG named vgname.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gboolean guestfs_session_wait_ready (GuestfsSession *session,GError **err);
wait until the qemu subprocess launches (no op)
This function is a no op.
In versions of the API < 1.0.71 you had to call this function just
after calling guestfs_session_launch() to wait for the launch to
complete. However this is no longer necessary because
guestfs_session_launch() now does the waiting.
If you see any calls to this function in code then you can just remove them, unless you want to retain compatibility with older versions of the API.
|
A GuestfsSession object. [transfer none] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gint32 guestfs_session_wc_c (GuestfsSession *session,const gchar *path,GError **err);
count characters in a file
This command counts the characters in a file, using the "wc -c" external command.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gint32 guestfs_session_wc_l (GuestfsSession *session,const gchar *path,GError **err);
count lines in a file
This command counts the lines in a file, using the "wc -l" external command.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gint32 guestfs_session_wc_w (GuestfsSession *session,const gchar *path,GError **err);
count words in a file
This command counts the words in a file, using the "wc -w" external command.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned value, or -1 on error |
gboolean guestfs_session_wipefs (GuestfsSession *session,const gchar *device,GError **err);
wipe a filesystem signature from a device
This command erases filesystem or RAID signatures from the specified
device to make the filesystem invisible to libblkid.
This does not erase the filesystem itself nor any other data from the
device.
Compare with guestfs_session_zero() which zeroes the first few blocks of
a device.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_write (GuestfsSession *session,const gchar *path,const guint8 *content,gsize content_size,GError **err);
create a new file
This call creates a file called path. The content of the file is the
string content (which can contain any 8 bit data).
See also guestfs_session_write_append().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
an array of binary data. [transfer none][array length=content_size][element-type guint8] |
|
The size of content, in bytes |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_write_append (GuestfsSession *session,const gchar *path,const guint8 *content,gsize content_size,GError **err);
append content to end of file
This call appends content to the end of file path. If path does not
exist, then a new file is created.
See also guestfs_session_write().
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
an array of binary data. [transfer none][array length=content_size][element-type guint8] |
|
The size of content, in bytes |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_write_file (GuestfsSession *session,const gchar *path,const gchar *content,gint32 size,GError **err);
create a file
This call creates a file called path. The contents of the file is the
string content (which can contain any 8 bit data), with length size.
As a special case, if size is 0 then the length is calculated using
strlen (so in this case the content cannot contain embedded ASCII
NULs).
*NB.* Owing to a bug, writing content containing ASCII NUL characters does *not* work, even if the length is specified.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
. [transfer none][type utf8] |
|
. [type gint32] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gchar ** guestfs_session_zegrep (GuestfsSession *session,const gchar *regex,const gchar *path,GError **err);
return lines matching a pattern
This calls the external zegrep program and returns the matching lines.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
gchar ** guestfs_session_zegrepi (GuestfsSession *session,const gchar *regex,const gchar *path,GError **err);
return lines matching a pattern
This calls the external "zegrep -i" program and returns the matching lines.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
gboolean guestfs_session_zero (GuestfsSession *session,const gchar *device,GError **err);
write zeroes to the device
This command writes zeroes over the first few blocks of device.
How many blocks are zeroed isn't specified (but it's *not* enough to securely wipe the device). It should be sufficient to remove any partition tables, filesystem superblocks and so on.
If blocks are already zero, then this command avoids writing zeroes. This prevents the underlying device from becoming non-sparse or growing unnecessarily.
See also: guestfs_session_zero_device(), guestfs_session_scrub_device(),
guestfs_session_is_zero_device()
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_zero_device (GuestfsSession *session,const gchar *device,GError **err);
write zeroes to an entire device
This command writes zeroes over the entire device. Compare with
guestfs_session_zero() which just zeroes the first few blocks of a
device.
If blocks are already zero, then this command avoids writing zeroes. This prevents the underlying device from becoming non-sparse or growing unnecessarily.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_zero_free_space (GuestfsSession *session,const gchar *directory,GError **err);
zero free space in a filesystem
Zero the free space in the filesystem mounted on directory. The
filesystem must be mounted read-write.
The filesystem contents are not affected, but any free space in the filesystem is freed.
In future (but not currently) these zeroed blocks will be "sparsified" - that is, given back to the host.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gboolean guestfs_session_zerofree (GuestfsSession *session,const gchar *device,GError **err);
zero unused inodes and disk blocks on ext2/3 filesystem
This runs the *zerofree* program on device. This program claims to zero
unused inodes and disk blocks on an ext2/3 filesystem, thus making it
possible to compress the filesystem more effectively.
You should not run this program if the filesystem is mounted.
It is possible that using this program can damage the filesystem or data on the filesystem.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
true on success, false on error |
gchar ** guestfs_session_zfgrep (GuestfsSession *session,const gchar *pattern,const gchar *path,GError **err);
return lines matching a pattern
This calls the external zfgrep program and returns the matching lines.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
gchar ** guestfs_session_zfgrepi (GuestfsSession *session,const gchar *pattern,const gchar *path,GError **err);
return lines matching a pattern
This calls the external "zfgrep -i" program and returns the matching lines.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
gchar * guestfs_session_zfile (GuestfsSession *session,const gchar *meth,const gchar *path,GError **err);
determine file type inside a compressed file
This command runs file after first decompressing path using method.
method must be one of gzip, compress or bzip2.
Since 1.0.63, use guestfs_session_file() instead which can now process
compressed files.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
the returned string, or NULL on error. [transfer full] |
gchar ** guestfs_session_zgrep (GuestfsSession *session,const gchar *regex,const gchar *path,GError **err);
return lines matching a pattern
This calls the external zgrep program and returns the matching lines.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
gchar ** guestfs_session_zgrepi (GuestfsSession *session,const gchar *regex,const gchar *path,GError **err);
return lines matching a pattern
This calls the external "zgrep -i" program and returns the matching lines.
|
A GuestfsSession object. [transfer none] |
|
. [transfer none][type utf8] |
|
. [transfer none][type filename] |
|
A GError object to receive any generated errors |
Returns : |
an array of returned strings, or NULL on error. [transfer full][array zero-terminated=1][element-type utf8] |
"appliance" signalvoid user_function (GuestfsSession *session,
GuestfsSessionEventParams *params,
gpointer user_data) : Run Last
See "SETTING CALLBACKS TO HANDLE EVENTS" in guestfs(3) for more details about this event.
|
The session which emitted the signal |
|
An object containing event parameters |
|
user data set when the signal handler was connected. |
"close" signalvoid user_function (GuestfsSession *session,
GuestfsSessionEventParams *params,
gpointer user_data) : Run Last
See "SETTING CALLBACKS TO HANDLE EVENTS" in guestfs(3) for more details about this event.
|
The session which emitted the signal |
|
An object containing event parameters |
|
user data set when the signal handler was connected. |
"enter" signalvoid user_function (GuestfsSession *session,
GuestfsSessionEventParams *params,
gpointer user_data) : Run Last
See "SETTING CALLBACKS TO HANDLE EVENTS" in guestfs(3) for more details about this event.
|
The session which emitted the signal |
|
An object containing event parameters |
|
user data set when the signal handler was connected. |
"launch-done" signalvoid user_function (GuestfsSession *guestfssession,
GuestfsSessionEventParams *arg1,
gpointer user_data) : Run Last
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"library" signalvoid user_function (GuestfsSession *session,
GuestfsSessionEventParams *params,
gpointer user_data) : Run Last
See "SETTING CALLBACKS TO HANDLE EVENTS" in guestfs(3) for more details about this event.
|
The session which emitted the signal |
|
An object containing event parameters |
|
user data set when the signal handler was connected. |
"progress" signalvoid user_function (GuestfsSession *session,
GuestfsSessionEventParams *params,
gpointer user_data) : Run Last
See "SETTING CALLBACKS TO HANDLE EVENTS" in guestfs(3) for more details about this event.
|
The session which emitted the signal |
|
An object containing event parameters |
|
user data set when the signal handler was connected. |
"subprocess-quit" signalvoid user_function (GuestfsSession *guestfssession,
GuestfsSessionEventParams *arg1,
gpointer user_data) : Run Last
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"trace" signalvoid user_function (GuestfsSession *session,
GuestfsSessionEventParams *params,
gpointer user_data) : Run Last
See "SETTING CALLBACKS TO HANDLE EVENTS" in guestfs(3) for more details about this event.
|
The session which emitted the signal |
|
An object containing event parameters |
|
user data set when the signal handler was connected. |