Mirrors/Munin-Contrib
1
0
Fork 0
mirror of https://github.com/munin-monitoring/contrib.git synced 2025-07-22 22:25:23 +00:00
Code Issues Releases Wiki Activity

Improve documantion of many plugins

Browse source 
Specifically the configuration examples are now indented properly.
This commit is contained in:
Lars Kruse 2020-10-24 17:28:11 +02:00
parent 384d482fe2
commit 09b88141b3
92 changed files with 556 additions and 388 deletions
Download patch file Download diff file Expand all files Collapse all files

20
plugins/router/arris-sb6183
View file

@ -24,10 +24,18 @@ arris-sb6183 - Health monitoring plugin for Arris SB6183 Cable Modem
=head1 DESCRIPTION
This provides the following multigraphs:
* upstream and downstream power levels
* downstream signal to noise ratio
* downstream error counts
* uptime
=over 4
=item upstream and downstream power levels
=item downstream signal to noise ratio
=item downstream error counts
=item uptime
=back
The values are retrieved from the cable modem's status web pages at
192.168.100.1. So, this plugin must be installed on a munin node
@ -40,8 +48,8 @@ Make sure 192.168.100.1 is accessible through your firewall.
To have this register with munin as it's own host set the "env.hostname" in config.
Also ensure that the hostname set is listed in munin.conf.
[arris*]
env.hostname modem
[arris*]
env.hostname modem
=head1 TESTING

47
plugins/router/arris-tg3442
View file

@ -12,20 +12,28 @@ downstream channels. (Signal Power, SNR, Lock Status)
=head1 REQUIREMENTS
- BeautifulSoup
- pycryptodome
=over 4
=item BeautifulSoup
=item pycryptodome
=back
=head1 CONFIGURATION
=head2 Example
[arris]
env.url http://192.168.100.1
env.username admin
env.password yourpassword
[arris]
env.url http://192.168.100.1
env.username admin
env.password yourpassword
=head2 Parameters
url - URL to web-frontend
username - defaults to "admin"
password - valid password
@ -37,22 +45,25 @@ https://www.arris.com/products/touchstone-tg3442-cable-voice-gateway/
=head1 AUTHOR
Copyright (c) 2019 Daniel Hiepler <d-munin@coderdu.de>
Copyright (c) 2004-2009 Nicolas Stransky <Nico@stransky.cx>
Copyright (c) 2018 Lars Kruse <devel@sumpfralle.de>
Copyright (c) 2019 Daniel Hiepler <d-munin@coderdu.de>
Copyright (c) 2004-2009 Nicolas Stransky <Nico@stransky.cx>
Copyright (c) 2018 Lars Kruse <devel@sumpfralle.de>
=head1 LICENSE
Permission to use, copy, and modify this software with or without fee
is hereby granted, provided that this entire notice is included in
all source code copies of any software which is or includes a copy or
modification of this software.
THIS SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR
IMPLIED WARRANTY. IN PARTICULAR, NONE OF THE AUTHORS MAKES ANY
REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THE
MERCHANTABILITY OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR
PURPOSE.
Permission to use, copy, and modify this software with or without fee
is hereby granted, provided that this entire notice is included in
all source code copies of any software which is or includes a copy or
modification of this software.
THIS SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR
IMPLIED WARRANTY. IN PARTICULAR, NONE OF THE AUTHORS MAKES ANY
REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THE
MERCHANTABILITY OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR
PURPOSE.
=head1 MAGIC MARKERS