##############################################################################
# Inrange 9801 Generic WAN Interface cfgmaker template v20030106
# Assembled by Greg Volk <gvolk@gvolk.com> from the Inrange 9801 mib.
# See http://mrtg.gvolk.com for updates and more info about mrtg in general.
#
# Example Usage:
# cfgmaker --subdirs=HOSTNAME '--if-filter=$default && $if_type==69' \
#          --if-template=interface-ir9801-genwan.template public@host
#
# I used the --if-filter option above because I don't want this type of 
# config to be built for any interfaces except the 9801 WAN-side interfaces. 
# All of my WAN-side interfaces happen to be fastEtherFX(69) so I spec'd
# 69. If you have a different wan-side type interface, then you may want
# to change the type number or leave the --if-filter option out entirely.
# Be advised that if you leave the filter off all together you will end up
# trying to poll these stats on interfaces that don't support them.
#
# Another possible way to determine what interfaces should be queried
# for the OIDs in this file is to go by interface number. From working
# with the IR9801's I have noticed that interface instance numbers in
# the 30000 range are WAN ints. I don't do it this way myself, and 
# instance numbering schemes can certainly change, but it might work.
#
# Notes:
# I didn't graph every possible wan-specific counter in the IR9801 mib.
# Some of them just didn't look very interesting, and I experimented with
# others and decided that they didn't apply to my particular configuration.
# There are many additional OIDs that can be gleaned from the mib, and if
# you find one that you think may be useful to others, please send it to 
# me in template form, and I'll add it.
#
# This template has been tested with the cfgmaker that was packaged with 
# mrtg-2.9.17.
#
#
# This template is available under the GNU GPL. For more information, please
# see http://www.gnu.org/copyleft/gpl.html.
#
#
# Caveats:
# When I did my snmpwalk testing, not surprisingly many of the gauge 
# variables updated very quickly. Because of this, plotting the gauge data
# once every five minutes may give misleading results.
# 
# I don't quite understand the numbers that come from the 
# ir9801snsWanTxAckReceiveAve10 (.1.3.6.1.4.1.5808.3.1.1.3.1.1.1.1.19) 
# gauge variable. The results that I get seem awfully high (~55000ms on
# average). 55 seconds seems like an excessively long time to wait for an 
# ACK to come back. I figure it's either off by an order of magnititude, or 
# maybe the box really does work like that.
#
#
# Version History:
# 20021003 - Initial Release
# 20030106 - Added GPL Licensing Note                                           #
#
#
###############################################################################
#
# The number of transmitted packets currently awaiting an ACK.
# ir9801snsWanTxPacketsAwaitingAck		.1.3.6.1.4.1.5808.3.1.1.3.1.1.1.1.3
#
# The number of packets currently queued for delivery to driver.
# ir9801snsWanTxPacketsQueued 			.1.3.6.1.4.1.5808.3.1.1.3.1.1.1.1.4
#
#
if ($if_ok) {
  
        my $target_name = $target_name . "-ir9801snsWanAckQ";
        my $directory_name = $directory_name . "";
   
        $head_lines .= <<ECHO;
  # ---------------------------------------------------------------------
ECHO
 

        $target_lines .= <<ECHO;
 

Target[$target_name]: .1.3.6.1.4.1.5808.3.1.1.3.1.1.1.1.3.$if_index&.1.3.6.1.4.1.5808.3.1.1.3.1.1.1.1.4.$if_index:$router_connect
RouterUptime[$target_name]: $router_connect
Directory[$target_name]: $directory_name
YLegend[$target_name]: ack/queue
ShortLegend[$target_name]:
Legend1[$target_name]: Packets Awaiting Ack
Legend2[$target_name]: Packets Queued
Legend3[$target_name]: Maximal Packets Awaiting Ack
Legend4[$target_name]: Maximal Packets Queued
LegendI[$target_name]: &nbsp;Packets Awaiting Ack:&nbsp;
LegendO[$target_name]: &nbsp;Packets Queued:&nbsp;
MaxBytes[$target_name]: 10000000
Options[$target_name]: growright, nopercent, gauge
Title[$target_name]: $router_name $if_ref Ack & Queue Status
PageTop[$target_name]: <H1>$router_name $if_ref</H1>
   <TABLE>
     <TR><TD>System:</TD><TD>$router_name in $html_syslocation</TD></TR>
     <TR><TD>Maintainer:</TD><TD>$html_syscontact</TD></TR>
     <TR><TD>Description:</TD><TD> The number of transmitted packets currently awaiting an ACK.<br>
     The number of packets currently queued for delivery to driver.<br>
     </TD></TR>
     <TR><TD>
     Resource:</TD><TD>
        ir9801snsWanTxPacketsAwaitingAck	.1.3.6.1.4.1.5808.3.1.1.3.1.1.1.1.3 (gauge) <br>
        ir9801snsWanTxPacketsQueued			.1.3.6.1.4.1.5808.3.1.1.3.1.1.1.1.4 (gauge) <br>
     </td></tr>
   </TABLE>
 
ECHO
   
}
  


