.. _snmp:

SNMP
####

StoredSafe can be monitored thru encrypted and authenticated SNMPv3
requests.

The below SNMP object identifiers (OID) are available and gives access
to CPU, disk, memory, processes, system information and sensors.

::

    .1.3.6.1.2.1.1 (HOST-RESOURCES-MIB::host)
    .1.3.6.1.2.1.25.1 (HOST-RESOURCES-MIB::host.hrSystem)
    .1.3.6.1.4.1.2021 (UCD-SNMP-MIB::ucdavis)
    .1.3.6.1.2.1.31.1.1.1 (IF-MIB::ifMIB)
    .1.3.6.1.4.1.8072.1.3.2 (NET-SNMP-EXTEND-MIB::nsExtendObjects)

The username, strings to be used for encryption and authentication, what
methods to use (AES/DES or SHA1/MD5) is set in the :ref:`usm_information`
sub menu.

Healthcheck
-----------

It is also possible to check the status of the appliance by running a
healthcheck via an SNMPv3 get on the OID
``NET-SNMP-EXTEND-MIB::nsExtendOutput1Line."healthcheck"``, which will
return the number of objects stored in the StoredSafe vault.

**Example**

In the output from the healthcheck below, the OID ``NET-SNMP-EXTEND-MIB::nsExtendOutput1Line."healthcheck"``
returns the total number (**4201**) of objects and files (both active and de-activated) in StoredSafe.

::

    $ snmpwalk -m +UCD-SNMP-MIB -v3 -l authPriv -u storedsafe -a SHA -A <authstring> -x AES -X <encryptionstring> 192.168.12.43 .1.3.6.1.4.1.8072.1.3.2
    NET-SNMP-EXTEND-MIB::nsExtendNumEntries.0 = INTEGER: 1
    NET-SNMP-EXTEND-MIB::nsExtendCommand."healthcheck" = STRING: /opt/storedsafe/bin/healthcheck
    NET-SNMP-EXTEND-MIB::nsExtendArgs."healthcheck" = STRING:
    NET-SNMP-EXTEND-MIB::nsExtendInput."healthcheck" = STRING:
    NET-SNMP-EXTEND-MIB::nsExtendCacheTime."healthcheck" = INTEGER: 5
    NET-SNMP-EXTEND-MIB::nsExtendExecType."healthcheck" = INTEGER: exec(1)
    NET-SNMP-EXTEND-MIB::nsExtendRunType."healthcheck" = INTEGER: run-on-read(1)
    NET-SNMP-EXTEND-MIB::nsExtendStorage."healthcheck" = INTEGER: permanent(4)
    NET-SNMP-EXTEND-MIB::nsExtendStatus."healthcheck" = INTEGER: active(1)
    NET-SNMP-EXTEND-MIB::nsExtendOutput1Line."healthcheck" = STRING: 4201
    NET-SNMP-EXTEND-MIB::nsExtendOutputFull."healthcheck" = STRING: 4201
    NET-SNMP-EXTEND-MIB::nsExtendOutNumLines."healthcheck" = INTEGER: 1
    NET-SNMP-EXTEND-MIB::nsExtendResult."healthcheck" = INTEGER: 0
    NET-SNMP-EXTEND-MIB::nsExtendOutLine."healthcheck".1 = STRING: 0

Monitoring
----------

The below example illustrates using the ``UCD-SNMP-MIB::ucdavis`` process
table to monitor processes on the StoredSafe appliance.

**Example**

In the example below 2 processes are down as seen by the ``UCD-SNMP-MIB::prErrorFlag.1``
and ``UCD-SNMP-MIB::prErrorFlag.2`` fields.


::

    $ snmpwalk -m +UCD-SNMP-MIB -v3 -l authPriv -u storedsafe -a SHA -A <authstring> -x AES -X <encryptionstring> 192.168.12.43 iso.3.6.1.4.1.2021
    UCD-SNMP-MIB::prIndex.1 = INTEGER: 1
    UCD-SNMP-MIB::prIndex.2 = INTEGER: 2
    UCD-SNMP-MIB::prIndex.3 = INTEGER: 3
    UCD-SNMP-MIB::prIndex.4 = INTEGER: 4
    UCD-SNMP-MIB::prNames.1 = STRING: python
    UCD-SNMP-MIB::prNames.2 = STRING: nginx
    UCD-SNMP-MIB::prNames.3 = STRING: rsyslogd
    UCD-SNMP-MIB::prNames.4 = STRING: mysqld
    UCD-SNMP-MIB::prMin.1 = INTEGER: 0
    UCD-SNMP-MIB::prMin.2 = INTEGER: 0
    UCD-SNMP-MIB::prMin.3 = INTEGER: 0
    UCD-SNMP-MIB::prMin.4 = INTEGER: 0
    UCD-SNMP-MIB::prMax.1 = INTEGER: 0
    UCD-SNMP-MIB::prMax.2 = INTEGER: 0
    UCD-SNMP-MIB::prMax.3 = INTEGER: 0
    UCD-SNMP-MIB::prMax.4 = INTEGER: 0
    UCD-SNMP-MIB::prCount.1 = INTEGER: 0
    UCD-SNMP-MIB::prCount.2 = INTEGER: 0
    UCD-SNMP-MIB::prCount.3 = INTEGER: 1
    UCD-SNMP-MIB::prCount.4 = INTEGER: 1
    UCD-SNMP-MIB::prErrorFlag.1 = INTEGER: error(1)
    UCD-SNMP-MIB::prErrorFlag.2 = INTEGER: error(1)
    UCD-SNMP-MIB::prErrorFlag.3 = INTEGER: noError(0)
    UCD-SNMP-MIB::prErrorFlag.4 = INTEGER: noError(0)
    UCD-SNMP-MIB::prErrMessage.1 = STRING: No python process running.
    UCD-SNMP-MIB::prErrMessage.2 = STRING: No nginx process running.