pyanaconda.modules.subscription.subscription_interface
======================================================

.. py:module:: pyanaconda.modules.subscription.subscription_interface


Classes
-------

.. autoapisummary::

   pyanaconda.modules.subscription.subscription_interface.RetrieveOrganizationsTaskInterface
   pyanaconda.modules.subscription.subscription_interface.SubscriptionInterface


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

.. py:class:: RetrieveOrganizationsTaskInterface

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


   The interface for a organization data parsing task.

   Such a task returns a list of organization data objects.


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


      Convert the list of org data DBus structs.

      Convert list of org data DBus structs to variant.
      :param value: a validation report
      :return: a variant with the structure



.. py:class:: SubscriptionInterface

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


   DBus interface for the Subscription service.


   .. py:method:: connect_signals()

      Connect the signals.



   .. py:method:: GetValidRoles()

      Return all valid system purpose roles.

      These are OS release specific, but could look like this:

      "Red Hat Enterprise Linux Server"
      "Red Hat Enterprise Linux Workstation"
      "Red Hat Enterprise Linux Compute Node"



   .. py:method:: GetValidSLAs()

      Return all valid system purpose SLAs.

      These are OS release specific, but could look like this:

      "Premium"
      "Standard"
      "Self-Support"



   .. py:method:: GetValidUsageTypes()

      List all valid system purpose usage types.

      These are OS release specific, but could look like this:

      "Production",
      "Development/Test",
      "Disaster Recovery"



   .. py:property:: SystemPurposeData
      :type: Structure


      Return DBus structure holding current system purpose data.


   .. py:method:: SetSystemPurposeWithTask()

      Set system purpose for the installed system with an installation task.

      :return: a DBus path of an installation task



   .. py:property:: SubscriptionRequest
      :type: Structure


      Return DBus structure holding current subscription request.

      Subscription request holds data necessary for a successful subscription attempt.


   .. py:property:: InsightsEnabled
      :type: Int


      Connect the target system to Red Hat Insights.


   .. py:property:: IsRegistered
      :type: Bool


      Report if the system is registered.


   .. py:property:: IsRegisteredToSatellite
      :type: Bool


      Report if the system is registered to a Satellite instance.


   .. py:property:: IsSimpleContentAccessEnabled
      :type: Bool


      Report if Simple Content Access is enabled.


   .. py:property:: IsSubscriptionAttached
      :type: Bool


      Report if an entitlement has been successfully attached.


   .. py:method:: SetRHSMConfigWithTask()

      Set RHSM configuration with a runtime DBus task.

      :return: a DBus path of an installation task



   .. py:method:: UnregisterWithTask()

      Unregister using a runtime DBus task.

      :return: a DBus path of an installation task



   .. py:method:: RegisterAndSubscribeWithTask()

      Register and subscribe with a runtime DBus task.

      :return: a DBus path of a runtime task



   .. py:method:: RetrieveOrganizationsWithTask()

      Get organization data using a runtime DBus task.

      :return: a DBus path of a runtime task