###############################################################################
#
# The count of retransmit timeouts that occurred while waiting for an ACK.
# ir9801snsWanTxTimeoutAcks				.1.3.6.1.4.1.5808.3.1.1.3.1.1.1.1.5
#
# The count of 'no data to send' timeouts that occurred while waiting for 
# transmit data to become available.
# ir9801snsWanTxTimeoutIdles			.1.3.6.1.4.1.5808.3.1.1.3.1.1.1.1.6
#

if ($if_ok) {

        my $target_name = $target_name . "-ir9801snsWanTimeouts";
        my $directory_name = $directory_name . "";

        $head_lines .= <<ECHO;
  # ---------------------------------------------------------------------
ECHO


        $target_lines .= <<ECHO;


Target[$target_name]: .1.3.6.1.4.1.5808.3.1.1.3.1.1.1.1.5.$if_index&.1.3.6.1.4.1.5808.3.1.1.3.1.1.1.1.6.$if_index:$router_connect
RouterUptime[$target_name]: $router_connect
Directory[$target_name]: $directory_name
YLegend[$target_name]: timeouts
ShortLegend[$target_name]: to/s
Legend1[$target_name]: Ack Timeouts
Legend2[$target_name]: Idle Timeouts
Legend3[$target_name]: Max five minute Ack Timeouts
Legend4[$target_name]: Max five minute Idle Timeouts
LegendI[$target_name]: &nbsp;Ack timeouts:&nbsp;
LegendO[$target_name]: &nbsp;Idle timeouts:&nbsp;
MaxBytes[$target_name]: 10000000
Options[$target_name]: growright, nopercent
Title[$target_name]: $router_name $if_ref WAN Timeouts
PageTop[$target_name]: <H1>$router_name $if_ref</H1>
   <TABLE>
     <TR><TD>System:</TD><TD>$router_name in $html_syslocation</TD></TR>
     <TR><TD>Maintainer:</TD><TD>$html_syscontact</TD></TR>
     <TR><TD>Description:</TD><TD> The count of retransmit timeouts that occurred while waiting for an ACK.<br>
     The count of 'no data to send' timeouts that occurred while waiting for transmit data to become available.<br>
     </TD></TR>
     <TR><TD>
     Resource:</TD><TD>
        ir9801snsWanTxTimeoutAcks   	.1.3.6.1.4.1.5808.3.1.1.3.1.1.1.1.5 (counter) <br>
        ir9801snsWanTxTimeoutIdles  	.1.3.6.1.4.1.5808.3.1.1.3.1.1.1.1.6 (counter) <br>
     </td></tr>
   </TABLE>

ECHO

}



###############################################################################
#
# The count of retransmit requests (NAK) sent.
# ir9801snsWanTxNaks         			.1.3.6.1.4.1.5808.3.1.1.3.1.1.1.1.7
#
# The count of NAKs sent for which no retransmitted packet was received.
# ir9801snsWanTxTimeoutNak           	.1.3.6.1.4.1.5808.3.1.1.3.1.1.1.1.8
#


