:py:mod:`pywebui.tcpip.hosts`
=============================

.. py:module:: pywebui.tcpip.hosts


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

Classes
~~~~~~~

.. autoapisummary::

   pywebui.tcpip.hosts.Host
   pywebui.tcpip.hosts.HostMethods




.. py:class:: Host(attrs)



   Host object.

   .. attribute:: address

      the IP address of host.

      :type: str

   .. attribute:: aliases

      the array with aliases of host.

      :type: list(str)

   .. attribute:: name

      the name of host.

      :type: str


.. py:class:: HostMethods

   Encapsulates methods for manage hosts.

   .. py:method:: get_hosts(self) -> List[Host]

      Returns list of hosts.


   .. py:method:: add_host(self, name: str, address: str, aliases: List[str] = None) -> bool

      Creates the new host.


   .. py:method:: edit_host_aliases(self, name: str, address: str, aliases: List[str] = None) -> bool

      Edits aliases of the selected host.


   .. py:method:: delete_host(self, name: str, address: str) -> bool

      Delete host.