documentation overhaul (#353)

* ident
* remove $Id$ tags from rcs software which has been retired
* make an effort to sync required mib docs with actual code
* sync even more docs with what code actually does
* some whitespace nits
* fixup example to use snmpv2 for all but the most ancient devices
* remove blurb to find more specific snmp::info classes for classes
  which alrdy are as specific as they can get (eg snmp::info::layer3::vmware
  doesn't need info on to find a specific module since there ain't none)
* rename all sub {vendor} strings to lowercase vendor, if cisco, juniper
  and arista can be lowercase, so can be all the rest.
* fix tests
* spread some use warnings around
* use $ instead of @
* remove defines that are included via parent classes
* use strict + warnings
* remove alrdy included modules
* add comma after last list item
* typos
* mibs are found in our mib repo, not on the cisco site
* documentation fixes
This commit is contained in:
nick n
2019-08-25 06:47:10 +02:00
committed by GitHub
parent 6c8d39d746
commit 3bcc522590
149 changed files with 630 additions and 1168 deletions

View File

@@ -28,6 +28,7 @@ package SNMP::Info::Layer3::SonicWALL;
# POSSIBILITY OF SUCH DAMAGE.
use strict;
use warnings;
use Exporter;
use SNMP::Info::Layer3;
@@ -56,7 +57,7 @@ $VERSION = '3.68';
%MUNGE = ( %SNMP::Info::Layer2::MUNGE, %SNMP::Info::Layer3::MUNGE, );
sub vendor {
return 'SonicWALL';
return 'sonicwall';
}
sub os {
@@ -107,7 +108,7 @@ phishphreek@gmail.com
Debug => 1,
DestHost => 'myrouter',
Community => 'public',
Version => 1
Version => 2
)
or die "Can't connect to DestHost.\n";
@@ -130,6 +131,8 @@ Subclass for Generic SonicWALL Firewalls
=over
=item F<SNWL-COMMON-MIB>
=item Inherited Classes' MIBs
See L<SNMP::Info::Layer3/"Required MIBs"> for its own MIB requirements.
@@ -146,7 +149,7 @@ These are methods that return scalar value from SNMP
=item $router->vendor()
Returns C<'SonicWALL'>
Returns C<'sonicwall'>
=item $router->os()
@@ -154,11 +157,11 @@ Returns C<'SonicOS'>
=item $router->os_ver()
Returns '4.2.0.0-10e'
Returns C<'snwlSysFirmwareVersion'>
=item $router->model()
Returns C<'PRO 3060 Enhanced'>
Returns C<'snwlSysModel'>
=item $router->serial()