100 lines
5.3 KiB
Plaintext
100 lines
5.3 KiB
Plaintext
## Copyright (c) 2020 Arseniy Kuznetsov
|
||
##
|
||
## This program is free software; you can redistribute it and/or
|
||
## modify it under the terms of the GNU General Public License
|
||
## as published by the Free Software Foundation; either version 2
|
||
## of the License, or (at your option) any later version.
|
||
##
|
||
## This program is distributed in the hope that it will be useful,
|
||
## but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
## GNU General Public License for more details.
|
||
|
||
|
||
[Sample-Router]
|
||
# for specific configuration on the router level, change here the defaults values from below
|
||
hostname = 192.168.88.1
|
||
|
||
[default]
|
||
# this affects configuration of all routers, unless overloaded on their specific levels
|
||
|
||
enabled = True # turns metrics collection for this RouterOS device on / off
|
||
module_only = False # use this entry only as a probe module (skip /metrics collection)
|
||
hostname = localhost # RouterOS IP address
|
||
port = 8728 # RouterOS IP Port
|
||
|
||
username = username # RouterOS user, needs to have 'read' and 'api' permissions
|
||
password = password
|
||
credentials_file = "" # To use an external file in YAML format for both username and password, specify the path here
|
||
|
||
custom_labels = None # Custom labels to be injected to all device metrics, comma-separated key:value (or key=value) pairs
|
||
|
||
use_ssl = False # enables connection via API-SSL servis
|
||
no_ssl_certificate = False # enables API_SSL connect without router SSL certificate
|
||
ssl_certificate_verify = False # turns SSL certificate verification on / off
|
||
ssl_check_hostname = True # check if the hostname matches the peer cert’s hostname
|
||
ssl_ca_file = "" # path to the certificate authority file to validate against, leave empty to use system store
|
||
plaintext_login = True # for legacy RouterOS versions below 6.43 use False
|
||
|
||
health = True # System Health metrics
|
||
installed_packages = True # Installed packages
|
||
dhcp = True # DHCP general metrics
|
||
dhcp_lease = True # DHCP lease metrics
|
||
|
||
connections = True # IP connections metrics
|
||
connection_stats = False # Open IP connections metrics
|
||
|
||
interface = True # Interfaces traffic metrics
|
||
|
||
route = True # IPv4 Routes metrics
|
||
pool = True # IPv4 Pool metrics
|
||
firewall = True # IPv4 Firewall rules traffic metrics
|
||
neighbor = True # IPv4 Reachable Neighbors
|
||
address_list = None # Firewall Address List metrics, a comma-separated list of names
|
||
dns = False # DNS stats
|
||
|
||
ipv6_route = False # IPv6 Routes metrics
|
||
ipv6_pool = False # IPv6 Pool metrics
|
||
ipv6_firewall = False # IPv6 Firewall rules traffic metrics
|
||
ipv6_neighbor = False # IPv6 Reachable Neighbors
|
||
ipv6_address_list = None # IPv6 Firewall Address List metrics, a comma-separated list of names
|
||
|
||
poe = True # POE metrics
|
||
monitor = True # Interface monitor metrics
|
||
netwatch = True # Netwatch metrics
|
||
public_ip = True # Public IP metrics
|
||
wireless = True # WLAN general metrics
|
||
wireless_clients = True # WLAN clients metrics
|
||
capsman = True # CAPsMAN general metrics
|
||
capsman_clients = True # CAPsMAN clients metrics
|
||
w60g = False # W60G metrics
|
||
|
||
eoip = False # EoIP status metrics
|
||
gre = False # GRE status metrics
|
||
ipip = False # IPIP status metrics
|
||
lte = False # LTE signal and status metrics (requires additional 'test' permission policy on RouterOS v6)
|
||
ipsec = False # IPSec active peer metrics
|
||
switch_port = False # Switch Port metrics
|
||
|
||
kid_control_assigned = False # Allow Kid Control metrics for connected devices with assigned users
|
||
kid_control_dynamic = False # Allow Kid Control metrics for all connected devices, including those without assigned user
|
||
|
||
user = True # Active Users metrics
|
||
queue = True # Queues metrics
|
||
|
||
bfd = False # BFD sessions metrics
|
||
bgp = False # BGP sessions metrics
|
||
routing_stats = False # Routing process stats
|
||
certificate = False # Certificates metrics
|
||
|
||
container = False # Containers metrics
|
||
|
||
remote_dhcp_entry = None # An MKTXP entry to provide for remote DHCP info / resolution
|
||
remote_capsman_entry = None # An MKTXP entry to provide for remote capsman info
|
||
|
||
interface_name_format = name # Format to use for interface / resource names, allowed values: 'name', 'comment', or 'combined'
|
||
# 'name': use interface name only (e.g. 'ether1')
|
||
# 'comment': use comment if available, fallback to name if not
|
||
# 'combined': use both (e.g. 'ether1 (Office Switch)')
|
||
check_for_updates = False # check for available ROS updates
|