# coding: utf-8
# libguestfs generated file
# WARNING: THIS FILE IS GENERATED FROM THE FOLLOWING FILES:
#          generator/python.ml
#          and from the code in the generator/ subdirectory.
# ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.
#
# Copyright (C) 2009-2025 Red Hat Inc.
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

"""Python bindings for libguestfs

import guestfs
g = guestfs.GuestFS(python_return_dict=True)
g.add_drive_opts("guest.img", format="raw")
g.launch()
parts = g.list_partitions()

The guestfs module provides a Python binding to the libguestfs API
for examining and modifying virtual machine disk images.

Amongst the things this is good for: making batch configuration
changes to guests, getting disk used/free statistics (see also:
virt-df), migrating between virtualization systems (see also:
virt-p2v), performing partial backups, performing partial guest
clones, cloning guests and changing registry/UUID/hostname info, and
much else besides.

Libguestfs uses Linux kernel and qemu code, and can access any type of
guest filesystem that Linux and qemu can, including but not limited
to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
schemes, qcow, qcow2, vmdk.

Libguestfs provides ways to enumerate guest storage (eg. partitions,
LVs, what filesystem is in each LV, etc.).  It can also run commands
in the context of the guest.  Also you can access filesystems over
FUSE.

Errors which happen while using the API are turned into Python
RuntimeError exceptions.

To create a guestfs handle you usually have to perform the following
sequence of calls:

# Create the handle, call add_drive* at least once, and possibly
# several times if the guest has multiple block devices:
g = guestfs.GuestFS()
g.add_drive_opts("guest.img", format="raw")

# Launch the qemu subprocess and wait for it to become ready:
g.launch()

# Now you can issue commands, for example:
logvols = g.lvs()

"""

import os
import sys
import libguestfsmod
from typing import Union, List, Tuple, Optional

EVENT_CLOSE = 0x1
EVENT_SUBPROCESS_QUIT = 0x2
EVENT_LAUNCH_DONE = 0x4
EVENT_PROGRESS = 0x8
EVENT_APPLIANCE = 0x10
EVENT_LIBRARY = 0x20
EVENT_TRACE = 0x40
EVENT_ENTER = 0x80
EVENT_LIBVIRT_AUTH = 0x100
EVENT_WARNING = 0x200
EVENT_ALL = 0x3ff


def event_to_string(events):
    """Return a printable string from an event or event bitmask"""
    return libguestfsmod.event_to_string(events)


class ClosedHandle(ValueError):
    pass