if ($if_ok) {
  
        my $target_name = $target_name . "-ir9801snsWanNAKs";
		my $directory_name = $directory_name . "";
   
        $head_lines .= <<ECHO;
  # ---------------------------------------------------------------------
ECHO
 

        $target_lines .= <<ECHO;
 

Target[$target_name]: .1.3.6.1.4.1.5808.3.1.1.3.1.1.1.1.7.$if_index&.1.3.6.1.4.1.5808.3.1.1.3.1.1.1.1.8.$if_index:$router_connect
RouterUptime[$target_name]: $router_connect
Directory[$target_name]: $directory_name
YLegend[$target_name]: timeouts/naks
ShortLegend[$target_name]: t/s
Legend1[$target_name]: NAK Transmits
Legend2[$target_name]: NAK Timeouts
Legend3[$target_name]: Max NAK Transmits
Legend4[$target_name]: Max NAK Timeouts
LegendI[$target_name]: &nbsp;NAK TX:&nbsp;
LegendO[$target_name]: &nbsp;NAK Timeouts:&nbsp;
MaxBytes[$target_name]: 10000000
Options[$target_name]: growright, nopercent
Title[$target_name]: $router_name $if_ref Nak Status
PageTop[$target_name]: <H1>$router_name $if_ref</H1>
   <TABLE>
     <TR><TD>System:</TD><TD>$router_name in $html_syslocation</TD></TR>
     <TR><TD>Maintainer:</TD><TD>$html_syscontact</TD></TR>
     <TR><TD>Description:</TD><TD> The count of retransmit requests (NAK) sent.<br>
     The count of NAKs sent for which no retransmitted packet was received.<br>
     </TD></TR>
     <TR><TD>
     Resource:</TD><TD>
        ir9801snsWanTxNaks    		.1.3.6.1.4.1.5808.3.1.1.3.1.1.1.1.7 (counter) <br>
        ir9801snsWanTxTimeoutNaks	.1.3.6.1.4.1.5808.3.1.1.3.1.1.1.1.8 (counter) <br>
     </td></tr>
   </TABLE>
 
ECHO
   
}
  


###############################################################################
#
# The count of retransmitted packets received for which a NAK was sent.
# ir9801snsWanRxPacketRetransmits		.1.3.6.1.4.1.5808.3.1.1.3.1.1.1.1.12
#
# The count of packets retransmitted due to timeouts or received NAKs.
# ir9801snsWanTxTimeoutNak              .1.3.6.1.4.1.5808.3.1.1.3.1.1.1.1.13
#

 
  
if ($if_ok) {
  
        my $target_name = $target_name . "-ir9801snsWanRetrans";
		my $directory_name = $directory_name . "";
   
        $head_lines .= <<ECHO;
  # ---------------------------------------------------------------------
ECHO
 

        $target_lines .= <<ECHO;
 

Target[$target_name]: .1.3.6.1.4.1.5808.3.1.1.3.1.1.1.1.12.$if_index&.1.3.6.1.4.1.5808.3.1.1.3.1.1.1.1.13.$if_index:$router_connect
RouterUptime[$target_name]: $router_connect
Directory[$target_name]: $directory_name
YLegend[$target_name]: retransmissions
ShortLegend[$target_name]: r/s
Legend1[$target_name]: RX Retransmit Request Fulfilled
Legend2[$target_name]: TX Retransmit Request Fulfilled
Legend3[$target_name]: Max RX Packet Retransmissions
Legend4[$target_name]: Max TX Packet Retransmissions
LegendI[$target_name]: &nbsp;RX Retrans:&nbsp;
LegendO[$target_name]: &nbsp;TX Retrans:&nbsp;
MaxBytes[$target_name]: 10000000
Options[$target_name]: growright, nopercent
Title[$target_name]: $router_name $if_ref Retransmissions
PageTop[$target_name]: <H1>$router_name $if_ref</H1>
   <TABLE>
     <TR><TD>System:</TD><TD>$router_name in $html_syslocation</TD></TR>
     <TR><TD>Maintainer:</TD><TD>$html_syscontact</TD></TR>
     <TR><TD>Description:</TD><TD> The count of retransmitted packets received for which a NAK was sent.<br>
     The count of packets retransmitted due to timeouts or received NAKs.<br>
     </TD></TR>
     <TR><TD>
     Resource:</TD><TD>
        ir9801snsWanRxPacketRetransmits		.1.3.6.1.4.1.5808.3.1.1.3.1.1.1.1.12 (counter) <br>
        ir9801snsWanTxPacketRetransmits		.1.3.6.1.4.1.5808.3.1.1.3.1.1.1.1.13 (counter) <br>
     </td></tr>
   </TABLE>
ECHO
   
}
  


