pyanaconda.modules.storage.devicetree.handler_interface
=======================================================

.. py:module:: pyanaconda.modules.storage.devicetree.handler_interface


Classes
-------

.. autoapisummary::

   pyanaconda.modules.storage.devicetree.handler_interface.DeviceTreeHandlerInterface


Module Contents
---------------

.. py:class:: DeviceTreeHandlerInterface

   Bases: :py:obj:`pyanaconda.modules.common.base.base_template.InterfaceTemplate`


   DBus interface for the device tree handler.


   .. py:method:: MountDevice(device_id, mount_point, options)

      Mount a filesystem on the device.

      :param device_id: ID of the device
      :param mount_point: a path to the mount point
      :param options: a string with mount options or an empty string to use defaults
      :raise: MountFilesystemError if mount fails



   .. py:method:: UnmountDevice(device_id, mount_point)

      Unmount a filesystem on the device.

      :param device_id: ID of the device
      :param mount_point: a path to the mount point
      :raise: MountFilesystemError if unmount fails



   .. py:method:: UnlockDevice(device_id, passphrase)

      Unlock a device.

      :param device_id: ID of the device
      :param passphrase: a passphrase
      :return: True if success, otherwise False



   .. py:method:: FindUnconfiguredLUKS()

      Find all unconfigured LUKS devices.

      Returns a list of devices that require to set up
      a passphrase to complete their configuration.

      :return: a list of device IDs



   .. py:method:: SetDevicePassphrase(device_id, passphrase)

      Set a passphrase of the unconfigured LUKS device.

      :param device_id: ID of the device
      :param passphrase: a passphrase



   .. py:method:: GetDeviceMountOptions(device_id)

      Get mount options of the specified device.

      :param device_id: ID of the device
      :return: a string with options



   .. py:method:: SetDeviceMountOptions(device_id, mount_options)

      Set mount options of the specified device.

      Specifies a free form string of options to be used when
      mounting the filesystem. This string will be copied into
      the /etc/fstab file of the installed system.

      :param device_id: ID of the device
      :param mount_options: a string with options



   .. py:method:: FindDevicesWithTask()

      Find new devices.

      The task will populate the device tree with new devices.

      :return: a path to the task



   .. py:method:: FindOpticalMedia()

      Find all devices with mountable optical media.

      :return: a list of device IDs



   .. py:method:: FindMountablePartitions()

      Find all mountable partitions.

      :return: a list of device IDs



   .. py:method:: FindExistingSystemsWithTask()

      Find existing GNU/Linux installations.

      The task will update data about existing installations.

      :return: a path to the task



   .. py:method:: MountExistingSystemWithTask(device_id, read_only)

      Mount existing GNU/Linux installation.

      :param device_id: device ID of the root device
      :param read_only: mount the system in read-only mode
      :return: a path to the task