pyanaconda.modules.storage.devicetree.viewer_interface
======================================================

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


Classes
-------

.. autoapisummary::

   pyanaconda.modules.storage.devicetree.viewer_interface.DeviceTreeViewerInterface


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

.. py:class:: DeviceTreeViewerInterface

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


   DBus interface for the device tree viewer.


   .. py:method:: GetRootDevice()

      Get the root device.

      :return: a name of the root device if any



   .. py:method:: GetDevices()

      Get all devices in the device tree.

      :return: a list of device IDs



   .. py:method:: GetDisks()

      Get all disks in the device tree.

      Ignored disks are excluded, as are disks with no media present.

      :return: a list of device IDs



   .. py:method:: GetMountPoints()

      Get all mount points in the device tree.

      :return: a dictionary of mount points and device IDs



   .. py:method:: GetDeviceData(device_id)

      Get the device data.

      :param device_id: device ID
      :return: a structure with device data
      :raise: UnknownDeviceError if the device is not found



   .. py:method:: GetFormatData(device_id)

      Get the device format data.

      Return data about a format of the specified device.

      For example: sda1

      :param device_id: ID of the device
      :return: a structure with format data



   .. py:method:: GetFormatTypeData(name)

      Get the format type data.

      Return data about the specified format type.

      For example: ext4

      :param name: a name of the format type
      :return: a structure with format data



   .. py:method:: GetActions()

      Get the device actions.

      :return: a list of structures with device action data



   .. py:method:: ResolveDevice(dev_spec)

      Get the device matching the provided device specification.

      The spec can be anything from a device name (eg: 'sda3') to a
      device node path (eg: '/dev/mapper/fedora-root') to something
      like 'UUID=xyz-tuv-qrs' or 'LABEL=rootfs'.

      If no device is found, return an empty string.

      :param dev_spec: a string describing a block device
      :return: a device ID or an empty string



   .. py:method:: GetAncestors(device_ids)

      Collect ancestors of the specified devices.

      Ancestors of a device don't include the device itself.
      The list is sorted by IDs of the devices.

      :param device_ids: a list of device names
      :return: a list of device IDs



   .. py:method:: GetSupportedFileSystems()

      Get the supported types of filesystems.

      :return: a list of filesystem names



   .. py:method:: GetRequiredDeviceSize(required_space)

      Get device size we need to get the required space on the device.

      :param required_space: a required space in bytes
      :return: a required device size in bytes



   .. py:method:: GetFileSystemFreeSpace(mount_points)

      Get total file system free space on the given mount points.

      :param mount_points: a list of mount points
      :return: a total size in bytes



   .. py:method:: GetDiskFreeSpace(disk_ids)

      Get total free space on the given disks.

      Calculates free space available for use.

      :param disk_ids: a list of disk IDs
      :return: a total size in bytes



   .. py:method:: GetDiskReclaimableSpace(disk_ids)

      Get total reclaimable space on the given disks.

      Calculates free space unavailable but reclaimable
      from existing partitions.

      :param disk_ids: a list of disk IDs
      :return: a total size in bytes



   .. py:method:: GetDiskTotalSpace(disk_ids)

      Get total space on the given disks.

      :param disk_ids: a list of disk IDs
      :return: a total size in bytes



   .. py:method:: GetFstabSpec(device_id)

      Get the device specifier for use in /etc/fstab.

      :param device_id: ID of the device
      :return: a device specifier for /etc/fstab



   .. py:method:: GetExistingSystems()

      Get existing GNU/Linux installations.

      :return: a list of data about found installations



   .. py:method:: GetMountPointConstraints()

      Get list of constraints on mountpoints for the current platform

      Also provides hints if the partition is required or recommended.

      This includes mount points required to boot (e.g. /boot/efi, /boot)
      and the / partition which is always considered to be required.

      :return: a list of mount points with its constraints