WANPIPE SNMP mibs
===========================
Author: Alex Feldman <al.feldman@sangoma.com>
Phone:	905.474.1990 x104


HISTORY:
-------------------------------------------------------------------------------
Version 	Date		Description
-------------------------------------------------------------------------------
1.1.1		Jan 20, 2003	Supporting up to NET-SNMP-5.1. Create 
				wan_snmp_install.sh script that install WANPIPE
				SNMP mibs automatically, configure, compile and 
				install NET-SNMP daemon.
1.0.4		Apr 24, 2003	Supporting UCD-SNMP-4.2.3
1.0.1		Mar 1, 2003	Initial version


Contents:
1. List of supporting WANPIPE SNMP mibs (includes related mib files).
2. WANPIPE SNMP file description
3. Download WANPIPE SNMP daemon
4. Automatic NET-SNMP daemon update with Sangoma WANPIPE SNMP mibs.
5. Manual NET-SNMP daemon update with Sangoma WANPIPE SNMP mibs.
6. How to use NET-SNMP daemon:


1. Current WANPIPE SNMP MIBs support:
	o Frame Relay	(frameRelayDTE) rfc1315
	o PPP		(ppp)		rfc1471, rfc1472, rfc1473, rfc1474
	o X.25		(x25)		rfc1382
	o DS1		(ds1)		rfc1493, rfc1495
   We not support full mibs. If you need mib parameters that we not supported 
   yet, please send email to Alex Feldman (al.feldman@sangoma.com)


2. WANPIPE SNMP file descrptions:

	README				 - this Readme file
	patches				 - this directory includes necassary
					   patches to NET-SNMP daemon.
	patches/interfaces.c.patch.4.2.3 - patch for UCD-SNMP-4.2.3 
	patches/interfaces.c.patch.5.0.8 - patch for NET-SNMP-5.0.8
	patches/interfaces.c.patch.5.0.9 - patch for NET-SNMP-5.0.9
	patches/interfaces.c.patch.5.1   - patch for NET-SNMP-5.1

	mibs				 - this directory includes WANPIPE
					   SNMP mib files.
	mibs/frameRelayDTE.c		 - Frame Relay mib source
	mibs/frameRelayDTE.h		 - Frame Relay mib header
	mibs/ppp.c			 - Point-to-Point mib source
	mibs/ppp.h			 - Point-to-Point mib header
	mibs/x25.c			 - X.25 mib source
	mibs/x25.h			 - X.25 mib header
	mibs/ds1.c			 - DS1 mib source
	mibs/ds1.h			 - DS1 mib header
	mibs/perfHistTCMIB.c		 - This mib source required by DS1 mib
	mibs/perfHistTCMIB.h		 - this mib header required by DS1 mib


3. Download WANPIPE SNMP daemon

	o Download the latest UCD-SNMP/NET-SNMP version from 
  		https://sourceforge.net/projects/net-snmp.

	o Untar the snmp daemon in a temp directory
	  eg: 	cd /usr/local
		tar xvfz <snmp-daemon-filename.tgz>


4. Automatic NET-SNMP daemon update with Sangoma WANPIPE SNMP mibs.

	o Before running automatic WANPIPE SNMP instalation script,
	  please configure, compile and install fresh NET-SNMP daemon
	  without Sangoma WANPIPE SNMP mibs.

	o Execute WANPIPE SNMP installation script:
		./wan_snmp_install.sh --snmp_dir=<NET-SNMP dir>
		./wan_snmp_install.sh --help	- Print help message

	o This script will exectue follow steps:
		1. Select WANPIPE SNMP mibs that you want to install
		2. Copy WANPIPE SNMP mib files and apply necassary patches
		   to NET-SNMP daemon.
		3. Configure NET-SNMP daemon
		4. Compile and install NET-SNMP daemon


5. Manual NET-SNMP daemon update with Sangoma WANPIPE SNMP mibs.


	o Copy the corresponding Wanpipe SNMP Mibs into the snmp daemon mib 
	  (agent/mibgroup) directory.
	  Wanpipe SNMP mibs are located in wanpipe/snmp directory.
	  eg:
	  	cd wanpipe_snmp/mibs
		cp *.* /usr/local/<NET-SNMP dir>/agent/mibgroup
		
  	o Configure the SNMP Daemon source code to include the new 
 	  Wanpipe MIB modules:
	  eg:
          	cd /usr/local/<NET-SNMP dir>
          	./configure --with-mib-modules="<protocol mib> <protocol mib> ..."
		
		where <protocol mib>= [ frameRelayDTE | ppp | x25 | ds1 perfHistTCMIB ]

		thus, configure snmp daemon with frame relay mib:
		
			./configure --with-mib-modules="frameRelayDTE"
		
		or configure snmp daemon with all Wanpipe mibs:
	
			./configure --with-mib-modules="frameRelayDTE ppp x25"
     
	     	or configure snmp daemon with DS1 mibs:
	
			./configure --with-mib-modules="ds1 perfHistTCMIB"

	o The ./configure script should setup the SNMP Daemon environment to 
	  include the new Wanpipe Mibs.  
	  
	  For sanity sake :) double check that file 'agent/Makefile' contain 
	  references to included Wanpipe Mibs? 

	o Compile the suite (make) but don't install it yet. 
	  eg:	make
	  
	o Make utility should have compiled all mibs correctly, including the
	  new Wanpipe Mibs.
	  
	  For sanity sake :) double check that Wanpipe mibs have indeed 
	  been compiled in 'agent/mibgroup/' directory.  
	  Look for <protocol mib>.o  files ? 

	o Install the agent. (make install).
	  eg:	make install
	  

	o The new snmp daemon should be installed now and will have
	  new Wanpipe Mibs installed. 


6. How to use SNMP daemon:

	o Load NET-SNMP daemon:
		snmpd

	o To find that your mib is install properly run:

		For UCD-SNMP-4.2.3:
			snmpwalk -v1 -c public localhost
		For NET-SNMP-5.x:
			snmpwalk -u <username> -A <password> -c public localhost

	and see if you mib appears in a output.


	o To get specific values, execute follow command:

		snmpgetnext [ common arguments ] objectID [objectID]

