Skip to content
Snippets Groups Projects
Commit 9e014ad0 authored by Erik Reid's avatar Erik Reid
Browse files

added docs

parent 65eb5f03
No related branches found
No related tags found
No related merge requests found
...@@ -33,4 +33,5 @@ API modules ...@@ -33,4 +33,5 @@ API modules
lg lg
data data
jobs jobs
msr msr
\ No newline at end of file lnetd
\ No newline at end of file
.. LnetD endpoint docs
LnetD support
=========================
This endpoint is intended for use with LnetD
.. contents:: :local:
/LnetD/interfaces</hostname>
---------------------------------
.. autofunction:: inventory_provider.routes.lnetd.interfaces
...@@ -130,17 +130,13 @@ def _load_interfaces(hostname=None): ...@@ -130,17 +130,13 @@ def _load_interfaces(hostname=None):
@common.require_accepts_json @common.require_accepts_json
def interfaces(hostname=None): def interfaces(hostname=None):
""" """
Handler for `/poller/interfaces` and Handler for `/LnetD/interfaces` and
`/poller/interfaces/<hostname>` `/LnetD/interfaces/<hostname>`
which returns information for either all interfaces which returns information for either all interfaces
or those on the requested hostname. or those on the requested hostname.
The response is a list of information for all
interfaces that should be polled, including service
information and snmp information.
.. asjson:: .. asjson::
inventory_provider.routes.poller.INTERFACE_LIST_SCHEMA inventory_provider.routes.lnetd.INTERFACE_LIST_SCHEMA
:param hostname: optional, if present should be a router hostname :param hostname: optional, if present should be a router hostname
:return: :return:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment