bird_ospf.py

#!/usr/bin/python
#
# Copyright (c) 2016 Travelping GmbH <copyright@travelping.com>
# by Tobias Hintze <tobias.hintze@travelping.com>
#
# This code is inspired and partially copied from 
# https://r3blog.nl/index.php/archives/2011/02/24/bgp4-mib-support-for-bird/
# That original code does not clearly declare any license.
# 
# This code also uses python-agentx library licensed under GPLv3
# (see agentx.py for details)
#
# So this code is licensed under the GPLv3 (see COPYING.GPLv3).
#

from adv_agentx import AgentX
from adv_agentx import SnmpGauge32, SnmpCounter32, SnmpIpAddress
import time, os

from birdagent import BirdAgent

## handle get and getnext requests
def OnSnmpRead(req, ax, axd):
	pass

# handle set requests
def OnSnmpWrite(req, ax, axd):
	pass

# handle get, getnext and set requests
def OnSnmpRequest(req, ax, axd):
	pass

## initialize any ax and axd dependant code here
def OnInit(ax, axd):
	pass

## register some variables
## this function is called when a new snmp request has been received and
## if CacheInterval has expired at that time
def OnUpdate(ax, axd, state):
	def state2int(state):
		if state.lower().startswith("full"):
			return 8
		elif state.lower().startswith("loading"):
			return 7
		elif state.lower().startswith("exchange"):
			return 6
		elif state.lower().startswith("exstart"):
			return 5
		elif state.lower().startswith("2-way"):
			return 4
		elif state.lower().startswith("init"):
			return 3
		elif state.lower().startswith("attempt"):
			return 2
		elif state.lower().startswith("down"):
			return 1
		else:
			return 1
	print('updated bird-ospf state: {0}'.format(time.time()))
	## register variables
	axd.RegisterVar('ospf', 0)

	# get ip-sorted neighbors
	nbrs = []
	for nbrid in sorted(state["ospf-neighbors"].keys(), BirdAgent.ipCompare):
		nbrs.append((nbrid, state["ospf-neighbors"][nbrid]))

	# register in MIB-sort:
	for nbrid, nbr in nbrs:
		axd.RegisterVar("ospfNbrIpAddr.%s.0"%nbrid, SnmpIpAddress(nbr["rtrip"]))
	for nbrid, nbr in nbrs:
		axd.RegisterVar("ospfNbrRtrId.%s.0"%nbrid, SnmpIpAddress(nbrid))
	for nbrid, nbr in nbrs:
		axd.RegisterVar("ospfNbrPriority.%s.0"%nbrid, nbr["pri"])
	for nbrid, nbr in nbrs:
		axd.RegisterVar("ospfNbrState.%s.0"%nbrid, state2int(nbr["state"]))
	return

# main program
if __name__ == '__main__':
	print('bird-ospf AgentX starting')

	bird = BirdAgent( \
			os.environ.get("BIRDCONF") or "/etc/bird/bird.conf", \
			os.environ.get("BIRDCPATH") or "/usr/sbin/birdc", \
			os.environ.get("NETSTATCMD") or "netstat -na")

	instance = "o_main"

	callbacks = {
			"OnSnmpRead"    : OnSnmpRead,
			"OnSnmpWrite"   : OnSnmpWrite,
			"OnSnmpRequest" : OnSnmpRequest,
			"OnInit"        : OnInit,
			"OnUpdate"      : lambda ax, axd: OnUpdate(ax,axd,bird.getOSPFState(instance))
			}

	## initialize agentx module and run main loop
	AgentX(
		callbacks,
		Name		= 'bird-ospf',
		#RootOID = '1.3.6.1.2.1.14',
		MIBFile		= os.environ.get("OSPFMIBFILE") or "/usr/share/bird-snmp/OSPF-MIB.txt",
		RootOID = 'OSPF-MIB::ospf',
		CacheInterval	= int(os.environ.get("AGENTCACHEINTERVAL") or "30")
	)
	print('bird-ospf AgentX terminating')

# vim:ts=4:sw=4:noexpandtab