# SNMP::Info::Layer1::Allied
# Max Baker <max@warped.org>
#
# Copyright (c) 2002, Regents of the University of California
# All rights reserved.
# 
# Redistribution and use in source and binary forms, with or without 
# modification, are permitted provided that the following conditions are met:
# 
#     * Redistributions of source code must retain the above copyright notice,
#       this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above copyright notice,
#       this list of conditions and the following disclaimer in the documentation
#       and/or other materials provided with the distribution.
#     * Neither the name of the University of California, Santa Cruz nor the 
#       names of its contributors may be used to endorse or promote products 
#       derived from this software without specific prior written permission.
# 
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
# ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package SNMP::Info::Layer1::Allied;
$VERSION = 0.2;
# $Id$
use strict;

use Exporter;
use SNMP::Info::Layer1;

@SNMP::Info::Layer1::Allied::ISA = qw/SNMP::Info::Layer1 Exporter/;
@SNMP::Info::Layer1::Allied::EXPORT_OK = qw//;

use vars qw/$VERSION %FUNCS %GLOBALS %MIBS %MUNGE $AUTOLOAD $INIT $DEBUG/;

# Set for No CDP
%GLOBALS = (
            %SNMP::Info::Layer1::GLOBALS,
            'root_ip'   => 'actualIPAddr',
            );

%FUNCS   = (%SNMP::Info::Layer1::FUNCS,
            'i_name2'    => 'ifName',
            'ati_p_name' => 'portName',
            'ati_up'     => 'linkTestLED',
            );

%MIBS    = (
            %SNMP::Info::Layer1::MIBS,
            'ATI-MIB' => 'atiPortGroupIndex'
            );

%MUNGE   = (%SNMP::Info::Layer1::MUNGE,
            );

sub vendor {
    return 'allied';
}

sub model {
    my $allied = shift;

    my $desc = $allied->description();

    if ($desc =~ /(AT-\d{4}\S{1}?)/){
        return $1;
    }
    return undef;
}

sub i_name{
    my $allied = shift;

    my $i_name = $allied->i_name2();

    my $ati_p_name = $allied->ati_p_name();

    foreach my $port (keys %$ati_p_name){
        my $name = $ati_p_name->{$port};
        $i_name->{$port} = $name if (defined $name and $name !~ /^\s*$/);
    }
    
    return $i_name;
}

sub i_up {
    my $allied = shift;

    my $i_up = SNMP::Info::Layer1::i_up($allied);
    my $ati_up = $allied->ati_up();

    foreach my $port (keys %$ati_up){
        my $up = $ati_up->{$port};
        $i_up->{$port} = 'down' if $up eq 'linktesterror';
        $i_up->{$port} = 'up' if $up eq 'nolinktesterror';
    }
    
    return $i_up;
}
1;
__END__

=head1 NAME

SNMP::Info::Layer1::Allied - SNMP Interface to old Allied Hubs

=head1 DESCRIPTION

Provides abstraction to the configuration information obtainable from a 
Allied device through SNMP. See inherited classes' documentation for 
inherited methods.

Inherits from:

 SNMP::Info::Layer1

Required MIBs:

 ATI-MIB - Download for your device from http://www.allied-telesyn.com/allied/support/

 MIBs listed in SNMP::Info::Layer1

=head1 AUTHOR

Max Baker (C<max@warped.org>)

=head1 SYNOPSIS

 my $allied = new SNMP::Info::Layer1::Allied(DestHost  => 'mycat1900' , 
                              Community => 'public' ); 

=head1 CREATING AN OBJECT

=over

=item  new SNMP::Info::Layer1::Allied()

Arguments passed to new() are passed on to SNMP::Session::new()
    

    my $allied = new SNMP::Info::Layer1::Allied(
        DestHost => $host,
        Community => 'public',
        Version => 3,...
        ) 
    die "Couldn't connect.\n" unless defined $allied;

=item  $allied->session()

Sets or returns the SNMP::Session object

    # Get
    my $sess = $allied->session();

    # Set
    my $newsession = new SNMP::Session(...);
    $allied->session($newsession);

=back

=head1 GLOBALS

=over

=item $allied->vendor()

Returns 'allied' :)

=item $allied->root_ip()

Returns IP Address of Managed Hub.

(B<actualIpAddr>)

=item $allied->model()

Trys to cull out AT-nnnnX out of the description field.

=back

=head1 TABLE ENTRIES

=head2 Overrides

=over

=item $allied->i_name()

Returns reference to map of IIDs to human-set port name.

=item $allied->i_up()

Returns reference to map of IIDs to link status.  Changes
the values of ati_up() to 'up' and 'down'.

=back

=head2 Allied MIB

=over

=item $allied->ati_p_name()

(B<portName>)

=item $allied->ati_up()

(B<linkTestLED>)

=back

=cut