From 48f06bb48ae47c1e59e4767bc1ffa979e3f7d928 Mon Sep 17 00:00:00 2001 From: Tony Murray Date: Thu, 31 May 2018 03:16:26 -0500 Subject: [PATCH] Add if label docs to os settings (#8779) DO NOT DELETE THIS TEXT #### Please note > Please read this information carefully. You can run `./scripts/pre-commit.php` to check your code before submitting. - [x] Have you followed our [code guidelines?](http://docs.librenms.org/Developing/Code-Guidelines/) #### Testers If you would like to test this pull request then please run: `./scripts/github-apply `, i.e `./scripts/github-apply 5926` --- doc/Developing/os/Settings.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/doc/Developing/os/Settings.md b/doc/Developing/os/Settings.md index 36a12ff4ba..843bfae471 100644 --- a/doc/Developing/os/Settings.md +++ b/doc/Developing/os/Settings.md @@ -4,6 +4,7 @@ source: os/Settings.md This page documents settings that can be set in the os yaml files or in config.php. All settings listed here are optional. If they are not set, the global default will be used. +### User override in config.php Users can override these settings in their config.php. For example, to set an alternate icon for ios: @@ -33,6 +34,18 @@ good_if: # ignore all other bad_if settings ifDescr (substring, case insensitive ``` +### Controlling interface labels +By default we use ifDescr to label ports/interfaces. +Setting either `ifname` or `ifalias` will override that. Only set one of these. ifAlias is user supplied. +`ifindex` will append the ifindex to the port label. + +```yaml +ifname: true +ifalias: true + +ifindex: true +``` + ### Disable snmpbulkwalk Some devices have buggy snmp implementations and don't respond well to the more efficient snmpbulkwalk. To disable snmpbulkwalk and only use snmpwalk for an os set the following.