1
0
mirror of https://github.com/nttgin/BGPalerter.git synced 2024-05-19 06:50:08 +00:00

added documentation for trasnport parameter

This commit is contained in:
Massimo Candela
2020-07-06 12:12:26 +02:00
parent e21d97c300
commit 8cd07e465b
2 changed files with 2 additions and 0 deletions

View File

@@ -138,6 +138,7 @@ reports:
# params:
# host: 127.0.0.1
# port: 514
# transport: udp
# templates: # See here how to write a template https://github.com/nttgin/BGPalerter/blob/master/docs/context.md
# default: "++BGPalerter-3-${type}: ${summary}|${earliest}|${latest}"
# hijack: "++BGPalerter-5-${type}: ${summary}|${prefix}|${description}|${asn}|${newprefix}|${neworigin}|${earliest}|${latest}|${peers}"

View File

@@ -377,6 +377,7 @@ Parameters for this report module:
|showPaths| Amount of AS_PATHs to report in the alert (0 to disable). |
|host| Host of the Syslog server (e.g. localhost).|
|port| Port of the Syslog server (e.g. 514).|
|transport| The transport protocol to use. Two options: `udp` or `tcp`|
|templates| A dictionary containing string templates for each BGPalerter channels. If a channel doesn't have a template defined, the `default` template will be used (see `config.yml.example` for more details). |
#### reportAlerta