Skip to content

Commit

Permalink
First stab at a functional description.
Browse files Browse the repository at this point in the history
  • Loading branch information
Sverre Johan Tøvik committed Oct 6, 2021
0 parents commit 3948d68
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions functional_description.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# General

An SNMP plugin which can take a *gapit config* as input, as oppsosed
to manually specifiying OIDs.

Parse/use gapit SNMP config, and snmp get all OIDs listed in config.
By default, stop querying OIDs for which "does not exist" is returned.
Results are returned in a similar format to the input format, e.g.
with group/stat names, and adjusted for specified scaling factors.

# Setup (node edit dialog)

* Same options as general snmp (server, community, etc.).
* A JSON text field for pasting a gapit config.
* Alternatively, the gapit config can be passed in the msg object,
overriding the text field (msg.gapit_config).
* A checkbox for "Keep querying non-existing OIDs" (also with a
msg.requery_nonexisting_oids).

# Internals

Keep track of OID avilability (i.e. which nodes return data, and which
return "OID does not exist") in *node context*. Unless "Keep quierying"
is set, stop querying unavailable OIDs. (This option is to account for
instances where OIDs are ephemeral.)

0 comments on commit 3948d68

Please sign in to comment.