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

@@ -1,5 +1,4 @@
# SNMP::Info::CiscoStack
# $Id$
#
# Copyright (c) 2008 Max Baker
# All rights reserved.
@@ -31,6 +30,7 @@
package SNMP::Info::CiscoStack;
use strict;
use warnings;
use Exporter;
@SNMP::Info::CiscoStack::ISA = qw/Exporter/;
@@ -106,7 +106,7 @@ $VERSION = '3.68';
1 => 'other',
2 => 'ok',
3 => 'minorFault',
4 => 'majorFault'
4 => 'majorFault',
);
# Changes binary byte describing each port into ascii, and returns
@@ -286,8 +286,7 @@ __END__
=head1 NAME
SNMP::Info::CiscoStack - SNMP Interface to data from F<CISCO-STACK-MIB> and
F<CISCO-PORT-SECURITY-MIB>
SNMP::Info::CiscoStack - SNMP Interface to data from F<CISCO-STACK-MIB>
=head1 AUTHOR
@@ -296,7 +295,7 @@ Max Baker
=head1 SYNOPSIS
# Let SNMP::Info determine the correct subclass for you.
my $ciscostats = new SNMP::Info(
my $ciscostack = new SNMP::Info(
AutoSpecify => 1,
Debug => 1,
DestHost => 'myswitch',
@@ -305,7 +304,7 @@ Max Baker
)
or die "Can't connect to DestHost.\n";
my $class = $ciscostats->class();
my $class = $ciscostack->class();
print "SNMP::Info determined this device to fall under subclass : $class\n";
=head1 DESCRIPTION