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: Move OS definitions into yaml files (#5189)

Browse Source
This commit is contained in:
Neil Lathwood
2016-12-23 17:53:19 +00:00
committed by GitHub
parent 6d027c5753
commit f5a16be0e3
315 changed files with 10839 additions and 2868 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
doc/Developing/Support-New-OS.md
View File

@@ -13,26 +13,23 @@ If we have the MIB, we can copy the file into the default directory:
```
#### New OS definition
Let's begin to declare the new OS in LibreNMS. At first we modify the definition file located here:
Let's begin to declare the new OS in LibreNMS. At first we create a new definition file located here:
```bash
includes/definitions.inc.php
includes/definitions/$os.yaml
```
```php
// Pulse Secure OS definition
$os = 'pulse';
$config['os'][$os]['text'] = 'Pulse Secure';
$config['os'][$os]['type'] = 'firewall';
$config['os'][$os]['icon'] = 'junos';
$config['os'][$os]['over'][0]['graph'] = 'device_bits';
$config['os'][$os]['over'][0]['text'] = 'Device Traffic';
$config['os'][$os]['over'][1]['graph'] = 'device_processor';
$config['os'][$os]['over'][1]['text'] = 'CPU Usage';
$config['os'][$os]['over'][2]['graph'] = 'device_mempool';
$config['os'][$os]['over'][2]['text'] = 'Memory Usage';
This is a [Yaml file](https://en.wikipedia.org/wiki/YAML). Please be careful of the formatting of this file.
//The icon described before is the image we have to create and put in the directory html/images/os
```yaml
os: pulse
text: 'Pulse Secure'
type: firewall
icon: pulse
over:
- { graph: device_bits, text: 'Device Traffic' }
- { graph: device_processor, text: 'CPU Usage' }
- { graph: device_mempool, text: 'Memory Usage' }
```
#### Discovery OS
@@ -127,26 +124,26 @@ iveCpuUtil.0 = Gauge32: 28
```
#### New OS definition
Let's begin to declare the new OS in LibreNMS. At first we modify the definition file located here:
Let's begin to declare the new OS in LibreNMS. At first we create a new definition file located here:
```bash
includes/definitions.inc.php
includes/definitions/$os.yaml
```
```php
// Pulse Secure OS definition
$os = 'pulse';
$config['os'][$os]['text'] = 'Pulse Secure';
$config['os'][$os]['type'] = 'firewall';
$config['os'][$os]['icon'] = 'junos';
$config['os'][$os]['over'][0]['graph'] = 'device_bits';
$config['os'][$os]['over'][0]['text'] = 'Device Traffic';
$config['os'][$os]['over'][1]['graph'] = 'device_processor';
$config['os'][$os]['over'][1]['text'] = 'CPU Usage';
$config['os'][$os]['over'][2]['graph'] = 'device_mempool';
$config['os'][$os]['over'][2]['text'] = 'Memory Usage';
This is a [Yaml file](https://en.wikipedia.org/wiki/YAML). Please be careful of the formatting of this file.
//The icon described before is the image we have to create and put in the directory html/images/os
```yaml
os: pulse
text: 'Pulse Secure'
type: firewall
icon: pulse
over:
- { graph: device_bits, text: 'Device Traffic' }
- { graph: device_processor, text: 'CPU Usage' }
- { graph: device_mempool, text: 'Memory Usage' }
```
If you are adding custom graphs, please add the following to `includes/definitions.inc.php`:
//Don't forget to declare the specific graphs if needed. It will be located near the end of the file.