###############################################################################
#
# The average value of the maximum number of octets awaiting an ACK over the 
# last 10 seconds.
# ir9801snsWanTxOctetsAveMax10       	.1.3.6.1.4.1.5808.3.1.1.3.1.1.1.1.17
#
# The average value of the number of octets awaiting an ACK over the last 10
# seconds.
# ir9801snsWanTxAckOctetsAve10       	.1.3.6.1.4.1.5808.3.1.1.3.1.1.1.1.18
#
 
if ($if_ok) {
  
        my $target_name = $target_name . "-ir9801snsWanOutstand";
		my $directory_name = $directory_name . "";
   
        $head_lines .= <<ECHO;
  # ---------------------------------------------------------------------
ECHO
 

        $target_lines .= <<ECHO;

Target[$target_name]: .1.3.6.1.4.1.5808.3.1.1.3.1.1.1.1.17.$if_index&.1.3.6.1.4.1.5808.3.1.1.3.1.1.1.1.18.$if_index:$router_connect
RouterUptime[$target_name]: $router_connect
Directory[$target_name]: $directory_name
YLegend[$target_name]: bits
ShortLegend[$target_name]: bits
Legend1[$target_name]: Max bits outstanding
Legend2[$target_name]: Ave bits outstanding
Legend3[$target_name]: Max bits outstanding
Legend4[$target_name]: Max bits outstanding
LegendI[$target_name]: &nbsp;outstanding:&nbsp;
LegendO[$target_name]: &nbsp;outstanding:&nbsp;
MaxBytes[$target_name]: 10000000
Options[$target_name]: growright, nopercent, gauge, bits
Title[$target_name]: $router_name $if_ref Outstanding Octets
PageTop[$target_name]: <H1>$router_name $if_ref</H1>
   <TABLE>
     <TR><TD>System:</TD><TD>$router_name in $html_syslocation</TD></TR>
     <TR><TD>Maintainer:</TD><TD>$html_syscontact</TD></TR>
     <TR><TD>Description:</TD><TD> The average value of the maximum number of octets*8 awaiting an ACK over the last 10 seconds.<br>
     The average value of the number of octets*8 awaiting an ACK over the last 10 seconds.<br>
     </TD></TR>
     <TR><TD>
     Resource:</TD><TD>
        ir9801snsWanTxOctetsAveMax10		.1.3.6.1.4.1.5808.3.1.1.3.1.1.1.1.17 (gauge) <br>
        ir9801snsWanTxAckOctetsAve10		.1.3.6.1.4.1.5808.3.1.1.3.1.1.1.1.18 (gauge) <br>
     </td></tr>
   </TABLE>
 
ECHO
   
}


###############################################################################
#
# The average time, in milliseconds, between a transmit and its received ACK 
# over the last ten seconds.
# ir9801snsWanTxAckReceiveAve10         .1.3.6.1.4.1.5808.3.1.1.3.1.1.1.1.19
#

