pyanaconda.modules.storage.iscsi.iscsi_interface
================================================

.. py:module:: pyanaconda.modules.storage.iscsi.iscsi_interface


Classes
-------

.. autoapisummary::

   pyanaconda.modules.storage.iscsi.iscsi_interface.ISCSIDiscoverTaskInterface
   pyanaconda.modules.storage.iscsi.iscsi_interface.ISCSIInterface


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

.. py:class:: ISCSIDiscoverTaskInterface

   Bases: :py:obj:`pyanaconda.modules.common.task.TaskInterface`


   The interface for iSCSI discovery task.

   Returns a list of Node structures representing discovered nodes.


   .. py:method:: convert_result(value)
      :staticmethod:


      Convert the value of the result.

      Convert the value into a variant.

      :param value: a value of the result
      :return: a variant with the value
      :raises: NoResultError by default



.. py:class:: ISCSIInterface

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


   DBus interface for the iSCSI module.


   .. py:method:: connect_signals()

      Connect the signals.



   .. py:method:: IsSupported()

      Is this module supported?



   .. py:property:: Initiator
      :type: Str


      ISCSI initiator name.


   .. py:method:: CanSetInitiator()

      Can the iSCSI initator be set?

      Initiator name can be changed when no sessions are active.



   .. py:method:: GetInterfaceMode()

      Get the mode of interface used for iSCSI operations.

      The mode is chosen during discovery of nodes.  Once there there are
      active nodes logged in using particular mode, the mode can't be
      changed.

      Return values: IscsiInterfacesMode



   .. py:method:: DiscoverWithTask(portal, credentials, interfaces_mode)

      Discover an iSCSI device.

      :param portal: the portal information
      :param credentials: the iSCSI credentials
      :param interfaces_mode: required mode specified by IscsiInterfacesMode string value
      :return: a DBus path to a task



   .. py:method:: LoginWithTask(portal, credentials, node)

      Login into an iSCSI node discovered on a portal.

      :param portal: the portal information
      :param credentials: the iSCSI credentials
      :param node: the node information
      :return: a DBus path to a task



   .. py:method:: IsNodeFromIbft(node)

      Is the node configured from iBFT table?.

      :param node: the node information



   .. py:method:: GetInterface(iscsi_iface)

      Get network interface backing iscsi iface.

      :param iscsi_iface: name of an iscsi interface (eg iface0)
      :returns: specification of interface backing the iscsi iface (eg ens3)
                or "" if there is none



   .. py:method:: GetDracutArguments(node)

      Get dracut arguments for iSCSI device backed by the node.

      :param node: the node information
      :return: a list of dracut arguments

      FIXME: This is just a temporary method.



   .. py:method:: WriteConfiguration()

      Write the configuration to sysroot.

      FIXME: This is just a temporary method.