From 0253df6f5e9dd7834713f8ab8e93633d6f52ba24 Mon Sep 17 00:00:00 2001 From: Lars Kruse Date: Mon, 12 Oct 2020 04:50:27 +0200 Subject: [PATCH] Plugin ag241-adsl: improve documentation formatting and add author --- plugins/router/ag241-adsl | 58 +++++++++++++++++++++++++-------------- 1 file changed, 37 insertions(+), 21 deletions(-) diff --git a/plugins/router/ag241-adsl b/plugins/router/ag241-adsl index e4063276..9866900a 100755 --- a/plugins/router/ag241-adsl +++ b/plugins/router/ag241-adsl @@ -2,36 +2,52 @@ =begin -munin plugin to retrieve connection statistics from the web admin interface -on a Linksys AG241v2 ADSL modem -Makes use of the http://modemaddress/ADSLCStatus.htm page +=head1 NAME -This plugin has only been tested on a Debian testing system +ag241-adsl - retrieve connection statistics from the web admin interface of a Linksys AG241v2 ADSL modem + +=head1 DESCRIPTION + +Data is extracted from the http://modemaddress/ADSLCStatus.htm page. + +This plugin has only been tested on a Debian testing system. This modem also has some basic SNMP support so you can configure it -as per the instructions on the munin wiki -http://munin.projects.linpro.no/wiki/Using_SNMP_plugins -By default the SNMP server is disabled, you can enable it in the web admin -You will need to set up the "virtual node" configuration as detailed -for snmp plugins +as per the instructions on the munin wiki: -Plugin will require some configuration in /etc/munin/plugin-conf.d/ag241_MODEMADDRESS + http://munin.projects.linpro.no/wiki/Using_SNMP_plugins + +By default the SNMP server is disabled, you can enable it in the web admin. +You will need to set up the "virtual node" configuration as detailed +for snmp plugins. + +=head1 CONFIGURATION + +The plugin requires some configuration in /etc/munin/plugin-conf.d/ag241_MODEMADDRESS e.g. -[ag241_vocume.stargate_*] -env.user admin -env.pass password -#env.port 80 + + [ag241_vocume.stargate_*] + env.user admin + env.pass password + #env.port 80 Once you have the above config set you will need to symlink the plugin to -/etc/munin/plugins/ag241_MODEMADDRESS_syncrate -/etc/munin/plugins/ag241_MODEMADDRESS_attenutation -/etc/munin/plugins/ag241_MODEMADDRESS_noise -now restart munin-node. -hopefully in 20-30mins you will have some nice graphs -Some magical munin foo... + /etc/munin/plugins/ag241_MODEMADDRESS_syncrate + /etc/munin/plugins/ag241_MODEMADDRESS_attenutation + /etc/munin/plugins/ag241_MODEMADDRESS_noise + +Restart munin-node afterwards. + +Hopefully in 20-30mins you will have some nice graphs. + +=head1 AUTHORS + +Copyright (C) 2010 David Leggett + +=head1 MAGIC MARKERS + #%# family=manual -#%# capabilities= =end