Documentation cleanup of Basic Setup, Advanced Setup, 3rd Party Integration sections (#13018)

* TOC cleanup of Basic Setup, Advanced Setup, 3rd Party Integration sections
This commit is contained in:
rhinoau
2021-07-10 03:34:01 +08:00
committed by GitHub
parent fbf653f02e
commit 02c2cd47b3
31 changed files with 403 additions and 389 deletions

View File

@@ -1,7 +1,7 @@
source: Extensions/Syslog.md
path: blob/master/doc/
# Setting up syslog support
# Syslog support
This document will explain how to send syslog data to LibreNMS.
Please also refer to the file Graylog.md for an alternate way of
@@ -251,7 +251,7 @@ Add the following to your LibreNMS `config.php` file to enable the Syslog extens
$config['enable_syslog'] = 1;
```
# Syslog Clean Up
## Syslog Clean Up
Can be set inside of `config.php`
@@ -263,7 +263,7 @@ The cleanup is run by daily.sh and any entries over X days old are
automatically purged. Values are in days. See here for more Clean Up
Options [Link](../Support/Cleanup-options.md)
# Client configuration
## Client configuration
Below are sample configurations for a variety of clients. You should
understand the config before using it as you may want to make some
@@ -273,19 +273,19 @@ Replace librenms.ip with IP or hostname of your LibreNMS install.
Replace any variables in <brackets> with the relevant information.
## syslog
### syslog
```config
*.* @librenms.ip
```
## rsyslog
### rsyslog
```config
*.* @librenms.ip:514
```
## Cisco ASA
### Cisco ASA
```config
logging enable
@@ -296,7 +296,7 @@ logging trap notifications
logging host <outside interface name> librenms.ip
```
## Cisco IOS
### Cisco IOS
```config
logging trap debugging
@@ -304,13 +304,13 @@ logging facility local6
logging librenms.ip
```
## Cisco NXOS
### Cisco NXOS
```config
logging server librenms.ip 5 use-vrf default facility local6
```
## Juniper Junos
### Juniper Junos
```config
set system syslog host librenms.ip authorization any
@@ -323,7 +323,7 @@ set system syslog host librenms.ip exclude-hostname
set system syslog time-format
```
## Huawei VRP
### Huawei VRP
```config
info-center loghost librenms.ip
@@ -339,14 +339,14 @@ info-center filter-id bymodule-alias SNMP SNMP_IPUNLOCK
info-center filter-id bymodule-alias HTTP ACL_DENY
```
## Huawei SmartAX (GPON OLT)
### Huawei SmartAX (GPON OLT)
```config
loghost add librenms.ip librenms
loghost activate name librenms
```
## Allied Telesis Alliedware Plus
### Allied Telesis Alliedware Plus
```config
log date-format iso // Required so syslog-ng/LibreNMS can correctly interpret the log message formatting.
@@ -361,14 +361,14 @@ If you have permitted udp and tcp 514 through any firewall then that
should be all you need. Logs should start appearing and displayed
within the LibreNMS web UI.
## Windows
### Windows
By Default windows has no native way to send logs to a remote syslog server.
Using this how to you can download Datagram-Syslog Agent to send logs
to a remote syslog server (LibreNMS).
### Note
#### Note
Keep in mind you can use any agent or program to send the logs. We are
just using this Datagram-Syslog Agent for this example.
@@ -378,7 +378,7 @@ just using this Datagram-Syslog Agent for this example.
You will need to download and install "Datagram-Syslog Agent" for this how to
[Link to Download](http://download.cnet.com/Datagram-SyslogAgent/3001-2085_4-10370938.html)
# External hooks
## External hooks
Trigger external scripts based on specific syslog patterns being
matched with syslog hooks. Add the following to your LibreNMS
@@ -392,43 +392,43 @@ The below are some example hooks to call an external script in the
event of a configuration change on Cisco ASA, IOS, NX-OS and IOS-XR
devices. Add to your `config.php` file to enable.
## Cisco ASA
### Cisco ASA
```ssh
$config['os']['asa']['syslog_hook'][] = Array('regex' => '/%ASA-(config-)?5-111005/', 'script' => '/opt/librenms/scripts/syslog-notify-oxidized.php');
```
## Cisco IOS
### Cisco IOS
```ssh
$config['os']['ios']['syslog_hook'][] = Array('regex' => '/%SYS-(SW[0-9]+-)?5-CONFIG_I/', 'script' => '/opt/librenms/scripts/syslog-notify-oxidized.php');
```
## Cisco NXOS
### Cisco NXOS
```ssh
$config['os']['nxos']['syslog_hook'][] = Array('regex' => '/%VSHD-5-VSHD_SYSLOG_CONFIG_I/', 'script' => '/opt/librenms/scripts/syslog-notify-oxidized.php');
```
## Cisco IOSXR
### Cisco IOSXR
```ssh
$config['os']['iosxr']['syslog_hook'][] = Array('regex' => '/%GBL-CONFIG-6-DB_COMMIT/', 'script' => '/opt/librenms/scripts/syslog-notify-oxidized.php');
```
## Juniper Junos
### Juniper Junos
```ssh
$config['os']['junos']['syslog_hook'][] = Array('regex' => '/UI_COMMIT:/', 'script' => '/opt/librenms/scripts/syslog-notify-oxidized.php');
```
## Juniper ScreenOS
### Juniper ScreenOS
```ssh
$config['os']['screenos']['syslog_hook'][] = Array('regex' => '/System configuration saved/', 'script' => '/opt/librenms/scripts/syslog-notify-oxidized.php');
```
## Allied Telesis Alliedware Plus
### Allied Telesis Alliedware Plus
**Note:** At least software version 5.4.8-2.1 is required. `log host
x.x.x.x level notices program imi` may also be required depending on
@@ -439,9 +439,9 @@ to the syslog server.
$config['os']['awplus']['syslog_hook'][] = Array('regex' => '/IMI.+.Startup-config saved on/', 'script' => '/opt/librenms/scripts/syslog-notify-oxidized.php');
```
# Configuration Options
## Configuration Options
## Matching syslogs to hosts with different names
### Matching syslogs to hosts with different names
In some cases, you may get logs that aren't being associated with the
device in LibreNMS. For example, in LibreNMS the device is known as