Skip to content

Commit

Permalink
[docs] Add instructions to create SNMP Check
Browse files Browse the repository at this point in the history
  • Loading branch information
purhan authored and Aryamanz29 committed May 18, 2022
1 parent 8abfc5b commit a08651c
Show file tree
Hide file tree
Showing 6 changed files with 49 additions and 10 deletions.
59 changes: 49 additions & 10 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -904,19 +904,58 @@ need to have an SNMP daemon in order for this to work.
This check is disabled by default, you may choose to enable auto creation of this check by setting
`OPENWISP_MONITORING_AUTO_SNMP <#OPENWISP_MONITORING_AUTO_SNMP>`_ to ``True``.

Instructions to use this feature:
Instructions to configure an SNMP Check
---------------------------------------

1. Register your device to OpenWISP via admin or `api <https://github.com/openwisp/openwisp-controller/#create-device>`_.
2. Create SNMP access credentials and add them to your device:
The following steps will help you use the SNMP Check feature:

In the admin, go to ``Access Credentials > Add Access Credentials`` and select a type suitable for your device's backend.
Then either enable ``Auto Add``, or add it to your device manually.
Alternatively, use the `api endpoint <https://github.com/openwisp/openwisp-controller/#create-credential>`_.
3. Create an SNMP check:
1. Register your device to OpenWISP
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Register your device making sure the ``mac address`` and ``management ip`` are correct:

.. image:: https://raw.githubusercontent.com/openwisp/openwisp-monitoring/issues/297-snmp-check/docs/snmp-check/snmp-check-1.png
:alt: Creating a device example

It is recommended to keep the `OPENWISP_MONITORING_AUTO_CLEAR_MANAGEMENT_IP <#OPENWISP_MONITORING_AUTO_CLEAR_MANAGEMENT_IP>`_
setting off to avoid losing the ``management ip``. This is important for the check to work.

1. Create SNMP access credentials and add them to your device
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

In the admin, go to ``Access Credentials > Add Access Credentials`` and select a type suitable for your device's backend.

.. image:: https://raw.githubusercontent.com/openwisp/openwisp-monitoring/issues/297-snmp-check/docs/snmp-check/snmp-check-2.png
:alt: Creating access credentials example

Then either enable ``Auto Add`` (it needs to have the same organization as the device for this to work), or add it to
your device manually as shown below.

.. image:: https://raw.githubusercontent.com/openwisp/openwisp-monitoring/issues/297-snmp-check/docs/snmp-check/snmp-check-3.png
:alt: Adding access credentials to device example

3. Create an SNMP check
~~~~~~~~~~~~~~~~~~~~~~~

You can skip this step and let OpenWISP do this automatically if you have the setting
`OPENWISP_MONITORING_AUTO_SNMP <#OPENWISP_MONITORING_AUTO_SNMP>`_ enabled.

To create the check manually, in the admin, go to ``Check > Add Check``. Now create a check as shown below:

.. image:: https://raw.githubusercontent.com/openwisp/openwisp-monitoring/issues/297-snmp-check/docs/snmp-check/snmp-check-4.png
:alt: Creating SNMP check example

Here, ``Object id`` is the UUID of the device you just created.

4. Run the check
~~~~~~~~~~~~~~~~

This should happen automatically if you have celery running in the background. For testing, you can
run this check manually using the `run_checks <#run_checks>`_ command. After that, you should see the
device charts and status instantly.

In the admin, go to ``Check > Add Check``. Choose ``content type: config | Device``, ``Check type: SNMP Device Monitoring``
and write your device's UUID in the ``Object id`` section.
You can alternatively use the setting `OPENWISP_MONITORING_AUTO_SNMP <#OPENWISP_MONITORING_AUTO_SNMP>`_.
.. image:: https://raw.githubusercontent.com/openwisp/openwisp-monitoring/issues/297-snmp-check/docs/snmp-check/snmp-check-5.png
:alt: Device status collected by snmp example

Settings
--------
Expand Down
Binary file added docs/snmp-check/snmp-check-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/snmp-check/snmp-check-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/snmp-check/snmp-check-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/snmp-check/snmp-check-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/snmp-check/snmp-check-5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a08651c

Please sign in to comment.