API
===

This page contains the auto-generated documentation for the ocs package.

agents
------

The ``agents/`` directory contains the OCS Agents, as well as any supporting
code.

agents.access_director
``````````````````````

.. automodule:: ocs.agents.access_director.agent
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex:

agents.aggregator
`````````````````

.. automodule:: ocs.agents.aggregator.agent
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex:

.. automodule:: ocs.agents.aggregator.drivers
    :members:
    :undoc-members:
    :show-inheritance:

agents.barebones
````````````````

.. automodule:: ocs.agents.barebones.agent
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex:

agents.fake_data
````````````````

.. automodule:: ocs.agents.fake_data.agent
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex:

agents.host_manager
```````````````````

.. automodule:: ocs.agents.host_manager.agent
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex:

.. automodule:: ocs.agents.host_manager.drivers
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex:

agents.influxdb_publisher
`````````````````````````

.. automodule:: ocs.agents.influxdb_publisher.agent
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex:

.. automodule:: ocs.agents.influxdb_publisher.drivers
    :members:
    :undoc-members:
    :show-inheritance:

agents.registry
```````````````

.. automodule:: ocs.agents.registry.agent
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex:

ocs.agent_cli
-------------

.. automodule:: ocs.agent_cli
    :members: build_agent_list
    :undoc-members:
    :show-inheritance:

ocs.access
----------

.. automodule:: ocs.access
    :members:
    :undoc-members:
    :show-inheritance:

.. _ocs_base_api:

ocs.base
--------

.. automodule:: ocs.base
    :members:
    :undoc-members:
    :show-inheritance:

ocs.client_http
---------------

.. automodule:: ocs.client_http
    :members:
    :undoc-members:
    :show-inheritance:

ocs.client_t
------------

.. automodule:: ocs.client_t
    :members:
    :undoc-members:
    :show-inheritance:

ocs.common
----------

The ``common/`` directory contains driver code shared among agents.

ocs.common.influxdb_drivers
```````````````````````````

.. automodule:: ocs.common.influxdb_drivers
    :members:
    :undoc-members:
    :show-inheritance:

.. _ocs_agent_api:

ocs.ocs_agent
-------------

.. automodule:: ocs.ocs_agent
    :members:
    :undoc-members:
    :private-members:
    :show-inheritance:

.. _ocs_feed_api:

ocs.ocs_client
------------------

.. automodule:: ocs.ocs_client
    :members:
    :exclude-members: _opname_to_attr, _humanized_time
    :undoc-members:
    :show-inheritance:
    :private-members:

ocs.ocs_feed
------------

.. automodule:: ocs.ocs_feed
    :members:
    :undoc-members:
    :show-inheritance:

.. _ocs_twisted_api:

ocs.ocs_twisted
---------------

.. automodule:: ocs.ocs_twisted
    :members:
    :undoc-members:
    :show-inheritance:

ocs.site_config
---------------

.. automodule:: ocs.site_config
    :members:
    :undoc-members:
    :show-inheritance: