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

Update Documentation (#12411)

Browse Source 
* Update Documentation

Most work in Graylog and SNMP
Fixed many code tags, spelling and wording.
Added SNMP PowerShell example.

* Update SNMP-Configuration-Examples.md

Fix TOC brackets
This commit is contained in:
dlehman83
2020-12-30 09:38:14 -05:00
committed by GitHub
parent c3d47dee4a
commit 9f591c0aa2
29 changed files with 149 additions and 95 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/Developing/Creating-Documentation.md
View File

@@ -31,7 +31,7 @@ documentation to go along with it. It's quite simple to do this:
- If the document could cover different distros like CentOS and
Ubuntu please try and include the information for them all. If
that's not possible then at least put a placeholder in asking for contributions.
- Ensure you use the correct formating for `commands` and `code
- Ensure you use the correct formatting for `commands` and `code
blocks` by wrapping one liners in backticks or blocks in ```.
- Put content into sub-headings where possible to organise the
content.

2
doc/Developing/Sensor-State-Support.md
View File

@@ -117,7 +117,7 @@ modules:
For advanced state discovery:
This example will be based on a Cisco power supply sensor and is all
it takes to have sensor state support for Cisco power supplys in Cisco
it takes to have sensor state support for Cisco power supplies in Cisco
switches. The file should be located in /includes/discovery/sensors/state/cisco.inc.php.
```php

34
doc/Developing/os/Wireless-Sensors.md
View File

@@ -32,7 +32,7 @@ with the values we expect to see the data in:
| ssr | dB | WirelessSsrDiscovery | The Signal strength ratio, the ratio(or difference) of Vertical rx power to Horizontal rx power |
| utilization | % | WirelessUtilizationDiscovery | The % of utilization compared to the current rate |
You will need to create a new OS class for your os if one doen't exist
You will need to create a new OS class for your os if one doesn't exist
under `LibreNMS/OS`. The name of this file should be the os name in
camel case for example `airos -> Airos`, `ios-wlc -> IosWlc`.
@@ -62,40 +62,40 @@ All discovery interfaces will require you to return an array of WirelessSensor o
`new WirelessSensor()` Accepts the following arguments:
- $type = Required. This is the sensor class from the table above (i.e humidity).
- $device_id = Required. You can get this value with $this->getDeviceId()
- $oids = Required. This must be the numerical OID for where the data
- `$type =` Required. This is the sensor class from the table above (i.e humidity).
- `$device_id =` Required. You can get this value with $this->getDeviceId()
- `$oids =` Required. This must be the numerical OID for where the data
can be found, i.e .1.2.3.4.5.6.7.0. If this is an array of oids, you
should probably specify an $aggregator.
- $subtype = Required. This should be the OS name, i.e airos.
- $index = Required. This must be unique for this sensor type, device and subtype.
- `$subtype =` Required. This should be the OS name, i.e airos.
- `$index =` Required. This must be unique for this sensor type, device and subtype.
Typically it's the index from the table being walked or it could be
the name of the OID if it's a single value.
- $description = Required. This is a descriptive value for the sensor.
- `$description =` Required. This is a descriptive value for the sensor.
Shown to the user, if this is a per-ssid statistic, using `SSID:
$ssid` here is appropriate
- $current = Defaults to null. Can be used to set the current value on discovery.
- `$current =` Defaults to null. Can be used to set the current value on discovery.
If this is null the values will be polled right away and if they do
not return valid value(s), the sensor will not be
discovered. Supplying a value here implies you have already verified
this sensor is valid.
- $multiplier = Defaults to 1. This is used to multiply the returned value.
- $divisor = Defaults to 1. This is used to divided the returned value.
- `$multiplier =` Defaults to 1. This is used to multiply the returned value.
- `$divisor =` Defaults to 1. This is used to divided the returned value.
- $aggregator = Defaults to sum. Valid values: sum, avg. This will
combine multiple values from multiple oids into one.
- $access_point_id = Defaults to null. If this is a wireless
- `$access_point_id =` Defaults to null. If this is a wireless
controller, you can link sensors to entries in the access_points table.
- $high_limit = Defaults to null. Sets the high limit for the sensor,
- `$high_limit =` Defaults to null. Sets the high limit for the sensor,
used in alerting to report out range sensors.
- $low_limit = Defaults to null. Sets the low threshold limit for the
- `$low_limit =` Defaults to null. Sets the low threshold limit for the
sensor, used in alerting to report out range sensors.
- $high_warn = Defaults to null. Sets the high warning limit for the
- `$high_warn =` Defaults to null. Sets the high warning limit for the
sensor, used in alerting to report near out of range sensors.
- $low_warn = Defaults to null. Sets the low warning limit for the
- `$low_warn =` Defaults to null. Sets the low warning limit for the
sensor, used in alerting to report near out of range sensors.
- $entPhysicalIndex = Defaults to null. Sets the entPhysicalIndex to
- `$entPhysicalIndex =` Defaults to null. Sets the entPhysicalIndex to
be used to look up further hardware if available.
- $entPhysicalIndexMeasured = Defaults to null. Sets the type of
- `$entPhysicalIndexMeasured =` Defaults to null. Sets the type of
entPhysicalIndex used, i.e ports.
Polling is done automatically based on the discovered data. If for