:py:mod:`pywebui.cluster`
=========================

.. py:module:: pywebui.cluster


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

Classes
~~~~~~~

.. autoapisummary::

   pywebui.cluster.Node
   pywebui.cluster.ClusterMethods




.. py:class:: Node



   Cluster node object.

   .. attribute:: boottime

      the time when the node was booted (Unix Epoch format).

      :type: int

   .. attribute:: csid

      the CSID of the node.

      :type: int

   .. attribute:: hardware

      the model name string of the node.

      :type: str

   .. attribute:: ip

      the IP address of the node.

      :type: str

   .. attribute:: nodename

      the name of the node.

      :type: str

   .. attribute:: online

      the state of WebUI server (true - WebUI server started on this node, false - WebUI server isn't started on this node or isn’t installed, unknown - state of WebUI server unknown).

      :type: str

   .. attribute:: os

      the software version number of the OpenVMS operating system running on the node.

      :type: str

   .. attribute:: status

      the status of the node in cluster.

      :type: str


.. py:class:: ClusterMethods

   Encapsulates methods for manage nodes.

   .. py:method:: get_nodes(self) -> List[Node]

      Returns list of nodes.