NAME
Device::ZyXEL::IES::Port - A model of a Port on a Slot on an IES.
VERSION
Version 0.01
SYNOPSIS
Models a port on a ZyXEL IES Device.
Based on Moose.
# Must have a Device::Zyxel::IES::Slot object
my $p = Device::ZyXEL::IES::Port( id => 301, slot => $s );
my $adminstatus = $p->read_adminstatus();
# $adminstatus is now the same as $p->adminstatus();
# DOWN the port
$p->adminstatus(1);
MOOSE ATTRIBUTES
id
Required attribute that identifies the port. Matches ifIndex.
slot
Required attribute that isa Device::ZyXEL::IES::Slot object.
adminstatus (rw)
ifAdminStatus on the port. Read from IES using read_adminstatus
operstatus (ro)
ifOperStatus on the port. Read from IES using read_operstatus
uptime (ro)
uptime on the port. Read from IES using read_uptime
profile (rw)
Configuration profile on the port. This attribute OID will depend on the type of xDSL interface of the port.
ifInOctets (ro)
the ifInOctets on the port. Note that if this conglomorate of modules is used to systematically read and record (say using RRD) values, you might expience trouble with cpu load on the IES. (See Device::ZyXEL::IES)
Retrieve a value for this attribute from the IES using read_ifInOctets
ifOutOctets (ro)
the ifOutOctets on the port. Note that if this conglomorate of modules is used to systematically read and record (say using RRD) values, you might expience trouble with cpu load on the IES. (See Device::ZyXEL::IES)
Retrieve a value for this attribute from the IES using read_ifOutOctets
userinfo (ro)
Contains the userinfo OID value from the IES.
Retrieve userinfo from the IES Port using read_userinfo
ifLastChange (ro)
Contains the ifLastChange OID value from the IES.
Retrieve a value from the IES Port using read_ifLastChange.
This attribute can be used to calculate the uptime of the port.
maxmac (rw)
Contains the maxmac setting from the IES.
Retrieve the maxmac value from the IES Port using read_maxmac, before that the value of this attribute will not reflect reality.
The maxmac setting is used by the IES in conjunction with the Snoop feature to ensure a maximum number of MAC address pr port.
maxdown (ro)
Contains the maxAttainableDownstream setting from the IES.
This attribute depends on the interface type, as determined by the assiciated Device::ZyXEL::IES::Slot object.
maxup (ro)
Contains the maxAttainableUpstream setting from the IES.
This attribute depends on the interface type, as determined by the assiciated Device::ZyXEL::IES::Slot object.
downspeed (ro)
Contains the currAttainableDownstream setting from the IES.
This attribute depends on the interface type, as determined by the assiciated Device::ZyXEL::IES::Slot object.
upspeed (ro)
Contains the currAttainableUpstream setting from the IES.
This attribute depends on the interface type, as determined by the assiciated Device::ZyXEL::IES::Slot object.
snr_down (ro)
Contains the SNR on the Downstream channel from the IES.
This attribute depends on the interface type, as determined by the assiciated Device::ZyXEL::IES::Slot object.
snr_up (ro)
Contains the SNR on the Upstream channel from the IES.
This attribute depends on the interface type, as determined by the assiciated Device::ZyXEL::IES::Slot object.
atn_down (ro)
Contains the current Attenautaion Downstream setting from the IES.
This attribute depends on the interface type, as determined by the assiciated Device::ZyXEL::IES::Slot object.
atn_up (ro)
Contains the current Attenautaion Upstream setting from the IES.
This attribute depends on the interface type, as determined by the assiciated Device::ZyXEL::IES::Slot object.
inp_down (rw)
Contains the current impulse noise protection level on the Downstream channel.
This attribute depends on the interface type, as determined by the assiciated Device::ZyXEL::IES::Slot object.
inp_up (rw)
The upstream Impulse Noise Protection minimum setting in unit of DMT symbol.
This attribute depends on the interface type, as determined by the assiciated Device::ZyXEL::IES::Slot object.
annexM (rw)
The ADSL Annex M setting.
This attribute depends on the interface type, as determined by the assiciated Device::ZyXEL::IES::Slot object.
annexL (rw)
The ADSL Annex L setting.
This attribute depends on the interface type, as determined by the assiciated Device::ZyXEL::IES::Slot object.
wirepairmode (ro)
The S.HDSL Wirepair Mode setting.
This attribute depends on the interface type, as determined by the assiciated Device::ZyXEL::IES::Slot object.
vdslprotocol (ro)
The VDSL Protocol Mode setting.
One of
none(1),
vdsl_8a(2),
vdsl_8b(3),
vdsl_8c(4),
vdsl_8d(5),
vdsl_12a(6),
vdsl_12b(7),
vdsl_17a(8),
vdsl_30a(9),
adsl2plus(10)This attribute depends on the interface type, as determined by the assiciated Device::ZyXEL::IES::Slot object.
FUNCTIONS
write_oid
Used (mainly internally) to write a new value into the specified OID on the IES.
The port ID is appended to the passed OID value.
read_oid
Uses Net::SNMP::Util to read the value of an oid for a specific slot.
read_operstatus
Asks the IES for OperStatus on the port.
read_uptime
Asks the IES for uptime on the port.
read_profile
Asks the IES for profile on the port.
read_ifInOctets
Asks the IES for ifInOctets on the port.
read_ifOutOctets
Asks the IES for ifOutOctets on the port.
read_ifLastChange
Asks the IES for ifLastChange on the port.
read_maxmac
Asks the IES for maxmac on the port.
read_adminstatus
Asks the IES for OperStatus on the port.
read_userinfo
Asks the IES for userinfo on the port.
readIfType
Retrieves the ifType [ADSL, VDSL, SHDSL] from the associated slot object. If cardtype (which determines the ifType) is not previosly read from the dslam, and present in the object, it start by reading the cardtype from the IES.
read_maxdown
Asks the IES for max attainable downstream speed on the port.
Different OID's for different slot types, determined by the slot cardtype.
read_maxup
Asks the IES for maximum attainable speed upstream on the port.
Different OID's for different slot types, determined by the slot cardtype.
read_downspeed
Asks the IES for the current downstream speed on the port.
Different OID's for different slot types, determined by the slot cardtype.
read_upspeed
Asks the IES for current upstream speed on the port.
Different OID's for different slot types, determined by the slot cardtype.
read_snrdown
Asks the IES for the SNR for the downstream channel on the port.
Network side in case of SHDSL.
Different OID's for different slot types, determined by the slot cardtype.
read_snrup
Asks the IES for SNR Margin on the upstream channel on the port.
Customer side in case of SHDSL.
Different OID's for different slot types, determined by the slot cardtype.
read_atndown
Asks the IES for the Attenaution for the downstream channel on the port.
Network side in case of SHDSL.
Different OID's for different slot types, determined by the slot cardtype.
read_atnup
Asks the IES for Attenaution on the upstream channel on the port.
Customer side in case of SHDSL.
Different OID's for different slot types, determined by the slot cardtype.
read_inpdown
Asks the IES for the Impulse Noice Protection level for the downstream channel on the port.
Different OID's for different slot types, determined by the slot cardtype.
read_inpup
Asks the IES for the Impulse Noice Protection level for the upstream channel on the port.
Different OID's for different slot types, determined by the slot cardtype.
read_annexM
Asks the IES for the Annex M setting for the ADSL port.
Different OID's for different slot types, determined by the slot cardtype.
read_annexL
Asks the IES for the Annex L setting for the ADSL port.
Different OID's for different slot types, determined by the slot cardtype.
read_wirepairmode
Asks the IES for the S.HDSL Wirepair mode of the port.
Different OID's for different slot types, determined by the slot cardtype.
read_vdslprotocol
Asks the IES for the actual VDSL protocol used on the port
Different OID's for different slot types, determined by the slot cardtype.
fetchDetails
Retrieves the details of a port from the IES.
Fetches all relevant information from the port, and fills values into the appropriate attributes.
SUPPORT
You can find documentation for this module with the perldoc command.
perldoc Device::ZyXEL::IES::Port
You can also look for information at:RT: CPAN's request tracker
AnnoCPAN: Annotated CPAN documentation
CPAN Ratings
Search CPAN
ACKNOWLEDGEMENTS
Fullrate (http://www.fullrate.dk) Thanks for allowing me to be introduced to the "wonderful" device ;) And thanks for donating some of my work time to create this module and sharing it with the world.
COPYRIGHT & LICENSE
Copyright 2012 Jesper Dalberg, all rights reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.