if ($if_ok) {

        my $target_name = $target_name . "-ir9801snsWanLatency";
        my $directory_name = $directory_name . "";

        $head_lines .= <<ECHO;
  # ---------------------------------------------------------------------
ECHO

        $target_lines .= <<ECHO;

Target[$target_name]: .1.3.6.1.4.1.5808.3.1.1.3.1.1.1.1.19.$if_index&.1.3.6.1.4.1.5808.3.1.1.3.1.1.1.1.19.$if_index:$router_connect
RouterUptime[$target_name]: $router_connect
Directory[$target_name]: $directory_name
YLegend[$target_name]: ms
ShortLegend[$target_name]: ms
Legend1[$target_name]: tx-rx latency
Legend2[$target_name]: tx-rx latency
Legend3[$target_name]: Max tx-rx latency
Legend4[$target_name]: Max tx-rx latency
LegendI[$target_name]: &nbsp;TxRxLatency:&nbsp;
LegendO[$target_name]: &nbsp;TxRxLatency:&nbsp;
MaxBytes[$target_name]: 10000000
Options[$target_name]: growright, nopercent, gauge
Title[$target_name]: $router_name $if_ref TX to RX Latency
PageTop[$target_name]: <H1>$router_name $if_ref</H1>
   <TABLE>
     <TR><TD>System:</TD><TD>$router_name in $html_syslocation</TD></TR>
     <TR><TD>Maintainer:</TD><TD>$html_syscontact</TD></TR>
     <TR><TD>Description:</TD><TD> The average time, in milliseconds, between a transmit and its received ACK over the last 10 seconds.<br>
     </TD></TR>
     <TR><TD>
     Resource:</TD><TD>
        ir9801snsWanTxAckReceiveAve10    .1.3.6.1.4.1.5808.3.1.1.3.1.1.1.1.19 (gauge) <br>
     </td></tr>
   </TABLE>

ECHO

}


###############################################################################
#
# Actual transmitted Bytes/Sec over the sample period.
# ir9801snsWanTxOctetsRate				.1.3.6.1.4.1.5808.3.1.1.3.1.1.1.1.20
# Actual received Bytes/Sec over the sample period.
# ir9801snsWanRxOctetsRate				.1.3.6.1.4.1.5808.3.1.1.3.1.1.1.1.21
# 

 
if ($if_ok) {
  
        my $target_name = $target_name . "-ir9801snsWanRate";
		my $directory_name = $directory_name . "";
   
        $head_lines .= <<ECHO;
  # ---------------------------------------------------------------------
ECHO
 

        $target_lines .= <<ECHO;
 

Target[$target_name]: .1.3.6.1.4.1.5808.3.1.1.3.1.1.1.1.21.$if_index&.1.3.6.1.4.1.5808.3.1.1.3.1.1.1.1.20.$if_index:$router_connect
RouterUptime[$target_name]: $router_connect
Directory[$target_name]: $directory_name
MaxBytes[$target_name]: 10000000
Options[$target_name]: growright, nopercent, gauge, bits
Title[$target_name]: $router_name $if_ref TX/RX Rate
PageTop[$target_name]: <H1>$router_name $if_ref</H1>
   <TABLE>
     <TR><TD>System:</TD><TD>$router_name in $html_syslocation</TD></TR>
     <TR><TD>Maintainer:</TD><TD>$html_syscontact</TD></TR>
     <TR><TD>Description:</TD><TD> Actual Transmitted Bytes*8/Sec over the sample period.<br>
     Actual received Bytes*8/Sec over the sample period<br>
     </TD></TR>
     <TR><TD>
     Resource:</TD><TD>
        ir9801snsWanRxOctetsRate	.1.3.6.1.4.1.5808.3.1.1.3.1.1.1.1.21 (gauge) <br>
        ir9801snsWanTxOctetsRate	.1.3.6.1.4.1.5808.3.1.1.3.1.1.1.1.20 (gauge) <br>
     </td></tr>
   </TABLE>
 
ECHO
   
}