pyanaconda.modules.storage.storage_interface
============================================

.. py:module:: pyanaconda.modules.storage.storage_interface


Classes
-------

.. autoapisummary::

   pyanaconda.modules.storage.storage_interface.StorageInterface


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

.. py:class:: StorageInterface

   Bases: :py:obj:`pyanaconda.modules.common.base.KickstartModuleInterface`


   DBus interface for Storage module.


   .. py:method:: connect_signals()

      Connect the signals.



   .. py:method:: ScanDevicesWithTask()

      Scan all devices with a task.

      Create a model of the current storage. This model will be used
      to schedule partitioning actions and validate the planned
      partitioning layout. See the CreatePartitioning method.

      :return: a path to a task



   .. py:method:: CreatePartitioning(method)

      Create a new partitioning.

      Create a new partitioning module with its own copy of the current
      storage model. The partitioning module provides an isolated
      playground for scheduling partitioning actions and validating
      the planned partitioning layout. Once the layout is valid, call
      ApplyPartitioning to choose it for the installation.

      Allowed values:
          AUTOMATIC
          CUSTOM
          MANUAL
          INTERACTIVE
          BLIVET

      :param method: a partitioning method
      :return: a path to a partitioning



   .. py:property:: CreatedPartitioning
      :type: List[ObjPath]


      List of all created partitioning modules.

      :return: a list of DBus paths


   .. py:method:: ApplyPartitioning(partitioning)

      Apply the partitioning.

      Choose a valid partitioning layout of the specified partitioning
      module for an installation. Call InstallWithTasks to execute the
      scheduled actions and commit these changes to selected disks.

      The device tree module provides information about the partitioned
      storage model instead of the model of the current storage if there
      is an applied partitioning.

      :param partitioning: a path to a partitioning
      :raise: InvalidStorageError if the partitioning is not valid



   .. py:property:: AppliedPartitioning
      :type: Str


      The applied partitioning.

      An empty string is not a valid object path, so
      the return type has to be a string in this case.

      :return: a DBus path or an empty string


   .. py:method:: ResetPartitioning()

      Reset the scheduled partitioning.

      Reset the applied partitioning and reset the storage models of all
      partitioning modules to the latest model of the system's storage
      configuration.

      This method will not rescan the system.



   .. py:method:: WriteConfigurationWithTask()

      Write the storage configuration with a task.

      FIXME: This is a temporary workaround.

      :return: an installation task