mirror/librenms-librenms
1
0
Fork 0
mirror of https://github.com/librenms/librenms.git synced 2024-10-07 16:52:45 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

refactor: Updated discovery/poller to use numeric sysObjectID (#7922)

Browse Source 
* refactor: Updated discovery to use a core module for sysDescr/sysObjectID use

* final update hopefully

* revert changes

* more changes + docs

* migrated poller to use numerical sysObjectID

* more updates for sysObjectID

* update any alert rules which might have enterprises. in

* moved schema file

* small updates

* updated getHostOS()

* scrut fixes

* updated sysObjectId -> sysObjectID

* updated sysObjectId -> sysObjectID

* updated remainder of sysObjectId -> sysObjectID

* another sysObjectId -> sysObjectID

* fixed secureplatform test data

* Fix tests: $device is not pulled from the database before polling
Also, update the db in the core discovery module.
This commit is contained in:
Neil Lathwood
2018-01-07 05:00:47 +00:00
committed by Tony Murray
parent e2f122aac8
commit 42e5819130
438 changed files with 666 additions and 647 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
doc/Developing/os/Initial-Detection.md
View File

@@ -18,18 +18,18 @@ over:
- { graph: device_processor, text: 'CPU Usage' }
- { graph: device_mempool, text: 'Memory Usage' }
discovery:
- sysObjectId:
- sysObjectID:
- .1.3.6.1.4.1.12532.
```
`over`: This is a list of the graphs which will be shown within the device header bar (mini graphs top right).
`discovery`: Here we are detecting this new OS using sysObjectId, this is the preferred method for detection.
`discovery`: Here we are detecting this new OS using sysObjectID, this is the preferred method for detection.
Other options are available:
- `sysObjectId` The preferred operator. Checks if the sysObjectID starts with one of the strings under this item
- `sysDescr` Use this in addition to sysObjectId if required. Check that the sysDescr contains one of the strings under this item
- `sysObjectId_regex` Please avoid use of this. Checks if the sysObjectId matches one of the regex statements under this item
- `sysObjectID` The preferred operator. Checks if the sysObjectID starts with one of the strings under this item
- `sysDescr` Use this in addition to sysObjectID if required. Check that the sysDescr contains one of the strings under this item
- `sysObjectID_regex` Please avoid use of this. Checks if the sysObjectID matches one of the regex statements under this item
- `sysDescr_regex` Please avoid use of this. Checks if the sysDescr matches one of the regex statements under this item
- `snmpget` Do not use this unless none of the other methods work. Fetch an oid and compare it against a value.
- `_except` You can add this to any of the above to exclude that element. As an example:
@@ -37,7 +37,7 @@ Other options are available:
```yaml
discovery:
-
sysObjectId:
sysObjectID:
- .1.3.6.1.4.1.12532.
sysDescr_except:
- 'Not some pulse'
@@ -86,24 +86,24 @@ discovery_modules:
YAML is converted to an array in PHP. Consider the following YAML:
```yaml
discovery:
- sysObjectId: foo
- sysObjectID: foo
-
sysDescr: [ snafu, exodar ]
sysObjectId: bar
sysObjectID: bar
```
This is how the discovery array would look in PHP:
```php
[
[
"sysObjectId" => "foo",
"sysObjectID" => "foo",
],
[
"sysDescr" => [
"snafu",
"exodar",
],
"sysObjectId" => "bar",
"sysObjectID" => "bar",
]
]
```
@@ -111,15 +111,20 @@ This is how the discovery array would look in PHP:
The logic for the discovery is as follows:
1. One of the first level items must match
2. ALL of the second level items must match (sysObjectId, sysDescr)
2. ALL of the second level items must match (sysObjectID, sysDescr)
3. One of the third level items (foo, [snafu,exodar], bar) must match
So, considering the example:
- `sysObjectId: foo, sysDescr: ANYTHING` matches
- `sysObjectId: bar, sysDescr: ANYTHING` does not match
- `sysObjectId: bar, sysDescr: exodar` matches
- `sysObjectId: bar, sysDescr: snafu` matches
- `sysObjectID: foo, sysDescr: ANYTHING` matches
- `sysObjectID: bar, sysDescr: ANYTHING` does not match
- `sysObjectID: bar, sysDescr: exodar` matches
- `sysObjectID: bar, sysDescr: snafu` matches
#### Discovery helpers
Within the discovery code base if you are using php then the following helpers are available:
`$device['sysObjectID]`: This will contain the full numerical sysObjectID for this device.
`$device['sysDescr']`: This will contain the full sysDescr for this device.
### Poller