nyx_client.circles
==================

.. py:module:: nyx_client.circles

.. autoapi-nested-parse::

   Module for Circles-related (i.e. ACL) definitions in Nyx.



Classes
-------

.. autoapisummary::

   nyx_client.circles.RemoteHost
   nyx_client.circles.Circle


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

.. py:class:: RemoteHost

   Represents a remote host on the network.


   .. py:attribute:: did
      :type:  str

      the name of the organization


   .. py:attribute:: name
      :type:  str
      :value: ''


      the name of the organization


   .. py:method:: from_dict(value)
      :classmethod:


      Builds a Remote Host object from json.

      :param value: a dictionary of the organization object

      :returns: `RemoteHost` object



.. py:class:: Circle

   Represents a circle, which is a grouping of remote hosts.


   .. py:attribute:: name
      :type:  str

      The name of the circle, this must be unique within your instance.


   .. py:attribute:: description
      :type:  str | None
      :value: None


      Optional description of what the circle is.


   .. py:attribute:: did
      :type:  str | None
      :value: None


      The did of the circle.


   .. py:attribute:: organizations
      :type:  Sequence[RemoteHost]
      :value: ()


      Optional list of remote organizations in the circle.


   .. py:method:: from_dict(value)
      :classmethod:


      Builds a circle object from json.

      :param value: a dictionary of the circle object

      :returns: Circle object



   .. py:method:: as_dict()

      Returns the object as a dictionary.

      :returns: A dictionary of the circle, that matches POST/PUT requests in the API.