Skip to content

Commit 43587a4

Browse files
authored
Updated docs to reflect use of MIB::OID usage in yaml and code (librenms#19053)
1 parent 9c0f53e commit 43587a4

1 file changed

Lines changed: 10 additions & 14 deletions

File tree

doc/Developing/os/Health-Information.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ the values we expect to see the data in:
1010
| ------------------------------- | --------------------------- |
1111
| airflow | cfm |
1212
| ber | ratio |
13+
| bitrate | bps |
1314
| charge | % |
1415
| chromatic_dispersion | ps/nm |
1516
| cooling | W |
@@ -23,6 +24,7 @@ the values we expect to see the data in:
2324
| humidity | % |
2425
| load | % |
2526
| loss | % |
27+
| percent | % |
2628
| power | W |
2729
| power_consumed | kWh |
2830
| power_factor | ratio |
@@ -34,11 +36,9 @@ the values we expect to see the data in:
3436
| state | # |
3537
| temperature | C |
3638
| tv_signal | dBmV |
37-
| bitrate | bps |
3839
| voltage | V |
3940
| waterflow | l/m |
40-
| percent | % |
41-
| signal_loss | dB |
41+
| signal_loss | dB |
4242

4343
### Simple health discovery
4444

@@ -58,35 +58,31 @@ all the data you need. We will use netbotz as an example here.
5858
`resources/definitions/os_discovery/netbotz.yaml`
5959

6060
```yaml
61-
mib: NETBOTZV2-MIB
6261
modules:
6362
sensors:
6463
airflow:
6564
options:
6665
skip_value_lt: 0
6766
data:
6867
-
69-
oid: airFlowSensorTable
70-
value: airFlowSensorValue
68+
oid: NETBOTZV2-MIB::airFlowSensorTable
69+
value: NETBOTZV2-MIB::airFlowSensorValue
7170
divisor: 10
7271
num_oid: '.1.3.6.1.4.1.5528.100.4.1.5.1.2.{{ $index }}'
73-
descr: '{{ $airFlowSensorLabel }}'
72+
descr: '{{ NETBOTZV2-MIB::airFlowSensorLabel }}'
7473
index: 'airFlowSensorValue.{{ $index }}'
7574
```
7675
77-
At the top you can define one or more mibs to be used in the lookup of data:
78-
79-
`mib: NETBOTZV2-MIB`
80-
For use of multiple MIB files separate them with a colon: `mib: NETBOTZV2-MIB:SECOND-MIB`
76+
Please ensure that you use the format MIB-NAME::OID for all references to OIDs.
8177
8278
For `data:` you have the following options:
8379

8480
The only sensor we have defined here is airflow. The available options
8581
are as follows:
8682

87-
- `oid` (required): This is the name of the table you want to snmp walk for data.
83+
- `oid` (required): This is the name of the table you want to snmp walk for data, prepended by the MIB-NAME, I.e `NETBOTZV2-MIB::airFlowSensorTable`.
8884
- `value` (optional): This is the key within the table that contains
89-
the value. If not provided will use `oid`
85+
the value, prepended by the MIB-NAME, I.e: `NETBOTZV2-MIB::airFlowSensorValue`. If not provided will use `oid`.
9086
- `num_oid` (required for PullRequests): If not provided, this parameter should be computed
9187
automatically by discovery process. This parameter is still required to
9288
submit a pull request. This is the numerical OID that contains
@@ -145,7 +141,7 @@ For `options:` you have the following available:
145141
- `skip_value_gt`: If sensor value is greater than this, skip the discovery.
146142

147143
Multiple variables can be used in the sensor's definition. The syntax
148-
is `{{ $variable }}`. Any oid in the current table can be used, as
144+
is `{{ MIB-NAME::variable }}`. Any oid in the current table can be used, as
149145
well as pre-fetched data. The index ($index) and the sub_indexes (in
150146
case the oid is indexed multiple times) are also available: if
151147
$index="1.20", then $subindex0="1" and $subindex1="20".

0 commit comments

Comments
 (0)