class GuestFS(object):
    """Instances of this class are libguestfs API handles."""

    def __init__(self, python_return_dict=False,
                 environment=True, close_on_exit=True):
        """Create a new libguestfs handle.

        Note about "python_return_dict" flag:

        Setting this flag to 'True' causes all functions
        that internally return hashes to return a dict.  This is
        natural for Python, and all new code should use
        python_return_dict=True.

        If this flag is not present then hashes are returned
        as lists of pairs.  This was the only possible behaviour
        in libguestfs <= 1.20.
        """
        flags = 0
        if not environment:
            flags |= libguestfsmod.GUESTFS_CREATE_NO_ENVIRONMENT
        if not close_on_exit:
            flags |= libguestfsmod.GUESTFS_CREATE_NO_CLOSE_ON_EXIT
        self._o = libguestfsmod.create(flags)
        self._python_return_dict = python_return_dict

        # If we don't do this, the program name is always set to 'python'.
        program = os.path.basename(sys.argv[0])
        libguestfsmod.set_program(self._o, program)

    def __del__(self):
        if self._o:
            libguestfsmod.close(self._o)

    def _check_not_closed(self):
        if not self._o:
            raise ClosedHandle("GuestFS: method called on closed handle")

    def _maybe_convert_to_dict(self, r):
        if self._python_return_dict:
            r = dict(r)
        return r

    def close(self):
        """Explicitly close the guestfs handle.

        The handle is closed implicitly when its reference count goes
        to zero (eg. when it goes out of scope or the program ends).

        This call is only needed if you want to force the handle to
        close now.  After calling this, the program must not call
        any method on the handle (except the implicit call to
        __del__ which happens when the final reference is cleaned up).
        """
        self._check_not_closed()
        libguestfsmod.close(self._o)
        self._o = None

    def set_event_callback(self, cb, event_bitmask):
        """Register an event callback.

        Register "cb" as a callback function for all of the
        events in "event_bitmask".  "event_bitmask" should be
        one or more "guestfs.EVENT_*" flags logically or'd together.

        This function returns an event handle which can be used
        to delete the callback (see "delete_event_callback").

        The callback function receives 4 parameters:

        cb (event, event_handle, buf, array)

        "event" is one of the "EVENT_*" flags.  "buf" is a
        message buffer (only for some types of events).  "array"
        is an array of integers (only for some types of events).

        You should read the documentation for
        "guestfs_set_event_callback" in guestfs(3) before using
        this function.
        """
        self._check_not_closed()
        return libguestfsmod.set_event_callback(self._o, cb, event_bitmask)

    def delete_event_callback(self, event_handle):
        """Delete an event callback."""
        self._check_not_closed()
        libguestfsmod.delete_event_callback(self._o, event_handle)

    def acl_delete_def_file(self, dir: str) -> None:
        """This function deletes the default POSIX Access Control
        List (ACL) attached to directory "dir".

        This function depends on the feature "acl". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.acl_delete_def_file(self._o, dir)
        return r

    def acl_get_file(self, path: str, acltype: str) -> str:
        """This function returns the POSIX Access Control List
        (ACL) attached to "path". The ACL is returned in "long
        text form" (see acl(5)).

        The "acltype" parameter may be:

        "access"
        Return the ordinary (access) ACL for any file,
        directory or other filesystem object.

        "default"
        Return the default ACL. Normally this only makes
        sense if "path" is a directory.

        This function depends on the feature "acl". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.acl_get_file(self._o, path, acltype)
        return r

    def acl_set_file(self, path: str, acltype: str, acl: str) -> None:
        """This function sets the POSIX Access Control List (ACL)
        attached to "path".

        The "acltype" parameter may be:

        "access"
        Set the ordinary (access) ACL for any file,
        directory or other filesystem object.

        "default"
        Set the default ACL. Normally this only makes sense
        if "path" is a directory.

        The "acl" parameter is the new ACL in either "long text
        form" or "short text form" (see acl(5)). The new ACL
        completely replaces any previous ACL on the file. The
        ACL must contain the full Unix permissions (eg.
        "u::rwx,g::rx,o::rx").

        If you are specifying individual users or groups, then
        the mask field is also required (eg. "m::rwx"), followed
        by the "u:*ID*:..." and/or "g:*ID*:..." field(s). A full
        ACL string might therefore look like this:

        u::rwx,g::rwx,o::rwx,m::rwx,u:500:rwx,g:500:rwx
        \\ Unix permissions / \\mask/ \\      ACL        /

        You should use numeric UIDs and GIDs. To map usernames
        and groupnames to the correct numeric ID in the context
        of the guest, use the Augeas functions (see
        "g.aug_init").

        This function depends on the feature "acl". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.acl_set_file(self._o, path, acltype, acl)
        return r

    def add_cdrom(self, filename: str) -> None:
        """This function adds a virtual CD-ROM disk image to the
        guest.

        The image is added as read-only drive, so this function
        is equivalent of "g.add_drive_ro".

        *This function is deprecated.* In new code, use the
        "add_drive_ro" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.add_drive_ro() "
                      "instead of GuestFS.add_cdrom()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.add_cdrom(self._o, filename)
        return r

    def add_domain(self, dom: str, libvirturi: Optional[str] = None,
                   readonly: Optional[bool] = None,
                   iface: Optional[str] = None, live: Optional[bool] = None,
                   allowuuid: Optional[bool] = None,
                   readonlydisk: Optional[str] = None,
                   cachemode: Optional[str] = None,
                   discard: Optional[str] = None,
                   copyonread: Optional[bool] = None) -> int:
        """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 "g.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
        <https://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 <https://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 is ignored in libguestfs ≥
        1.48.

        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.

        If present, the value of "logical_block_size" attribute
        of <blockio/> tag in libvirt XML will be passed as
        "blocksize" parameter to "g.add_drive_opts".

        The other optional parameters are passed directly
        through to "g.add_drive_opts".
        """
        self._check_not_closed()
        r = libguestfsmod.add_domain(self._o, dom, libvirturi, readonly, iface,
                                     live, allowuuid, readonlydisk, cachemode,
                                     discard, copyonread)
        return r

    def add_drive(self, filename: str, readonly: Optional[bool] = None,
                  format: Optional[str] = None, iface: Optional[str] = None,
                  name: Optional[str] = None, label: Optional[str] = None,
                  protocol: Optional[str] = None,
                  server: Optional[List[str]] = None,
                  username: Optional[str] = None, secret: Optional[str] = None,
                  cachemode: Optional[str] = None,
                  discard: Optional[str] = None,
                  copyonread: Optional[bool] = None,
                  blocksize: Optional[int] = None) -> None:
        """This function adds a disk image called filename to the
        handle. filename may be a regular host file or a host
        device.

        When this function is called before "g.launch" (the
        usual case) then the first time you call this function,
        the disk appears in the API 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.

        filename may be the special string "/dev/null". See
        "NULL DISKS" in guestfs(3).

        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 "g.add_drive" or "g.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 "g.add_drive_with_if"
        call (q.v.)

        "name"
        This field used to be passed as a hint for guest
        inspection, but it is no longer used.

        "label"
        Give the disk a label. The label should be a unique,
        short string using *only* ASCII characters
        "[a-zA-Z]". As well as its usual name in the API
        (such as /dev/sda), the drive will also be named
        /dev/disk/guestfs/*label*.

        See "DISK LABELS" in guestfs(3).

        "protocol"
        The optional protocol argument can be used to select
        an alternate source protocol.

        See also: "REMOTE STORAGE" in guestfs(3).

        "protocol = "file""
        filename is interpreted as a local file or
        device. This is the default if the optional
        protocol parameter is omitted.

        "protocol = "ftp"|"ftps"|"http"|"https""
        Connect to a remote FTP or HTTP server. The
        "server" parameter must also be supplied - see
        below.

        See also: "FTP AND HTTP" in guestfs(3)

        "protocol = "iscsi""
        Connect to the iSCSI server. The "server"
        parameter must also be supplied - see below. The
        "username" parameter may be supplied. See below.
        The "secret" parameter may be supplied. See
        below.

        See also: "ISCSI" in guestfs(3).

        "protocol = "nbd""
        Connect to the Network Block Device server. The
        "server" parameter must also be supplied - see
        below.

        See also: "NETWORK BLOCK DEVICE" in guestfs(3).

        "protocol = "rbd""
        Connect to the Ceph (librbd/RBD) server. The
        "server" parameter must also be supplied - see
        below. The "username" parameter may be supplied.
        See below. The "secret" parameter may be
        supplied. See below.

        See also: "CEPH" in guestfs(3).

        "protocol = "ssh""
        Connect to the Secure Shell (ssh) server.

        The "server" parameter must be supplied. The
        "username" parameter may be supplied. See below.

        See also: "SSH" in guestfs(3).

        "server"
        For protocols which require access to a remote
        server, this is a list of server(s).

        Protocol       Number of servers required
        --------       --------------------------
        file           List must be empty or param not used at all
        ftp|ftps|http|https  Exactly one
        iscsi          Exactly one
        nbd            Exactly one
        rbd            Zero or more
        ssh            Exactly one

        Each list element is a string specifying a server.
        The string must be in one of the following formats:

        hostname
        hostname:port
        tcp:hostname
        tcp:hostname:port
        unix:/path/to/socket

        If the port number is omitted, then the standard
        port number for the protocol is used (see
        /etc/services).

        "username"
        For the "ftp", "ftps", "http", "https", "iscsi",
        "rbd" and "ssh" protocols, this specifies the remote
        username.

        If not given, then the local username is used for
        "ssh", and no authentication is attempted for ceph.
        But note this sometimes may give unexpected results,
        for example if using the libvirt backend and if the
        libvirt backend is configured to start the qemu
        appliance as a special user such as "qemu.qemu". If
        in doubt, specify the remote username you want.

        "secret"
        For the "rbd" protocol only, this specifies the
        ‘secret’ to use when connecting to the remote
        device. It must be base64 encoded.

        If not given, then a secret matching the given
        username will be looked up in the default keychain
        locations, or if no username is given, then no
        authentication will be used.

        "cachemode"
        Choose whether or not libguestfs will obey sync
        operations (safe but slow) or not (unsafe but fast).
        The possible values for this string are:

        "cachemode = "writeback""
        This is the default.

        Write operations in the API do not return until
        a write(2) call has completed in the host [but
        note this does not imply that anything gets
        written to disk].

        Sync operations in the API, including implicit
        syncs caused by filesystem journalling, will not
        return until an fdatasync(2) call has completed
        in the host, indicating that data has been
        committed to disk.

        "cachemode = "unsafe""
        In this mode, there are no guarantees.
        Libguestfs may cache anything and ignore sync
        requests. This is suitable only for scratch or
        temporary disks.

        "discard"
        Enable or disable discard (a.k.a. trim or unmap)
        support on this drive. If enabled, operations such
        as "g.fstrim" will be able to discard / make thin /
        punch holes in the underlying host file or device.

        Possible discard settings are:

        "discard = "disable""
        Disable discard support. This is the default.

        "discard = "enable""
        Enable discard support. Fail if discard is not
        possible.

        "discard = "besteffort""
        Enable discard support if possible, but don't
        fail if it is not supported.

        Since not all backends and not all underlying
        systems support discard, this is a good choice
        if you want to use discard if possible, but
        don't mind if it doesn't work.

        "copyonread"
        The boolean parameter "copyonread" enables
        copy-on-read support. This only affects disk formats
        which have backing files, and causes reads to be
        stored in the overlay layer, speeding up multiple
        reads of the same area of disk.

        The default is false.

        "blocksize"
        This parameter sets the sector size of the disk.
        Possible values are 512 (the default if the
        parameter is omitted) or 4096. Use 4096 when
        handling an "Advanced Format" disk that uses 4K
        sector size
        (<https://en.wikipedia.org/wiki/Advanced_Format>).

        Only a subset of the backends support this parameter
        (currently only the libvirt and direct backends do).
        """
        self._check_not_closed()
        r = libguestfsmod.add_drive(self._o, filename, readonly, format, iface,
                                    name, label, protocol, server, username,
                                    secret, cachemode, discard, copyonread,
                                    blocksize)
        return r

    add_drive_opts = add_drive

    def add_drive_ro(self, filename: str) -> None:
        """This function is the equivalent of calling
        "g.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.
        """
        self._check_not_closed()
        r = libguestfsmod.add_drive_ro(self._o, filename)
        return r

    def add_drive_ro_with_if(self, filename: str, iface: str) -> None:
        """This is the same as "g.add_drive_ro" but it allows you
        to specify the QEMU interface emulation to use at run
        time. Both the direct and the libvirt backends ignore
        "iface".

        *This function is deprecated.* In new code, use the
        "add_drive" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.add_drive() "
                      "instead of GuestFS.add_drive_ro_with_if()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.add_drive_ro_with_if(self._o, filename, iface)
        return r

    def add_drive_scratch(self, size: int, name: Optional[str] = None,
                          label: Optional[str] = None,
                          blocksize: Optional[int] = None) -> None:
        """This command adds a temporary scratch drive to the
        handle. The "size" parameter is the virtual size (in
        bytes). The scratch drive is blank initially (all reads
        return zeroes until you start writing to it). The drive
        is deleted when the handle is closed.

        The optional arguments "name", "label" and "blocksize"
        are passed through to "g.add_drive_opts".
        """
        self._check_not_closed()
        r = libguestfsmod.add_drive_scratch(self._o, size, name, label,
                                            blocksize)
        return r

    def add_drive_with_if(self, filename: str, iface: str) -> None:
        """This is the same as "g.add_drive" but it allows you to
        specify the QEMU interface emulation to use at run time.
        Both the direct and the libvirt backends ignore "iface".

        *This function is deprecated.* In new code, use the
        "add_drive" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.add_drive() "
                      "instead of GuestFS.add_drive_with_if()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.add_drive_with_if(self._o, filename, iface)
        return r

    def add_libvirt_dom(self, dom, readonly: Optional[bool] = None,
                        iface: Optional[str] = None,
                        live: Optional[bool] = None,
                        readonlydisk: Optional[str] = None,
                        cachemode: Optional[str] = None,
                        discard: Optional[str] = None,
                        copyonread: Optional[bool] = None) -> int:
        """This function adds the disk(s) attached to the libvirt
        domain "dom". It works by requesting the domain XML from
        libvirt, parsing it for disks, and calling
        "g.add_drive_opts" on each one.

        In the C API we declare "void *dom", but really it has
        type "virDomainPtr dom". This is so we don't need
        <libvirt.h>.

        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
        <https://libvirt.org/remote.html>) will fail unless
        those disks are accessible via the same device path
        locally too.

        The optional "live" flag is ignored in libguestfs ≥
        1.48.

        The optional "readonlydisk" parameter controls what we
        do for disks which are marked <readonly/> in the libvirt
        XML. See "g.add_domain" for possible values.

        If present, the value of "logical_block_size" attribute
        of <blockio/> tag in libvirt XML will be passed as
        "blocksize" parameter to "g.add_drive_opts".

        The other optional parameters are passed directly
        through to "g.add_drive_opts".
        """
        dom = dom.c_pointer()
        self._check_not_closed()
        r = libguestfsmod.add_libvirt_dom(self._o, dom, readonly, iface, live,
                                          readonlydisk, cachemode, discard,
                                          copyonread)
        return r

    def aug_clear(self, augpath: str) -> None:
        """Set the value associated with "path" to "NULL". This is
        the same as the augtool(1) "clear" command.
        """
        self._check_not_closed()
        r = libguestfsmod.aug_clear(self._o, augpath)
        return r

    def aug_close(self) -> None:
        """Close the current Augeas handle and free up any
        resources used by it. After calling this, you have to
        call "g.aug_init" again before you can use any other
        Augeas functions.
        """
        self._check_not_closed()
        r = libguestfsmod.aug_close(self._o)
        return r

    def aug_defnode(self, name: str, expr: str, val: str) -> dict:
        """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 "g.aug_set" "expr",
        "val". "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.

        This function returns a dictionary, with keys matching
        the various fields in the guestfs_int_bool structure.
        """
        self._check_not_closed()
        r = libguestfsmod.aug_defnode(self._o, name, expr, val)
        return r

    def aug_defvar(self, name: str, expr: Optional[str]) -> int:
        """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.
        """
        self._check_not_closed()
        r = libguestfsmod.aug_defvar(self._o, name, expr)
        return r

    def aug_get(self, augpath: str) -> str:
        """Look up the value associated with "path". If "path"
        matches exactly one node, the "value" is returned.
        """
        self._check_not_closed()
        r = libguestfsmod.aug_get(self._o, augpath)
        return r

    def aug_init(self, root: str, flags: int) -> None:
        """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 "g.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 "g.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 "g.aug_init".

        To close the handle, you can call "g.aug_close".

        To find out more about Augeas, see <http://augeas.net/>.
        """
        self._check_not_closed()
        r = libguestfsmod.aug_init(self._o, root, flags)
        return r

    def aug_insert(self, augpath: str, label: str, before: bool) -> None:
        """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]".
        """
        self._check_not_closed()
        r = libguestfsmod.aug_insert(self._o, augpath, label, before)
        return r

    def aug_label(self, augpath: str) -> str:
        """The label (name of the last element) of the Augeas path
        expression "augpath" is returned. "augpath" must match
        exactly one node, else this function returns an error.
        """
        self._check_not_closed()
        r = libguestfsmod.aug_label(self._o, augpath)
        return r

    def aug_load(self) -> None:
        """Load files into the tree.

        See "aug_load" in the Augeas documentation for the full
        gory details.
        """
        self._check_not_closed()
        r = libguestfsmod.aug_load(self._o)
        return r

    def aug_ls(self, augpath: str) -> List[str]:
        """This is just a shortcut for listing "g.aug_match"
        "path/*" and sorting the resulting nodes into
        alphabetical order.

        This function returns a list of strings.
        """
        self._check_not_closed()
        r = libguestfsmod.aug_ls(self._o, augpath)
        return r

    def aug_match(self, augpath: str) -> List[str]:
        """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.

        This function returns a list of strings.
        """
        self._check_not_closed()
        r = libguestfsmod.aug_match(self._o, augpath)
        return r

    def aug_mv(self, src: str, dest: str) -> None:
        """Move the node "src" to "dest". "src" must match exactly
        one node. "dest" is overwritten if it exists.
        """
        self._check_not_closed()
        r = libguestfsmod.aug_mv(self._o, src, dest)
        return r

    def aug_rm(self, augpath: str) -> int:
        """Remove "path" and all of its children.

        On success this returns the number of entries which were
        removed.
        """
        self._check_not_closed()
        r = libguestfsmod.aug_rm(self._o, augpath)
        return r

    def aug_save(self) -> None:
        """This writes all pending changes to disk.

        The flags which were passed to "g.aug_init" affect
        exactly how files are saved.
        """
        self._check_not_closed()
        r = libguestfsmod.aug_save(self._o)
        return r

    def aug_set(self, augpath: str, val: str) -> None:
        """Set the value associated with "augpath" 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 "g.aug_clear" call.
        """
        self._check_not_closed()
        r = libguestfsmod.aug_set(self._o, augpath, val)
        return r

    def aug_setm(self, base: str, sub: Optional[str], val: str) -> int:
        """Change multiple Augeas nodes in a single operation.
        "base" is an expression matching multiple nodes. "sub"
        is a path expression relative to "base". All nodes
        matching "base" are found, and then for each node, "sub"
        is changed to "val". "sub" may also be "NULL" in which
        case the "base" nodes are modified.

        This returns the number of nodes modified.
        """
        self._check_not_closed()
        r = libguestfsmod.aug_setm(self._o, base, sub, val)
        return r

    def aug_transform(self, lens: str, file: str,
                      remove: Optional[bool] = None) -> None:
        """Add an Augeas transformation for the specified "lens" so
        it can handle "file".

        If "remove" is true ("false" by default), then the
        transformation is removed.
        """
        self._check_not_closed()
        r = libguestfsmod.aug_transform(self._o, lens, file, remove)
        return r

    def available(self, groups: List[str]) -> None:
        """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 "g.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:*

        *   "g.feature_available" is the same as this call, but
        with a slightly simpler to use API: that call
        returns a boolean true/false instead of throwing an
        error.

        *   You must call "g.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 "g.version".

        See also "g.filesystem_available".
        """
        groups = list(groups)
        self._check_not_closed()
        r = libguestfsmod.available(self._o, groups)
        return r

    def available_all_groups(self) -> List[str]:
        """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
        "g.available" / "g.feature_available" on each member of
        the returned list.

        See also "g.available", "g.feature_available" and
        "AVAILABILITY" in guestfs(3).

        This function returns a list of strings.
        """
        self._check_not_closed()
        r = libguestfsmod.available_all_groups(self._o)
        return r

    def base64_in(self, base64file: str, filename: str) -> None:
        """This command uploads base64-encoded data from
        "base64file" to filename.
        """
        self._check_not_closed()
        r = libguestfsmod.base64_in(self._o, base64file, filename)
        return r

    def base64_out(self, filename: str, base64file: str) -> None:
        """This command downloads the contents of filename, writing
        it out to local file "base64file" encoded as base64.
        """
        self._check_not_closed()
        r = libguestfsmod.base64_out(self._o, filename, base64file)
        return r

    def blkdiscard(self, device: str) -> None:
        """This discards all blocks on the block device "device",
        giving the free space back to the host.

        This operation requires support in libguestfs, the host
        filesystem, qemu and the host kernel. If this support
        isn't present it may give an error or even appear to run
        but do nothing. You must also set the "discard"
        attribute on the underlying drive (see
        "g.add_drive_opts").

        This function depends on the feature "blkdiscard". See
        also "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.blkdiscard(self._o, device)
        return r

    def blkdiscardzeroes(self, device: str) -> bool:
        """This call returns true if blocks on "device" that have
        been discarded by a call to "g.blkdiscard" are returned
        as blocks of zero bytes when read the next time.

        If it returns false, then it may be that discarded
        blocks are read as stale or random data.

        This function depends on the feature "blkdiscardzeroes".
        See also "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.blkdiscardzeroes(self._o, device)
        return r

    def blkid(self, device: str) -> Union[List[Tuple[str, str]], dict]:
        """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".

        This function returns a hash. If the GuestFS constructor
        was called with python_return_dict=True (recommended)
        then the return value is in fact a Python dict.
        Otherwise the return value is a list of pairs of
        strings, for compatibility with old code.
        """
        self._check_not_closed()
        r = libguestfsmod.blkid(self._o, device)
        r = self._maybe_convert_to_dict(r)
        return r

    def blockdev_flushbufs(self, device: str) -> None:
        """This tells the kernel to flush internal buffers
        associated with "device".

        This uses the blockdev(8) command.
        """
        self._check_not_closed()
        r = libguestfsmod.blockdev_flushbufs(self._o, device)
        return r

    def blockdev_getbsz(self, device: str) -> int:
        """This returns the block size of a device.

        Note: this is different from both *size in blocks* and
        *filesystem block size*. Also this setting is not really
        used by anything. You should probably not use it for
        anything. Filesystems have their own idea about what
        block size to choose.

        This uses the blockdev(8) command.
        """
        self._check_not_closed()
        r = libguestfsmod.blockdev_getbsz(self._o, device)
        return r

    def blockdev_getro(self, device: str) -> bool:
        """Returns a boolean indicating if the block device is
        read-only (true if read-only, false if not).

        This uses the blockdev(8) command.
        """
        self._check_not_closed()
        r = libguestfsmod.blockdev_getro(self._o, device)
        return r

    def blockdev_getsize64(self, device: str) -> int:
        """This returns the size of the device in bytes.

        See also "g.blockdev_getsz".

        This uses the blockdev(8) command.
        """
        self._check_not_closed()
        r = libguestfsmod.blockdev_getsize64(self._o, device)
        return r

    def blockdev_getss(self, device: str) -> int:
        """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
        "g.blockdev_getsz" for that).

        This uses the blockdev(8) command.
        """
        self._check_not_closed()
        r = libguestfsmod.blockdev_getss(self._o, device)
        return r

    def blockdev_getsz(self, device: str) -> int:
        """This returns the size of the device in units of 512-byte
        sectors (even if the sectorsize isn't 512 bytes ...
        weird).

        See also "g.blockdev_getss" for the real sector size of
        the device, and "g.blockdev_getsize64" for the more
        useful *size in bytes*.

        This uses the blockdev(8) command.
        """
        self._check_not_closed()
        r = libguestfsmod.blockdev_getsz(self._o, device)
        return r

    def blockdev_rereadpt(self, device: str) -> None:
        """Reread the partition table on "device".

        This uses the blockdev(8) command.
        """
        self._check_not_closed()
        r = libguestfsmod.blockdev_rereadpt(self._o, device)
        return r

    def blockdev_setbsz(self, device: str, blocksize: int) -> None:
        """This call does nothing and has never done anything
        because of a bug in blockdev. Do not use it.

        If you need to set the filesystem block size, use the
        "blocksize" option of "g.mkfs".

        *This function is deprecated.* There is no replacement.
        Consult the API documentation in guestfs(3) for further
        information.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("do not use GuestFS.blockdev_setbsz()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.blockdev_setbsz(self._o, device, blocksize)
        return r

    def blockdev_setra(self, device: str, sectors: int) -> None:
        """Set readahead (in 512-byte sectors) for the device.

        This uses the blockdev(8) command.
        """
        self._check_not_closed()
        r = libguestfsmod.blockdev_setra(self._o, device, sectors)
        return r

    def blockdev_setro(self, device: str) -> None:
        """Sets the block device named "device" to read-only.

        This uses the blockdev(8) command.
        """
        self._check_not_closed()
        r = libguestfsmod.blockdev_setro(self._o, device)
        return r

    def blockdev_setrw(self, device: str) -> None:
        """Sets the block device named "device" to read-write.

        This uses the blockdev(8) command.
        """
        self._check_not_closed()
        r = libguestfsmod.blockdev_setrw(self._o, device)
        return r

    def btrfs_balance_cancel(self, path: str) -> None:
        """Cancel a running balance on a btrfs filesystem.

        This function depends on the feature "btrfs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.btrfs_balance_cancel(self._o, path)
        return r

    def btrfs_balance_pause(self, path: str) -> None:
        """Pause a running balance on a btrfs filesystem.

        This function depends on the feature "btrfs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.btrfs_balance_pause(self._o, path)
        return r

    def btrfs_balance_resume(self, path: str) -> None:
        """Resume a paused balance on a btrfs filesystem.

        This function depends on the feature "btrfs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.btrfs_balance_resume(self._o, path)
        return r

    def btrfs_balance_status(self, path: str) -> dict:
        """Show the status of a running or paused balance on a
        btrfs filesystem.

        This function returns a dictionary, with keys matching
        the various fields in the guestfs_btrfsbalance
        structure.

        This function depends on the feature "btrfs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.btrfs_balance_status(self._o, path)
        return r

    def btrfs_device_add(self, devices: List[str], fs: str) -> None:
        """Add the list of device(s) in "devices" to the btrfs
        filesystem mounted at "fs". If "devices" is an empty
        list, this does nothing.

        This function depends on the feature "btrfs". See also
        "g.feature-available".
        """
        devices = list(devices)
        self._check_not_closed()
        r = libguestfsmod.btrfs_device_add(self._o, devices, fs)
        return r

    def btrfs_device_delete(self, devices: List[str], fs: str) -> None:
        """Remove the "devices" from the btrfs filesystem mounted
        at "fs". If "devices" is an empty list, this does
        nothing.

        This function depends on the feature "btrfs". See also
        "g.feature-available".
        """
        devices = list(devices)
        self._check_not_closed()
        r = libguestfsmod.btrfs_device_delete(self._o, devices, fs)
        return r

    def btrfs_filesystem_balance(self, fs: str) -> None:
        """Balance the chunks in the btrfs filesystem mounted at
        "fs" across the underlying devices.

        This function depends on the feature "btrfs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.btrfs_filesystem_balance(self._o, fs)
        return r

    def btrfs_filesystem_defragment(self, path: str,
                                    flush: Optional[bool] = None,
                                    compress: Optional[str] = None) -> None:
        """Defragment a file or directory on a btrfs filesystem.
        compress is one of zlib or lzo.

        This function depends on the feature "btrfs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.btrfs_filesystem_defragment(self._o, path, flush,
                                                      compress)
        return r

    def btrfs_filesystem_resize(self, mountpoint: str,
                                size: Optional[int] = None) -> None:
        """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).

        This function depends on the feature "btrfs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.btrfs_filesystem_resize(self._o, mountpoint, size)
        return r

    def btrfs_filesystem_show(self, device: str) -> List[str]:
        """Show all the devices where the filesystems in "device"
        is spanned over.

        If not all the devices for the filesystems are present,
        then this function fails and the "errno" is set to
        "ENODEV".

        This function returns a list of strings.

        This function depends on the feature "btrfs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.btrfs_filesystem_show(self._o, device)
        return r

    def btrfs_filesystem_sync(self, fs: str) -> None:
        """Force sync on the btrfs filesystem mounted at "fs".

        This function depends on the feature "btrfs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.btrfs_filesystem_sync(self._o, fs)
        return r

    def btrfs_fsck(self, device: str, superblock: Optional[int] = None,
                   repair: Optional[bool] = None) -> None:
        """Used to check a btrfs filesystem, "device" is the device
        file where the filesystem is stored.

        This function depends on the feature "btrfs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.btrfs_fsck(self._o, device, superblock, repair)
        return r

    def btrfs_image(self, source: List[str], image: str,
                    compresslevel: Optional[int] = None) -> None:
        """This is used to create an image of a btrfs filesystem.
        All data will be zeroed, but metadata and the like is
        preserved.

        This function depends on the feature "btrfs". See also
        "g.feature-available".
        """
        source = list(source)
        self._check_not_closed()
        r = libguestfsmod.btrfs_image(self._o, source, image, compresslevel)
        return r

    def btrfs_qgroup_assign(self, src: str, dst: str, path: str) -> None:
        """Add qgroup "src" to parent qgroup "dst". This command
        can group several qgroups into a parent qgroup to share
        common limit.

        This function depends on the feature "btrfs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.btrfs_qgroup_assign(self._o, src, dst, path)
        return r

    def btrfs_qgroup_create(self, qgroupid: str, subvolume: str) -> None:
        """Create a quota group (qgroup) for subvolume at
        "subvolume".

        This function depends on the feature "btrfs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.btrfs_qgroup_create(self._o, qgroupid, subvolume)
        return r

    def btrfs_qgroup_destroy(self, qgroupid: str, subvolume: str) -> None:
        """Destroy a quota group.

        This function depends on the feature "btrfs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.btrfs_qgroup_destroy(self._o, qgroupid, subvolume)
        return r

    def btrfs_qgroup_limit(self, subvolume: str, size: int) -> None:
        """Limit the size of the subvolume with path "subvolume".

        This function depends on the feature "btrfs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.btrfs_qgroup_limit(self._o, subvolume, size)
        return r

    def btrfs_qgroup_remove(self, src: str, dst: str, path: str) -> None:
        """Remove qgroup "src" from the parent qgroup "dst".

        This function depends on the feature "btrfs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.btrfs_qgroup_remove(self._o, src, dst, path)
        return r

    def btrfs_qgroup_show(self, path: str) -> List[dict]:
        """Show all subvolume quota groups in a btrfs filesystem,
        including their usages.

        This function returns a list of btrfsqgroups. Each
        btrfsqgroup is represented as a dictionary.

        This function depends on the feature "btrfs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.btrfs_qgroup_show(self._o, path)
        return r

    def btrfs_quota_enable(self, fs: str, enable: bool) -> None:
        """Enable or disable subvolume quota support for filesystem
        which contains "path".

        This function depends on the feature "btrfs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.btrfs_quota_enable(self._o, fs, enable)
        return r

    def btrfs_quota_rescan(self, fs: str) -> None:
        """Trash all qgroup numbers and scan the metadata again
        with the current config.

        This function depends on the feature "btrfs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.btrfs_quota_rescan(self._o, fs)
        return r

    def btrfs_replace(self, srcdev: str, targetdev: str,
                      mntpoint: str) -> None:
        """Replace device of a btrfs filesystem. On a live
        filesystem, duplicate the data to the target device
        which is currently stored on the source device. After
        completion of the operation, the source device is wiped
        out and removed from the filesystem.

        The "targetdev" needs to be same size or larger than the
        "srcdev". Devices which are currently mounted are never
        allowed to be used as the "targetdev".

        This function depends on the feature "btrfs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.btrfs_replace(self._o, srcdev, targetdev, mntpoint)
        return r

    def btrfs_rescue_chunk_recover(self, device: str) -> None:
        """Recover the chunk tree of btrfs filesystem by scanning
        the devices one by one.

        This function depends on the feature "btrfs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.btrfs_rescue_chunk_recover(self._o, device)
        return r

    def btrfs_rescue_super_recover(self, device: str) -> None:
        """Recover bad superblocks from good copies.

        This function depends on the feature "btrfs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.btrfs_rescue_super_recover(self._o, device)
        return r

    def btrfs_scrub_cancel(self, path: str) -> None:
        """Cancel a running scrub on a btrfs filesystem.

        This function depends on the feature "btrfs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.btrfs_scrub_cancel(self._o, path)
        return r

    def btrfs_scrub_resume(self, path: str) -> None:
        """Resume a previously canceled or interrupted scrub on a
        btrfs filesystem.

        This function depends on the feature "btrfs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.btrfs_scrub_resume(self._o, path)
        return r

    def btrfs_scrub_start(self, path: str) -> None:
        """Reads all the data and metadata on the filesystem, and
        uses checksums and the duplicate copies from RAID
        storage to identify and repair any corrupt data.

        This function depends on the feature "btrfs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.btrfs_scrub_start(self._o, path)
        return r

    def btrfs_scrub_status(self, path: str) -> dict:
        """Show status of running or finished scrub on a btrfs
        filesystem.

        This function returns a dictionary, with keys matching
        the various fields in the guestfs_btrfsscrub structure.

        This function depends on the feature "btrfs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.btrfs_scrub_status(self._o, path)
        return r

    def btrfs_set_seeding(self, device: str, seeding: bool) -> None:
        """Enable or disable the seeding feature of a device that
        contains a btrfs filesystem.

        This function depends on the feature "btrfs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.btrfs_set_seeding(self._o, device, seeding)
        return r

    def btrfs_subvolume_create(self, dest: str,
                               qgroupid: Optional[str] = None) -> None:
        """Create a btrfs subvolume. The "dest" argument is the
        destination directory and the name of the subvolume, in
        the form /path/to/dest/name. The optional parameter
        "qgroupid" represents the qgroup which the newly created
        subvolume will be added to.

        This function depends on the feature "btrfs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.btrfs_subvolume_create(self._o, dest, qgroupid)
        return r

    btrfs_subvolume_create_opts = btrfs_subvolume_create

    def btrfs_subvolume_delete(self, subvolume: str) -> None:
        """Delete the named btrfs subvolume or snapshot.

        This function depends on the feature "btrfs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.btrfs_subvolume_delete(self._o, subvolume)
        return r

    def btrfs_subvolume_get_default(self, fs: str) -> int:
        """Get the default subvolume or snapshot of a filesystem
        mounted at "mountpoint".

        This function depends on the feature "btrfs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.btrfs_subvolume_get_default(self._o, fs)
        return r

    def btrfs_subvolume_list(self, fs: str) -> List[dict]:
        """List the btrfs snapshots and subvolumes of the btrfs
        filesystem which is mounted at "fs".

        This function returns a list of btrfssubvolumes. Each
        btrfssubvolume is represented as a dictionary.

        This function depends on the feature "btrfs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.btrfs_subvolume_list(self._o, fs)
        return r

    def btrfs_subvolume_set_default(self, id: int, fs: str) -> None:
        """Set the subvolume of the btrfs filesystem "fs" which
        will be mounted by default. See "g.btrfs_subvolume_list"
        to get a list of subvolumes.

        This function depends on the feature "btrfs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.btrfs_subvolume_set_default(self._o, id, fs)
        return r

    def btrfs_subvolume_show(self, subvolume: str) -> Union[List[Tuple[str,
                             str]], dict]:
        """Return detailed information of the subvolume.

        This function returns a hash. If the GuestFS constructor
        was called with python_return_dict=True (recommended)
        then the return value is in fact a Python dict.
        Otherwise the return value is a list of pairs of
        strings, for compatibility with old code.

        This function depends on the feature "btrfs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.btrfs_subvolume_show(self._o, subvolume)
        r = self._maybe_convert_to_dict(r)
        return r

    def btrfs_subvolume_snapshot(self, source: str, dest: str,
                                 ro: Optional[bool] = None,
                                 qgroupid: Optional[str] = None) -> None:
        """Create a 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. By
        default the newly created snapshot is writable, if the
        value of optional parameter "ro" is true, then a
        readonly snapshot is created. The optional parameter
        "qgroupid" represents the qgroup which the newly created
        snapshot will be added to.

        This function depends on the feature "btrfs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.btrfs_subvolume_snapshot(self._o, source, dest, ro,
                                                   qgroupid)
        return r

    btrfs_subvolume_snapshot_opts = btrfs_subvolume_snapshot

    def btrfstune_enable_extended_inode_refs(self, device: str) -> None:
        """This will Enable extended inode refs.

        This function depends on the feature "btrfs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.btrfstune_enable_extended_inode_refs(self._o, device)
        return r

    def btrfstune_enable_skinny_metadata_extent_refs(self,
                                                     device: str) -> None:
        """This enable skinny metadata extent refs.

        This function depends on the feature "btrfs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.btrfstune_enable_skinny_metadata_extent_refs(self._o,
                                                                       device)
        return r

    def btrfstune_seeding(self, device: str, seeding: bool) -> None:
        """Enable seeding of a btrfs device, this will force a fs
        readonly so that you can use it to build other
        filesystems.

        This function depends on the feature "btrfs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.btrfstune_seeding(self._o, device, seeding)
        return r

    def c_pointer(self) -> int:
        """In non-C language bindings, this allows you to retrieve
        the underlying C pointer to the handle (ie. "g.h *").
        The purpose of this is to allow other libraries to
        interwork with libguestfs.
        """
        self._check_not_closed()
        r = libguestfsmod.c_pointer(self._o)
        return r

    def canonical_device_name(self, device: str) -> str:
        """This utility function is useful when displaying device
        names to the user. It takes a number of irregular device
        names and returns them in a consistent format:

        /dev/hdX
        /dev/vdX
        These are returned as /dev/sdX. Note this works for
        device names and partition names. This is
        approximately the reverse of the algorithm described
        in "BLOCK DEVICE NAMING" in guestfs(3).

        /dev/mapper/VG-LV
        /dev/dm-N
        Converted to /dev/VG/LV form using
        "g.lvm_canonical_lv_name".

        Other strings are returned unmodified.
        """
        self._check_not_closed()
        r = libguestfsmod.canonical_device_name(self._o, device)
        return r

    def cap_get_file(self, path: str) -> str:
        """This function returns the Linux capabilities attached to
        "path". The capabilities set is returned in text form
        (see cap_to_text(3)).

        If no capabilities are attached to a file, an empty
        string is returned.

        This function depends on the feature "linuxcaps". See
        also "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.cap_get_file(self._o, path)
        return r

    def cap_set_file(self, path: str, cap: str) -> None:
        """This function sets the Linux capabilities attached to
        "path". The capabilities set "cap" should be passed in
        text form (see cap_from_text(3)).

        This function depends on the feature "linuxcaps". See
        also "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.cap_set_file(self._o, path, cap)
        return r

    def case_sensitive_path(self, path: str) -> str:
        """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:
        <https://www.tuxera.com/community/ntfs-3g-faq/#posixfile
        names1>

        "g.case_sensitive_path" attempts to resolve the true
        case of each element in the path. It will return a
        resolved path if either the full path or its parent
        directory exists. If the parent directory exists but the
        full path does not, the case of the parent directory
        will be correctly resolved, and the remainder appended
        unmodified. For example, if the file
        "/Windows/System32/netkvm.sys" exists:

        "g.case_sensitive_path" ("/windows/system32/netkvm.sys")
        "Windows/System32/netkvm.sys"

        "g.case_sensitive_path" ("/windows/system32/NoSuchFile")
        "Windows/System32/NoSuchFile"

        "g.case_sensitive_path" ("/windows/system33/netkvm.sys")
        *ERROR*

        *Note*: Because of the above behaviour,
        "g.case_sensitive_path" cannot be used to check for the
        existence of a file.

        *Note*: This function does not handle drive names,
        backslashes etc.

        See also "g.realpath".
        """
        self._check_not_closed()
        r = libguestfsmod.case_sensitive_path(self._o, path)
        return r

    def cat(self, path: str) -> str:
        """Return the contents of the file named "path".

        Because, in C, this function returns a "char *", there
        is no way to differentiate between a "\\0" character in a
        file and end of string. To handle binary files, use the
        "g.read_file" or "g.download" functions.
        """
        self._check_not_closed()
        r = libguestfsmod.cat(self._o, path)
        return r

    def checksum(self, csumtype: str, path: str) -> str:
        """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.

        "gost"
        "gost12"
        Compute the checksum using GOST R34.11-94 or GOST
        R34.11-2012 message digest.

        "md5"
        Compute the MD5 hash (using the md5sum(1) program).

        "sha1"
        Compute the SHA1 hash (using the sha1sum(1)
        program).

        "sha224"
        Compute the SHA224 hash (using the sha224sum(1)
        program).

        "sha256"
        Compute the SHA256 hash (using the sha256sum(1)
        program).

        "sha384"
        Compute the SHA384 hash (using the sha384sum(1)
        program).

        "sha512"
        Compute the SHA512 hash (using the sha512sum(1)
        program).

        The checksum is returned as a printable string.

        To get the checksum for a device, use
        "g.checksum_device".

        To get the checksums for many files, use
        "g.checksums_out".
        """
        self._check_not_closed()
        r = libguestfsmod.checksum(self._o, csumtype, path)
        return r

    def checksum_device(self, csumtype: str, device: str) -> str:
        """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 "g.checksum" command.
        """
        self._check_not_closed()
        r = libguestfsmod.checksum_device(self._o, csumtype, device)
        return r

    def checksums_out(self, csumtype: str, directory: str,
                      sumsfile: str) -> None:
        """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.
        """
        self._check_not_closed()
        r = libguestfsmod.checksums_out(self._o, csumtype, directory, sumsfile)
        return r

    def chmod(self, mode: int, path: str) -> None:
        """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.
        """
        self._check_not_closed()
        r = libguestfsmod.chmod(self._o, mode, path)
        return r

    def chown(self, owner: int, group: int, path: str) -> None:
        """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).
        """
        self._check_not_closed()
        r = libguestfsmod.chown(self._o, owner, group, path)
        return r

    def clear_backend_setting(self, name: str) -> int:
        """If there is a backend setting string matching "name" or
        beginning with "name=", then that string is removed from
        the backend settings.

        This call returns the number of strings which were
        removed (which may be 0, 1 or greater than 1).

        See "BACKEND" in guestfs(3), "BACKEND SETTINGS" in
        guestfs(3).
        """
        self._check_not_closed()
        r = libguestfsmod.clear_backend_setting(self._o, name)
        return r

    def clevis_luks_unlock(self, device: str, mapname: str) -> None:
        """This command opens a block device that has been
        encrypted according to the Linux Unified Key Setup
        (LUKS) standard, using network-bound disk encryption
        (NBDE).

        "device" is the encrypted block device.

        The appliance will connect to the Tang servers noted in
        the tree of Clevis pins that is bound to a keyslot of
        the LUKS header. The Clevis pin tree may comprise "sss"
        (redudancy) pins as internal nodes (optionally), and
        "tang" pins as leaves. "tpm2" pins are not supported.
        The appliance unlocks the encrypted block device by
        combining responses from the Tang servers with metadata
        from the LUKS header; there is no "key" parameter.

        This command will fail if networking has not been
        enabled for the appliance. Refer to "g.set_network".

        The command 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. Close the decrypted
        block device with "g.cryptsetup_close".

        "mapname" cannot be "control" because that name is
        reserved by device-mapper.

        If this block device contains LVM volume groups, then
        calling "g.lvm_scan" with the "activate" parameter
        "true" will make them visible.

        Use "g.list_dm_devices" to list all device mapper
        devices.

        This function depends on the feature "clevisluks". See
        also "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.clevis_luks_unlock(self._o, device, mapname)
        return r

    def command(self, arguments: List[str]) -> str:
        """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 "g.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.

        Because of the message protocol, there is a transfer
        limit of somewhere between 2MB and 4MB. See "PROTOCOL
        LIMITS" in guestfs(3).
        """
        arguments = list(arguments)
        self._check_not_closed()
        r = libguestfsmod.command(self._o, arguments)
        return r

    def command_lines(self, arguments: List[str]) -> List[str]:
        """This is the same as "g.command", but splits the result
        into a list of lines.

        See also: "g.sh_lines"

        This function returns a list of strings.

        Because of the message protocol, there is a transfer
        limit of somewhere between 2MB and 4MB. See "PROTOCOL
        LIMITS" in guestfs(3).
        """
        arguments = list(arguments)
        self._check_not_closed()
        r = libguestfsmod.command_lines(self._o, arguments)
        return r

    def command_out(self, arguments: List[str], output: str) -> None:
        """This is the same as "g.command", but streams the output
        back, handling the case where the output from the
        command is larger than the protocol limit.

        See also: "g.sh_out"
        """
        arguments = list(arguments)
        self._check_not_closed()
        r = libguestfsmod.command_out(self._o, arguments, output)
        return r

    def compress_device_out(self, ctype: str, device: str, zdevice: str,
                            level: Optional[int] = None) -> None:
        """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 "g.compress_out".
        """
        self._check_not_closed()
        r = libguestfsmod.compress_device_out(self._o, ctype, device, zdevice,
                                              level)
        return r

    def compress_out(self, ctype: str, file: str, zfile: str,
                     level: Optional[int] = None) -> None:
        """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.
        """
        self._check_not_closed()
        r = libguestfsmod.compress_out(self._o, ctype, file, zfile, level)
        return r

    def config(self, hvparam: str, hvvalue: Optional[str]) -> None:
        """This can be used to add arbitrary hypervisor 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 "hvparam" string must be a "-"
        (dash).

        "hvvalue" can be NULL.
        """
        self._check_not_closed()
        r = libguestfsmod.config(self._o, hvparam, hvvalue)
        return r

    def copy_attributes(self, src: str, dest: str, all: Optional[bool] = None,
                        mode: Optional[bool] = None,
                        xattributes: Optional[bool] = None,
                        ownership: Optional[bool] = None) -> None:
        """Copy the attributes of a path (which can be a file or a
        directory) to another path.

        By default no attribute is copied, so make sure to
        specify any (or "all" to copy everything).

        The optional arguments specify which attributes can be
        copied:

        "mode"
        Copy part of the file mode from "source" to
        "destination". Only the UNIX permissions and the
        sticky/setuid/setgid bits can be copied.

        "xattributes"
        Copy the Linux extended attributes (xattrs) from
        "source" to "destination". This flag does nothing if
        the *linuxxattrs* feature is not available (see
        "g.feature_available").

        "ownership"
        Copy the owner uid and the group gid of "source" to
        "destination".

        "all"
        Copy all the attributes from "source" to
        "destination". Enabling it enables all the other
        flags, if they are not specified already.
        """
        self._check_not_closed()
        r = libguestfsmod.copy_attributes(self._o, src, dest, all, mode,
                                          xattributes, ownership)
        return r

    def copy_device_to_device(self, src: str, dest: str,
                              srcoffset: Optional[int] = None,
                              destoffset: Optional[int] = None,
                              size: Optional[int] = None,
                              sparse: Optional[bool] = None,
                              append: Optional[bool] = None) -> None:
        """The four calls "g.copy_device_to_device",
        "g.copy_device_to_file", "g.copy_file_to_device", and
        "g.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.

        If the destination is a file and the "append" flag is
        not set, then the destination file is truncated. If the
        "append" flag is set, then the copy appends to the
        destination file. The "append" flag currently cannot be
        set for devices.

        If the "sparse" flag is true then the call avoids
        writing blocks that contain only zeroes, which can help
        in some situations where the backing disk is
        thin-provisioned. Note that unless the target is already
        zeroed, using this option will result in incorrect
        copying.
        """
        self._check_not_closed()
        r = libguestfsmod.copy_device_to_device(self._o, src, dest, srcoffset,
                                                destoffset, size, sparse,
                                                append)
        return r

    def copy_device_to_file(self, src: str, dest: str,
                            srcoffset: Optional[int] = None,
                            destoffset: Optional[int] = None,
                            size: Optional[int] = None,
                            sparse: Optional[bool] = None,
                            append: Optional[bool] = None) -> None:
        """See "g.copy_device_to_device" for a general overview of
        this call.
        """
        self._check_not_closed()
        r = libguestfsmod.copy_device_to_file(self._o, src, dest, srcoffset,
                                              destoffset, size, sparse, append)
        return r

    def copy_file_to_device(self, src: str, dest: str,
                            srcoffset: Optional[int] = None,
                            destoffset: Optional[int] = None,
                            size: Optional[int] = None,
                            sparse: Optional[bool] = None,
                            append: Optional[bool] = None) -> None:
        """See "g.copy_device_to_device" for a general overview of
        this call.
        """
        self._check_not_closed()
        r = libguestfsmod.copy_file_to_device(self._o, src, dest, srcoffset,
                                              destoffset, size, sparse, append)
        return r

    def copy_file_to_file(self, src: str, dest: str,
                          srcoffset: Optional[int] = None,
                          destoffset: Optional[int] = None,
                          size: Optional[int] = None,
                          sparse: Optional[bool] = None,
                          append: Optional[bool] = None) -> None:
        """See "g.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
        "g.cp", "g.cp_a" and "g.mv" for general file copying and
        moving functions.
        """
        self._check_not_closed()
        r = libguestfsmod.copy_file_to_file(self._o, src, dest, srcoffset,
                                            destoffset, size, sparse, append)
        return r

    def copy_in(self, localpath: str, remotedir: str) -> None:
        """"g.copy_in" copies local files or directories
        recursively into the disk image, placing them in the
        directory called "remotedir" (which must exist).

        Wildcards cannot be used.
        """
        self._check_not_closed()
        r = libguestfsmod.copy_in(self._o, localpath, remotedir)
        return r

    def copy_out(self, remotepath: str, localdir: str) -> None:
        """"g.copy_out" copies remote files or directories
        recursively out of the disk image, placing them on the
        host disk in a local directory called "localdir" (which
        must exist).

        To download to the current directory, use "." as in:

        C<g.copy_out> /home .

        Wildcards cannot be used.
        """
        self._check_not_closed()
        r = libguestfsmod.copy_out(self._o, remotepath, localdir)
        return r

    def copy_size(self, src: str, dest: str, size: int) -> None:
        """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.

        *This function is deprecated.* In new code, use the
        "copy_device_to_device" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.copy_device_to_device() "
                      "instead of GuestFS.copy_size()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.copy_size(self._o, src, dest, size)
        return r

    def cp(self, src: str, dest: str) -> None:
        """This copies a file from "src" to "dest" where "dest" is
        either a destination filename or destination directory.
        """
        self._check_not_closed()
        r = libguestfsmod.cp(self._o, src, dest)
        return r

    def cp_a(self, src: str, dest: str) -> None:
        """This copies a file or directory from "src" to "dest"
        recursively using the "cp -a" command.
        """
        self._check_not_closed()
        r = libguestfsmod.cp_a(self._o, src, dest)
        return r

    def cp_r(self, src: str, dest: str) -> None:
        """This copies a file or directory from "src" to "dest"
        recursively using the "cp -rP" command.

        Most users should use "g.cp_a" instead. This command is
        useful when you don't want to preserve permissions,
        because the target filesystem does not support it
        (primarily when writing to DOS FAT filesystems).
        """
        self._check_not_closed()
        r = libguestfsmod.cp_r(self._o, src, dest)
        return r

    def cpio_out(self, directory: str, cpiofile: str,
                 format: Optional[str] = None) -> None:
        """This command packs the contents of directory and
        downloads it to local file "cpiofile".

        The optional "format" parameter can be used to select
        the format. Only the following formats are currently
        permitted:

        "newc"
        New (SVR4) portable format. This format happens to
        be compatible with the cpio-like format used by the
        Linux kernel for initramfs.

        This is the default format.

        "crc"
        New (SVR4) portable format with a checksum.
        """
        self._check_not_closed()
        r = libguestfsmod.cpio_out(self._o, directory, cpiofile, format)
        return r

    def cryptsetup_close(self, device: str) -> None:
        """This closes an encrypted device that was created earlier
        by "g.cryptsetup_open". The "device" parameter must be
        the name of the mapping device (ie. /dev/mapper/mapname)
        and *not* the name of the underlying block device.

        This function depends on the feature "luks". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.cryptsetup_close(self._o, device)
        return r

    def cryptsetup_open(self, device: str, key: str, mapname: str,
                        readonly: Optional[bool] = None,
                        crypttype: Optional[str] = None,
                        cipher: Optional[str] = None) -> None:
        """This command opens a block device which has been
        encrypted according to the Linux Unified Key Setup
        (LUKS) standard, Windows BitLocker, or some other types.

        "device" is the encrypted block device or partition.

        The caller must supply one of the keys associated with
        the encrypted 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.

        "mapname" cannot be "control" because that name is
        reserved by device-mapper.

        If the optional "crypttype" parameter is not present
        then libguestfs tries to guess the correct type (for
        example LUKS or BitLocker). However you can override
        this by specifying one of the following types:

        "luks"
        A Linux LUKS device.

        "bitlk"
        A Windows BitLocker device.

        The optional "readonly" flag, if set to true, creates a
        read-only mapping.

        The optional "cipher" parameter allows specifying which
        cipher to use.

        If this block device contains LVM volume groups, then
        calling "g.lvm_scan" with the "activate" parameter
        "true" will make them visible.

        Use "g.list_dm_devices" to list all device mapper
        devices.

        This function depends on the feature "luks". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.cryptsetup_open(self._o, device, key, mapname,
                                          readonly, crypttype, cipher)
        return r

    def dd(self, src: str, dest: str) -> None:
        """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 "g.copy_device_to_device").

        *This function is deprecated.* In new code, use the
        "copy_device_to_device" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.copy_device_to_device() "
                      "instead of GuestFS.dd()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.dd(self._o, src, dest)
        return r

    def debug(self, subcmd: str, extraargs: List[str]) -> str:
        extraargs = list(extraargs)
        self._check_not_closed()
        r = libguestfsmod.debug(self._o, subcmd, extraargs)
        return r

    def debug_drives(self) -> List[str]:
        self._check_not_closed()
        r = libguestfsmod.debug_drives(self._o)
        return r

    def debug_upload(self, filename: str, tmpname: str, mode: int) -> None:
        self._check_not_closed()
        r = libguestfsmod.debug_upload(self._o, filename, tmpname, mode)
        return r

    def device_index(self, device: str) -> int:
        """This function takes a device name (eg. "/dev/sdb") and
        returns the index of the device in the list of devices.

        Index numbers start from 0. The named device must exist,
        for example as a string returned from "g.list_devices".

        See also "g.list_devices", "g.part_to_dev",
        "g.device_name".
        """
        self._check_not_closed()
        r = libguestfsmod.device_index(self._o, device)
        return r

    def device_name(self, index: int) -> str:
        """This function takes a device index and returns the
        device name. For example index 0 will return the string
        "/dev/sda".

        The drive index must have been added to the handle.

        See also "g.list_devices", "g.part_to_dev",
        "g.device_index".
        """
        self._check_not_closed()
        r = libguestfsmod.device_name(self._o, index)
        return r

    def df(self) -> str:
        """This command runs the df(1) 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 "g.statvfs" from programs.
        """
        self._check_not_closed()
        r = libguestfsmod.df(self._o)
        return r

    def df_h(self) -> str:
        """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 "g.statvfs" from programs.
        """
        self._check_not_closed()
        r = libguestfsmod.df_h(self._o)
        return r

    def disk_create(self, filename: str, format: str, size: int,
                    backingfile: Optional[str] = None,
                    backingformat: Optional[str] = None,
                    preallocation: Optional[str] = None,
                    compat: Optional[str] = None,
                    clustersize: Optional[int] = None) -> None:
        """Create a blank disk image called filename (a host file)
        with format "format" (usually "raw" or "qcow2"). The
        size is "size" bytes.

        If used with the optional "backingfile" parameter, then
        a snapshot is created on top of the backing file. In
        this case, "size" must be passed as -1. The size of the
        snapshot is the same as the size of the backing file,
        which is discovered automatically. You are encouraged to
        also pass "backingformat" to describe the format of
        "backingfile".

        If filename refers to a block device, then the device is
        formatted. The "size" is ignored since block devices
        have an intrinsic size.

        The other optional parameters are:

        "preallocation"
        If format is "raw", then this can be either "off"
        (or "sparse") or "full" to create a sparse or fully
        allocated file respectively. The default is "off".

        If format is "qcow2", then this can be "off" (or
        "sparse"), "metadata" or "full". Preallocating
        metadata can be faster when doing lots of writes,
        but uses more space. The default is "off".

        "compat"
        "qcow2" only: Pass the string 1.1 to use the
        advanced qcow2 format supported by qemu ≥ 1.1.

        "clustersize"
        "qcow2" only: Change the qcow2 cluster size. The
        default is 65536 (bytes) and this setting may be any
        power of two between 512 and 2097152.

        Note that this call does not add the new disk to the
        handle. You may need to call "g.add_drive_opts"
        separately.
        """
        self._check_not_closed()
        r = libguestfsmod.disk_create(self._o, filename, format, size,
                                      backingfile, backingformat,
                                      preallocation, compat, clustersize)
        return r

    def disk_format(self, filename: str) -> str:
        """Detect and return the format of the disk image called
        filename. filename can also be a host device, etc. If
        the format of the image could not be detected, then
        "unknown" is returned.

        Note that detecting the disk format can be insecure
        under some circumstances. See "CVE-2010-3851" in
        guestfs(3).

        See also: "DISK IMAGE FORMATS" in guestfs(3)
        """
        self._check_not_closed()
        r = libguestfsmod.disk_format(self._o, filename)
        return r

    def disk_has_backing_file(self, filename: str) -> bool:
        """Detect and return whether the disk image filename has a
        backing file.

        Note that detecting disk features can be insecure under
        some circumstances. See "CVE-2010-3851" in guestfs(3).
        """
        self._check_not_closed()
        r = libguestfsmod.disk_has_backing_file(self._o, filename)
        return r

    def disk_virtual_size(self, filename: str) -> int:
        """Detect and return the virtual size in bytes of the disk
        image called filename.

        Note that detecting disk features can be insecure under
        some circumstances. See "CVE-2010-3851" in guestfs(3).
        """
        self._check_not_closed()
        r = libguestfsmod.disk_virtual_size(self._o, filename)
        return r

    def dmesg(self) -> str:
        """This returns the kernel messages (dmesg(1) 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 "g.set_verbose" or by setting the
        environment variable "LIBGUESTFS_DEBUG=1" before running
        the program.
        """
        self._check_not_closed()
        r = libguestfsmod.dmesg(self._o)
        return r

    def download(self, remotefilename: str, filename: str) -> None:
        """Download file remotefilename and save it as filename on
        the local machine.

        filename can also be a named pipe.

        See also "g.upload", "g.cat".
        """
        self._check_not_closed()
        r = libguestfsmod.download(self._o, remotefilename, filename)
        return r

    def download_blocks(self, device: str, start: int, stop: int,
                        filename: str,
                        unallocated: Optional[bool] = None) -> None:
        """Download the data units from start address to stop from
        the disk partition (eg. /dev/sda1) and save them as
        filename on the local machine.

        The use of this API on sparse disk image formats such as
        QCOW, may result in large zero-filled files downloaded
        on the host.

        The size of a data unit varies across filesystem
        implementations. On NTFS filesystems data units are
        referred as clusters while on ExtX ones they are
        referred as fragments.

        If the optional "unallocated" flag is true (default is
        false), only the unallocated blocks will be extracted.
        This is useful to detect hidden data or to retrieve
        deleted files which data units have not been overwritten
        yet.

        This function depends on the feature "sleuthkit". See
        also "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.download_blocks(self._o, device, start, stop,
                                          filename, unallocated)
        return r

    def download_inode(self, device: str, inode: int, filename: str) -> None:
        """Download a file given its inode from the disk partition
        (eg. /dev/sda1) and save it as filename on the local
        machine.

        It is not required to mount the disk to run this
        command.

        The command is capable of downloading deleted or
        inaccessible files.

        This function depends on the feature "sleuthkit". See
        also "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.download_inode(self._o, device, inode, filename)
        return r

    def download_offset(self, remotefilename: str, filename: str, offset: int,
                        size: int) -> None:
        """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 "g.pread",
        and this call always reads the full amount unless an
        error occurs.

        See also "g.download", "g.pread".
        """
        self._check_not_closed()
        r = libguestfsmod.download_offset(self._o, remotefilename, filename,
                                          offset, size)
        return r

    def drop_caches(self, whattodrop: int) -> None:
        """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 <https://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.
        """
        self._check_not_closed()
        r = libguestfsmod.drop_caches(self._o, whattodrop)
        return r

    def du(self, path: str) -> int:
        """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).
        """
        self._check_not_closed()
        r = libguestfsmod.du(self._o, path)
        return r

    def e2fsck(self, device: str, correct: Optional[bool] = None,
               forceall: Optional[bool] = None) -> None:
        """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.
        """
        self._check_not_closed()
        r = libguestfsmod.e2fsck(self._o, device, correct, forceall)
        return r

    def e2fsck_f(self, device: str) -> None:
        """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*).

        *This function is deprecated.* In new code, use the
        "e2fsck" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.e2fsck() "
                      "instead of GuestFS.e2fsck_f()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.e2fsck_f(self._o, device)
        return r

    def echo_daemon(self, words: List[str]) -> str:
        """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 "g.ping_daemon".
        """
        words = list(words)
        self._check_not_closed()
        r = libguestfsmod.echo_daemon(self._o, words)
        return r

    def egrep(self, regex: str, path: str) -> List[str]:
        """This calls the external egrep(1) program and returns the
        matching lines.

        This function returns a list of strings.

        Because of the message protocol, there is a transfer
        limit of somewhere between 2MB and 4MB. See "PROTOCOL
        LIMITS" in guestfs(3).

        *This function is deprecated.* In new code, use the
        "grep" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.grep() "
                      "instead of GuestFS.egrep()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.egrep(self._o, regex, path)
        return r

    def egrepi(self, regex: str, path: str) -> List[str]:
        """This calls the external "egrep -i" program and returns
        the matching lines.

        This function returns a list of strings.

        Because of the message protocol, there is a transfer
        limit of somewhere between 2MB and 4MB. See "PROTOCOL
        LIMITS" in guestfs(3).

        *This function is deprecated.* In new code, use the
        "grep" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.grep() "
                      "instead of GuestFS.egrepi()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.egrepi(self._o, regex, path)
        return r

    def equal(self, file1: str, file2: str) -> bool:
        """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.
        """
        self._check_not_closed()
        r = libguestfsmod.equal(self._o, file1, file2)
        return r

    def exists(self, path: str) -> bool:
        """This returns "true" if and only if there is a file,
        directory (or anything) with the given "path" name.

        See also "g.is_file", "g.is_dir", "g.stat".
        """
        self._check_not_closed()
        r = libguestfsmod.exists(self._o, path)
        return r

    def extlinux(self, directory: str) -> None:
        """Install the SYSLINUX bootloader on the device mounted at
        directory. Unlike "g.syslinux" which requires a FAT
        filesystem, this can be used on an ext2/3/4 or btrfs
        filesystem.

        The directory parameter can be either a mountpoint, or a
        directory within the mountpoint.

        You also have to mark the partition as "active"
        ("g.part_set_bootable") and a Master Boot Record must be
        installed (eg. using "g.pwrite_device") on the first
        sector of the whole disk. The SYSLINUX package comes
        with some suitable Master Boot Records. See the
        extlinux(1) man page for further information.

        Additional configuration can be supplied to SYSLINUX by
        placing a file called extlinux.conf on the filesystem
        under directory. For further information about the
        contents of this file, see extlinux(1).

        See also "g.syslinux".

        This function depends on the feature "extlinux". See
        also "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.extlinux(self._o, directory)
        return r

    def f2fs_expand(self, device: str) -> None:
        """This expands a f2fs filesystem to match the size of the
        underlying device.

        This function depends on the feature "f2fs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.f2fs_expand(self._o, device)
        return r

    def fallocate(self, path: str, len: int) -> None:
        """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.

        *This function is deprecated.* In new code, use the
        "fallocate64" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.fallocate64() "
                      "instead of GuestFS.fallocate()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.fallocate(self._o, path, len)
        return r

    def fallocate64(self, path: str, len: int) -> None:
        """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 "g.truncate_size" instead.

        The deprecated call "g.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.
        """
        self._check_not_closed()
        r = libguestfsmod.fallocate64(self._o, path, len)
        return r

    def feature_available(self, groups: List[str]) -> bool:
        """This is the same as "g.available", but unlike that call
        it returns a simple true/false boolean result, instead
        of throwing an exception if a feature is not found. For
        other documentation see "g.available".
        """
        groups = list(groups)
        self._check_not_closed()
        r = libguestfsmod.feature_available(self._o, groups)
        return r

    def fgrep(self, pattern: str, path: str) -> List[str]:
        """This calls the external fgrep(1) program and returns the
        matching lines.

        This function returns a list of strings.

        Because of the message protocol, there is a transfer
        limit of somewhere between 2MB and 4MB. See "PROTOCOL
        LIMITS" in guestfs(3).

        *This function is deprecated.* In new code, use the
        "grep" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.grep() "
                      "instead of GuestFS.fgrep()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.fgrep(self._o, pattern, path)
        return r

    def fgrepi(self, pattern: str, path: str) -> List[str]:
        """This calls the external "fgrep -i" program and returns
        the matching lines.

        This function returns a list of strings.

        Because of the message protocol, there is a transfer
        limit of somewhere between 2MB and 4MB. See "PROTOCOL
        LIMITS" in guestfs(3).

        *This function is deprecated.* In new code, use the
        "grep" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.grep() "
                      "instead of GuestFS.fgrepi()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.fgrepi(self._o, pattern, path)
        return r

    def file(self, path: str) -> str:
        """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 filename is not prepended to the output (like the
        file command *-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), "g.vfs_type", "g.lstat", "g.is_file",
        "g.is_blockdev" (etc), "g.is_zero".
        """
        self._check_not_closed()
        r = libguestfsmod.file(self._o, path)
        return r

    def file_architecture(self, filename: str) -> str:
        """This detects the architecture of the binary filename,
        and returns it if known.

        Currently defined architectures are:

        "aarch64"
        64 bit ARM.

        "arm"
        32 bit ARM.

        "i386"
        This string is returned for all 32 bit i386, i486,
        i586, i686 binaries irrespective of the precise
        processor requirements of the binary.

        "ia64"
        Intel Itanium.

        "ppc"
        32 bit Power PC.

        "ppc64"
        64 bit Power PC (big endian).

        "ppc64le"
        64 bit Power PC (little endian).

        "loongarch64"
        64 bit LoongArch64 (little endian).

        "riscv32"
        "riscv64"
        "riscv128"
        RISC-V 32-, 64- or 128-bit variants.

        "s390"
        31 bit IBM S/390.

        "s390x"
        64 bit IBM S/390.

        "sparc"
        32 bit SPARC.

        "sparc64"
        64 bit SPARC V9 and above.

        "x86_64"
        64 bit x86-64.

        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.
        """
        self._check_not_closed()
        r = libguestfsmod.file_architecture(self._o, filename)
        return r

    def filesize(self, file: str) -> int:
        """This command returns the size of file in bytes.

        To get other stats about a file, use "g.stat",
        "g.lstat", "g.is_dir", "g.is_file" etc. To get the size
        of block devices, use "g.blockdev_getsize64".
        """
        self._check_not_closed()
        r = libguestfsmod.filesize(self._o, file)
        return r

    def filesystem_available(self, filesystem: str) -> bool:
        """Check whether libguestfs supports the named filesystem.
        The argument "filesystem" is a filesystem name, such as
        "ext3".

        You must call "g.launch" before using this command.

        This is mainly useful as a negative test. If this
        returns true, it doesn't mean that a particular
        filesystem can be created or mounted, since filesystems
        can fail for other reasons such as it being a later
        version of the filesystem, or having incompatible
        features, or lacking the right mkfs.<*fs*> tool.

        See also "g.available", "g.feature_available",
        "AVAILABILITY" in guestfs(3).
        """
        self._check_not_closed()
        r = libguestfsmod.filesystem_available(self._o, filesystem)
        return r

    def filesystem_walk(self, device: str) -> List[dict]:
        """Walk through the internal structures of a disk partition
        (eg. /dev/sda1) in order to return a list of all the
        files and directories stored within.

        It is not necessary to mount the disk partition to run
        this command.

        All entries in the filesystem are returned. This
        function can list deleted or unaccessible files. The
        entries are *not* sorted.

        The "tsk_dirent" structure contains the following
        fields.

        "tsk_inode"
        Filesystem reference number of the node. It might be
        0 if the node has been deleted.

        "tsk_type"
        Basic file type information. See below for a
        detailed list of values.

        "tsk_size"
        File size in bytes. It might be -1 if the node has
        been deleted.

        "tsk_name"
        The file path relative to its directory.

        "tsk_flags"
        Bitfield containing extra information regarding the
        entry. It contains the logical OR of the following
        values:

        0x0001
        If set to 1, the file is allocated and visible
        within the filesystem. Otherwise, the file has
        been deleted. Under certain circumstances, the
        function "download_inode" can be used to recover
        deleted files.

        0x0002
        Filesystem such as NTFS and Ext2 or greater,
        separate the file name from the metadata
        structure. The bit is set to 1 when the file
        name is in an unallocated state and the metadata
        structure is in an allocated one. This generally
        implies the metadata has been reallocated to a
        new file. Therefore, information such as file
        type, file size, timestamps, number of links and
        symlink target might not correspond with the
        ones of the original deleted entry.

        0x0004
        The bit is set to 1 when the file is compressed
        using filesystem native compression support
        (NTFS). The API is not able to detect
        application level compression.

        "tsk_atime_sec"
        "tsk_atime_nsec"
        "tsk_mtime_sec"
        "tsk_mtime_nsec"
        "tsk_ctime_sec"
        "tsk_ctime_nsec"
        "tsk_crtime_sec"
        "tsk_crtime_nsec"
        Respectively, access, modification, last status
        change and creation time in Unix format in seconds
        and nanoseconds.

        "tsk_nlink"
        Number of file names pointing to this entry.

        "tsk_link"
        If the entry is a symbolic link, this field will
        contain the path to the target file.

        The "tsk_type" 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

        'h' Shadow inode (Solaris)

        'w' Whiteout inode (BSD)

        'u' Unknown file type

        This function returns a list of tsk_dirents. Each
        tsk_dirent is represented as a dictionary.

        This function depends on the feature "libtsk". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.filesystem_walk(self._o, device)
        return r

    def fill(self, c: int, len: int, path: str) -> None:
        """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 "g.truncate_size". To create a
        file with a pattern of repeating bytes use
        "g.fill_pattern".
        """
        self._check_not_closed()
        r = libguestfsmod.fill(self._o, c, len, path)
        return r

    def fill_dir(self, dir: str, nr: int) -> None:
        """This function, useful for testing filesystems, creates
        "nr" empty files in the directory "dir" with names
        00000000 through "nr-1" (ie. each file name is 8 digits
        long padded with zeroes).
        """
        self._check_not_closed()
        r = libguestfsmod.fill_dir(self._o, dir, nr)
        return r

    def fill_pattern(self, pattern: str, len: int, path: str) -> None:
        """This function is like "g.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.
        """
        self._check_not_closed()
        r = libguestfsmod.fill_pattern(self._o, pattern, len, path)
        return r

    def find(self, directory: str) -> List[str]:
        """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 "g.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.

        This function returns a list of strings.
        """
        self._check_not_closed()
        r = libguestfsmod.find(self._o, directory)
        return r

    def find0(self, directory: str, files: str) -> None:
        """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 "g.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*.

        *   The result list is not sorted.
        """
        self._check_not_closed()
        r = libguestfsmod.find0(self._o, directory, files)
        return r

    def find_inode(self, device: str, inode: int) -> List[dict]:
        """Searches all the entries associated with the given
        inode.

        For each entry, a "tsk_dirent" structure is returned.
        See "filesystem_walk" for more information about
        "tsk_dirent" structures.

        This function returns a list of tsk_dirents. Each
        tsk_dirent is represented as a dictionary.

        This function depends on the feature "libtsk". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.find_inode(self._o, device, inode)
        return r

    def findfs_label(self, label: str) -> str:
        """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 "g.vfs_label".
        """
        self._check_not_closed()
        r = libguestfsmod.findfs_label(self._o, label)
        return r

    def findfs_partlabel(self, label: str) -> str:
        """This command searches the partitions and returns the one
        which has the given label. An error is returned if no
        such partition can be found.

        To find the label of a partition, use "g.blkid"
        ("PART_ENTRY_NAME").
        """
        self._check_not_closed()
        r = libguestfsmod.findfs_partlabel(self._o, label)
        return r

    def findfs_partuuid(self, uuid: str) -> str:
        """This command searches the partitions and returns the one
        which has the given partition UUID. An error is returned
        if no such partition can be found.

        To find the UUID of a partition, use "g.blkid"
        ("PART_ENTRY_UUID").
        """
        self._check_not_closed()
        r = libguestfsmod.findfs_partuuid(self._o, uuid)
        return r

    def findfs_uuid(self, uuid: str) -> str:
        """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 "g.vfs_uuid".
        """
        self._check_not_closed()
        r = libguestfsmod.findfs_uuid(self._o, uuid)
        return r

    def fsck(self, fstype: str, device: str) -> int:
        """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".
        """
        self._check_not_closed()
        r = libguestfsmod.fsck(self._o, fstype, device)
        return r

    def fstrim(self, mountpoint: str, offset: Optional[int] = None,
               length: Optional[int] = None,
               minimumfreeextent: Optional[int] = None) -> None:
        """Trim the free space in the filesystem mounted on
        "mountpoint". The filesystem must be mounted read-write.

        The filesystem contents are not affected, but any free
        space in the filesystem is "trimmed", that is, given
        back to the host device, thus making disk images more
        sparse, allowing unused space in qcow2 files to be
        reused, etc.

        This operation requires support in libguestfs, the
        mounted filesystem, the host filesystem, qemu and the
        host kernel. If this support isn't present it may give
        an error or even appear to run but do nothing.

        In the case where the kernel vfs driver does not support
        trimming, this call will fail with errno set to
        "ENOTSUP". Currently this happens when trying to trim
        FAT filesystems.

        See also "g.zero_free_space". That is a slightly
        different operation that turns free space in the
        filesystem into zeroes. It is valid to call "g.fstrim"
        either instead of, or after calling "g.zero_free_space".

        This function depends on the feature "fstrim". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.fstrim(self._o, mountpoint, offset, length,
                                 minimumfreeextent)
        return r

    def get_append(self) -> Optional[str]:
        """Return the additional kernel options which are added to
        the libguestfs appliance kernel command line.

        If "NULL" then no options are added.
        """
        self._check_not_closed()
        r = libguestfsmod.get_append(self._o)
        return r

    def get_attach_method(self) -> str:
        """Return the current backend.

        See "g.set_backend" and "BACKEND" in guestfs(3).

        *This function is deprecated.* In new code, use the
        "get_backend" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.get_backend() "
                      "instead of GuestFS.get_attach_method()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.get_attach_method(self._o)
        return r

    def get_autosync(self) -> bool:
        """Get the autosync flag.
        """
        self._check_not_closed()
        r = libguestfsmod.get_autosync(self._o)
        return r

    def get_backend(self) -> str:
        """Return the current backend.

        This handle property was previously called the "attach
        method".

        See "g.set_backend" and "BACKEND" in guestfs(3).
        """
        self._check_not_closed()
        r = libguestfsmod.get_backend(self._o)
        return r

    def get_backend_setting(self, name: str) -> str:
        """Find a backend setting string which is either "name" or
        begins with "name=". If "name", this returns the string
        "1". If "name=", this returns the part after the equals
        sign (which may be an empty string).

        If no such setting is found, this function throws an
        error. The errno (see "g.last_errno") will be "ESRCH" in
        this case.

        See "BACKEND" in guestfs(3), "BACKEND SETTINGS" in
        guestfs(3).
        """
        self._check_not_closed()
        r = libguestfsmod.get_backend_setting(self._o, name)
        return r

    def get_backend_settings(self) -> List[str]:
        """Return the current backend settings.

        This call returns all backend settings strings. If you
        want to find a single backend setting, see
        "g.get_backend_setting".

        See "BACKEND" in guestfs(3), "BACKEND SETTINGS" in
        guestfs(3).

        This function returns a list of strings.
        """
        self._check_not_closed()
        r = libguestfsmod.get_backend_settings(self._o)
        return r

    def get_cachedir(self) -> str:
        """Get the directory used by the handle to store the
        appliance cache.
        """
        self._check_not_closed()
        r = libguestfsmod.get_cachedir(self._o)
        return r

    def get_direct(self) -> bool:
        """Return the direct appliance mode flag.

        *This function is deprecated.* In new code, use the
        "internal_get_console_socket" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.internal_get_console_socket() "
                      "instead of GuestFS.get_direct()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.get_direct(self._o)
        return r

    def get_e2attrs(self, file: str) -> str:
        """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 "g.set_e2attrs".

        Don't confuse these attributes with extended attributes
        (see "g.getxattr").
        """
        self._check_not_closed()
        r = libguestfsmod.get_e2attrs(self._o, file)
        return r

    def get_e2generation(self, file: str) -> int:
        """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 "g.set_e2generation".
        """
        self._check_not_closed()
        r = libguestfsmod.get_e2generation(self._o, file)
        return r

    def get_e2label(self, device: str) -> str:
        """This returns the ext2/3/4 filesystem label of the
        filesystem on "device".

        *This function is deprecated.* In new code, use the
        "vfs_label" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.vfs_label() "
                      "instead of GuestFS.get_e2label()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.get_e2label(self._o, device)
        return r

    def get_e2uuid(self, device: str) -> str:
        """This returns the ext2/3/4 filesystem UUID of the
        filesystem on "device".

        *This function is deprecated.* In new code, use the
        "vfs_uuid" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.vfs_uuid() "
                      "instead of GuestFS.get_e2uuid()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.get_e2uuid(self._o, device)
        return r

    def get_hv(self) -> str:
        """Return the current hypervisor binary.

        This is always non-NULL. If it wasn't set already, then
        this will return the default qemu binary name.
        """
        self._check_not_closed()
        r = libguestfsmod.get_hv(self._o)
        return r

    def get_identifier(self) -> str:
        """Get the handle identifier. See "g.set_identifier".
        """
        self._check_not_closed()
        r = libguestfsmod.get_identifier(self._o)
        return r

    def get_libvirt_requested_credential_challenge(self, index: int) -> str:
        """Get the challenge (provided by libvirt) for the
        "index"'th requested credential. If libvirt did not
        provide a challenge, this returns the empty string "".

        See "LIBVIRT AUTHENTICATION" in guestfs(3) for
        documentation and example code.
        """
        self._check_not_closed()
        r = libguestfsmod.get_libvirt_requested_credential_challenge(self._o,
                                                                     index)
        return r

    def get_libvirt_requested_credential_defresult(self, index: int) -> str:
        """Get the default result (provided by libvirt) for the
        "index"'th requested credential. If libvirt did not
        provide a default result, this returns the empty string
        "".

        See "LIBVIRT AUTHENTICATION" in guestfs(3) for
        documentation and example code.
        """
        self._check_not_closed()
        r = libguestfsmod.get_libvirt_requested_credential_defresult(self._o,
                                                                     index)
        return r

    def get_libvirt_requested_credential_prompt(self, index: int) -> str:
        """Get the prompt (provided by libvirt) for the "index"'th
        requested credential. If libvirt did not provide a
        prompt, this returns the empty string "".

        See "LIBVIRT AUTHENTICATION" in guestfs(3) for
        documentation and example code.
        """
        self._check_not_closed()
        r = libguestfsmod.get_libvirt_requested_credential_prompt(self._o,
                                                                  index)
        return r

    def get_libvirt_requested_credentials(self) -> List[str]:
        """This should only be called during the event callback for
        events of type "GUESTFS_EVENT_LIBVIRT_AUTH".

        Return the list of credentials requested by libvirt.
        Possible values are a subset of the strings provided
        when you called "g.set_libvirt_supported_credentials".

        See "LIBVIRT AUTHENTICATION" in guestfs(3) for
        documentation and example code.

        This function returns a list of strings.
        """
        self._check_not_closed()
        r = libguestfsmod.get_libvirt_requested_credentials(self._o)
        return r

    def get_memsize(self) -> int:
        """This gets the memory size in megabytes allocated to the
        hypervisor.

        If "g.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).
        """
        self._check_not_closed()
        r = libguestfsmod.get_memsize(self._o)
        return r

    def get_network(self) -> bool:
        """This returns the enable network flag.
        """
        self._check_not_closed()
        r = libguestfsmod.get_network(self._o)
        return r

    def get_path(self) -> str:
        """Return the current search path.

        This is always non-NULL. If it wasn't set already, then
        this will return the default path.
        """
        self._check_not_closed()
        r = libguestfsmod.get_path(self._o)
        return r

    def get_pgroup(self) -> bool:
        """This returns the process group flag.
        """
        self._check_not_closed()
        r = libguestfsmod.get_pgroup(self._o)
        return r

    def get_pid(self) -> int:
        """Return the process ID of the hypervisor. If there is no
        hypervisor running, then this will return an error.

        This is an internal call used for debugging and testing.
        """
        self._check_not_closed()
        r = libguestfsmod.get_pid(self._o)
        return r

    def get_program(self) -> str:
        """Get the program name. See "g.set_program".
        """
        self._check_not_closed()
        r = libguestfsmod.get_program(self._o)
        return r

    def get_qemu(self) -> str:
        """Return the current hypervisor binary (usually qemu).

        This is always non-NULL. If it wasn't set already, then
        this will return the default qemu binary name.

        *This function is deprecated.* In new code, use the
        "get_hv" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.get_hv() "
                      "instead of GuestFS.get_qemu()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.get_qemu(self._o)
        return r

    def get_recovery_proc(self) -> bool:
        """Return the recovery process enabled flag.
        """
        self._check_not_closed()
        r = libguestfsmod.get_recovery_proc(self._o)
        return r

    def get_selinux(self) -> bool:
        """This returns the current setting of the selinux flag
        which is passed to the appliance at boot time. See
        "g.set_selinux".

        For more information on the architecture of libguestfs,
        see guestfs(3).

        *This function is deprecated.* In new code, use the
        "selinux_relabel" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.selinux_relabel() "
                      "instead of GuestFS.get_selinux()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.get_selinux(self._o)
        return r

    def get_smp(self) -> int:
        """This returns the number of virtual CPUs assigned to the
        appliance.
        """
        self._check_not_closed()
        r = libguestfsmod.get_smp(self._o)
        return r

    def get_sockdir(self) -> str:
        """Get the directory used by the handle to store temporary
        socket and PID files.

        This is different from "g.get_tmpdir", as we need
        shorter paths for sockets (due to the limited buffers of
        filenames for UNIX sockets), and "g.get_tmpdir" may be
        too long for them. Furthermore, sockets and PID files
        must be accessible to such background services started
        by libguestfs that may not have permission to access the
        temporary directory returned by "g.get_tmpdir".

        The environment variable "XDG_RUNTIME_DIR" controls the
        default value: If "XDG_RUNTIME_DIR" is set, then that is
        the default. Else /tmp is the default.
        """
        self._check_not_closed()
        r = libguestfsmod.get_sockdir(self._o)
        return r

    def get_state(self) -> int:
        """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).
        """
        self._check_not_closed()
        r = libguestfsmod.get_state(self._o)
        return r

    def get_tmpdir(self) -> str:
        """Get the directory used by the handle to store temporary
        files.
        """
        self._check_not_closed()
        r = libguestfsmod.get_tmpdir(self._o)
        return r

    def get_trace(self) -> bool:
        """Return the command trace flag.
        """
        self._check_not_closed()
        r = libguestfsmod.get_trace(self._o)
        return r

    def get_umask(self) -> int:
        """Return the current umask. By default the umask is 022
        unless it has been set by calling "g.umask".
        """
        self._check_not_closed()
        r = libguestfsmod.get_umask(self._o)
        return r

    def get_verbose(self) -> bool:
        """This returns the verbose messages flag.
        """
        self._check_not_closed()
        r = libguestfsmod.get_verbose(self._o)
        return r

    def getcon(self) -> str:
        """This gets the SELinux security context of the daemon.

        See the documentation about SELINUX in guestfs(3), and
        "g.setcon"

        *This function is deprecated.* In new code, use the
        "selinux_relabel" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.

        This function depends on the feature "selinux". See also
        "g.feature-available".
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.selinux_relabel() "
                      "instead of GuestFS.getcon()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.getcon(self._o)
        return r

    def getxattr(self, path: str, name: str) -> bytes:
        """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
        "g.lgetxattr".

        Normally it is better to get all extended attributes
        from a file in one go by calling "g.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: "g.getxattrs", "g.lgetxattr", attr(5).

        This function depends on the feature "linuxxattrs". See
        also "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.getxattr(self._o, path, name)
        return r

    def getxattrs(self, path: str) -> List[dict]:
        """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: "g.lgetxattrs", attr(5).

        This function returns a list of xattrs. Each xattr is
        represented as a dictionary.

        This function depends on the feature "linuxxattrs". See
        also "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.getxattrs(self._o, path)
        return r

    def glob_expand(self, pattern: str,
                    directoryslash: Optional[bool] = None) -> List[str]:
        """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.

        "directoryslash" controls whether use the "GLOB_MARK"
        flag for glob(3), and it defaults to true. It can be
        explicitly set as off to return no trailing slashes in
        filenames of directories.

        Notice that there is no equivalent command for expanding
        a device name (eg. /dev/sd*). Use "g.list_devices",
        "g.list_partitions" etc functions instead.

        This function returns a list of strings.
        """
        self._check_not_closed()
        r = libguestfsmod.glob_expand(self._o, pattern, directoryslash)
        return r

    glob_expand_opts = glob_expand

    def grep(self, regex: str, path: str, extended: Optional[bool] = None,
             fixed: Optional[bool] = None, insensitive: Optional[bool] = None,
             compressed: Optional[bool] = None) -> List[str]:
        """This calls the external grep(1) program and returns the
        matching lines.

        The optional flags are:

        "extended"
        Use extended regular expressions. This is the same
        as using the *-E* flag.

        "fixed"
        Match fixed (don't use regular expressions). This is
        the same as using the *-F* flag.

        "insensitive"
        Match case-insensitive. This is the same as using
        the *-i* flag.

        "compressed"
        Use zgrep(1) instead of grep(1). This allows the
        input to be compress- or gzip-compressed.

        This function returns a list of strings.

        Because of the message protocol, there is a transfer
        limit of somewhere between 2MB and 4MB. See "PROTOCOL
        LIMITS" in guestfs(3).
        """
        self._check_not_closed()
        r = libguestfsmod.grep(self._o, regex, path, extended, fixed,
                               insensitive, compressed)
        return r

    grep_opts = grep

    def grepi(self, regex: str, path: str) -> List[str]:
        """This calls the external "grep -i" program and returns
        the matching lines.

        This function returns a list of strings.

        Because of the message protocol, there is a transfer
        limit of somewhere between 2MB and 4MB. See "PROTOCOL
        LIMITS" in guestfs(3).

        *This function is deprecated.* In new code, use the
        "grep" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.grep() "
                      "instead of GuestFS.grepi()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.grepi(self._o, regex, path)
        return r

    def grub_install(self, root: str, device: str) -> None:
        """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(8) 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.

        This function depends on the feature "grub". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.grub_install(self._o, root, device)
        return r

    def head(self, path: str) -> List[str]:
        """This command returns up to the first 10 lines of a file
        as a list of strings.

        This function returns a list of strings.

        Because of the message protocol, there is a transfer
        limit of somewhere between 2MB and 4MB. See "PROTOCOL
        LIMITS" in guestfs(3).
        """
        self._check_not_closed()
        r = libguestfsmod.head(self._o, path)
        return r

    def head_n(self, nrlines: int, path: str) -> List[str]:
        """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.

        This function returns a list of strings.

        Because of the message protocol, there is a transfer
        limit of somewhere between 2MB and 4MB. See "PROTOCOL
        LIMITS" in guestfs(3).
        """
        self._check_not_closed()
        r = libguestfsmod.head_n(self._o, nrlines, path)
        return r

    def hexdump(self, path: str) -> str:
        """This runs "hexdump -C" on the given "path". The result
        is the human-readable, canonical hex dump of the file.

        Because of the message protocol, there is a transfer
        limit of somewhere between 2MB and 4MB. See "PROTOCOL
        LIMITS" in guestfs(3).
        """
        self._check_not_closed()
        r = libguestfsmod.hexdump(self._o, path)
        return r

    def hivex_close(self) -> None:
        """Close the current hivex handle.

        This is a wrapper around the hivex(3) call of the same
        name.

        This function depends on the feature "hivex". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.hivex_close(self._o)
        return r

    def hivex_commit(self, filename: Optional[str]) -> None:
        """Commit (write) changes to the hive.

        If the optional filename parameter is null, then the
        changes are written back to the same hive that was
        opened. If this is not null then they are written to the
        alternate filename given and the original hive is left
        untouched.

        This is a wrapper around the hivex(3) call of the same
        name.

        This function depends on the feature "hivex". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.hivex_commit(self._o, filename)
        return r

    def hivex_node_add_child(self, parent: int, name: str) -> int:
        """Add a child node to "parent" named "name".

        This is a wrapper around the hivex(3) call of the same
        name.

        This function depends on the feature "hivex". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.hivex_node_add_child(self._o, parent, name)
        return r

    def hivex_node_children(self, nodeh: int) -> List[dict]:
        """Return the list of nodes which are subkeys of "nodeh".

        This is a wrapper around the hivex(3) call of the same
        name.

        This function returns a list of hivex_nodes. Each
        hivex_node is represented as a dictionary.

        This function depends on the feature "hivex". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.hivex_node_children(self._o, nodeh)
        return r

    def hivex_node_delete_child(self, nodeh: int) -> None:
        """Delete "nodeh", recursively if necessary.

        This is a wrapper around the hivex(3) call of the same
        name.

        This function depends on the feature "hivex". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.hivex_node_delete_child(self._o, nodeh)
        return r

    def hivex_node_get_child(self, nodeh: int, name: str) -> int:
        """Return the child of "nodeh" with the name "name", if it
        exists. This can return 0 meaning the name was not
        found.

        This is a wrapper around the hivex(3) call of the same
        name.

        This function depends on the feature "hivex". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.hivex_node_get_child(self._o, nodeh, name)
        return r

    def hivex_node_get_value(self, nodeh: int, key: str) -> int:
        """Return the value attached to "nodeh" which has the name
        "key", if it exists. This can return 0 meaning the key
        was not found.

        This is a wrapper around the hivex(3) call of the same
        name.

        This function depends on the feature "hivex". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.hivex_node_get_value(self._o, nodeh, key)
        return r

    def hivex_node_name(self, nodeh: int) -> str:
        """Return the name of "nodeh".

        This is a wrapper around the hivex(3) call of the same
        name.

        This function depends on the feature "hivex". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.hivex_node_name(self._o, nodeh)
        return r

    def hivex_node_parent(self, nodeh: int) -> int:
        """Return the parent node of "nodeh".

        This is a wrapper around the hivex(3) call of the same
        name.

        This function depends on the feature "hivex". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.hivex_node_parent(self._o, nodeh)
        return r

    def hivex_node_set_value(self, nodeh: int, key: str, t: int,
                             val: bytes) -> None:
        """Set or replace a single value under the node "nodeh".
        The "key" is the name, "t" is the type, and "val" is the
        data.

        This is a wrapper around the hivex(3) call of the same
        name.

        This function depends on the feature "hivex". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.hivex_node_set_value(self._o, nodeh, key, t, val)
        return r

    def hivex_node_values(self, nodeh: int) -> List[dict]:
        """Return the array of (key, datatype, data) tuples
        attached to "nodeh".

        This is a wrapper around the hivex(3) call of the same
        name.

        This function returns a list of hivex_values. Each
        hivex_value is represented as a dictionary.

        This function depends on the feature "hivex". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.hivex_node_values(self._o, nodeh)
        return r

    def hivex_open(self, filename: str, verbose: Optional[bool] = None,
                   debug: Optional[bool] = None, write: Optional[bool] = None,
                   unsafe: Optional[bool] = None) -> None:
        """Open the Windows Registry hive file named filename. If
        there was any previous hivex handle associated with this
        guestfs session, then it is closed.

        This is a wrapper around the hivex(3) call of the same
        name.

        This function depends on the feature "hivex". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.hivex_open(self._o, filename, verbose, debug, write,
                                     unsafe)
        return r

    def hivex_root(self) -> int:
        """Return the root node of the hive.

        This is a wrapper around the hivex(3) call of the same
        name.

        This function depends on the feature "hivex". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.hivex_root(self._o)
        return r

    def hivex_value_key(self, valueh: int) -> str:
        """Return the key (name) field of a (key, datatype, data)
        tuple.

        This is a wrapper around the hivex(3) call of the same
        name.

        This function depends on the feature "hivex". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.hivex_value_key(self._o, valueh)
        return r

    def hivex_value_string(self, valueh: int) -> str:
        """This calls "g.hivex_value_value" (which returns the data
        field from a hivex value tuple). It then assumes that
        the field is a UTF-16LE string and converts the result
        to UTF-8 (or if this is not possible, it returns an
        error).

        This is useful for reading strings out of the Windows
        registry. However it is not foolproof because the
        registry is not strongly-typed and fields can contain
        arbitrary or unexpected data.

        This function depends on the feature "hivex". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.hivex_value_string(self._o, valueh)
        return r

    def hivex_value_type(self, valueh: int) -> int:
        """Return the data type field from a (key, datatype, data)
        tuple.

        This is a wrapper around the hivex(3) call of the same
        name.

        This function depends on the feature "hivex". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.hivex_value_type(self._o, valueh)
        return r

    def hivex_value_utf8(self, valueh: int) -> str:
        """This calls "g.hivex_value_value" (which returns the data
        field from a hivex value tuple). It then assumes that
        the field is a UTF-16LE string and converts the result
        to UTF-8 (or if this is not possible, it returns an
        error).

        This is useful for reading strings out of the Windows
        registry. However it is not foolproof because the
        registry is not strongly-typed and fields can contain
        arbitrary or unexpected data.

        *This function is deprecated.* In new code, use the
        "hivex_value_string" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.

        This function depends on the feature "hivex". See also
        "g.feature-available".
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.hivex_value_string() "
                      "instead of GuestFS.hivex_value_utf8()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.hivex_value_utf8(self._o, valueh)
        return r

    def hivex_value_value(self, valueh: int) -> bytes:
        """Return the data field of a (key, datatype, data) tuple.

        This is a wrapper around the hivex(3) call of the same
        name.

        See also: "g.hivex_value_utf8".

        This function depends on the feature "hivex". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.hivex_value_value(self._o, valueh)
        return r

    def initrd_cat(self, initrdpath: str, filename: str) -> bytes:
        """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 "g.initrd_list".

        Because of the message protocol, there is a transfer
        limit of somewhere between 2MB and 4MB. See "PROTOCOL
        LIMITS" in guestfs(3).
        """
        self._check_not_closed()
        r = libguestfsmod.initrd_cat(self._o, initrdpath, filename)
        return r

    def initrd_list(self, path: str) -> List[str]:
        """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).

        This function returns a list of strings.
        """
        self._check_not_closed()
        r = libguestfsmod.initrd_list(self._o, path)
        return r

    def inotify_add_watch(self, path: str, mask: int) -> int:
        """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.

        This function depends on the feature "inotify". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.inotify_add_watch(self._o, path, mask)
        return r

    def inotify_close(self) -> None:
        """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.

        This function depends on the feature "inotify". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.inotify_close(self._o)
        return r

    def inotify_files(self) -> List[str]:
        """This function is a helpful wrapper around
        "g.inotify_read" which just returns a list of pathnames
        of objects that were touched. The returned pathnames are
        sorted and deduplicated.

        This function returns a list of strings.

        This function depends on the feature "inotify". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.inotify_files(self._o)
        return r

    def inotify_init(self, maxevents: int) -> None:
        """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 "g.inotify_read" or
        "g.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 "g.inotify_read").

        Before any events are generated, you have to add some
        watches to the internal watch list. See:
        "g.inotify_add_watch" and "g.inotify_rm_watch".

        Queued up events should be read periodically by calling
        "g.inotify_read" (or "g.inotify_files" which is just a
        helpful wrapper around "g.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
        "g.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.

        This function depends on the feature "inotify". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.inotify_init(self._o, maxevents)
        return r

    def inotify_read(self) -> List[dict]:
        """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.

        This function returns a list of inotify_events. Each
        inotify_event is represented as a dictionary.

        This function depends on the feature "inotify". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.inotify_read(self._o)
        return r

    def inotify_rm_watch(self, wd: int) -> None:
        """Remove a previously defined inotify watch. See
        "g.inotify_add_watch".

        This function depends on the feature "inotify". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.inotify_rm_watch(self._o, wd)
        return r

    def inspect_get_arch(self, root: str) -> str:
        """This returns the architecture of the inspected operating
        system. The possible return values are listed under
        "g.file_architecture".

        If the architecture could not be determined, then the
        string "unknown" is returned.

        Please read "INSPECTION" in guestfs(3) for more details.
        """
        self._check_not_closed()
        r = libguestfsmod.inspect_get_arch(self._o, root)
        return r

    def inspect_get_build_id(self, root: str) -> str:
        """This returns the build ID of the system, or the string
        "unknown" if the system does not have a build ID.

        For Windows, this gets the build number. Although it is
        returned as a string, it is (so far) always a number.
        See
        <https://en.wikipedia.org/wiki/List_of_Microsoft_Windows
        _versions> for some possible values.

        For Linux, this returns the "BUILD_ID" string from
        /etc/os-release, although this is not often used.

        Please read "INSPECTION" in guestfs(3) for more details.
        """
        self._check_not_closed()
        r = libguestfsmod.inspect_get_build_id(self._o, root)
        return r

    def inspect_get_distro(self, root: str) -> str:
        """This returns the distro (distribution) of the inspected
        operating system.

        Currently defined distros are:

        "alpinelinux"
        Alpine Linux.

        "altlinux"
        ALT Linux.

        "archlinux"
        Arch Linux.

        "buildroot"
        Buildroot-derived distro, but not one we
        specifically recognize.

        "centos"
        CentOS.

        "circle"
        Circle Linux.

        "cirros"
        Cirros.

        "coreos"
        CoreOS.

        "debian"
        Debian.

        "fedora"
        Fedora.

        "freebsd"
        FreeBSD.

        "freedos"
        FreeDOS.

        "frugalware"
        Frugalware.

        "gentoo"
        Gentoo.

        "kalilinux"
        Kali Linux.

        "kylin"
        Kylin.

        "linuxmint"
        Linux Mint.

        "mageia"
        Mageia.

        "mandriva"
        Mandriva.

        "meego"
        MeeGo.

        "msdos"
        Microsoft DOS.

        "neokylin"
        NeoKylin.

        "netbsd"
        NetBSD.

        "openbsd"
        OpenBSD.

        "openeuler"
        openEuler.

        "openmandriva"
        OpenMandriva Lx.

        "opensuse"
        OpenSUSE.

        "oraclelinux"
        Oracle Linux.

        "pardus"
        Pardus.

        "pldlinux"
        PLD Linux.

        "redhat-based"
        Some Red Hat-derived distro.

        "rhel"
        Red Hat Enterprise Linux.

        "rocky"
        Rocky Linux.

        "scientificlinux"
        Scientific Linux.

        "slackware"
        Slackware.

        "sles"
        SuSE Linux Enterprise Server or Desktop.

        "suse-based"
        Some openSuSE-derived distro.

        "ttylinux"
        ttylinux.

        "ubuntu"
        Ubuntu.

        "unknown"
        The distro could not be determined.

        "voidlinux"
        Void Linux.

        "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.
        """
        self._check_not_closed()
        r = libguestfsmod.inspect_get_distro(self._o, root)
        return r

    def inspect_get_drive_mappings(self, root: str) -> Union[List[Tuple[str,
                                   str]], dict]:
        """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 "g.inspect_get_mountpoints",
        "g.inspect_get_filesystems".

        This function returns a hash. If the GuestFS constructor
        was called with python_return_dict=True (recommended)
        then the return value is in fact a Python dict.
        Otherwise the return value is a list of pairs of
        strings, for compatibility with old code.
        """
        self._check_not_closed()
        r = libguestfsmod.inspect_get_drive_mappings(self._o, root)
        r = self._maybe_convert_to_dict(r)
        return r

    def inspect_get_filesystems(self, root: str) -> List[str]:
        """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 "g.inspect_get_mountpoints".

        This function returns a list of strings.
        """
        self._check_not_closed()
        r = libguestfsmod.inspect_get_filesystems(self._o, root)
        return r

    def inspect_get_format(self, root: str) -> str:
        """Before libguestfs 1.38, there was some unreliable
        support for detecting installer CDs. This API would
        return:

        "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.

        In libguestfs ≥ 1.38, this only returns "installed". Use
        libosinfo directly to detect installer CDs.

        Please read "INSPECTION" in guestfs(3) for more details.

        *This function is deprecated.* There is no replacement.
        Consult the API documentation in guestfs(3) for further
        information.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("do not use GuestFS.inspect_get_format()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.inspect_get_format(self._o, root)
        return r

    def inspect_get_hostname(self, root: str) -> str:
        """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.
        """
        self._check_not_closed()
        r = libguestfsmod.inspect_get_hostname(self._o, root)
        return r

    def inspect_get_icon(self, root: str, favicon: Optional[bool] = None,
                         highquality: Optional[bool] = None) -> bytes:
        """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(1) program from the "icoutils"
        package, and several programs (bmptopnm(1),
        pnmtopng(1), pamcut(1)) from the "netpbm" package.
        These must be installed separately.

        *   Operating system icons are usually trademarks. Seek
        legal advice before using trademarks in
        applications.
        """
        self._check_not_closed()
        r = libguestfsmod.inspect_get_icon(self._o, root, favicon, highquality)
        return r

    def inspect_get_major_version(self, root: str) -> int:
        """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.
        """
        self._check_not_closed()
        r = libguestfsmod.inspect_get_major_version(self._o, root)
        return r

    def inspect_get_minor_version(self, root: str) -> int:
        """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 "g.inspect_get_major_version".
        """
        self._check_not_closed()
        r = libguestfsmod.inspect_get_minor_version(self._o, root)
        return r

    def inspect_get_mountpoints(self, root: str) -> Union[List[Tuple[str,
                                str]], dict]:
        """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
        "g.inspect_get_drive_mappings".

        Please read "INSPECTION" in guestfs(3) for more details.
        See also "g.inspect_get_filesystems".

        This function returns a hash. If the GuestFS constructor
        was called with python_return_dict=True (recommended)
        then the return value is in fact a Python dict.
        Otherwise the return value is a list of pairs of
        strings, for compatibility with old code.
        """
        self._check_not_closed()
        r = libguestfsmod.inspect_get_mountpoints(self._o, root)
        r = self._maybe_convert_to_dict(r)
        return r

    def inspect_get_osinfo(self, root: str) -> str:
        """This function returns a possible short ID for libosinfo
        corresponding to the guest.

        *Note:* The returned ID is only a guess by libguestfs,
        and nothing ensures that it actually exists in
        osinfo-db.

        If no ID could not be determined, then the string
        "unknown" is returned.
        """
        self._check_not_closed()
        r = libguestfsmod.inspect_get_osinfo(self._o, root)
        return r

    def inspect_get_package_format(self, root: str) -> str:
        """This function and "g.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" or "dnf" (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", "apk", "xbps". Future
        versions of libguestfs may return other strings.

        Please read "INSPECTION" in guestfs(3) for more details.
        """
        self._check_not_closed()
        r = libguestfsmod.inspect_get_package_format(self._o, root)
        return r

    def inspect_get_package_management(self, root: str) -> str:
        """"g.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" or "dnf" (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", "dnf", "up2date", "apt"
        (for all Debian derivatives), "portage", "pisi",
        "pacman", "urpmi", "zypper", "apk", "xbps". Future
        versions of libguestfs may return other strings.

        Please read "INSPECTION" in guestfs(3) for more details.
        """
        self._check_not_closed()
        r = libguestfsmod.inspect_get_package_management(self._o, root)
        return r

    def inspect_get_product_name(self, root: str) -> str:
        """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.
        """
        self._check_not_closed()
        r = libguestfsmod.inspect_get_product_name(self._o, root)
        return r

    def inspect_get_product_variant(self, root: str) -> str:
        """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 "g.inspect_get_product_name",
        "g.inspect_get_major_version".
        """
        self._check_not_closed()
        r = libguestfsmod.inspect_get_product_variant(self._o, root)
        return r

    def inspect_get_roots(self) -> List[str]:
        """This function is a convenient way to get the list of
        root devices, as returned from a previous call to
        "g.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 "g.inspect_os".

        Please read "INSPECTION" in guestfs(3) for more details.

        This function returns a list of strings.
        """
        self._check_not_closed()
        r = libguestfsmod.inspect_get_roots(self._o)
        return r

    def inspect_get_type(self, root: str) -> str:
        """This returns the type of the inspected operating system.
        Currently defined types are:

        "linux"
        Any Linux-based operating system.

        "windows"
        Any Microsoft Windows operating system.

        "freebsd"
        FreeBSD.

        "netbsd"
        NetBSD.

        "openbsd"
        OpenBSD.

        "hurd"
        GNU/Hurd.

        "dos"
        MS-DOS, FreeDOS and others.

        "minix"
        MINIX.

        "unknown"
        The operating system type could not be determined.

        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.
        """
        self._check_not_closed()
        r = libguestfsmod.inspect_get_type(self._o, root)
        return r

    def inspect_get_windows_current_control_set(self, root: str) -> str:
        """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.
        """
        self._check_not_closed()
        r = libguestfsmod.inspect_get_windows_current_control_set(self._o,
                                                                  root)
        return r

    def inspect_get_windows_software_hive(self, root: str) -> str:
        """This returns the path to the hive (binary Windows
        Registry file) corresponding to HKLM\\SOFTWARE.

        This call assumes that the guest is Windows and that the
        guest has a software hive file with the right name. If
        this is not the case then an error is returned. This
        call does not check that the hive is a valid Windows
        Registry hive.

        You can use "g.hivex_open" to read or write to the hive.

        Please read "INSPECTION" in guestfs(3) for more details.
        """
        self._check_not_closed()
        r = libguestfsmod.inspect_get_windows_software_hive(self._o, root)
        return r

    def inspect_get_windows_system_hive(self, root: str) -> str:
        """This returns the path to the hive (binary Windows
        Registry file) corresponding to HKLM\\SYSTEM.

        This call assumes that the guest is Windows and that the
        guest has a system hive file with the right name. If
        this is not the case then an error is returned. This
        call does not check that the hive is a valid Windows
        Registry hive.

        You can use "g.hivex_open" to read or write to the hive.

        Please read "INSPECTION" in guestfs(3) for more details.
        """
        self._check_not_closed()
        r = libguestfsmod.inspect_get_windows_system_hive(self._o, root)
        return r

    def inspect_get_windows_systemroot(self, root: str) -> str:
        """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.
        """
        self._check_not_closed()
        r = libguestfsmod.inspect_get_windows_systemroot(self._o, root)
        return r

    def inspect_is_live(self, root: str) -> bool:
        """This is deprecated and always returns "false".

        Please read "INSPECTION" in guestfs(3) for more details.

        *This function is deprecated.* There is no replacement.
        Consult the API documentation in guestfs(3) for further
        information.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("do not use GuestFS.inspect_is_live()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.inspect_is_live(self._o, root)
        return r

    def inspect_is_multipart(self, root: str) -> bool:
        """This is deprecated and always returns "false".

        Please read "INSPECTION" in guestfs(3) for more details.

        *This function is deprecated.* There is no replacement.
        Consult the API documentation in guestfs(3) for further
        information.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("do not use GuestFS.inspect_is_multipart()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.inspect_is_multipart(self._o, root)
        return r

    def inspect_is_netinst(self, root: str) -> bool:
        """This is deprecated and always returns "false".

        Please read "INSPECTION" in guestfs(3) for more details.

        *This function is deprecated.* There is no replacement.
        Consult the API documentation in guestfs(3) for further
        information.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("do not use GuestFS.inspect_is_netinst()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.inspect_is_netinst(self._o, root)
        return r

    def inspect_list_applications(self, root: str) -> List[dict]:
        """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 "g.inspect_os",
        then "g.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 "g.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 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.

        This function returns a list of applications. Each
        application is represented as a dictionary.

        *This function is deprecated.* In new code, use the
        "inspect_list_applications2" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.inspect_list_applications2() "
                      "instead of GuestFS.inspect_list_applications()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.inspect_list_applications(self._o, root)
        return r

    def inspect_list_applications2(self, root: str) -> List[dict]:
        """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 "g.inspect_os",
        then "g.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 "g.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:

        "app2_name"
        The name of the application. For Linux guests, this
        is the package name.

        "app2_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
        "app2_name" instead.

        "app2_epoch"
        For package managers which use epochs, this contains
        the epoch of the package (an integer). If
        unavailable, this is returned as 0.

        "app2_version"
        The version string of the application or package. If
        unavailable this is returned as an empty string "".

        "app2_release"
        The release string of the application or package,
        for package managers that use this. If unavailable
        this is returned as an empty string "".

        "app2_arch"
        The architecture string of the application or
        package, for package managers that use this. If
        unavailable this is returned as an empty string "".

        "app2_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
        "".

        "app2_trans_path"
        The install path translated into a libguestfs path.
        If unavailable this is returned as an empty string
        "".

        "app2_publisher"
        The name of the publisher of the application, for
        package managers that use this. If unavailable this
        is returned as an empty string "".

        "app2_url"
        The URL (eg. upstream URL) of the application. If
        unavailable this is returned as an empty string "".

        "app2_source_package"
        For packaging systems which support this, the name
        of the source package. If unavailable this is
        returned as an empty string "".

        "app2_summary"
        A short (usually one line) description of the
        application or package. If unavailable this is
        returned as an empty string "".

        "app2_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.

        This function returns a list of application2s. Each
        application2 is represented as a dictionary.
        """
        self._check_not_closed()
        r = libguestfsmod.inspect_list_applications2(self._o, root)
        return r

    def inspect_os(self) -> List[str]:
        """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
        "g.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
        "g.mount_ro" and "g.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 "g.list_filesystems".

        This function returns a list of strings.
        """
        self._check_not_closed()
        r = libguestfsmod.inspect_os(self._o)
        return r

    def internal_exit(self) -> None:
        self._check_not_closed()
        r = libguestfsmod.internal_exit(self._o)
        return r

    def internal_test(self, str: str, optstr: Optional[str],
                      strlist: List[str], b: bool, integer: int,
                      integer64: int, filein: str, fileout: str,
                      bufferin: bytes, obool: Optional[bool] = None,
                      oint: Optional[int] = None, oint64: Optional[int] = None,
                      ostring: Optional[str] = None,
                      ostringlist: Optional[List[str]] = None) -> None:
        strlist = list(strlist)
        self._check_not_closed()
        r = libguestfsmod.internal_test(self._o, str, optstr, strlist, b,
                                        integer, integer64, filein, fileout,
                                        bufferin, obool, oint, oint64, ostring,
                                        ostringlist)
        return r

    def internal_test_63_optargs(self, opt1: Optional[int] = None,
                                 opt2: Optional[int] = None,
                                 opt3: Optional[int] = None,
                                 opt4: Optional[int] = None,
                                 opt5: Optional[int] = None,
                                 opt6: Optional[int] = None,
                                 opt7: Optional[int] = None,
                                 opt8: Optional[int] = None,
                                 opt9: Optional[int] = None,
                                 opt10: Optional[int] = None,
                                 opt11: Optional[int] = None,
                                 opt12: Optional[int] = None,
                                 opt13: Optional[int] = None,
                                 opt14: Optional[int] = None,
                                 opt15: Optional[int] = None,
                                 opt16: Optional[int] = None,
                                 opt17: Optional[int] = None,
                                 opt18: Optional[int] = None,
                                 opt19: Optional[int] = None,
                                 opt20: Optional[int] = None,
                                 opt21: Optional[int] = None,
                                 opt22: Optional[int] = None,
                                 opt23: Optional[int] = None,
                                 opt24: Optional[int] = None,
                                 opt25: Optional[int] = None,
                                 opt26: Optional[int] = None,
                                 opt27: Optional[int] = None,
                                 opt28: Optional[int] = None,
                                 opt29: Optional[int] = None,
                                 opt30: Optional[int] = None,
                                 opt31: Optional[int] = None,
                                 opt32: Optional[int] = None,
                                 opt33: Optional[int] = None,
                                 opt34: Optional[int] = None,
                                 opt35: Optional[int] = None,
                                 opt36: Optional[int] = None,
                                 opt37: Optional[int] = None,
                                 opt38: Optional[int] = None,
                                 opt39: Optional[int] = None,
                                 opt40: Optional[int] = None,
                                 opt41: Optional[int] = None,
                                 opt42: Optional[int] = None,
                                 opt43: Optional[int] = None,
                                 opt44: Optional[int] = None,
                                 opt45: Optional[int] = None,
                                 opt46: Optional[int] = None,
                                 opt47: Optional[int] = None,
                                 opt48: Optional[int] = None,
                                 opt49: Optional[int] = None,
                                 opt50: Optional[int] = None,
                                 opt51: Optional[int] = None,
                                 opt52: Optional[int] = None,
                                 opt53: Optional[int] = None,
                                 opt54: Optional[int] = None,
                                 opt55: Optional[int] = None,
                                 opt56: Optional[int] = None,
                                 opt57: Optional[int] = None,
                                 opt58: Optional[int] = None,
                                 opt59: Optional[int] = None,
                                 opt60: Optional[int] = None,
                                 opt61: Optional[int] = None,
                                 opt62: Optional[int] = None,
                                 opt63: Optional[int] = None) -> None:
        self._check_not_closed()
        r = libguestfsmod.internal_test_63_optargs(self._o, opt1, opt2, opt3,
                                                   opt4, opt5, opt6, opt7,
                                                   opt8, opt9, opt10, opt11,
                                                   opt12, opt13, opt14, opt15,
                                                   opt16, opt17, opt18, opt19,
                                                   opt20, opt21, opt22, opt23,
                                                   opt24, opt25, opt26, opt27,
                                                   opt28, opt29, opt30, opt31,
                                                   opt32, opt33, opt34, opt35,
                                                   opt36, opt37, opt38, opt39,
                                                   opt40, opt41, opt42, opt43,
                                                   opt44, opt45, opt46, opt47,
                                                   opt48, opt49, opt50, opt51,
                                                   opt52, opt53, opt54, opt55,
                                                   opt56, opt57, opt58, opt59,
                                                   opt60, opt61, opt62, opt63)
        return r

    def internal_test_close_output(self) -> None:
        self._check_not_closed()
        r = libguestfsmod.internal_test_close_output(self._o)
        return r

    def internal_test_only_optargs(self, test: Optional[int] = None) -> None:
        self._check_not_closed()
        r = libguestfsmod.internal_test_only_optargs(self._o, test)
        return r

    def internal_test_rbool(self, val: str) -> bool:
        self._check_not_closed()
        r = libguestfsmod.internal_test_rbool(self._o, val)
        return r

    def internal_test_rboolerr(self) -> bool:
        self._check_not_closed()
        r = libguestfsmod.internal_test_rboolerr(self._o)
        return r

    def internal_test_rbufferout(self, val: str) -> bytes:
        self._check_not_closed()
        r = libguestfsmod.internal_test_rbufferout(self._o, val)
        return r

    def internal_test_rbufferouterr(self) -> bytes:
        self._check_not_closed()
        r = libguestfsmod.internal_test_rbufferouterr(self._o)
        return r

    def internal_test_rconstoptstring(self, val: str) -> Optional[str]:
        self._check_not_closed()
        r = libguestfsmod.internal_test_rconstoptstring(self._o, val)
        return r

    def internal_test_rconstoptstringerr(self) -> Optional[str]:
        self._check_not_closed()
        r = libguestfsmod.internal_test_rconstoptstringerr(self._o)
        return r

    def internal_test_rconststring(self, val: str) -> str:
        self._check_not_closed()
        r = libguestfsmod.internal_test_rconststring(self._o, val)
        return r

    def internal_test_rconststringerr(self) -> str:
        self._check_not_closed()
        r = libguestfsmod.internal_test_rconststringerr(self._o)
        return r

    def internal_test_rhashtable(self, val: str) -> Union[List[Tuple[str,
                                 str]], dict]:
        self._check_not_closed()
        r = libguestfsmod.internal_test_rhashtable(self._o, val)
        r = self._maybe_convert_to_dict(r)
        return r

    def internal_test_rhashtableerr(self) -> Union[List[Tuple[str, str]],
                                    dict]:
        self._check_not_closed()
        r = libguestfsmod.internal_test_rhashtableerr(self._o)
        r = self._maybe_convert_to_dict(r)
        return r

    def internal_test_rint(self, val: str) -> int:
        self._check_not_closed()
        r = libguestfsmod.internal_test_rint(self._o, val)
        return r

    def internal_test_rint64(self, val: str) -> int:
        self._check_not_closed()
        r = libguestfsmod.internal_test_rint64(self._o, val)
        return r

    def internal_test_rint64err(self) -> int:
        self._check_not_closed()
        r = libguestfsmod.internal_test_rint64err(self._o)
        return r

    def internal_test_rinterr(self) -> int:
        self._check_not_closed()
        r = libguestfsmod.internal_test_rinterr(self._o)
        return r

    def internal_test_rstring(self, val: str) -> str:
        self._check_not_closed()
        r = libguestfsmod.internal_test_rstring(self._o, val)
        return r

    def internal_test_rstringerr(self) -> str:
        self._check_not_closed()
        r = libguestfsmod.internal_test_rstringerr(self._o)
        return r

    def internal_test_rstringlist(self, val: str) -> List[str]:
        self._check_not_closed()
        r = libguestfsmod.internal_test_rstringlist(self._o, val)
        return r

    def internal_test_rstringlisterr(self) -> List[str]:
        self._check_not_closed()
        r = libguestfsmod.internal_test_rstringlisterr(self._o)
        return r

    def internal_test_rstruct(self, val: str) -> dict:
        self._check_not_closed()
        r = libguestfsmod.internal_test_rstruct(self._o, val)
        return r

    def internal_test_rstructerr(self) -> dict:
        self._check_not_closed()
        r = libguestfsmod.internal_test_rstructerr(self._o)
        return r

    def internal_test_rstructlist(self, val: str) -> List[dict]:
        self._check_not_closed()
        r = libguestfsmod.internal_test_rstructlist(self._o, val)
        return r

    def internal_test_rstructlisterr(self) -> List[dict]:
        self._check_not_closed()
        r = libguestfsmod.internal_test_rstructlisterr(self._o)
        return r

    def internal_test_set_output(self, filename: str) -> None:
        self._check_not_closed()
        r = libguestfsmod.internal_test_set_output(self._o, filename)
        return r

    def is_blockdev(self, path: str,
                    followsymlinks: Optional[bool] = None) -> bool:
        """This returns "true" if and only if there is a block
        device with the given "path" name.

        If the optional flag "followsymlinks" is true, then a
        symlink (or chain of symlinks) that ends with a block
        device also causes the function to return true.

        This call only looks at files within the guest
        filesystem. Libguestfs partitions and block devices (eg.
        /dev/sda) cannot be used as the "path" parameter of this
        call.

        See also "g.stat".
        """
        self._check_not_closed()
        r = libguestfsmod.is_blockdev(self._o, path, followsymlinks)
        return r

    is_blockdev_opts = is_blockdev

    def is_busy(self) -> bool:
        """This always returns false. This function is deprecated
        with no replacement. Do not use this function.

        For more information on states, see guestfs(3).
        """
        self._check_not_closed()
        r = libguestfsmod.is_busy(self._o)
        return r

    def is_chardev(self, path: str,
                   followsymlinks: Optional[bool] = None) -> bool:
        """This returns "true" if and only if there is a character
        device with the given "path" name.

        If the optional flag "followsymlinks" is true, then a
        symlink (or chain of symlinks) that ends with a chardev
        also causes the function to return true.

        See also "g.stat".
        """
        self._check_not_closed()
        r = libguestfsmod.is_chardev(self._o, path, followsymlinks)
        return r

    is_chardev_opts = is_chardev

    def is_config(self) -> bool:
        """This returns true iff this handle is being configured
        (in the "CONFIG" state).

        For more information on states, see guestfs(3).
        """
        self._check_not_closed()
        r = libguestfsmod.is_config(self._o)
        return r

    def is_dir(self, path: str,
               followsymlinks: Optional[bool] = None) -> bool:
        """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.

        If the optional flag "followsymlinks" is true, then a
        symlink (or chain of symlinks) that ends with a
        directory also causes the function to return true.

        See also "g.stat".
        """
        self._check_not_closed()
        r = libguestfsmod.is_dir(self._o, path, followsymlinks)
        return r

    is_dir_opts = is_dir

    def is_fifo(self, path: str,
                followsymlinks: Optional[bool] = None) -> bool:
        """This returns "true" if and only if there is a FIFO
        (named pipe) with the given "path" name.

        If the optional flag "followsymlinks" is true, then a
        symlink (or chain of symlinks) that ends with a FIFO
        also causes the function to return true.

        See also "g.stat".
        """
        self._check_not_closed()
        r = libguestfsmod.is_fifo(self._o, path, followsymlinks)
        return r

    is_fifo_opts = is_fifo

    def is_file(self, path: str,
                followsymlinks: Optional[bool] = None) -> bool:
        """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.

        If the optional flag "followsymlinks" is true, then a
        symlink (or chain of symlinks) that ends with a file
        also causes the function to return true.

        See also "g.stat".
        """
        self._check_not_closed()
        r = libguestfsmod.is_file(self._o, path, followsymlinks)
        return r

    is_file_opts = is_file

    def is_launching(self) -> bool:
        """This returns true iff this handle is launching the
        subprocess (in the "LAUNCHING" state).

        For more information on states, see guestfs(3).
        """
        self._check_not_closed()
        r = libguestfsmod.is_launching(self._o)
        return r

    def is_lv(self, mountable: str) -> bool:
        """This command tests whether "mountable" is a logical
        volume, and returns true iff this is the case.
        """
        self._check_not_closed()
        r = libguestfsmod.is_lv(self._o, mountable)
        return r

    def is_ready(self) -> bool:
        """This returns true iff this handle is ready to accept
        commands (in the "READY" state).

        For more information on states, see guestfs(3).
        """
        self._check_not_closed()
        r = libguestfsmod.is_ready(self._o)
        return r

    def is_socket(self, path: str,
                  followsymlinks: Optional[bool] = None) -> bool:
        """This returns "true" if and only if there is a Unix
        domain socket with the given "path" name.

        If the optional flag "followsymlinks" is true, then a
        symlink (or chain of symlinks) that ends with a socket
        also causes the function to return true.

        See also "g.stat".
        """
        self._check_not_closed()
        r = libguestfsmod.is_socket(self._o, path, followsymlinks)
        return r

    is_socket_opts = is_socket

    def is_symlink(self, path: str) -> bool:
        """This returns "true" if and only if there is a symbolic
        link with the given "path" name.

        See also "g.stat".
        """
        self._check_not_closed()
        r = libguestfsmod.is_symlink(self._o, path)
        return r

    def is_whole_device(self, device: str) -> bool:
        """This returns "true" if and only if "device" refers to a
        whole block device. That is, not a partition or a
        logical device.
        """
        self._check_not_closed()
        r = libguestfsmod.is_whole_device(self._o, device)
        return r

    def is_zero(self, path: str) -> bool:
        """This returns true iff the file exists and the file is
        empty or it contains all zero bytes.
        """
        self._check_not_closed()
        r = libguestfsmod.is_zero(self._o, path)
        return r

    def is_zero_device(self, device: str) -> bool:
        """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.
        """
        self._check_not_closed()
        r = libguestfsmod.is_zero_device(self._o, device)
        return r

    def isoinfo(self, isofile: str) -> dict:
        """This is the same as "g.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
        "g.isoinfo_device".

        This function returns a dictionary, with keys matching
        the various fields in the guestfs_isoinfo structure.
        """
        self._check_not_closed()
        r = libguestfsmod.isoinfo(self._o, isofile)
        return r

    def isoinfo_device(self, device: str) -> dict:
        """"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
        <https://wiki.osdev.org/ISO_9660#The_Primary_Volume_Desc
        riptor>

        This function returns a dictionary, with keys matching
        the various fields in the guestfs_isoinfo structure.
        """
        self._check_not_closed()
        r = libguestfsmod.isoinfo_device(self._o, device)
        return r

    def journal_close(self) -> None:
        """Close the journal handle.

        This function depends on the feature "journal". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.journal_close(self._o)
        return r

    def journal_get(self) -> List[dict]:
        """Read the current journal entry. This returns all the
        fields in the journal as a set of "(attrname, attrval)"
        pairs. The "attrname" is the field name (a string).

        The "attrval" is the field value (a binary blob, often
        but not always a string). Please note that "attrval" is
        a byte array, *not* a \\0-terminated C string.

        The length of data may be truncated to the data
        threshold (see: "g.journal_set_data_threshold",
        "g.journal_get_data_threshold").

        If you set the data threshold to unlimited (0) then this
        call can read a journal entry of any size, ie. it is not
        limited by the libguestfs protocol.

        This function returns a list of xattrs. Each xattr is
        represented as a dictionary.

        This function depends on the feature "journal". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.journal_get(self._o)
        return r

    def journal_get_data_threshold(self) -> int:
        """Get the current data threshold for reading journal
        entries. This is a hint to the journal that it may
        truncate data fields to this size when reading them
        (note also that it may not truncate them). If this
        returns 0, then the threshold is unlimited.

        See also "g.journal_set_data_threshold".

        This function depends on the feature "journal". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.journal_get_data_threshold(self._o)
        return r

    def journal_get_realtime_usec(self) -> int:
        """Get the realtime (wallclock) timestamp of the current
        journal entry.

        This function depends on the feature "journal". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.journal_get_realtime_usec(self._o)
        return r

    def journal_next(self) -> bool:
        """Move to the next journal entry. You have to call this at
        least once after opening the handle before you are able
        to read data.

        The returned boolean tells you if there are any more
        journal records to read. "true" means you can read the
        next record (eg. using "g.journal_get"), and "false"
        means you have reached the end of the journal.

        This function depends on the feature "journal". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.journal_next(self._o)
        return r

    def journal_open(self, directory: str) -> None:
        """Open the systemd journal located in directory. Any
        previously opened journal handle is closed.

        The contents of the journal can be read using
        "g.journal_next" and "g.journal_get".

        After you have finished using the journal, you should
        close the handle by calling "g.journal_close".

        This function depends on the feature "journal". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.journal_open(self._o, directory)
        return r

    def journal_set_data_threshold(self, threshold: int) -> None:
        """Set the data threshold for reading journal entries. This
        is a hint to the journal that it may truncate data
        fields to this size when reading them (note also that it
        may not truncate them). If you set this to 0, then the
        threshold is unlimited.

        See also "g.journal_get_data_threshold".

        This function depends on the feature "journal". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.journal_set_data_threshold(self._o, threshold)
        return r

    def journal_skip(self, skip: int) -> int:
        """Skip forwards ("skip ≥ 0") or backwards ("skip < 0") in
        the journal.

        The number of entries actually skipped is returned (note
        "rskip ≥ 0"). If this is not the same as the absolute
        value of the skip parameter ("|skip|") you passed in
        then it means you have reached the end or the start of
        the journal.

        This function depends on the feature "journal". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.journal_skip(self._o, skip)
        return r

    def kill_subprocess(self) -> None:
        """This kills the hypervisor.

        Do not call this. See: "g.shutdown" instead.

        *This function is deprecated.* In new code, use the
        "shutdown" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.shutdown() "
                      "instead of GuestFS.kill_subprocess()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.kill_subprocess(self._o)
        return r

    def launch(self) -> None:
        """You should call this after configuring the handle (eg.
        adding drives) but before performing any actions.

        Do not call "g.launch" twice on the same handle.
        Although it will not give an error (for historical
        reasons), the precise behaviour when you do this is not
        well defined. Handles are very cheap to create, so
        create a new one for each launch.
        """
        self._check_not_closed()
        r = libguestfsmod.launch(self._o)
        return r

    def lchown(self, owner: int, group: int, path: str) -> None:
        """Change the file owner to "owner" and group to "group".
        This is like "g.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).
        """
        self._check_not_closed()
        r = libguestfsmod.lchown(self._o, owner, group, path)
        return r

    def ldmtool_create_all(self) -> None:
        """This function scans all block devices looking for
        Windows dynamic disk volumes and partitions, and creates
        devices for any that were found.

        Call "g.list_ldm_volumes" and "g.list_ldm_partitions" to
        return all devices.

        Note that you don't normally need to call this
        explicitly, since it is done automatically at "g.launch"
        time.

        This function depends on the feature "ldm". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.ldmtool_create_all(self._o)
        return r

    def ldmtool_diskgroup_disks(self, diskgroup: str) -> List[str]:
        """Return the disks in a Windows dynamic disk group. The
        "diskgroup" parameter should be the GUID of a disk
        group, one element from the list returned by
        "g.ldmtool_scan".

        This function returns a list of strings.

        This function depends on the feature "ldm". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.ldmtool_diskgroup_disks(self._o, diskgroup)
        return r

    def ldmtool_diskgroup_name(self, diskgroup: str) -> str:
        """Return the name of a Windows dynamic disk group. The
        "diskgroup" parameter should be the GUID of a disk
        group, one element from the list returned by
        "g.ldmtool_scan".

        This function depends on the feature "ldm". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.ldmtool_diskgroup_name(self._o, diskgroup)
        return r

    def ldmtool_diskgroup_volumes(self, diskgroup: str) -> List[str]:
        """Return the volumes in a Windows dynamic disk group. The
        "diskgroup" parameter should be the GUID of a disk
        group, one element from the list returned by
        "g.ldmtool_scan".

        This function returns a list of strings.

        This function depends on the feature "ldm". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.ldmtool_diskgroup_volumes(self._o, diskgroup)
        return r

    def ldmtool_remove_all(self) -> None:
        """This is essentially the opposite of
        "g.ldmtool_create_all". It removes the device mapper
        mappings for all Windows dynamic disk volumes

        This function depends on the feature "ldm". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.ldmtool_remove_all(self._o)
        return r

    def ldmtool_scan(self) -> List[str]:
        """This function scans for Windows dynamic disks. It
        returns a list of identifiers (GUIDs) for all disk
        groups that were found. These identifiers can be passed
        to other "g.ldmtool_*" functions.

        This function scans all block devices. To scan a subset
        of block devices, call "g.ldmtool_scan_devices" instead.

        This function returns a list of strings.

        This function depends on the feature "ldm". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.ldmtool_scan(self._o)
        return r

    def ldmtool_scan_devices(self, devices: List[str]) -> List[str]:
        """This function scans for Windows dynamic disks. It
        returns a list of identifiers (GUIDs) for all disk
        groups that were found. These identifiers can be passed
        to other "g.ldmtool_*" functions.

        The parameter "devices" is a list of block devices which
        are scanned. If this list is empty, all block devices
        are scanned.

        This function returns a list of strings.

        This function depends on the feature "ldm". See also
        "g.feature-available".
        """
        devices = list(devices)
        self._check_not_closed()
        r = libguestfsmod.ldmtool_scan_devices(self._o, devices)
        return r

    def ldmtool_volume_hint(self, diskgroup: str, volume: str) -> str:
        """Return the hint field of the volume named "volume" in
        the disk group with GUID "diskgroup". This may not be
        defined, in which case the empty string is returned. The
        hint field is often, though not always, the name of a
        Windows drive, eg. "E:".

        This function depends on the feature "ldm". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.ldmtool_volume_hint(self._o, diskgroup, volume)
        return r

    def ldmtool_volume_partitions(self, diskgroup: str,
                                  volume: str) -> List[str]:
        """Return the list of partitions in the volume named
        "volume" in the disk group with GUID "diskgroup".

        This function returns a list of strings.

        This function depends on the feature "ldm". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.ldmtool_volume_partitions(self._o, diskgroup, volume)
        return r

    def ldmtool_volume_type(self, diskgroup: str, volume: str) -> str:
        """Return the type of the volume named "volume" in the disk
        group with GUID "diskgroup".

        Possible volume types that can be returned here include:
        "simple", "spanned", "striped", "mirrored", "raid5".
        Other types may also be returned.

        This function depends on the feature "ldm". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.ldmtool_volume_type(self._o, diskgroup, volume)
        return r

    def lgetxattr(self, path: str, name: str) -> bytes:
        """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 "g.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: "g.lgetxattrs", "g.getxattr", attr(5).

        This function depends on the feature "linuxxattrs". See
        also "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.lgetxattr(self._o, path, name)
        return r

    def lgetxattrs(self, path: str) -> List[dict]:
        """This is the same as "g.getxattrs", but if "path" is a
        symbolic link, then it returns the extended attributes
        of the link itself.

        This function returns a list of xattrs. Each xattr is
        represented as a dictionary.

        This function depends on the feature "linuxxattrs". See
        also "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.lgetxattrs(self._o, path)
        return r

    def list_9p(self) -> List[str]:
        """This call does nothing and returns an error.

        This function returns a list of strings.

        *This function is deprecated.* There is no replacement.
        Consult the API documentation in guestfs(3) for further
        information.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("do not use GuestFS.list_9p()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.list_9p(self._o)
        return r

    def list_devices(self) -> List[str]:
        """List all the block devices.

        The full block device names are returned, eg. /dev/sda.

        See also "g.list_filesystems".

        This function returns a list of strings.
        """
        self._check_not_closed()
        r = libguestfsmod.list_devices(self._o)
        return r

    def list_disk_labels(self) -> Union[List[Tuple[str, str]], dict]:
        """If you add drives using the optional "label" parameter
        of "g.add_drive_opts", you can use this call to map
        between disk labels, and raw block device and partition
        names (like /dev/sda and /dev/sda1).

        This returns a hashtable, where keys are the disk labels
        (*without* the /dev/disk/guestfs prefix), and the values
        are the full raw block device and partition names (eg.
        /dev/sda and /dev/sda1).

        This function returns a hash. If the GuestFS constructor
        was called with python_return_dict=True (recommended)
        then the return value is in fact a Python dict.
        Otherwise the return value is a list of pairs of
        strings, for compatibility with old code.
        """
        self._check_not_closed()
        r = libguestfsmod.list_disk_labels(self._o)
        r = self._maybe_convert_to_dict(r)
        return r

    def list_dm_devices(self) -> List[str]:
        """List all device mapper devices.

        The returned list contains /dev/mapper/* devices, eg.
        ones created by a previous call to "g.luks_open".

        Device mapper devices which correspond to logical
        volumes are *not* returned in this list. Call "g.lvs" if
        you want to list logical volumes.

        This function returns a list of strings.
        """
        self._check_not_closed()
        r = libguestfsmod.list_dm_devices(self._o)
        return r

    def list_filesystems(self) -> Union[List[Tuple[str, str]], dict]:
        """This inspection command looks for filesystems on
        partitions, block devices and logical volumes, returning
        a list of "mountables" 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 key is not necessarily a block device. It may also
        be an opaque ‘mountable’ string which can be passed to
        "g.mount".

        The value can have the special value "unknown", meaning
        the content of the device is undetermined or empty.
        "swap" means a Linux swap partition.

        In libguestfs ≤ 1.36 this command ran other libguestfs
        commands, which might have included "g.mount" and
        "g.umount", and therefore you had to use this soon after
        launch and only when nothing else was mounted. This
        restriction is removed in libguestfs ≥ 1.38.

        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 "g.inspect_os" to look for OSes).

        This function returns a hash. If the GuestFS constructor
        was called with python_return_dict=True (recommended)
        then the return value is in fact a Python dict.
        Otherwise the return value is a list of pairs of
        strings, for compatibility with old code.
        """
        self._check_not_closed()
        r = libguestfsmod.list_filesystems(self._o)
        r = self._maybe_convert_to_dict(r)
        return r

    def list_ldm_partitions(self) -> List[str]:
        """This function returns all Windows dynamic disk
        partitions that were found at launch time. It returns a
        list of device names.

        This function returns a list of strings.

        This function depends on the feature "ldm". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.list_ldm_partitions(self._o)
        return r

    def list_ldm_volumes(self) -> List[str]:
        """This function returns all Windows dynamic disk volumes
        that were found at launch time. It returns a list of
        device names.

        This function returns a list of strings.

        This function depends on the feature "ldm". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.list_ldm_volumes(self._o)
        return r

    def list_md_devices(self) -> List[str]:
        """List all Linux md devices.

        This function returns a list of strings.
        """
        self._check_not_closed()
        r = libguestfsmod.list_md_devices(self._o)
        return r

    def list_partitions(self) -> List[str]:
        """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 "g.lvs".

        See also "g.list_filesystems".

        This function returns a list of strings.
        """
        self._check_not_closed()
        r = libguestfsmod.list_partitions(self._o)
        return r

    def ll(self, directory: str) -> str:
        """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.
        """
        self._check_not_closed()
        r = libguestfsmod.ll(self._o, directory)
        return r

    def llz(self, directory: str) -> str:
        """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.

        *This function is deprecated.* In new code, use the
        "lgetxattrs" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.lgetxattrs() "
                      "instead of GuestFS.llz()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.llz(self._o, directory)
        return r

    def ln(self, target: str, linkname: str) -> None:
        """This command creates a hard link.
        """
        self._check_not_closed()
        r = libguestfsmod.ln(self._o, target, linkname)
        return r

    def ln_f(self, target: str, linkname: str) -> None:
        """This command creates a hard link, removing the link
        "linkname" if it exists already.
        """
        self._check_not_closed()
        r = libguestfsmod.ln_f(self._o, target, linkname)
        return r

    def ln_s(self, target: str, linkname: str) -> None:
        """This command creates a symbolic link using the "ln -s"
        command.
        """
        self._check_not_closed()
        r = libguestfsmod.ln_s(self._o, target, linkname)
        return r

    def ln_sf(self, target: str, linkname: str) -> None:
        """This command creates a symbolic link using the "ln -sf"
        command, The *-f* option removes the link ("linkname")
        if it exists already.
        """
        self._check_not_closed()
        r = libguestfsmod.ln_sf(self._o, target, linkname)
        return r

    def lremovexattr(self, xattr: str, path: str) -> None:
        """This is the same as "g.removexattr", but if "path" is a
        symbolic link, then it removes an extended attribute of
        the link itself.

        This function depends on the feature "linuxxattrs". See
        also "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.lremovexattr(self._o, xattr, path)
        return r

    def ls(self, directory: str) -> List[str]:
        """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 function returns a list of strings.
        """
        self._check_not_closed()
        r = libguestfsmod.ls(self._o, directory)
        return r

    def ls0(self, dir: str, filenames: str) -> None:
        """This specialized command is used to get a listing of the
        filenames in the directory "dir". The list of filenames
        is written to the local file filenames (on the host).

        In the output file, the filenames are separated by "\\0"
        characters.

        "." and ".." are not returned. The filenames are not
        sorted.
        """
        self._check_not_closed()
        r = libguestfsmod.ls0(self._o, dir, filenames)
        return r

    def lsetxattr(self, xattr: str, val: str, vallen: int, path: str) -> None:
        """This is the same as "g.setxattr", but if "path" is a
        symbolic link, then it sets an extended attribute of the
        link itself.

        This function depends on the feature "linuxxattrs". See
        also "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.lsetxattr(self._o, xattr, val, vallen, path)
        return r

    def lstat(self, path: str) -> dict:
        """Returns file information for the given "path".

        This is the same as "g.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.

        This function returns a dictionary, with keys matching
        the various fields in the guestfs_stat structure.

        *This function is deprecated.* In new code, use the
        "lstatns" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.lstatns() "
                      "instead of GuestFS.lstat()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.lstat(self._o, path)
        return r

    def lstatlist(self, path: str, names: List[str]) -> List[dict]:
        """This call allows you to perform the "g.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
        "st_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 "g.lxattrlist" for a
        similarly efficient call for getting extended
        attributes.

        This function returns a list of stats. Each stat is
        represented as a dictionary.

        *This function is deprecated.* In new code, use the
        "lstatnslist" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        names = list(names)
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.lstatnslist() "
                      "instead of GuestFS.lstatlist()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.lstatlist(self._o, path, names)
        return r

    def lstatns(self, path: str) -> dict:
        """Returns file information for the given "path".

        This is the same as "g.statns" 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.

        This function returns a dictionary, with keys matching
        the various fields in the guestfs_statns structure.
        """
        self._check_not_closed()
        r = libguestfsmod.lstatns(self._o, path)
        return r

    def lstatnslist(self, path: str, names: List[str]) -> List[dict]:
        """This call allows you to perform the "g.lstatns"
        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
        "st_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 "g.lxattrlist" for a
        similarly efficient call for getting extended
        attributes.

        This function returns a list of statnss. Each statns is
        represented as a dictionary.
        """
        names = list(names)
        self._check_not_closed()
        r = libguestfsmod.lstatnslist(self._o, path, names)
        return r

    def luks_add_key(self, device: str, key: str, newkey: str,
                     keyslot: int) -> None:
        """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 "g.luks_kill_slot"
        first to remove that key.

        This function depends on the feature "luks". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.luks_add_key(self._o, device, key, newkey, keyslot)
        return r

    def luks_close(self, device: str) -> None:
        """This closes a LUKS device that was created earlier by
        "g.luks_open" or "g.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.

        *This function is deprecated.* In new code, use the
        "cryptsetup_close" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.

        This function depends on the feature "luks". See also
        "g.feature-available".
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.cryptsetup_close() "
                      "instead of GuestFS.luks_close()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.luks_close(self._o, device)
        return r

    def luks_format(self, device: str, key: str, keyslot: int) -> None:
        """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 "keyslot".
        (LUKS supports 8 key slots, numbered 0-7).

        This function depends on the feature "luks". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.luks_format(self._o, device, key, keyslot)
        return r

    def luks_format_cipher(self, device: str, key: str, keyslot: int,
                           cipher: str) -> None:
        """This command is the same as "g.luks_format" but it also
        allows you to set the "cipher" used.

        This function depends on the feature "luks". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.luks_format_cipher(self._o, device, key, keyslot,
                                             cipher)
        return r

    def luks_kill_slot(self, device: str, key: str, keyslot: int) -> None:
        """This command deletes the key in key slot "keyslot" from
        the encrypted LUKS device "device". "key" must be one of
        the *other* keys.

        This function depends on the feature "luks". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.luks_kill_slot(self._o, device, key, keyslot)
        return r

    def luks_open(self, device: str, key: str, mapname: str) -> None:
        """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 "g.lvm_scan" with the "activate" parameter
        "true" will make them visible.

        Use "g.list_dm_devices" to list all device mapper
        devices.

        *This function is deprecated.* In new code, use the
        "cryptsetup_open" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.

        This function depends on the feature "luks". See also
        "g.feature-available".
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.cryptsetup_open() "
                      "instead of GuestFS.luks_open()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.luks_open(self._o, device, key, mapname)
        return r

    def luks_open_ro(self, device: str, key: str, mapname: str) -> None:
        """This is the same as "g.luks_open" except that a
        read-only mapping is created.

        *This function is deprecated.* In new code, use the
        "cryptsetup_open" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.

        This function depends on the feature "luks". See also
        "g.feature-available".
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.cryptsetup_open() "
                      "instead of GuestFS.luks_open_ro()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.luks_open_ro(self._o, device, key, mapname)
        return r

    def luks_uuid(self, device: str) -> str:
        """This returns the UUID of the LUKS device "device".

        This function depends on the feature "luks". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.luks_uuid(self._o, device)
        return r

    def lvcreate(self, logvol: str, volgroup: str, mbytes: int) -> None:
        """This creates an LVM logical volume called "logvol" on
        the volume group "volgroup", with "size" megabytes.

        This function depends on the feature "lvm2". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.lvcreate(self._o, logvol, volgroup, mbytes)
        return r

    def lvcreate_free(self, logvol: str, volgroup: str, percent: int) -> None:
        """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.

        This function depends on the feature "lvm2". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.lvcreate_free(self._o, logvol, volgroup, percent)
        return r

    def lvm_canonical_lv_name(self, lvname: str) -> str:
        """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. In this case errno
        will be set to "EINVAL".

        See also "g.is_lv", "g.canonical_device_name".
        """
        self._check_not_closed()
        r = libguestfsmod.lvm_canonical_lv_name(self._o, lvname)
        return r

    def lvm_clear_filter(self) -> None:
        """This undoes the effect of "g.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.
        """
        self._check_not_closed()
        r = libguestfsmod.lvm_clear_filter(self._o)
        return r

    def lvm_remove_all(self) -> None:
        """This command removes all LVM logical volumes, volume
        groups and physical volumes.

        This function depends on the feature "lvm2". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.lvm_remove_all(self._o)
        return r

    def lvm_scan(self, activate: bool) -> None:
        """This scans all block devices and rebuilds the list of
        LVM physical volumes, volume groups and logical volumes.

        If the "activate" parameter is "true" then newly found
        volume groups and logical volumes are activated, meaning
        the LV /dev/VG/LV devices become visible.

        When a libguestfs handle is launched it scans for
        existing devices, so you do not normally need to use
        this API. However it is useful when you have added a new
        device or deleted an existing device (such as when the
        "g.luks_open" API is used).
        """
        self._check_not_closed()
        r = libguestfsmod.lvm_scan(self._o, activate)
        return r

    def lvm_set_filter(self, devices: List[str]) -> None:
        """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.

        This function depends on the feature "lvm2". See also
        "g.feature-available".
        """
        devices = list(devices)
        self._check_not_closed()
        r = libguestfsmod.lvm_set_filter(self._o, devices)
        return r

    def lvremove(self, device: str) -> None:
        """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.

        This function depends on the feature "lvm2". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.lvremove(self._o, device)
        return r

    def lvrename(self, logvol: str, newlogvol: str) -> None:
        """Rename a logical volume "logvol" with the new name
        "newlogvol".
        """
        self._check_not_closed()
        r = libguestfsmod.lvrename(self._o, logvol, newlogvol)
        return r

    def lvresize(self, device: str, mbytes: int) -> None:
        """This resizes (expands or shrinks) an existing LVM
        logical volume to "mbytes". When reducing, data in the
        reduced part is lost.

        This function depends on the feature "lvm2". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.lvresize(self._o, device, mbytes)
        return r

    def lvresize_free(self, lv: str, percent: int) -> None:
        """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.

        This function depends on the feature "lvm2". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.lvresize_free(self._o, lv, percent)
        return r

    def lvs(self) -> List[str]:
        """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 "g.lvs_full", "g.list_filesystems".

        This function returns a list of strings.

        This function depends on the feature "lvm2". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.lvs(self._o)
        return r

    def lvs_full(self) -> List[dict]:
        """List all the logical volumes detected. This is the
        equivalent of the lvs(8) command. The "full" version
        includes all fields.

        This function returns a list of lvm_lvs. Each lvm_lv is
        represented as a dictionary.

        This function depends on the feature "lvm2". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.lvs_full(self._o)
        return r

    def lvuuid(self, device: str) -> str:
        """This command returns the UUID of the LVM LV "device".
        """
        self._check_not_closed()
        r = libguestfsmod.lvuuid(self._o, device)
        return r

    def lxattrlist(self, path: str, names: List[str]) -> List[dict]:
        """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 "g.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 "g.lstatlist" for a similarly
        efficient call for getting standard stats.

        This function returns a list of xattrs. Each xattr is
        represented as a dictionary.

        This function depends on the feature "linuxxattrs". See
        also "g.feature-available".
        """
        names = list(names)
        self._check_not_closed()
        r = libguestfsmod.lxattrlist(self._o, path, names)
        return r

    def max_disks(self) -> int:
        """Return the maximum number of disks that may be added to
        a handle (eg. by "g.add_drive_opts" and similar calls).

        This function was added in libguestfs 1.19.7. In
        previous versions of libguestfs the limit was 25.

        See "MAXIMUM NUMBER OF DISKS" in guestfs(3) for
        additional information on this topic.
        """
        self._check_not_closed()
        r = libguestfsmod.max_disks(self._o)
        return r

    def md_create(self, name: str, devices: List[str],
                  missingbitmap: Optional[int] = None,
                  nrdevices: Optional[int] = None, spare: Optional[int] = None,
                  chunk: Optional[int] = None,
                  level: Optional[str] = None) -> None:
        """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.

        The "chunk" parameter does not make sense, and
        should not be specified, when "level" is "raid1"
        (which is the default; see below).

        "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".

        This function depends on the feature "mdadm". See also
        "g.feature-available".
        """
        devices = list(devices)
        self._check_not_closed()
        r = libguestfsmod.md_create(self._o, name, devices, missingbitmap,
                                    nrdevices, spare, chunk, level)
        return r

    def md_detail(self, md: str) -> Union[List[Tuple[str, str]], dict]:
        """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.

        This function returns a hash. If the GuestFS constructor
        was called with python_return_dict=True (recommended)
        then the return value is in fact a Python dict.
        Otherwise the return value is a list of pairs of
        strings, for compatibility with old code.

        This function depends on the feature "mdadm". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.md_detail(self._o, md)
        r = self._maybe_convert_to_dict(r)
        return r

    def md_stat(self, md: str) -> List[dict]:
        """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
        "g.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

        This function returns a list of mdstats. Each mdstat is
        represented as a dictionary.

        This function depends on the feature "mdadm". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.md_stat(self._o, md)
        return r

    def md_stop(self, md: str) -> None:
        """This command deactivates the MD array named "md". The
        device is stopped, but it is not destroyed or zeroed.

        This function depends on the feature "mdadm". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.md_stop(self._o, md)
        return r

    def mkdir(self, path: str) -> None:
        """Create a directory named "path".
        """
        self._check_not_closed()
        r = libguestfsmod.mkdir(self._o, path)
        return r

    def mkdir_mode(self, path: str, mode: int) -> None:
        """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 "g.mkdir", "g.umask"
        """
        self._check_not_closed()
        r = libguestfsmod.mkdir_mode(self._o, path, mode)
        return r

    def mkdir_p(self, path: str) -> None:
        """Create a directory named "path", creating any parent
        directories as necessary. This is like the "mkdir -p"
        shell command.
        """
        self._check_not_closed()
        r = libguestfsmod.mkdir_p(self._o, path)
        return r

    def mkdtemp(self, tmpl: str) -> str:
        """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)
        """
        self._check_not_closed()
        r = libguestfsmod.mkdtemp(self._o, tmpl)
        return r

    def mke2fs(self, device: str, blockscount: Optional[int] = None,
               blocksize: Optional[int] = None, fragsize: Optional[int] = None,
               blockspergroup: Optional[int] = None,
               numberofgroups: Optional[int] = None,
               bytesperinode: Optional[int] = None,
               inodesize: Optional[int] = None,
               journalsize: Optional[int] = None,
               numberofinodes: Optional[int] = None,
               stridesize: Optional[int] = None,
               stripewidth: Optional[int] = None,
               maxonlineresize: Optional[int] = None,
               reservedblockspercentage: Optional[int] = None,
               mmpupdateinterval: Optional[int] = None,
               journaldevice: Optional[str] = None,
               label: Optional[str] = None,
               lastmounteddir: Optional[str] = None,
               creatoros: Optional[str] = None, fstype: Optional[str] = None,
               usagetype: Optional[str] = None, uuid: Optional[str] = None,
               forcecreate: Optional[bool] = None,
               writesbandgrouponly: Optional[bool] = None,
               lazyitableinit: Optional[bool] = None,
               lazyjournalinit: Optional[bool] = None,
               testfs: Optional[bool] = None, discard: Optional[bool] = None,
               quotatype: Optional[bool] = None, extent: Optional[bool] = None,
               filetype: Optional[bool] = None, flexbg: Optional[bool] = None,
               hasjournal: Optional[bool] = None,
               journaldev: Optional[bool] = None,
               largefile: Optional[bool] = None, quota: Optional[bool] = None,
               resizeinode: Optional[bool] = None,
               sparsesuper: Optional[bool] = None,
               uninitbg: Optional[bool] = None) -> None:
        """"mke2fs" is used to create an ext2, ext3, or ext4
        filesystem on "device".

        The optional "blockscount" is the size of the filesystem
        in blocks. If omitted it defaults to the size of
        "device". Note if the filesystem is too small to contain
        a journal, "mke2fs" will silently create an ext2
        filesystem instead.
        """
        self._check_not_closed()
        r = libguestfsmod.mke2fs(self._o, device, blockscount, blocksize,
                                 fragsize, blockspergroup, numberofgroups,
                                 bytesperinode, inodesize, journalsize,
                                 numberofinodes, stridesize, stripewidth,
                                 maxonlineresize, reservedblockspercentage,
                                 mmpupdateinterval, journaldevice, label,
                                 lastmounteddir, creatoros, fstype, usagetype,
                                 uuid, forcecreate, writesbandgrouponly,
                                 lazyitableinit, lazyjournalinit, testfs,
                                 discard, quotatype, extent, filetype, flexbg,
                                 hasjournal, journaldev, largefile, quota,
                                 resizeinode, sparsesuper, uninitbg)
        return r

    def mke2fs_J(self, fstype: str, blocksize: int, device: str,
                 journal: str) -> None:
        """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 "g.mke2journal".

        *This function is deprecated.* In new code, use the
        "mke2fs" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.mke2fs() "
                      "instead of GuestFS.mke2fs_J()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.mke2fs_J(self._o, fstype, blocksize, device, journal)
        return r

    def mke2fs_JL(self, fstype: str, blocksize: int, device: str,
                  label: str) -> None:
        """This creates an ext2/3/4 filesystem on "device" with an
        external journal on the journal labeled "label".

        See also "g.mke2journal_L".

        *This function is deprecated.* In new code, use the
        "mke2fs" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.mke2fs() "
                      "instead of GuestFS.mke2fs_JL()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.mke2fs_JL(self._o, fstype, blocksize, device, label)
        return r

    def mke2fs_JU(self, fstype: str, blocksize: int, device: str,
                  uuid: str) -> None:
        """This creates an ext2/3/4 filesystem on "device" with an
        external journal on the journal with UUID "uuid".

        See also "g.mke2journal_U".

        *This function is deprecated.* In new code, use the
        "mke2fs" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.

        This function depends on the feature "linuxfsuuid". See
        also "g.feature-available".
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.mke2fs() "
                      "instead of GuestFS.mke2fs_JU()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.mke2fs_JU(self._o, fstype, blocksize, device, uuid)
        return r

    def mke2journal(self, blocksize: int, device: str) -> None:
        """This creates an ext2 external journal on "device". It is
        equivalent to the command:

        mke2fs -O journal_dev -b blocksize device

        *This function is deprecated.* In new code, use the
        "mke2fs" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.mke2fs() "
                      "instead of GuestFS.mke2journal()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.mke2journal(self._o, blocksize, device)
        return r

    def mke2journal_L(self, blocksize: int, label: str, device: str) -> None:
        """This creates an ext2 external journal on "device" with
        label "label".

        *This function is deprecated.* In new code, use the
        "mke2fs" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.mke2fs() "
                      "instead of GuestFS.mke2journal_L()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.mke2journal_L(self._o, blocksize, label, device)
        return r

    def mke2journal_U(self, blocksize: int, uuid: str, device: str) -> None:
        """This creates an ext2 external journal on "device" with
        UUID "uuid".

        *This function is deprecated.* In new code, use the
        "mke2fs" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.

        This function depends on the feature "linuxfsuuid". See
        also "g.feature-available".
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.mke2fs() "
                      "instead of GuestFS.mke2journal_U()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.mke2journal_U(self._o, blocksize, uuid, device)
        return r

    def mkfifo(self, mode: int, path: str) -> None:
        """This call creates a FIFO (named pipe) called "path" with
        mode "mode". It is just a convenient wrapper around
        "g.mknod".

        Unlike with "g.mknod", "mode" must contain only
        permissions bits.

        The mode actually set is affected by the umask.

        This function depends on the feature "mknod". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.mkfifo(self._o, mode, path)
        return r

    def mkfs(self, fstype: str, device: str, blocksize: Optional[int] = None,
             features: Optional[str] = None, inode: Optional[int] = None,
             sectorsize: Optional[int] = None,
             label: Optional[str] = None) -> None:
        """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.
        """
        self._check_not_closed()
        r = libguestfsmod.mkfs(self._o, fstype, device, blocksize, features,
                               inode, sectorsize, label)
        return r

    mkfs_opts = mkfs

    def mkfs_b(self, fstype: str, blocksize: int, device: str) -> None:
        """This call is similar to "g.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.

        *This function is deprecated.* In new code, use the
        "mkfs" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.mkfs() "
                      "instead of GuestFS.mkfs_b()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.mkfs_b(self._o, fstype, blocksize, device)
        return r

    def mkfs_btrfs(self, devices: List[str], allocstart: Optional[int] = None,
                   bytecount: Optional[int] = None,
                   datatype: Optional[str] = None,
                   leafsize: Optional[int] = None, label: Optional[str] = None,
                   metadata: Optional[str] = None,
                   nodesize: Optional[int] = None,
                   sectorsize: Optional[int] = None) -> None:
        """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 "g.mkfs".

        This function depends on the feature "btrfs". See also
        "g.feature-available".
        """
        devices = list(devices)
        self._check_not_closed()
        r = libguestfsmod.mkfs_btrfs(self._o, devices, allocstart, bytecount,
                                     datatype, leafsize, label, metadata,
                                     nodesize, sectorsize)
        return r

    def mklost_and_found(self, mountpoint: str) -> None:
        """Make the "lost+found" directory, normally in the root
        directory of an ext2/3/4 filesystem. "mountpoint" is the
        directory under which we try to create the "lost+found"
        directory.
        """
        self._check_not_closed()
        r = libguestfsmod.mklost_and_found(self._o, mountpoint)
        return r

    def mkmountpoint(self, exemptpath: str) -> None:
        """"g.mkmountpoint" and "g.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.

        "g.mkmountpoint" is not compatible with "g.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.

        "g.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
        <https://bugzilla.redhat.com/show_bug.cgi?id=599503>

        Autosync [see "g.set_autosync", this is set by default
        on handles] can cause "g.umount_all" to be called when
        the handle is closed which can also trigger these
        issues.
        """
        self._check_not_closed()
        r = libguestfsmod.mkmountpoint(self._o, exemptpath)
        return r

    def mknod(self, mode: int, devmajor: int, devminor: int,
              path: str) -> None:
        """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 "g.mknod_b", "g.mknod_c" or
        "g.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.

        This function depends on the feature "mknod". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.mknod(self._o, mode, devmajor, devminor, path)
        return r

    def mknod_b(self, mode: int, devmajor: int, devminor: int,
                path: str) -> None:
        """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
        "g.mknod".

        Unlike with "g.mknod", "mode" must contain only
        permissions bits.

        The mode actually set is affected by the umask.

        This function depends on the feature "mknod". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.mknod_b(self._o, mode, devmajor, devminor, path)
        return r

    def mknod_c(self, mode: int, devmajor: int, devminor: int,
                path: str) -> None:
        """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
        "g.mknod".

        Unlike with "g.mknod", "mode" must contain only
        permissions bits.

        The mode actually set is affected by the umask.

        This function depends on the feature "mknod". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.mknod_c(self._o, mode, devmajor, devminor, path)
        return r

    def mksquashfs(self, path: str, filename: str,
                   compress: Optional[str] = None,
                   excludes: Optional[List[str]] = None) -> None:
        """Create a squashfs filesystem for the specified "path".

        The optional "compress" flag controls compression. If
        not given, then the output compressed using "gzip".
        Otherwise one of the following strings may be given to
        select the compression type of the squashfs: "gzip",
        "lzma", "lzo", "lz4", "xz".

        The other optional arguments are:

        "excludes"
        A list of wildcards. Files are excluded if they
        match any of the wildcards.

        Please note that this API may fail when used to compress
        directories with large files, such as the resulting
        squashfs will be over 3GB big.

        This function depends on the feature "squashfs". See
        also "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.mksquashfs(self._o, path, filename, compress,
                                     excludes)
        return r

    def mkswap(self, device: str, label: Optional[str] = None,
               uuid: Optional[str] = None) -> None:
        """Create a Linux swap partition on "device".

        The option arguments "label" and "uuid" allow you to set
        the label and/or UUID of the new swap partition.
        """
        self._check_not_closed()
        r = libguestfsmod.mkswap(self._o, device, label, uuid)
        return r

    mkswap_opts = mkswap

    def mkswap_L(self, label: str, device: str) -> None:
        """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.

        *This function is deprecated.* In new code, use the
        "mkswap" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.mkswap() "
                      "instead of GuestFS.mkswap_L()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.mkswap_L(self._o, label, device)
        return r

    def mkswap_U(self, uuid: str, device: str) -> None:
        """Create a swap partition on "device" with UUID "uuid".

        *This function is deprecated.* In new code, use the
        "mkswap" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.

        This function depends on the feature "linuxfsuuid". See
        also "g.feature-available".
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.mkswap() "
                      "instead of GuestFS.mkswap_U()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.mkswap_U(self._o, uuid, device)
        return r

    def mkswap_file(self, path: str) -> None:
        """Create a swap file.

        This command just writes a swap file signature to an
        existing file. To create the file itself, use something
        like "g.fallocate".
        """
        self._check_not_closed()
        r = libguestfsmod.mkswap_file(self._o, path)
        return r

    def mktemp(self, tmpl: str, suffix: Optional[str] = None) -> str:
        """This command creates a temporary file. 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 file that was created is
        returned.

        The temporary file is created with mode 0600 and is
        owned by root.

        The caller is responsible for deleting the temporary
        file after use.

        If the optional "suffix" parameter is given, then the
        suffix (eg. ".txt") is appended to the temporary name.

        See also: "g.mkdtemp".
        """
        self._check_not_closed()
        r = libguestfsmod.mktemp(self._o, tmpl, suffix)
        return r

    def modprobe(self, modulename: str) -> None:
        """This loads a kernel module in the appliance.

        This function depends on the feature "linuxmodules". See
        also "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.modprobe(self._o, modulename)
        return r

    def mount(self, mountable: str, mountpoint: str) -> None:
        """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,
        or ‘mountable’ strings returned by "g.list_filesystems"
        or "g.inspect_get_mountpoints".

        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 "g.mount_options" instead
        (using an empty string for the first parameter if you
        don't want any options).
        """
        self._check_not_closed()
        r = libguestfsmod.mount(self._o, mountable, mountpoint)
        return r

    def mount_9p(self, mounttag: str, mountpoint: str,
                 options: Optional[str] = None) -> None:
        """This call does nothing and returns an error.

        *This function is deprecated.* There is no replacement.
        Consult the API documentation in guestfs(3) for further
        information.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("do not use GuestFS.mount_9p()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.mount_9p(self._o, mounttag, mountpoint, options)
        return r

    def mount_local(self, localmountpoint: str,
                    readonly: Optional[bool] = None,
                    options: Optional[str] = None,
                    cachetimeout: Optional[int] = None,
                    debugcalls: Optional[bool] = None) -> None:
        """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 "g.mount_local" returns, the filesystem is ready,
        but is not processing requests (access to it will
        block). You have to call "g.mount_local_run" to run the
        main loop.

        See "MOUNT LOCAL" in guestfs(3) for full documentation.
        """
        self._check_not_closed()
        r = libguestfsmod.mount_local(self._o, localmountpoint, readonly,
                                      options, cachetimeout, debugcalls)
        return r

    def mount_local_run(self) -> None:
        """Run the main loop which translates kernel calls to
        libguestfs calls.

        This should only be called after "g.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.

        You may call this from a different thread than the one
        which called "g.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.
        """
        self._check_not_closed()
        r = libguestfsmod.mount_local_run(self._o)
        return r

    def mount_loop(self, file: str, mountpoint: str) -> None:
        """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".
        """
        self._check_not_closed()
        r = libguestfsmod.mount_loop(self._o, file, mountpoint)
        return r

    def mount_options(self, options: str, mountable: str,
                      mountpoint: str) -> None:
        """This is the same as the "g.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).
        """
        self._check_not_closed()
        r = libguestfsmod.mount_options(self._o, options, mountable,
                                        mountpoint)
        return r

    def mount_ro(self, mountable: str, mountpoint: str) -> None:
        """This is the same as the "g.mount" command, but it mounts
        the filesystem with the read-only (*-o ro*) flag.
        """
        self._check_not_closed()
        r = libguestfsmod.mount_ro(self._o, mountable, mountpoint)
        return r

    def mount_vfs(self, options: str, vfstype: str, mountable: str,
                  mountpoint: str) -> None:
        """This is the same as the "g.mount" command, but it allows
        you to set both the mount options and the vfstype as for
        the mount(8) *-o* and *-t* flags.
        """
        self._check_not_closed()
        r = libguestfsmod.mount_vfs(self._o, options, vfstype, mountable,
                                    mountpoint)
        return r

    def mountable_device(self, mountable: str) -> str:
        """Returns the device name of a mountable. In quite a lot
        of cases, the mountable is the device name.

        However this doesn't apply for btrfs subvolumes, where
        the mountable is a combination of both the device name
        and the subvolume path (see also "g.mountable_subvolume"
        to extract the subvolume path of the mountable if any).
        """
        self._check_not_closed()
        r = libguestfsmod.mountable_device(self._o, mountable)
        return r

    def mountable_subvolume(self, mountable: str) -> str:
        """Returns the subvolume path of a mountable. Btrfs
        subvolumes mountables are a combination of both the
        device name and the subvolume path (see also
        "g.mountable_device" to extract the device of the
        mountable).

        If the mountable does not represent a btrfs subvolume,
        then this function fails and the "errno" is set to
        "EINVAL".
        """
        self._check_not_closed()
        r = libguestfsmod.mountable_subvolume(self._o, mountable)
        return r

    def mountpoints(self) -> Union[List[Tuple[str, str]], dict]:
        """This call is similar to "g.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.

        This function returns a hash. If the GuestFS constructor
        was called with python_return_dict=True (recommended)
        then the return value is in fact a Python dict.
        Otherwise the return value is a list of pairs of
        strings, for compatibility with old code.
        """
        self._check_not_closed()
        r = libguestfsmod.mountpoints(self._o)
        r = self._maybe_convert_to_dict(r)
        return r

    def mounts(self) -> List[str]:
        """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: "g.mountpoints"

        This function returns a list of strings.
        """
        self._check_not_closed()
        r = libguestfsmod.mounts(self._o)
        return r

    def mv(self, src: str, dest: str) -> None:
        """This moves a file from "src" to "dest" where "dest" is
        either a destination filename or destination directory.

        See also: "g.rename".
        """
        self._check_not_closed()
        r = libguestfsmod.mv(self._o, src, dest)
        return r

    def nr_devices(self) -> int:
        """This returns the number of whole block devices that were
        added. This is the same as the number of devices that
        would be returned if you called "g.list_devices".

        To find out the maximum number of devices that could be
        added, call "g.max_disks".
        """
        self._check_not_closed()
        r = libguestfsmod.nr_devices(self._o)
        return r

    def ntfs_3g_probe(self, rw: bool, device: str) -> int:
        """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.

        This function depends on the feature "ntfs3g". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.ntfs_3g_probe(self._o, rw, device)
        return r

    def ntfscat_i(self, device: str, inode: int, filename: str) -> None:
        """Download a file given its inode from a NTFS filesystem
        and save it as filename on the local machine.

        This allows to download some otherwise inaccessible
        files such as the ones within the $Extend folder.

        The filesystem from which to extract the file must be
        unmounted, otherwise the call will fail.
        """
        self._check_not_closed()
        r = libguestfsmod.ntfscat_i(self._o, device, inode, filename)
        return r

    def ntfsclone_in(self, backupfile: str, device: str) -> None:
        """Restore the "backupfile" (from a previous call to
        "g.ntfsclone_out") to "device", overwriting any existing
        contents of this device.

        This function depends on the feature "ntfs3g". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.ntfsclone_in(self._o, backupfile, device)
        return r

    def ntfsclone_out(self, device: str, backupfile: str,
                      metadataonly: Optional[bool] = None,
                      rescue: Optional[bool] = None,
                      ignorefscheck: Optional[bool] = None,
                      preservetimestamps: Optional[bool] = None,
                      force: Optional[bool] = None) -> None:
        """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 "g.ntfsclone_in" to restore the file back to a
        libguestfs device.

        This function depends on the feature "ntfs3g". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.ntfsclone_out(self._o, device, backupfile,
                                        metadataonly, rescue, ignorefscheck,
                                        preservetimestamps, force)
        return r

    def ntfsfix(self, device: str,
                clearbadsectors: Optional[bool] = None) -> None:
        """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.

        This function depends on the feature "ntfs3g". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.ntfsfix(self._o, device, clearbadsectors)
        return r

    def ntfsresize(self, device: str, size: Optional[int] = None,
                   force: Optional[bool] = None) -> None:
        """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 "g.ntfsresize" multiple times on a single
        filesystem without booting into Windows between each
        resize.

        See also ntfsresize(8).

        This function depends on the feature "ntfsprogs". See
        also "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.ntfsresize(self._o, device, size, force)
        return r

    ntfsresize_opts = ntfsresize

    def ntfsresize_size(self, device: str, size: int) -> None:
        """This command is the same as "g.ntfsresize" except that
        it allows you to specify the new size (in bytes)
        explicitly.

        *This function is deprecated.* In new code, use the
        "ntfsresize" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.

        This function depends on the feature "ntfsprogs". See
        also "g.feature-available".
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.ntfsresize() "
                      "instead of GuestFS.ntfsresize_size()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.ntfsresize_size(self._o, device, size)
        return r

    def parse_environment(self) -> None:
        """Parse the program’s environment and set flags in the
        handle accordingly. For example if "LIBGUESTFS_DEBUG=1"
        then the ‘verbose’ flag is set in the handle.

        *Most programs do not need to call this*. It is done
        implicitly when you call "g.create".

        See "ENVIRONMENT VARIABLES" in guestfs(3) for a list of
        environment variables that can affect libguestfs
        handles. See also "guestfs_create_flags" in guestfs(3),
        and "g.parse_environment_list".
        """
        self._check_not_closed()
        r = libguestfsmod.parse_environment(self._o)
        return r

    def parse_environment_list(self, environment: List[str]) -> None:
        """Parse the list of strings in the argument "environment"
        and set flags in the handle accordingly. For example if
        "LIBGUESTFS_DEBUG=1" is a string in the list, then the
        ‘verbose’ flag is set in the handle.

        This is the same as "g.parse_environment" except that it
        parses an explicit list of strings instead of the
        program's environment.
        """
        environment = list(environment)
        self._check_not_closed()
        r = libguestfsmod.parse_environment_list(self._o, environment)
        return r

    def part_add(self, device: str, prlogex: str, startsect: int,
                 endsect: int) -> None:
        """This command adds a partition to "device". If there is
        no partition table on the device, call "g.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 "g.part_disk" to do that.
        """
        self._check_not_closed()
        r = libguestfsmod.part_add(self._o, device, prlogex, startsect,
                                   endsect)
        return r

    def part_del(self, device: str, partnum: int) -> None:
        """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.
        """
        self._check_not_closed()
        r = libguestfsmod.part_del(self._o, device, partnum)
        return r

    def part_disk(self, device: str, parttype: str) -> None:
        """This command is simply a combination of "g.part_init"
        followed by "g.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
        "g.part_init".
        """
        self._check_not_closed()
        r = libguestfsmod.part_disk(self._o, device, parttype)
        return r

    def part_expand_gpt(self, device: str) -> None:
        """Move backup GPT data structures to the end of the disk.
        This is useful in case of in-place image expand since
        disk space after backup GPT header is not usable. This
        is equivalent to "sgdisk -e".

        See also sgdisk(8).

        This function depends on the feature "gdisk". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.part_expand_gpt(self._o, device)
        return r

    def part_get_bootable(self, device: str, partnum: int) -> bool:
        """This command returns true if the partition "partnum" on
        "device" has the bootable flag set.

        See also "g.part_set_bootable".
        """
        self._check_not_closed()
        r = libguestfsmod.part_get_bootable(self._o, device, partnum)
        return r

    def part_get_disk_guid(self, device: str) -> str:
        """Return the disk identifier (GUID) of a GPT-partitioned
        "device". Behaviour is undefined for other partition
        types.
        """
        self._check_not_closed()
        r = libguestfsmod.part_get_disk_guid(self._o, device)
        return r

    def part_get_gpt_attributes(self, device: str, partnum: int) -> int:
        """Return the attribute flags of numbered GPT partition
        "partnum". An error is returned for MBR partitions.
        """
        self._check_not_closed()
        r = libguestfsmod.part_get_gpt_attributes(self._o, device, partnum)
        return r

    def part_get_gpt_guid(self, device: str, partnum: int) -> str:
        """Return the GUID of numbered GPT partition "partnum".
        """
        self._check_not_closed()
        r = libguestfsmod.part_get_gpt_guid(self._o, device, partnum)
        return r

    def part_get_gpt_type(self, device: str, partnum: int) -> str:
        """Return the type GUID of numbered GPT partition
        "partnum".
        """
        self._check_not_closed()
        r = libguestfsmod.part_get_gpt_type(self._o, device, partnum)
        return r

    def part_get_mbr_id(self, device: str, partnum: int) -> int:
        """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 "g.part_get_parttype").
        """
        self._check_not_closed()
        r = libguestfsmod.part_get_mbr_id(self._o, device, partnum)
        return r

    def part_get_mbr_part_type(self, device: str, partnum: int) -> str:
        """This returns the partition type of an MBR partition
        numbered "partnum" on device "device".

        It returns "primary", "logical", or "extended".
        """
        self._check_not_closed()
        r = libguestfsmod.part_get_mbr_part_type(self._o, device, partnum)
        return r

    def part_get_name(self, device: str, partnum: int) -> str:
        """This gets the partition name on partition numbered
        "partnum" on device "device". Note that partitions are
        numbered from 1.

        The partition name can only be read on certain types of
        partition table. This works on "gpt" but not on "mbr"
        partitions.
        """
        self._check_not_closed()
        r = libguestfsmod.part_get_name(self._o, device, partnum)
        return r

    def part_get_parttype(self, device: str) -> str:
        """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 "g.part_init" for a full list.
        """
        self._check_not_closed()
        r = libguestfsmod.part_get_parttype(self._o, device)
        return r

    def part_init(self, device: str, parttype: str) -> None:
        """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 "g.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.
        """
        self._check_not_closed()
        r = libguestfsmod.part_init(self._o, device, parttype)
        return r

    def part_list(self, device: str) -> List[dict]:
        """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
        "g.blockdev_getss".

        "part_end"
        End of the partition in bytes.

        "part_size"
        Size of the partition in bytes.

        This function returns a list of partitions. Each
        partition is represented as a dictionary.
        """
        self._check_not_closed()
        r = libguestfsmod.part_list(self._o, device)
        return r

    def part_resize(self, device: str, partnum: int, endsect: int) -> None:
        """This command resizes the partition numbered "partnum" on
        "device" by moving the end position.

        Note that this does not modify any filesystem present in
        the partition. If you wish to do this, you will need to
        use filesystem resizing commands like "g.resize2fs".

        When growing a partition you will want to grow the
        filesystem afterwards, but when shrinking, you need to
        shrink the filesystem before the partition.
        """
        self._check_not_closed()
        r = libguestfsmod.part_resize(self._o, device, partnum, endsect)
        return r

    def part_set_bootable(self, device: str, partnum: int,
                          bootable: bool) -> None:
        """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.
        """
        self._check_not_closed()
        r = libguestfsmod.part_set_bootable(self._o, device, partnum, bootable)
        return r

    def part_set_disk_guid(self, device: str, guid: str) -> None:
        """Set the disk identifier (GUID) of a GPT-partitioned
        "device" to "guid". Return an error if the partition
        table of "device" isn't GPT, or if "guid" is not a valid
        GUID.
        """
        self._check_not_closed()
        r = libguestfsmod.part_set_disk_guid(self._o, device, guid)
        return r

    def part_set_disk_guid_random(self, device: str) -> None:
        """Set the disk identifier (GUID) of a GPT-partitioned
        "device" to a randomly generated value. Return an error
        if the partition table of "device" isn't GPT.
        """
        self._check_not_closed()
        r = libguestfsmod.part_set_disk_guid_random(self._o, device)
        return r

    def part_set_gpt_attributes(self, device: str, partnum: int,
                                attributes: int) -> None:
        """Set the attribute flags of numbered GPT partition
        "partnum" to "attributes". Return an error if the
        partition table of "device" isn't GPT.

        See
        <https://en.wikipedia.org/wiki/GUID_Partition_Table#Part
        ition_entries> for a useful list of partition
        attributes.
        """
        self._check_not_closed()
        r = libguestfsmod.part_set_gpt_attributes(self._o, device, partnum,
                                                  attributes)
        return r

    def part_set_gpt_guid(self, device: str, partnum: int, guid: str) -> None:
        """Set the GUID of numbered GPT partition "partnum" to
        "guid". Return an error if the partition table of
        "device" isn't GPT, or if "guid" is not a valid GUID.
        """
        self._check_not_closed()
        r = libguestfsmod.part_set_gpt_guid(self._o, device, partnum, guid)
        return r

    def part_set_gpt_type(self, device: str, partnum: int, guid: str) -> None:
        """Set the type GUID of numbered GPT partition "partnum" to
        "guid". Return an error if the partition table of
        "device" isn't GPT, or if "guid" is not a valid GUID.

        See
        <https://en.wikipedia.org/wiki/GUID_Partition_Table#Part
        ition_type_GUIDs> for a useful list of type GUIDs.
        """
        self._check_not_closed()
        r = libguestfsmod.part_set_gpt_type(self._o, device, partnum, guid)
        return r

    def part_set_mbr_id(self, device: str, partnum: int, idbyte: int) -> None:
        """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 "g.part_get_parttype").
        """
        self._check_not_closed()
        r = libguestfsmod.part_set_mbr_id(self._o, device, partnum, idbyte)
        return r

    def part_set_name(self, device: str, partnum: int, name: str) -> None:
        """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.
        """
        self._check_not_closed()
        r = libguestfsmod.part_set_name(self._o, device, partnum, name)
        return r

    def part_to_dev(self, partition: str) -> str:
        """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 "g.list_partitions".

        See also "g.part_to_partnum", "g.device_index".
        """
        self._check_not_closed()
        r = libguestfsmod.part_to_dev(self._o, partition)
        return r

    def part_to_partnum(self, partition: str) -> int:
        """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 "g.list_partitions".

        See also "g.part_to_dev".
        """
        self._check_not_closed()
        r = libguestfsmod.part_to_partnum(self._o, partition)
        return r

    def ping_daemon(self) -> None:
        """This is a test probe into the guestfs daemon running
        inside the libguestfs appliance. 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.
        """
        self._check_not_closed()
        r = libguestfsmod.ping_daemon(self._o)
        return r

    def pread(self, path: str, count: int, offset: int) -> bytes:
        """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 "g.pwrite", "g.pread_device".

        Because of the message protocol, there is a transfer
        limit of somewhere between 2MB and 4MB. See "PROTOCOL
        LIMITS" in guestfs(3).
        """
        self._check_not_closed()
        r = libguestfsmod.pread(self._o, path, count, offset)
        return r

    def pread_device(self, device: str, count: int, offset: int) -> bytes:
        """This command lets you read part of a block device. 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 "g.pread".

        Because of the message protocol, there is a transfer
        limit of somewhere between 2MB and 4MB. See "PROTOCOL
        LIMITS" in guestfs(3).
        """
        self._check_not_closed()
        r = libguestfsmod.pread_device(self._o, device, count, offset)
        return r

    def pvchange_uuid(self, device: str) -> None:
        """Generate a new random UUID for the physical volume
        "device".

        This function depends on the feature "lvm2". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.pvchange_uuid(self._o, device)
        return r

    def pvchange_uuid_all(self) -> None:
        """Generate new random UUIDs for all physical volumes.

        This function depends on the feature "lvm2". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.pvchange_uuid_all(self._o)
        return r

    def pvcreate(self, device: str) -> None:
        """This creates an LVM physical volume on the named
        "device", where "device" should usually be a partition
        name such as /dev/sda1.

        This function depends on the feature "lvm2". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.pvcreate(self._o, device)
        return r

    def pvremove(self, device: str) -> None:
        """This wipes a physical volume "device" so that LVM will
        no longer recognise it.

        The implementation uses the pvremove(8) command which
        refuses to wipe physical volumes that contain any volume
        groups, so you have to remove those first.

        This function depends on the feature "lvm2". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.pvremove(self._o, device)
        return r

    def pvresize(self, device: str) -> None:
        """This resizes (expands or shrinks) an existing LVM
        physical volume to match the new size of the underlying
        device.

        This function depends on the feature "lvm2". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.pvresize(self._o, device)
        return r

    def pvresize_size(self, device: str, size: int) -> None:
        """This command is the same as "g.pvresize" except that it
        allows you to specify the new size (in bytes)
        explicitly.

        This function depends on the feature "lvm2". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.pvresize_size(self._o, device, size)
        return r

    def pvs(self) -> List[str]:
        """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 "g.pvs_full".

        This function returns a list of strings.

        This function depends on the feature "lvm2". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.pvs(self._o)
        return r

    def pvs_full(self) -> List[dict]:
        """List all the physical volumes detected. This is the
        equivalent of the pvs(8) command. The "full" version
        includes all fields.

        This function returns a list of lvm_pvs. Each lvm_pv is
        represented as a dictionary.

        This function depends on the feature "lvm2". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.pvs_full(self._o)
        return r

    def pvuuid(self, device: str) -> str:
        """This command returns the UUID of the LVM PV "device".
        """
        self._check_not_closed()
        r = libguestfsmod.pvuuid(self._o, device)
        return r

    def pwrite(self, path: str, content: bytes, offset: int) -> int:
        """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 "g.pread", "g.pwrite_device".

        Because of the message protocol, there is a transfer
        limit of somewhere between 2MB and 4MB. See "PROTOCOL
        LIMITS" in guestfs(3).
        """
        self._check_not_closed()
        r = libguestfsmod.pwrite(self._o, path, content, offset)
        return r

    def pwrite_device(self, device: str, content: bytes, offset: int) -> int:
        """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 "g.pwrite".

        Because of the message protocol, there is a transfer
        limit of somewhere between 2MB and 4MB. See "PROTOCOL
        LIMITS" in guestfs(3).
        """
        self._check_not_closed()
        r = libguestfsmod.pwrite_device(self._o, device, content, offset)
        return r

    def read_file(self, path: str) -> bytes:
        """This calls returns the contents of the file "path" as a
        buffer.

        Unlike "g.cat", this function can correctly handle files
        that contain embedded ASCII NUL characters.
        """
        self._check_not_closed()
        r = libguestfsmod.read_file(self._o, path)
        return r

    def read_lines(self, path: str) -> List[str]:
        """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 string). For those you need
        to use the "g.read_file" function and split the buffer
        into lines yourself.

        This function returns a list of strings.
        """
        self._check_not_closed()
        r = libguestfsmod.read_lines(self._o, path)
        return r

    def readdir(self, dir: str) -> List[dict]:
        """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 "g.ls". To get a
        printable directory for human consumption, use "g.ll".

        This function returns a list of dirents. Each dirent is
        represented as a dictionary.
        """
        self._check_not_closed()
        r = libguestfsmod.readdir(self._o, dir)
        return r

    def readlink(self, path: str) -> str:
        """This command reads the target of a symbolic link.
        """
        self._check_not_closed()
        r = libguestfsmod.readlink(self._o, path)
        return r

    def readlinklist(self, path: str, names: List[str]) -> List[str]:
        """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.

        This function returns a list of strings.
        """
        names = list(names)
        self._check_not_closed()
        r = libguestfsmod.readlinklist(self._o, path, names)
        return r

    def realpath(self, path: str) -> str:
        """Return the canonicalized absolute pathname of "path".
        The returned path has no ".", ".." or symbolic link path
        elements.
        """
        self._check_not_closed()
        r = libguestfsmod.realpath(self._o, path)
        return r

    def remount(self, mountpoint: str, rw: Optional[bool] = None) -> None:
        """This call allows you to change the "rw"
        (readonly/read-write) flag on an already mounted
        filesystem at "mountpoint", converting a readonly
        filesystem to be read-write, or vice-versa.

        Note that at the moment you must supply the "optional"
        "rw" parameter. In future we may allow other flags to be
        adjusted.
        """
        self._check_not_closed()
        r = libguestfsmod.remount(self._o, mountpoint, rw)
        return r

    def remove_drive(self, label: str) -> None:
        """This call does nothing and returns an error.

        *This function is deprecated.* There is no replacement.
        Consult the API documentation in guestfs(3) for further
        information.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("do not use GuestFS.remove_drive()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.remove_drive(self._o, label)
        return r

    def removexattr(self, xattr: str, path: str) -> None:
        """This call removes the extended attribute named "xattr"
        of the file "path".

        See also: "g.lremovexattr", attr(5).

        This function depends on the feature "linuxxattrs". See
        also "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.removexattr(self._o, xattr, path)
        return r

    def rename(self, oldpath: str, newpath: str) -> None:
        """Rename a file to a new place on the same filesystem.
        This is the same as the Linux rename(2) system call. In
        most cases you are better to use "g.mv" instead.
        """
        self._check_not_closed()
        r = libguestfsmod.rename(self._o, oldpath, newpath)
        return r

    def resize2fs(self, device: str) -> None:
        """This resizes an ext2, ext3 or ext4 filesystem to match
        the size of the underlying device.

        See also "RESIZE2FS ERRORS" in guestfs(3).
        """
        self._check_not_closed()
        r = libguestfsmod.resize2fs(self._o, device)
        return r

    def resize2fs_M(self, device: str) -> None:
        """This command is the same as "g.resize2fs", but the
        filesystem is resized to its minimum size. This works
        like the *-M* option to the resize2fs(8) command.

        To get the resulting size of the filesystem you should
        call "g.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).
        """
        self._check_not_closed()
        r = libguestfsmod.resize2fs_M(self._o, device)
        return r

    def resize2fs_size(self, device: str, size: int) -> None:
        """This command is the same as "g.resize2fs" except that it
        allows you to specify the new size (in bytes)
        explicitly.

        See also "RESIZE2FS ERRORS" in guestfs(3).
        """
        self._check_not_closed()
        r = libguestfsmod.resize2fs_size(self._o, device, size)
        return r

    def rm(self, path: str) -> None:
        """Remove the single file "path".
        """
        self._check_not_closed()
        r = libguestfsmod.rm(self._o, path)
        return r

    def rm_f(self, path: str) -> None:
        """Remove the file "path".

        If the file doesn't exist, that error is ignored. (Other
        errors, eg. I/O errors or bad paths, are not ignored)

        This call cannot remove directories. Use "g.rmdir" to
        remove an empty directory, or "g.rm_rf" to remove
        directories recursively.
        """
        self._check_not_closed()
        r = libguestfsmod.rm_f(self._o, path)
        return r

    def rm_rf(self, path: str) -> None:
        """Remove the file or directory "path", recursively
        removing the contents if its a directory. This is like
        the "rm -rf" shell command.
        """
        self._check_not_closed()
        r = libguestfsmod.rm_rf(self._o, path)
        return r

    def rmdir(self, path: str) -> None:
        """Remove the single directory "path".
        """
        self._check_not_closed()
        r = libguestfsmod.rmdir(self._o, path)
        return r

    def rmmountpoint(self, exemptpath: str) -> None:
        """This call removes a mountpoint that was previously
        created with "g.mkmountpoint". See "g.mkmountpoint" for
        full details.
        """
        self._check_not_closed()
        r = libguestfsmod.rmmountpoint(self._o, exemptpath)
        return r

    def rsync(self, src: str, dest: str, archive: Optional[bool] = None,
              deletedest: Optional[bool] = None) -> None:
        """This call may be used to copy or synchronize two
        directories under the same libguestfs handle. This uses
        the rsync(1) program which uses a fast algorithm that
        avoids copying files unnecessarily.

        "src" and "dest" are the source and destination
        directories. Files are copied from "src" to "dest".

        The optional arguments are:

        "archive"
        Turns on archive mode. This is the same as passing
        the *--archive* flag to "rsync".

        "deletedest"
        Delete files at the destination that do not exist at
        the source.

        This function depends on the feature "rsync". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.rsync(self._o, src, dest, archive, deletedest)
        return r

    def rsync_in(self, remote: str, dest: str, archive: Optional[bool] = None,
                 deletedest: Optional[bool] = None) -> None:
        """This call may be used to copy or synchronize the
        filesystem on the host or on a remote computer with the
        filesystem within libguestfs. This uses the rsync(1)
        program which uses a fast algorithm that avoids copying
        files unnecessarily.

        This call only works if the network is enabled. See
        "g.set_network" or the *--network* option to various
        tools like guestfish(1).

        Files are copied from the remote server and directory
        specified by "remote" to the destination directory
        "dest".

        The format of the remote server string is defined by
        rsync(1). Note that there is no way to supply a password
        or passphrase so the target must be set up not to
        require one.

        The optional arguments are the same as those of
        "g.rsync".

        This function depends on the feature "rsync". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.rsync_in(self._o, remote, dest, archive, deletedest)
        return r

    def rsync_out(self, src: str, remote: str, archive: Optional[bool] = None,
                  deletedest: Optional[bool] = None) -> None:
        """This call may be used to copy or synchronize the
        filesystem within libguestfs with a filesystem on the
        host or on a remote computer. This uses the rsync(1)
        program which uses a fast algorithm that avoids copying
        files unnecessarily.

        This call only works if the network is enabled. See
        "g.set_network" or the *--network* option to various
        tools like guestfish(1).

        Files are copied from the source directory "src" to the
        remote server and directory specified by "remote".

        The format of the remote server string is defined by
        rsync(1). Note that there is no way to supply a password
        or passphrase so the target must be set up not to
        require one.

        The optional arguments are the same as those of
        "g.rsync".

        Globbing does not happen on the "src" parameter. In
        programs which use the API directly you have to expand
        wildcards yourself (see "g.glob_expand"). In guestfish
        you can use the "glob" command (see "glob" in
        guestfish(1)), for example:

        ><fs> glob rsync-out /* rsync://remote/

        This function depends on the feature "rsync". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.rsync_out(self._o, src, remote, archive, deletedest)
        return r

    def scrub_device(self, device: str) -> None:
        """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.

        This function depends on the feature "scrub". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.scrub_device(self._o, device)
        return r

    def scrub_file(self, file: str) -> None:
        """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.

        This function depends on the feature "scrub". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.scrub_file(self._o, file)
        return r

    def scrub_freespace(self, dir: str) -> None:
        """This command creates the directory "dir" and then fills
        it with files until the filesystem is full, and scrubs
        the files as for "g.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.

        This function depends on the feature "scrub". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.scrub_freespace(self._o, dir)
        return r

    def selinux_relabel(self, specfile: str, path: str,
                        force: Optional[bool] = None) -> None:
        """SELinux relabel parts of the filesystem.

        The "specfile" parameter controls the policy spec file
        used. You have to parse "/etc/selinux/config" to find
        the correct SELinux policy and then pass the spec file,
        usually: "/etc/selinux/" + *selinuxtype* +
        "/contexts/files/file_contexts".

        The required "path" parameter is the top level directory
        where relabelling starts. Normally you should pass
        "path" as "/" to relabel the whole guest filesystem.

        The optional "force" boolean controls whether the
        context is reset for customizable files, and also
        whether the user, role and range parts of the file
        context is changed.

        This function depends on the feature "selinuxrelabel".
        See also "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.selinux_relabel(self._o, specfile, path, force)
        return r

    def set_append(self, append: Optional[str]) -> None:
        """This function is used to add additional options to the
        libguestfs appliance 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).
        """
        self._check_not_closed()
        r = libguestfsmod.set_append(self._o, append)
        return r

    def set_attach_method(self, backend: str) -> None:
        """Set the method that libguestfs uses to connect to the
        backend guestfsd daemon.

        See "BACKEND" in guestfs(3).

        *This function is deprecated.* In new code, use the
        "set_backend" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.set_backend() "
                      "instead of GuestFS.set_attach_method()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.set_attach_method(self._o, backend)
        return r

    def set_autosync(self, autosync: bool) -> None:
        """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).
        """
        self._check_not_closed()
        r = libguestfsmod.set_autosync(self._o, autosync)
        return r

    def set_backend(self, backend: str) -> None:
        """Set the method that libguestfs uses to connect to the
        backend guestfsd daemon.

        This handle property was previously called the "attach
        method".

        See "BACKEND" in guestfs(3).
        """
        self._check_not_closed()
        r = libguestfsmod.set_backend(self._o, backend)
        return r

    def set_backend_setting(self, name: str, val: str) -> None:
        """Append "name=value" to the backend settings string list.
        However if a string already exists matching "name" or
        beginning with "name=", then that setting is replaced.

        See "BACKEND" in guestfs(3), "BACKEND SETTINGS" in
        guestfs(3).
        """
        self._check_not_closed()
        r = libguestfsmod.set_backend_setting(self._o, name, val)
        return r

    def set_backend_settings(self, settings: List[str]) -> None:
        """Set a list of zero or more settings which are passed
        through to the current backend. Each setting is a string
        which is interpreted in a backend-specific way, or
        ignored if not understood by the backend.

        The default value is an empty list, unless the
        environment variable "LIBGUESTFS_BACKEND_SETTINGS" was
        set when the handle was created. This environment
        variable contains a colon-separated list of settings.

        This call replaces all backend settings. If you want to
        replace a single backend setting, see
        "g.set_backend_setting". If you want to clear a single
        backend setting, see "g.clear_backend_setting".

        See "BACKEND" in guestfs(3), "BACKEND SETTINGS" in
        guestfs(3).
        """
        settings = list(settings)
        self._check_not_closed()
        r = libguestfsmod.set_backend_settings(self._o, settings)
        return r

    def set_cachedir(self, cachedir: Optional[str]) -> None:
        """Set the directory used by the handle to store the
        appliance cache, when using a supermin appliance. The
        appliance is cached and shared between all handles which
        have the same effective user ID.

        The environment variables "LIBGUESTFS_CACHEDIR" and
        "TMPDIR" control the default value: If
        "LIBGUESTFS_CACHEDIR" is set, then that is the default.
        Else if "TMPDIR" is set, then that is the default. Else
        /var/tmp is the default.
        """
        self._check_not_closed()
        r = libguestfsmod.set_cachedir(self._o, cachedir)
        return r

    def set_direct(self, direct: bool) -> None:
        """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
        "g.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.

        *This function is deprecated.* In new code, use the
        "internal_get_console_socket" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.internal_get_console_socket() "
                      "instead of GuestFS.set_direct()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.set_direct(self._o, direct)
        return r

    def set_e2attrs(self, file: str, attrs: str,
                    clear: Optional[bool] = None) -> None:
        """This sets or clears the file attributes "attrs"
        associated with the inode file.

        "attrs" is a string of characters representing file
        attributes. See "g.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.
        """
        self._check_not_closed()
        r = libguestfsmod.set_e2attrs(self._o, file, attrs, clear)
        return r

    def set_e2generation(self, file: str, generation: int) -> None:
        """This sets the ext2 file generation of a file.

        See "g.get_e2generation".
        """
        self._check_not_closed()
        r = libguestfsmod.set_e2generation(self._o, file, generation)
        return r

    def set_e2label(self, device: str, label: str) -> None:
        """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 "g.tune2fs_l" or "g.get_e2label" to
        return the existing label on a filesystem.

        *This function is deprecated.* In new code, use the
        "set_label" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.set_label() "
                      "instead of GuestFS.set_e2label()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.set_e2label(self._o, device, label)
        return r

    def set_e2uuid(self, device: str, uuid: str) -> None:
        """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 "g.vfs_uuid" to return the existing UUID of
        a filesystem.

        *This function is deprecated.* In new code, use the
        "set_uuid" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.set_uuid() "
                      "instead of GuestFS.set_e2uuid()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.set_e2uuid(self._o, device, uuid)
        return r

    def set_hv(self, hv: str) -> None:
        """Set the hypervisor binary that we will use. The
        hypervisor depends on the backend, but is usually the
        location of the qemu/KVM hypervisor.

        The default is chosen when the library was compiled by
        the configure script.

        You can also override this by setting the
        "LIBGUESTFS_HV" environment variable.

        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_HV" is safest of all since that picks the
        qemu binary at the same time as the handle is created.
        """
        self._check_not_closed()
        r = libguestfsmod.set_hv(self._o, hv)
        return r

    def set_identifier(self, identifier: str) -> None:
        """This is an informative string which the caller may
        optionally set in the handle. It is printed in various
        places, allowing the current handle to be identified in
        debugging output.

        One important place is when tracing is enabled. If the
        identifier string is not an empty string, then trace
        messages change from this:

        libguestfs: trace: get_tmpdir
        libguestfs: trace: get_tmpdir = "/tmp"

        to this:

        libguestfs: trace: ID: get_tmpdir
        libguestfs: trace: ID: get_tmpdir = "/tmp"

        where "ID" is the identifier string set by this call.

        The identifier must only contain alphanumeric ASCII
        characters, underscore and minus sign. The default is
        the empty string.

        See also "g.set_program", "g.set_trace",
        "g.get_identifier".
        """
        self._check_not_closed()
        r = libguestfsmod.set_identifier(self._o, identifier)
        return r

    def set_label(self, mountable: str, label: str) -> None:
        """Set the filesystem label on "mountable" to "label".

        Only some filesystem types support labels, and
        libguestfs supports setting labels on only a subset of
        these.

        ext2, ext3, ext4
        Labels are limited to 16 bytes.

        NTFS
        Labels are limited to 128 unicode characters.

        XFS The label is limited to 12 bytes. The filesystem
        must not be mounted when trying to set the label.

        btrfs
        The label is limited to 255 bytes and some
        characters are not allowed. Setting the label on a
        btrfs subvolume will set the label on its parent
        filesystem. The filesystem must not be mounted when
        trying to set the label.

        fat The label is limited to 11 bytes.

        swap
        The label is limited to 16 bytes.

        If there is no support for changing the label for the
        type of the specified filesystem, set_label will fail
        and set errno as ENOTSUP.

        To read the label on a filesystem, call "g.vfs_label".
        """
        self._check_not_closed()
        r = libguestfsmod.set_label(self._o, mountable, label)
        return r

    def set_libvirt_requested_credential(self, index: int,
                                         cred: bytes) -> None:
        """After requesting the "index"'th credential from the
        user, call this function to pass the answer back to
        libvirt.

        See "LIBVIRT AUTHENTICATION" in guestfs(3) for
        documentation and example code.
        """
        self._check_not_closed()
        r = libguestfsmod.set_libvirt_requested_credential(self._o, index,
                                                           cred)
        return r

    def set_libvirt_supported_credentials(self, creds: List[str]) -> None:
        """Call this function before setting an event handler for
        "GUESTFS_EVENT_LIBVIRT_AUTH", to supply the list of
        credential types that the program knows how to process.

        The "creds" list must be a non-empty list of strings.
        Possible strings are:

        "username"
        "authname"
        "language"
        "cnonce"
        "passphrase"
        "echoprompt"
        "noechoprompt"
        "realm"
        "external"

        See libvirt documentation for the meaning of these
        credential types.

        See "LIBVIRT AUTHENTICATION" in guestfs(3) for
        documentation and example code.
        """
        creds = list(creds)
        self._check_not_closed()
        r = libguestfsmod.set_libvirt_supported_credentials(self._o, creds)
        return r

    def set_memsize(self, memsize: int) -> None:
        """This sets the memory size in megabytes allocated to the
        hypervisor. This only has any effect if called before
        "g.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).
        """
        self._check_not_closed()
        r = libguestfsmod.set_memsize(self._o, memsize)
        return r

    def set_network(self, network: bool) -> None:
        """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 "g.launch", otherwise
        it has no effect.
        """
        self._check_not_closed()
        r = libguestfsmod.set_network(self._o, network)
        return r

    def set_path(self, searchpath: Optional[str]) -> None:
        """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.
        """
        self._check_not_closed()
        r = libguestfsmod.set_path(self._o, searchpath)
        return r

    def set_pgroup(self, pgroup: bool) -> None:
        """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
        "g.user_cancel").
        """
        self._check_not_closed()
        r = libguestfsmod.set_pgroup(self._o, pgroup)
        return r

    def set_program(self, program: str) -> None:
        """Set the program name. This is an informative string
        which the main program may optionally set in the handle.

        When the handle is created, the program name in the
        handle is set to the basename from "argv[0]". The
        program name can never be "NULL".
        """
        self._check_not_closed()
        r = libguestfsmod.set_program(self._o, program)
        return r

    def set_qemu(self, hv: Optional[str]) -> None:
        """Set the hypervisor binary (usually qemu) 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_HV" environment variable.

        Setting "hv" 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_HV" is safest of all since that picks the
        qemu binary at the same time as the handle is created.

        *This function is deprecated.* In new code, use the
        "set_hv" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.set_hv() "
                      "instead of GuestFS.set_qemu()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.set_qemu(self._o, hv)
        return r

    def set_recovery_proc(self, recoveryproc: bool) -> None:
        """If this is called with the parameter "false" then
        "g.launch" does not create a recovery process. The
        purpose of the recovery process is to stop runaway
        hypervisor processes in the case where the main program
        aborts abruptly.

        This only has any effect if called before "g.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 the hypervisor, which is not
        very helpful.
        """
        self._check_not_closed()
        r = libguestfsmod.set_recovery_proc(self._o, recoveryproc)
        return r

    def set_selinux(self, selinux: bool) -> None:
        """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).

        *This function is deprecated.* In new code, use the
        "selinux_relabel" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.selinux_relabel() "
                      "instead of GuestFS.set_selinux()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.set_selinux(self._o, selinux)
        return r

    def set_smp(self, smp: int) -> None:
        """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 "g.launch".
        """
        self._check_not_closed()
        r = libguestfsmod.set_smp(self._o, smp)
        return r

    def set_tmpdir(self, tmpdir: Optional[str]) -> None:
        """Set the directory used by the handle to store temporary
        files.

        The environment variables "LIBGUESTFS_TMPDIR" and
        "TMPDIR" control the default value: If
        "LIBGUESTFS_TMPDIR" is set, then that is the default.
        Else if "TMPDIR" is set, then that is the default. Else
        /tmp is the default.
        """
        self._check_not_closed()
        r = libguestfsmod.set_tmpdir(self._o, tmpdir)
        return r

    def set_trace(self, trace: bool) -> None:
        """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
        "g.set_event_callback").
        """
        self._check_not_closed()
        r = libguestfsmod.set_trace(self._o, trace)
        return r

    def set_uuid(self, device: str, uuid: str) -> None:
        """Set the filesystem UUID on "device" to "uuid". If this
        fails and the errno is ENOTSUP, means that there is no
        support for changing the UUID for the type of the
        specified filesystem.

        Only some filesystem types support setting UUIDs.

        To read the UUID on a filesystem, call "g.vfs_uuid".
        """
        self._check_not_closed()
        r = libguestfsmod.set_uuid(self._o, device, uuid)
        return r

    def set_uuid_random(self, device: str) -> None:
        """Set the filesystem UUID on "device" to a random UUID. If
        this fails and the errno is ENOTSUP, means that there is
        no support for changing the UUID for the type of the
        specified filesystem.

        Only some filesystem types support setting UUIDs.

        To read the UUID on a filesystem, call "g.vfs_uuid".
        """
        self._check_not_closed()
        r = libguestfsmod.set_uuid_random(self._o, device)
        return r

    def set_verbose(self, verbose: bool) -> None:
        """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
        "g.set_event_callback").
        """
        self._check_not_closed()
        r = libguestfsmod.set_verbose(self._o, verbose)
        return r

    def setcon(self, context: str) -> None:
        """This sets the SELinux security context of the daemon to
        the string "context".

        See the documentation about SELINUX in guestfs(3).

        *This function is deprecated.* In new code, use the
        "selinux_relabel" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.

        This function depends on the feature "selinux". See also
        "g.feature-available".
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.selinux_relabel() "
                      "instead of GuestFS.setcon()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.setcon(self._o, context)
        return r

    def setxattr(self, xattr: str, val: str, vallen: int, path: str) -> None:
        """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: "g.lsetxattr", attr(5).

        This function depends on the feature "linuxxattrs". See
        also "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.setxattr(self._o, xattr, val, vallen, path)
        return r

    def sfdisk(self, device: str, cyls: int, heads: int, sectors: int,
               lines: List[str]) -> None:
        """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(8) 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(8) (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(8).
        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: "g.sfdisk_l", "g.sfdisk_N", "g.part_init"

        *This function is deprecated.* In new code, use the
        "part_add" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        lines = list(lines)
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.part_add() "
                      "instead of GuestFS.sfdisk()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.sfdisk(self._o, device, cyls, heads, sectors, lines)
        return r

    def sfdiskM(self, device: str, lines: List[str]) -> None:
        """This is a simplified interface to the "g.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: "g.sfdisk", the sfdisk(8) manpage and
        "g.part_disk"

        *This function is deprecated.* In new code, use the
        "part_add" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        lines = list(lines)
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.part_add() "
                      "instead of GuestFS.sfdiskM()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.sfdiskM(self._o, device, lines)
        return r

    def sfdisk_N(self, device: str, partnum: int, cyls: int, heads: int,
                 sectors: int, line: str) -> None:
        """This runs sfdisk(8) option to modify just the single
        partition "n" (note: "n" counts from 1).

        For other parameters, see "g.sfdisk". You should usually
        pass 0 for the cyls/heads/sectors parameters.

        See also: "g.part_add"

        *This function is deprecated.* In new code, use the
        "part_add" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.part_add() "
                      "instead of GuestFS.sfdisk_N()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.sfdisk_N(self._o, device, partnum, cyls, heads,
                                   sectors, line)
        return r

    def sfdisk_disk_geometry(self, device: str) -> str:
        """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
        "g.sfdisk_kernel_geometry").

        The result is in human-readable format, and not designed
        to be parsed.
        """
        self._check_not_closed()
        r = libguestfsmod.sfdisk_disk_geometry(self._o, device)
        return r

    def sfdisk_kernel_geometry(self, device: str) -> str:
        """This displays the kernel’s idea of the geometry of
        "device".

        The result is in human-readable format, and not designed
        to be parsed.
        """
        self._check_not_closed()
        r = libguestfsmod.sfdisk_kernel_geometry(self._o, device)
        return r

    def sfdisk_l(self, device: str) -> str:
        """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: "g.part_list"

        *This function is deprecated.* In new code, use the
        "part_list" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.part_list() "
                      "instead of GuestFS.sfdisk_l()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.sfdisk_l(self._o, device)
        return r

    def sh(self, command: str) -> str:
        """This call runs a command from the guest filesystem via
        the guest’s /bin/sh.

        This is like "g.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 "g.command" apply to this call.
        """
        self._check_not_closed()
        r = libguestfsmod.sh(self._o, command)
        return r

    def sh_lines(self, command: str) -> List[str]:
        """This is the same as "g.sh", but splits the result into a
        list of lines.

        See also: "g.command_lines"

        This function returns a list of strings.
        """
        self._check_not_closed()
        r = libguestfsmod.sh_lines(self._o, command)
        return r

    def sh_out(self, command: str, output: str) -> None:
        """This is the same as "g.sh", but streams the output back,
        handling the case where the output from the command is
        larger than the protocol limit.

        See also: "g.command_out"
        """
        self._check_not_closed()
        r = libguestfsmod.sh_out(self._o, command, output)
        return r

    def shutdown(self) -> None:
        """This is the opposite of "g.launch". It performs an
        orderly shutdown of the backend process(es). If the
        autosync flag is set (which is the default) then the
        disk image is synchronized.

        If the subprocess exits with an error then this function
        will return an error, which should *not* be ignored (it
        may indicate that the disk image could not be written
        out properly).

        It is safe to call this multiple times. Extra calls are
        ignored.

        This call does *not* close or free up the handle. You
        still need to call "g.close" afterwards.

        "g.close" will call this if you don't do it explicitly,
        but note that any errors are ignored in that case.
        """
        self._check_not_closed()
        r = libguestfsmod.shutdown(self._o)
        return r

    def sleep(self, secs: int) -> None:
        """Sleep for "secs" seconds.
        """
        self._check_not_closed()
        r = libguestfsmod.sleep(self._o, secs)
        return r

    def stat(self, path: str) -> dict:
        """Returns file information for the given "path".

        This is the same as the stat(2) system call.

        This function returns a dictionary, with keys matching
        the various fields in the guestfs_stat structure.

        *This function is deprecated.* In new code, use the
        "statns" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.statns() "
                      "instead of GuestFS.stat()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.stat(self._o, path)
        return r

    def statns(self, path: str) -> dict:
        """Returns file information for the given "path".

        This is the same as the stat(2) system call.

        This function returns a dictionary, with keys matching
        the various fields in the guestfs_statns structure.
        """
        self._check_not_closed()
        r = libguestfsmod.statns(self._o, path)
        return r

    def statvfs(self, path: str) -> dict:
        """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.

        This function returns a dictionary, with keys matching
        the various fields in the guestfs_statvfs structure.
        """
        self._check_not_closed()
        r = libguestfsmod.statvfs(self._o, path)
        return r

    def strings(self, path: str) -> List[str]:
        """This runs the strings(1) command on a file and returns
        the list of printable strings found.

        The "strings" command has, in the past, had problems
        with parsing untrusted files. These are mitigated in the
        current version of libguestfs, but see "CVE-2014-8484"
        in guestfs(3).

        This function returns a list of strings.

        Because of the message protocol, there is a transfer
        limit of somewhere between 2MB and 4MB. See "PROTOCOL
        LIMITS" in guestfs(3).
        """
        self._check_not_closed()
        r = libguestfsmod.strings(self._o, path)
        return r

    def strings_e(self, encoding: str, path: str) -> List[str]:
        """This is like the "g.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
        "g.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.

        The "strings" command has, in the past, had problems
        with parsing untrusted files. These are mitigated in the
        current version of libguestfs, but see "CVE-2014-8484"
        in guestfs(3).

        This function returns a list of strings.

        Because of the message protocol, there is a transfer
        limit of somewhere between 2MB and 4MB. See "PROTOCOL
        LIMITS" in guestfs(3).
        """
        self._check_not_closed()
        r = libguestfsmod.strings_e(self._o, encoding, path)
        return r

    def swapoff_device(self, device: str) -> None:
        """This command disables the libguestfs appliance swap
        device or partition named "device". See
        "g.swapon_device".
        """
        self._check_not_closed()
        r = libguestfsmod.swapoff_device(self._o, device)
        return r

    def swapoff_file(self, file: str) -> None:
        """This command disables the libguestfs appliance swap on
        file.
        """
        self._check_not_closed()
        r = libguestfsmod.swapoff_file(self._o, file)
        return r

    def swapoff_label(self, label: str) -> None:
        """This command disables the libguestfs appliance swap on
        labeled swap partition.
        """
        self._check_not_closed()
        r = libguestfsmod.swapoff_label(self._o, label)
        return r

    def swapoff_uuid(self, uuid: str) -> None:
        """This command disables the libguestfs appliance swap
        partition with the given UUID.

        This function depends on the feature "linuxfsuuid". See
        also "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.swapoff_uuid(self._o, uuid)
        return r

    def swapon_device(self, device: str) -> None:
        """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 "g.command" or "g.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.
        """
        self._check_not_closed()
        r = libguestfsmod.swapon_device(self._o, device)
        return r

    def swapon_file(self, file: str) -> None:
        """This command enables swap to a file. See
        "g.swapon_device" for other notes.
        """
        self._check_not_closed()
        r = libguestfsmod.swapon_file(self._o, file)
        return r

    def swapon_label(self, label: str) -> None:
        """This command enables swap to a labeled swap partition.
        See "g.swapon_device" for other notes.
        """
        self._check_not_closed()
        r = libguestfsmod.swapon_label(self._o, label)
        return r

    def swapon_uuid(self, uuid: str) -> None:
        """This command enables swap to a swap partition with the
        given UUID. See "g.swapon_device" for other notes.

        This function depends on the feature "linuxfsuuid". See
        also "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.swapon_uuid(self._o, uuid)
        return r

    def sync(self) -> None:
        """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.
        """
        self._check_not_closed()
        r = libguestfsmod.sync(self._o)
        return r

    def syslinux(self, device: str, directory: Optional[str] = None) -> None:
        """Install the SYSLINUX bootloader on "device".

        The device parameter must be either a whole disk
        formatted as a FAT filesystem, or a partition formatted
        as a FAT filesystem. In the latter case, the partition
        should be marked as "active" ("g.part_set_bootable") and
        a Master Boot Record must be installed (eg. using
        "g.pwrite_device") on the first sector of the whole
        disk. The SYSLINUX package comes with some suitable
        Master Boot Records. See the syslinux(1) man page for
        further information.

        The optional arguments are:

        directory
        Install SYSLINUX in the named subdirectory, instead
        of in the root directory of the FAT filesystem.

        Additional configuration can be supplied to SYSLINUX by
        placing a file called syslinux.cfg on the FAT
        filesystem, either in the root directory, or under
        directory if that optional argument is being used. For
        further information about the contents of this file, see
        syslinux(1).

        See also "g.extlinux".

        This function depends on the feature "syslinux". See
        also "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.syslinux(self._o, device, directory)
        return r

    def tail(self, path: str) -> List[str]:
        """This command returns up to the last 10 lines of a file
        as a list of strings.

        This function returns a list of strings.

        Because of the message protocol, there is a transfer
        limit of somewhere between 2MB and 4MB. See "PROTOCOL
        LIMITS" in guestfs(3).
        """
        self._check_not_closed()
        r = libguestfsmod.tail(self._o, path)
        return r

    def tail_n(self, nrlines: int, path: str) -> List[str]:
        """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
        "-nrlines"'th line.

        If the parameter "nrlines" is zero, this returns an
        empty list.

        This function returns a list of strings.

        Because of the message protocol, there is a transfer
        limit of somewhere between 2MB and 4MB. See "PROTOCOL
        LIMITS" in guestfs(3).
        """
        self._check_not_closed()
        r = libguestfsmod.tail_n(self._o, nrlines, path)
        return r

    def tar_in(self, tarfile: str, directory: str,
               compress: Optional[str] = None, xattrs: Optional[bool] = None,
               selinux: Optional[bool] = None,
               acls: Optional[bool] = None) -> None:
        """This command uploads and unpacks local file "tarfile"
        into directory.

        The optional "compress" flag controls compression. If
        not given, then the input should be an uncompressed tar
        file. Otherwise one of the following strings may be
        given to select the compression type of the input file:
        "compress", "gzip", "bzip2", "xz", "lzop", "lzma",
        "zstd". (Note that not all builds of libguestfs will
        support all of these compression types).

        The other optional arguments are:

        "xattrs"
        If set to true, extended attributes are restored
        from the tar file.

        "selinux"
        If set to true, SELinux contexts are restored from
        the tar file.

        "acls"
        If set to true, POSIX ACLs are restored from the tar
        file.
        """
        self._check_not_closed()
        r = libguestfsmod.tar_in(self._o, tarfile, directory, compress, xattrs,
                                 selinux, acls)
        return r

    tar_in_opts = tar_in

    def tar_out(self, directory: str, tarfile: str,
                compress: Optional[str] = None,
                numericowner: Optional[bool] = None,
                excludes: Optional[List[str]] = None,
                xattrs: Optional[bool] = None, selinux: Optional[bool] = None,
                acls: Optional[bool] = None) -> None:
        """This command packs the contents of directory and
        downloads it to local file "tarfile".

        The optional "compress" flag controls compression. If
        not given, then the output will be an uncompressed tar
        file. Otherwise one of the following strings may be
        given to select the compression type of the output file:
        "compress", "gzip", "bzip2", "xz", "lzop", "lzma",
        "zstd". (Note that not all builds of libguestfs will
        support all of these compression types).

        The other optional arguments are:

        "excludes"
        A list of wildcards. Files are excluded if they
        match any of the wildcards.

        "numericowner"
        If set to true, the output tar file will contain
        UID/GID numbers instead of user/group names.

        "xattrs"
        If set to true, extended attributes are saved in the
        output tar.

        "selinux"
        If set to true, SELinux contexts are saved in the
        output tar.

        "acls"
        If set to true, POSIX ACLs are saved in the output
        tar.
        """
        self._check_not_closed()
        r = libguestfsmod.tar_out(self._o, directory, tarfile, compress,
                                  numericowner, excludes, xattrs, selinux,
                                  acls)
        return r

    tar_out_opts = tar_out

    def tgz_in(self, tarball: str, directory: str) -> None:
        """This command uploads and unpacks local file "tarball" (a
        *gzip compressed* tar file) into directory.

        *This function is deprecated.* In new code, use the
        "tar_in" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.tar_in() "
                      "instead of GuestFS.tgz_in()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.tgz_in(self._o, tarball, directory)
        return r

    def tgz_out(self, directory: str, tarball: str) -> None:
        """This command packs the contents of directory and
        downloads it to local file "tarball".

        *This function is deprecated.* In new code, use the
        "tar_out" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.tar_out() "
                      "instead of GuestFS.tgz_out()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.tgz_out(self._o, directory, tarball)
        return r

    def touch(self, path: str) -> None:
        """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.
        """
        self._check_not_closed()
        r = libguestfsmod.touch(self._o, path)
        return r

    def truncate(self, path: str) -> None:
        """This command truncates "path" to a zero-length file. The
        file must exist already.
        """
        self._check_not_closed()
        r = libguestfsmod.truncate(self._o, path)
        return r

    def truncate_size(self, path: str, size: int) -> None:
        """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 "g.fallocate64"
        instead.
        """
        self._check_not_closed()
        r = libguestfsmod.truncate_size(self._o, path, size)
        return r

    def tune2fs(self, device: str, force: Optional[bool] = None,
                maxmountcount: Optional[int] = None,
                mountcount: Optional[int] = None,
                errorbehavior: Optional[str] = None,
                group: Optional[int] = None,
                intervalbetweenchecks: Optional[int] = None,
                reservedblockspercentage: Optional[int] = None,
                lastmounteddirectory: Optional[str] = None,
                reservedblockscount: Optional[int] = None,
                user: Optional[int] = None) -> None:
        """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(8)
        "-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(8) "-c" option.

        "mountcount"
        Set the number of times the filesystem has been
        mounted. This is the same as the tune2fs(8) "-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(8) "-e" option.

        "group"
        Set the group which can use reserved filesystem
        blocks. This is the same as the tune2fs(8) "-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(8) "-i" option.

        "reservedblockspercentage"
        Set the percentage of the filesystem which may only
        be allocated by privileged processes. This is the
        same as the tune2fs(8) "-m" option.

        "lastmounteddirectory"
        Set the last mounted directory. This is the same as
        the tune2fs(8) "-M" option.

        "reservedblockscount" Set the number of reserved
        filesystem blocks. This is the same as the tune2fs(8)
        "-r" option.
        "user"
        Set the user who can use the reserved filesystem
        blocks. This is the same as the tune2fs(8) "-u"
        option except that it can only be specified as a
        number.

        To get the current values of filesystem parameters, see
        "g.tune2fs_l". For precise details of how tune2fs works,
        see the tune2fs(8) man page.
        """
        self._check_not_closed()
        r = libguestfsmod.tune2fs(self._o, device, force, maxmountcount,
                                  mountcount, errorbehavior, group,
                                  intervalbetweenchecks,
                                  reservedblockspercentage,
                                  lastmounteddirectory, reservedblockscount,
                                  user)
        return r

    def tune2fs_l(self, device: str) -> Union[List[Tuple[str, str]], dict]:
        """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.

        This function returns a hash. If the GuestFS constructor
        was called with python_return_dict=True (recommended)
        then the return value is in fact a Python dict.
        Otherwise the return value is a list of pairs of
        strings, for compatibility with old code.
        """
        self._check_not_closed()
        r = libguestfsmod.tune2fs_l(self._o, device)
        r = self._maybe_convert_to_dict(r)
        return r

    def txz_in(self, tarball: str, directory: str) -> None:
        """This command uploads and unpacks local file "tarball"
        (an *xz compressed* tar file) into directory.

        *This function is deprecated.* In new code, use the
        "tar_in" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.

        This function depends on the feature "xz". See also
        "g.feature-available".
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.tar_in() "
                      "instead of GuestFS.txz_in()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.txz_in(self._o, tarball, directory)
        return r

    def txz_out(self, directory: str, tarball: str) -> None:
        """This command packs the contents of directory and
        downloads it to local file "tarball" (as an xz
        compressed tar archive).

        *This function is deprecated.* In new code, use the
        "tar_out" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.

        This function depends on the feature "xz". See also
        "g.feature-available".
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.tar_out() "
                      "instead of GuestFS.txz_out()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.txz_out(self._o, directory, tarball)
        return r

    def umask(self, mask: int) -> int:
        """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 "g.get_umask", umask(2), "g.mknod", "g.mkdir".

        This call returns the previous umask.
        """
        self._check_not_closed()
        r = libguestfsmod.umask(self._o, mask)
        return r

    def umount(self, pathordevice: str, force: Optional[bool] = None,
               lazyunmount: Optional[bool] = None) -> None:
        """This unmounts the given filesystem. The filesystem may
        be specified either by its mountpoint (path) or the
        device which contains the filesystem.
        """
        self._check_not_closed()
        r = libguestfsmod.umount(self._o, pathordevice, force, lazyunmount)
        return r

    umount_opts = umount

    def umount_all(self) -> None:
        """This unmounts all mounted filesystems.

        Some internal mounts are not unmounted by this call.
        """
        self._check_not_closed()
        r = libguestfsmod.umount_all(self._o)
        return r

    def umount_local(self, retry: Optional[bool] = None) -> None:
        """If libguestfs is exporting the filesystem on a local
        mountpoint, then this unmounts it.

        See "MOUNT LOCAL" in guestfs(3) for full documentation.
        """
        self._check_not_closed()
        r = libguestfsmod.umount_local(self._o, retry)
        return r

    def upload(self, filename: str, remotefilename: str) -> None:
        """Upload local file filename to remotefilename on the
        filesystem.

        filename can also be a named pipe.

        See also "g.download".
        """
        self._check_not_closed()
        r = libguestfsmod.upload(self._o, filename, remotefilename)
        return r

    def upload_offset(self, filename: str, remotefilename: str,
                      offset: int) -> None:
        """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-existent
        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 "g.pwrite",
        and this call always writes the full amount unless an
        error occurs.

        See also "g.upload", "g.pwrite".
        """
        self._check_not_closed()
        r = libguestfsmod.upload_offset(self._o, filename, remotefilename,
                                        offset)
        return r

    def user_cancel(self) -> None:
        """This function cancels the current upload or download
        operation.

        Unlike most other libguestfs calls, this function is
        signal safe and thread safe. You can call it from a
        signal handler or from another thread, without needing
        to do any locking.

        The transfer that was in progress (if there is one) will
        stop shortly afterwards, and will return an error. The
        errno (see "guestfs_last_errno") is set to "EINTR", so
        you can test for this to find out if the operation was
        cancelled or failed because of another error.

        No cleanup is performed: for example, if a file was
        being uploaded then after cancellation there may be a
        partially uploaded file. It is the caller’s
        responsibility to clean up if necessary.

        There are two common places that you might call
        "g.user_cancel":

        In an interactive text-based program, you might call it
        from a "SIGINT" signal handler so that pressing "^C"
        cancels the current operation. (You also need to call
        "g.set_pgroup" so that child processes don't receive the
        "^C" signal).

        In a graphical program, when the main thread is
        displaying a progress bar with a cancel button, wire up
        the cancel button to call this function.
        """
        self._check_not_closed()
        r = libguestfsmod.user_cancel(self._o)
        return r

    def utimens(self, path: str, atsecs: int, atnsecs: int, mtsecs: int,
                mtnsecs: int) -> None:
        """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).
        """
        self._check_not_closed()
        r = libguestfsmod.utimens(self._o, path, atsecs, atnsecs, mtsecs,
                                  mtnsecs)
        return r

    def utsname(self) -> dict:
        """This returns the kernel version of the appliance, where
        this is available. This information is only useful for
        debugging. Nothing in the returned structure is defined
        by the API.

        This function returns a dictionary, with keys matching
        the various fields in the guestfs_utsname structure.
        """
        self._check_not_closed()
        r = libguestfsmod.utsname(self._o)
        return r

    def version(self) -> dict:
        """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
        "g.available" or "g.feature_available" instead.

        This function returns a dictionary, with keys matching
        the various fields in the guestfs_version structure.
        """
        self._check_not_closed()
        r = libguestfsmod.version(self._o)
        return r

    def vfs_label(self, mountable: str) -> str:
        """This returns the label of the filesystem on "mountable".

        If the filesystem is unlabeled, this returns the empty
        string.

        To find a filesystem from the label, use
        "g.findfs_label".
        """
        self._check_not_closed()
        r = libguestfsmod.vfs_label(self._o, mountable)
        return r

    def vfs_minimum_size(self, mountable: str) -> int:
        """Get the minimum size of filesystem in bytes. This is the
        minimum possible size for filesystem shrinking.

        If getting minimum size of specified filesystem is not
        supported, this will fail and set errno as ENOTSUP.

        See also ntfsresize(8), resize2fs(8), btrfs(8),
        xfs_info(8).
        """
        self._check_not_closed()
        r = libguestfsmod.vfs_minimum_size(self._o, mountable)
        return r

    def vfs_type(self, mountable: str) -> str:
        """This command gets the filesystem type corresponding to
        the filesystem on "mountable".

        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".
        """
        self._check_not_closed()
        r = libguestfsmod.vfs_type(self._o, mountable)
        return r

    def vfs_uuid(self, mountable: str) -> str:
        """This returns the filesystem UUID of the filesystem on
        "mountable".

        If the filesystem does not have a UUID, this returns the
        empty string.

        To find a filesystem from the UUID, use "g.findfs_uuid".
        """
        self._check_not_closed()
        r = libguestfsmod.vfs_uuid(self._o, mountable)
        return r

    def vg_activate(self, activate: bool, volgroups: List[str]) -> None:
        """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.

        This function depends on the feature "lvm2". See also
        "g.feature-available".
        """
        volgroups = list(volgroups)
        self._check_not_closed()
        r = libguestfsmod.vg_activate(self._o, activate, volgroups)
        return r

    def vg_activate_all(self, activate: bool) -> None:
        """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"

        This function depends on the feature "lvm2". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.vg_activate_all(self._o, activate)
        return r

    def vgchange_uuid(self, vg: str) -> None:
        """Generate a new random UUID for the volume group "vg".

        This function depends on the feature "lvm2". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.vgchange_uuid(self._o, vg)
        return r

    def vgchange_uuid_all(self) -> None:
        """Generate new random UUIDs for all volume groups.

        This function depends on the feature "lvm2". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.vgchange_uuid_all(self._o)
        return r

    def vgcreate(self, volgroup: str, physvols: List[str]) -> None:
        """This creates an LVM volume group called "volgroup" from
        the non-empty list of physical volumes "physvols".

        This function depends on the feature "lvm2". See also
        "g.feature-available".
        """
        physvols = list(physvols)
        self._check_not_closed()
        r = libguestfsmod.vgcreate(self._o, volgroup, physvols)
        return r

    def vglvuuids(self, vgname: str) -> List[str]:
        """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 "g.lvs" and "g.lvuuid" calls
        to associate logical volumes and volume groups.

        See also "g.vgpvuuids".

        This function returns a list of strings.
        """
        self._check_not_closed()
        r = libguestfsmod.vglvuuids(self._o, vgname)
        return r

    def vgmeta(self, vgname: str) -> bytes:
        """"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.

        This function depends on the feature "lvm2". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.vgmeta(self._o, vgname)
        return r

    def vgpvuuids(self, vgname: str) -> List[str]:
        """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 "g.pvs" and "g.pvuuid" calls
        to associate physical volumes and volume groups.

        See also "g.vglvuuids".

        This function returns a list of strings.
        """
        self._check_not_closed()
        r = libguestfsmod.vgpvuuids(self._o, vgname)
        return r

    def vgremove(self, vgname: str) -> None:
        """Remove an LVM volume group "vgname", (for example "VG").

        This also forcibly removes all logical volumes in the
        volume group (if any).

        This function depends on the feature "lvm2". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.vgremove(self._o, vgname)
        return r

    def vgrename(self, volgroup: str, newvolgroup: str) -> None:
        """Rename a volume group "volgroup" with the new name
        "newvolgroup".
        """
        self._check_not_closed()
        r = libguestfsmod.vgrename(self._o, volgroup, newvolgroup)
        return r

    def vgs(self) -> List[str]:
        """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 "g.vgs_full".

        This function returns a list of strings.

        This function depends on the feature "lvm2". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.vgs(self._o)
        return r

    def vgs_full(self) -> List[dict]:
        """List all the volumes groups detected. This is the
        equivalent of the vgs(8) command. The "full" version
        includes all fields.

        This function returns a list of lvm_vgs. Each lvm_vg is
        represented as a dictionary.

        This function depends on the feature "lvm2". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.vgs_full(self._o)
        return r

    def vgscan(self) -> None:
        """This rescans all block devices and rebuilds the list of
        LVM physical volumes, volume groups and logical volumes.

        *This function is deprecated.* In new code, use the
        "lvm_scan" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.lvm_scan() "
                      "instead of GuestFS.vgscan()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.vgscan(self._o)
        return r

    def vguuid(self, vgname: str) -> str:
        """This command returns the UUID of the LVM VG named
        "vgname".
        """
        self._check_not_closed()
        r = libguestfsmod.vguuid(self._o, vgname)
        return r

    def wait_ready(self) -> None:
        """This function is a no op.

        In versions of the API < 1.0.71 you had to call this
        function just after calling "g.launch" to wait for the
        launch to complete. However this is no longer necessary
        because "g.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.

        *This function is deprecated.* There is no replacement.
        Consult the API documentation in guestfs(3) for further
        information.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("do not use GuestFS.wait_ready()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.wait_ready(self._o)
        return r

    def wc_c(self, path: str) -> int:
        """This command counts the characters in a file, using the
        "wc -c" external command.
        """
        self._check_not_closed()
        r = libguestfsmod.wc_c(self._o, path)
        return r

    def wc_l(self, path: str) -> int:
        """This command counts the lines in a file, using the "wc
        -l" external command.
        """
        self._check_not_closed()
        r = libguestfsmod.wc_l(self._o, path)
        return r

    def wc_w(self, path: str) -> int:
        """This command counts the words in a file, using the "wc
        -w" external command.
        """
        self._check_not_closed()
        r = libguestfsmod.wc_w(self._o, path)
        return r

    def wipefs(self, device: str) -> None:
        """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 "g.zero" which zeroes the first few blocks
        of a device.

        This function depends on the feature "wipefs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.wipefs(self._o, device)
        return r

    def write(self, path: str, content: bytes) -> None:
        """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 "g.write_append".
        """
        self._check_not_closed()
        r = libguestfsmod.write(self._o, path, content)
        return r

    def write_append(self, path: str, content: bytes) -> None:
        """This call appends "content" to the end of file "path".
        If "path" does not exist, then a new file is created.

        See also "g.write".
        """
        self._check_not_closed()
        r = libguestfsmod.write_append(self._o, path, content)
        return r

    def write_file(self, path: str, content: str, size: int) -> None:
        """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.

        Because of the message protocol, there is a transfer
        limit of somewhere between 2MB and 4MB. See "PROTOCOL
        LIMITS" in guestfs(3).

        *This function is deprecated.* In new code, use the
        "write" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.write() "
                      "instead of GuestFS.write_file()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.write_file(self._o, path, content, size)
        return r

    def xfs_admin(self, device: str, extunwritten: Optional[bool] = None,
                  imgfile: Optional[bool] = None, v2log: Optional[bool] = None,
                  projid32bit: Optional[bool] = None,
                  lazycounter: Optional[bool] = None,
                  label: Optional[str] = None,
                  uuid: Optional[str] = None) -> None:
        """Change the parameters of the XFS filesystem on "device".

        Devices that are mounted cannot be modified.
        Administrators must unmount filesystems before this call
        can modify parameters.

        Some of the parameters of a mounted filesystem can be
        examined and modified using the "g.xfs_info" and
        "g.xfs_growfs" calls.

        Beginning with XFS version 5, it is no longer possible
        to modify the lazy-counters setting (ie. "lazycounter"
        parameter has no effect).

        This function depends on the feature "xfs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.xfs_admin(self._o, device, extunwritten, imgfile,
                                    v2log, projid32bit, lazycounter, label,
                                    uuid)
        return r

    def xfs_growfs(self, path: str, datasec: Optional[bool] = None,
                   logsec: Optional[bool] = None, rtsec: Optional[bool] = None,
                   datasize: Optional[int] = None,
                   logsize: Optional[int] = None, rtsize: Optional[int] = None,
                   rtextsize: Optional[int] = None,
                   maxpct: Optional[int] = None) -> None:
        """Grow the XFS filesystem mounted at "path".

        The returned struct contains geometry information.
        Missing fields are returned as -1 (for numeric fields)
        or empty string.

        This function depends on the feature "xfs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.xfs_growfs(self._o, path, datasec, logsec, rtsec,
                                     datasize, logsize, rtsize, rtextsize,
                                     maxpct)
        return r

    def xfs_info(self, pathordevice: str) -> dict:
        """"pathordevice" is a mounted XFS filesystem or a device
        containing an XFS filesystem. This command returns the
        geometry of the filesystem.

        The returned struct contains geometry information.
        Missing fields are returned as -1 (for numeric fields)
        or empty string.

        This function returns a dictionary, with keys matching
        the various fields in the guestfs_xfsinfo structure.

        This function depends on the feature "xfs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.xfs_info(self._o, pathordevice)
        return r

    def xfs_repair(self, device: str, forcelogzero: Optional[bool] = None,
                   nomodify: Optional[bool] = None,
                   noprefetch: Optional[bool] = None,
                   forcegeometry: Optional[bool] = None,
                   maxmem: Optional[int] = None,
                   ihashsize: Optional[int] = None,
                   bhashsize: Optional[int] = None,
                   agstride: Optional[int] = None,
                   logdev: Optional[str] = None,
                   rtdev: Optional[str] = None) -> int:
        """Repair corrupt or damaged XFS filesystem on "device".

        The filesystem is specified using the "device" argument
        which should be the device name of the disk partition or
        volume containing the filesystem. If given the name of a
        block device, "xfs_repair" will attempt to find the raw
        device associated with the specified block device and
        will use the raw device instead.

        Regardless, the filesystem to be repaired must be
        unmounted, otherwise, the resulting filesystem may be
        inconsistent or corrupt.

        The returned status indicates whether filesystem
        corruption was detected (returns 1) or was not detected
        (returns 0).

        This function depends on the feature "xfs". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.xfs_repair(self._o, device, forcelogzero, nomodify,
                                     noprefetch, forcegeometry, maxmem,
                                     ihashsize, bhashsize, agstride, logdev,
                                     rtdev)
        return r

    def yara_destroy(self) -> None:
        """Destroy previously loaded Yara rules in order to free
        libguestfs resources.

        This function depends on the feature "libyara". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.yara_destroy(self._o)
        return r

    def yara_load(self, filename: str) -> None:
        """Upload a set of Yara rules from local file filename.

        Yara rules allow to categorize files based on textual or
        binary patterns within their content. See "g.yara_scan"
        to see how to scan files with the loaded rules.

        Rules can be in binary format, as when compiled with
        yarac command, or in source code format. In the latter
        case, the rules will be first compiled and then loaded.

        Rules in source code format cannot include external
        files. In such cases, it is recommended to compile them
        first.

        Previously loaded rules will be destroyed.

        This function depends on the feature "libyara". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.yara_load(self._o, filename)
        return r

    def yara_scan(self, path: str) -> List[dict]:
        """Scan a file with the previously loaded Yara rules.

        For each matching rule, a "yara_detection" structure is
        returned.

        The "yara_detection" structure contains the following
        fields.

        "yara_name"
        Path of the file matching a Yara rule.

        "yara_rule"
        Identifier of the Yara rule which matched against
        the given file.

        This function returns a list of yara_detections. Each
        yara_detection is represented as a dictionary.

        This function depends on the feature "libyara". See also
        "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.yara_scan(self._o, path)
        return r

    def zegrep(self, regex: str, path: str) -> List[str]:
        """This calls the external "zegrep" program and returns the
        matching lines.

        This function returns a list of strings.

        Because of the message protocol, there is a transfer
        limit of somewhere between 2MB and 4MB. See "PROTOCOL
        LIMITS" in guestfs(3).

        *This function is deprecated.* In new code, use the
        "grep" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.grep() "
                      "instead of GuestFS.zegrep()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.zegrep(self._o, regex, path)
        return r

    def zegrepi(self, regex: str, path: str) -> List[str]:
        """This calls the external "zegrep -i" program and returns
        the matching lines.

        This function returns a list of strings.

        Because of the message protocol, there is a transfer
        limit of somewhere between 2MB and 4MB. See "PROTOCOL
        LIMITS" in guestfs(3).

        *This function is deprecated.* In new code, use the
        "grep" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.grep() "
                      "instead of GuestFS.zegrepi()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.zegrepi(self._o, regex, path)
        return r

    def zero(self, device: str) -> None:
        """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: "g.zero_device", "g.scrub_device",
        "g.is_zero_device"
        """
        self._check_not_closed()
        r = libguestfsmod.zero(self._o, device)
        return r

    def zero_device(self, device: str) -> None:
        """This command writes zeroes over the entire "device".
        Compare with "g.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.
        """
        self._check_not_closed()
        r = libguestfsmod.zero_device(self._o, device)
        return r

    def zero_free_space(self, directory: str) -> None:
        """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.

        Free space is not "trimmed". You may want to call
        "g.fstrim" either as an alternative to this, or after
        calling this, depending on your requirements.
        """
        self._check_not_closed()
        r = libguestfsmod.zero_free_space(self._o, directory)
        return r

    def zerofree(self, device: str) -> None:
        """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.

        This function depends on the feature "zerofree". See
        also "g.feature-available".
        """
        self._check_not_closed()
        r = libguestfsmod.zerofree(self._o, device)
        return r

    def zfgrep(self, pattern: str, path: str) -> List[str]:
        """This calls the external "zfgrep" program and returns the
        matching lines.

        This function returns a list of strings.

        Because of the message protocol, there is a transfer
        limit of somewhere between 2MB and 4MB. See "PROTOCOL
        LIMITS" in guestfs(3).

        *This function is deprecated.* In new code, use the
        "grep" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.grep() "
                      "instead of GuestFS.zfgrep()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.zfgrep(self._o, pattern, path)
        return r

    def zfgrepi(self, pattern: str, path: str) -> List[str]:
        """This calls the external "zfgrep -i" program and returns
        the matching lines.

        This function returns a list of strings.

        Because of the message protocol, there is a transfer
        limit of somewhere between 2MB and 4MB. See "PROTOCOL
        LIMITS" in guestfs(3).

        *This function is deprecated.* In new code, use the
        "grep" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.grep() "
                      "instead of GuestFS.zfgrepi()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.zfgrepi(self._o, pattern, path)
        return r

    def zfile(self, meth: str, path: str) -> str:
        """This command runs file(1) after first decompressing
        "path" using "meth".

        "meth" must be one of "gzip", "compress" or "bzip2".

        Since 1.0.63, use "g.file" instead which can now process
        compressed files.

        *This function is deprecated.* In new code, use the
        "file" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.file() "
                      "instead of GuestFS.zfile()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.zfile(self._o, meth, path)
        return r

    def zgrep(self, regex: str, path: str) -> List[str]:
        """This calls the external zgrep(1) program and returns the
        matching lines.

        This function returns a list of strings.

        Because of the message protocol, there is a transfer
        limit of somewhere between 2MB and 4MB. See "PROTOCOL
        LIMITS" in guestfs(3).

        *This function is deprecated.* In new code, use the
        "grep" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.grep() "
                      "instead of GuestFS.zgrep()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.zgrep(self._o, regex, path)
        return r

    def zgrepi(self, regex: str, path: str) -> List[str]:
        """This calls the external "zgrep -i" program and returns
        the matching lines.

        This function returns a list of strings.

        Because of the message protocol, there is a transfer
        limit of somewhere between 2MB and 4MB. See "PROTOCOL
        LIMITS" in guestfs(3).

        *This function is deprecated.* In new code, use the
        "grep" call instead.

        Deprecated functions will not be removed from the API,
        but the fact that they are deprecated indicates that
        there are problems with correct use of these functions.
        """
        self._check_not_closed()
        import warnings
        warnings.warn("use GuestFS.grep() "
                      "instead of GuestFS.zgrepi()",
                      DeprecationWarning, stacklevel=2)
        r = libguestfsmod.zgrepi(self._o, regex, path)
        return r
