diff --git a/CDB/LOFAR_ConfigDb.json b/CDB/LOFAR_ConfigDb.json
index 56263d3c25383e5066b71e4ffdef640b8f4b348e..26378e962292197d2e3dbed10a22dc20e51d1174 100644
--- a/CDB/LOFAR_ConfigDb.json
+++ b/CDB/LOFAR_ConfigDb.json
@@ -35,7 +35,8 @@
"TileBeam": {
"STAT": {
"TileBeam": {
- "STAT/TileBeam/1": {}
+ "STAT/TileBeam/1": {
+ }
}
}
},
diff --git a/tangostationcontrol/tangostationcontrol/clients/snmp_client.py b/tangostationcontrol/tangostationcontrol/clients/snmp_client.py
index 7a7f45808cdc2d160cb9db3356d3a0e9beda4be0..83bdfb2e6da940cdb3d297e8fb521ce533fb8ab8 100644
--- a/tangostationcontrol/tangostationcontrol/clients/snmp_client.py
+++ b/tangostationcontrol/tangostationcontrol/clients/snmp_client.py
@@ -2,6 +2,8 @@
from tangostationcontrol.clients.comms_client import CommClient
from pysnmp import hlapi
+from pysnmp.smi import builder
+from os import path
import numpy
import logging
@@ -12,8 +14,9 @@ __all__ = ["SNMP_client"]
snmp_to_numpy_dict = {
hlapi.Integer32: numpy.int64,
+ hlapi.Integer: numpy.int64,
hlapi.TimeTicks: numpy.int64,
- str: str,
+ hlapi.OctetString: str,
hlapi.ObjectIdentity: str,
hlapi.Counter32: numpy.int64,
hlapi.Gauge32: numpy.int64,
@@ -21,6 +24,27 @@ snmp_to_numpy_dict = {
}
+class SNMP_comm:
+ """
+ Holds information for communicating with the SNMP server
+ """
+
+ def __init__(self, community, host, port):
+ self.port = port
+ self.engine = hlapi.SnmpEngine()
+ self.community = hlapi.CommunityData(community)
+ self.transport = hlapi.UdpTransportTarget((host, port))
+
+ # context data sets the version used. Default SNMPv2
+ self.ctx_data = hlapi.ContextData()
+
+ def getter(self, objs):
+ return next(hlapi.getCmd(self.engine, self.community, self.transport, self.ctx_data, *objs))
+
+ def setter(self, objs):
+ return next(hlapi.getCmd(self.engine, self.community, self.transport, self.ctx_data, *objs))
+
+
class SNMP_client(CommClient):
"""
messages to keep a check on the connection. On connection failure, reconnects once.
@@ -36,26 +60,23 @@ class SNMP_client(CommClient):
super().__init__(fault_func, try_interval)
logger.debug(f"setting up SNMP engine with host: {host} and community: {community}")
- self.port = port
-
- self.engine = hlapi.SnmpEngine()
- self.community = hlapi.CommunityData(community)
- self.transport = hlapi.UdpTransportTarget((host, port))
-
- # context data sets the version used. Default SNMPv2
- self.ctx_data = hlapi.ContextData()
+ self.SNMP_comm = SNMP_comm(community, host, port)
# only sets up the engine, doesn't connect
self.connected = True
+ def _process_annotation(self, annotation):
- def _setup_annotation(self, annotation):
- """
- parses the annotation this attribute received for its initialisation.
- """
+ try:
+ mib = annotation["mib"]
+ name = annotation["name"]
+
+ # SNMP has tables that require an index number to access them. regular non-table variable have an index of 0
+ idx = annotation.get('index', 0)
- wrapper = annotation_wrapper(annotation)
- return wrapper
+ return mib, name, idx
+ except KeyError:
+ raise ValueError(f"SNMP attribute annotation requires a dict argument with both a 'name' and 'mib' key. Instead got: {annotation}")
def setup_value_conversion(self, attribute):
"""
@@ -78,11 +99,11 @@ class SNMP_client(CommClient):
"""
# process the annotation
- wrapper = self._setup_annotation(annotation)
+ mib, name, idx = self._process_annotation(annotation)
# get all the necessary data to set up the read/write functions from the attribute_wrapper
dim_x, dim_y, dtype = self.setup_value_conversion(attribute)
- snmp_attr = snmp_attribute(self, wrapper, dtype, dim_x, dim_y)
+ snmp_attr = snmp_attribute(self, mib, name, idx, dtype, dim_x, dim_y)
# return the read/write functions
def read_function():
@@ -93,145 +114,48 @@ class SNMP_client(CommClient):
return read_function, write_function
+class snmp_attribute:
-class annotation_wrapper:
- def __init__(self, annotation):
- """
- The SNMP client uses a dict and takes the following keys:
-
- either
- oids: Required. An oid string of the object
- or
- mib: the mib name
- name: name of the value to read
- index (optional) the index if the value thats being read from is a table.
- """
-
- # values start as None because we have a way too complicated interface
- self.oids = None
- self.mib = None
- self.name = None
- self.idx = None
-
- # check if the 'oids' key is used and not the 'mib' and 'name' keys
-
- if 'oids' in annotation and 'mib' not in annotation and 'name' not in annotation:
- self.oids = annotation["oids"]
-
- # checks to make sure this isn't present
- if 'index' in annotation:
- raise ValueError(f"SNMP attribute annotation doesn't support oid type declarations with an index present.")
-
+ def __init__(self, comm: SNMP_comm, mib, name, idx, dtype, dim_x, dim_y):
- # check if the 'oids' key is NOT used but instead the 'mib' and 'name' keys
- elif 'oids' not in annotation and 'mib' in annotation and 'name' in annotation:
- self.mib = annotation["mib"]
- self.name = annotation["name"]
+ self.comm = comm
+ self.mib = mib
+ self.name = name
+ self.idx = idx
+ self.dtype = dtype
- # SNMP has tables that require an index number to access them. regular non-table variable have an index of 0
- self.idx = annotation.get('index', 0)
+ self.len = self.get_len(dim_x, dim_y)
+ self.is_scalar = self.len == 1
- else:
- raise ValueError(
- f"SNMP attribute annotation requires a dict argument with either a 'oids' key or both a 'name' and 'mib' key. Not both. Instead got: {annotation}")
+ self.objID = self.create_objID()
- def create_objID(self, x, y):
- is_scalar = (x + y) == 1
+ def get_len(self, dim_x, dim_y):
+ """""Small helper function to not clutter the __init__"""
- # if oids are used
- if self.oids is not None:
- # get a list of str of the oids
- self.oids = self._get_oids(x, y, self.oids)
+ if dim_x == 0:
+ dim_x = 1
+ if dim_y == 0:
+ dim_y = 1
+ return dim_x * dim_y
- # turn the list of oids in to a tuple of pysnmp object identities. These are used for the
- objID = tuple(hlapi.ObjectIdentity(self.oids[i]) for i in range(len(self.oids)))
+ def create_objID(self):
- # if mib + name is used
+ if self.is_scalar:
+ objID = hlapi.ObjectIdentity(self.mib, self.name, self.idx)
else:
-
- # only scalars can be used at the present time.
- if not is_scalar:
- # tuple(hlapi.ObjectIdentity(mib, name, idx) for i in range(len(oids)))
-
- raise ValueError(f"MIB + name type attributes can only be scalars, got dimensions of: ({x}, {y})")
- else:
- objID = hlapi.ObjectIdentity(self.mib, self.name, self.idx)
+ objID = tuple(hlapi.ObjectIdentity(self.mib, self.name, self.idx + i) for i in range(self.len))
return objID
- def _get_oids(self, x, y, in_oid):
- """
- This function expands oids depending on dimensionality.
- if its a scalar its left alone, but if its an array it creates a list of sequential oids if not already provided
-
- scalar "1.1.1.1" -> stays the same
- spectrum: "1.1.1.1" -> ["1.1.1.1.1", "1.1.1.1.2, ..."]
- """
-
- if x == 0:
- x = 1
- if y == 0:
- y = 1
-
- is_scalar = (x * y) == 1
- nof_oids = x * y
-
- # if scalar
- if is_scalar:
- if type(in_oid) is str:
- # for ease of handling put single oid in a 1 element list
- in_oid = [in_oid]
-
- return in_oid
-
- else:
- # if we got a single str oid, make a list of sequential oids
- if type(in_oid) is str:
- return ["{}.{}".format(in_oid, i + 1) for i in range(nof_oids)]
-
- # if its an already expanded list of all oids
- elif type(in_oid) is list and len(in_oid) == nof_oids:
- return in_oid
-
- # if its a list of attributes with the wrong length.
- else:
- raise ValueError(
- "SNMP oids need to either be a single value or an array the size of the attribute dimensions. got: {} expected: {}x{}={}".format(
- len(in_oid), x, y, x * y))
-
-
-class snmp_attribute:
-
- def __init__(self, client : SNMP_client, wrapper, dtype, dim_x, dim_y):
-
- self.client = client
- self.wrapper = wrapper
- self.dtype = dtype
- self.dim_x = dim_x
- self.dim_y = dim_y
- self.is_scalar = (self.dim_x + self.dim_y) == 1
-
- self.objID = self.wrapper.create_objID(self.dim_x, self.dim_y)
-
- def next_wrap(self, cmd):
- """
- This function exists to allow the next(cmd) call to be mocked for unit testing. As the
- """
- return next(cmd)
-
def read_function(self):
"""
Read function we give to the attribute wrapper
"""
-
- # must be recreated for each read it seems
+ # we need to remake this every time it seems or things dont work
self.objs = tuple(hlapi.ObjectType(i) for i in self.objID)
- # get the thingy to get the values
- get_cmd = hlapi.getCmd(self.client.engine, self.client.community, self.client.trasport, self.client.ctx_data, *self.objs)
-
- # dont ask me why 'next' is used to get all of the values
- errorIndication, errorStatus, errorIndex, *varBinds = self.next_wrap(get_cmd)
+ # get all of the values
+ errorIndication, errorStatus, errorIndex, *varBinds = self.comm.getter(*self.objs)
# get all the values in a list converted to the correct type
val_lst = self.convert(varBinds)
@@ -250,8 +174,7 @@ class snmp_attribute:
else:
write_obj = tuple(hlapi.ObjectType(self.objID[i], value[i]) for i in range(len(self.objID)))
- set_cmd = hlapi.setCmd(self.client.engine, self.client.community, self.client.trasport, self.client.ctx_data, *write_obj)
- errorIndication, errorStatus, errorIndex, *varBinds = self.next_wrap(set_cmd)
+ errorIndication, errorStatus, errorIndex, *varBinds = self.comm.setter(write_obj)
def convert(self, varBinds):
"""
@@ -259,20 +182,43 @@ class snmp_attribute:
"""
vals = []
+
if not self.is_scalar:
#just the first element of this single element list
varBinds = varBinds[0]
for varBind in varBinds:
- # class 'DisplayString' doesnt want to play along for whatever reason
- if "DisplayString" in str(type(varBind[1])):
- vals.append(varBind[1].prettyPrint())
- elif type(varBind[1]) == hlapi.IpAddress:
+
+ # Some MIB's used custom types, some dont. Custom types are merely wrapped base types.
+ varbind_types = varBind[1].__class__.__bases__ + (type(varBind[1]),)
+
+ snmp_type = None
+
+ # find if one of the base types is present.
+ for i in varbind_types:
+ if i in snmp_to_numpy_dict.keys():
+ snmp_type = i
+
+ if snmp_type is None:
+ raise TypeError(f"Error: did not find a valid snmp type. Got: {varbind_types}, expected one of: '{snmp_to_numpy_dict.keys()}'")
+
+ if snmp_type is hlapi.IpAddress:
# IpAddress values get printed as their raw value but in hex (7F 20 20 01 for 127.0.0.1 for example)
vals.append(varBind[1].prettyPrint())
+
+ elif snmp_type is hlapi.Integer32 or snmp_type is hlapi.Integer and self.dtype == str:
+ # Integers can have 'named values', Where a value can be translated to a specific name. A dict basically
+ # Example: {1: "other", 2: "invalid", 3: "dynamic", 4: "static",}
+
+ if varBind[1].namedValues == {}:
+ # An empty dict {} means no namedValue's are present.
+ vals.append(snmp_to_numpy_dict[snmp_type](varBind[1]))
+ else:
+ # append the named values string instead of the raw number.
+ vals.append(varBind[1].prettyPrint())
else:
# convert from the funky pysnmp types to numpy types and then append
- vals.append(snmp_to_numpy_dict[type(varBind[1])](varBind[1]))
+ vals.append(snmp_to_numpy_dict[snmp_type](varBind[1]))
if self.is_scalar:
vals = vals[0]
@@ -280,3 +226,16 @@ class snmp_attribute:
return vals
+class mib_loader:
+
+ def __init__(self, mib_dir: str):
+ self.mibBuilder = builder.MibBuilder()
+
+ if not path.isabs(mib_dir):
+ mib_dir = "/" + mib_dir
+
+ mib_source = builder.DirMibSource(mib_dir)
+ self.mibBuilder.addMibSources(mib_source)
+
+ def load_pymib(self, mib_name):
+ self.mibBuilder.loadModule(mib_name)
diff --git a/tangostationcontrol/tangostationcontrol/devices/snmp_device.py b/tangostationcontrol/tangostationcontrol/devices/snmp_device.py
index 04d5a1425e19b0c5fbcb076f206bcd4ed122618a..b5bfd8395a75a9831bdaaf47fb17bbfdf947c36a 100644
--- a/tangostationcontrol/tangostationcontrol/devices/snmp_device.py
+++ b/tangostationcontrol/tangostationcontrol/devices/snmp_device.py
@@ -12,16 +12,14 @@
"""
# PyTango imports
-from tango.server import run
-from tango.server import device_property
-from tango import AttrWriteType
-
-# Additional import
-from tangostationcontrol.clients.snmp_client import SNMP_client
-from tangostationcontrol.clients.attribute_wrapper import attribute_wrapper
+from tangostationcontrol.common.entrypoint import entry
from tangostationcontrol.devices.lofar_device import lofar_device
-import numpy
+from tango.server import device_property, command
+import os
+
+# Additional import
+from tangostationcontrol.clients.snmp_client import SNMP_client, mib_loader
import logging
logger = logging.getLogger()
@@ -39,6 +37,10 @@ class SNMP(lofar_device):
- Type:'DevString'
SNMP_host
- Type:'DevULong'
+ SNMP_community
+ - Type:'DevString'
+ SNMP_rel_mib_dir
+ - Type:'DevString'
SNMP_timeout
- Type:'DevDouble'
"""
@@ -57,6 +59,11 @@ class SNMP(lofar_device):
mandatory=True
)
+ SNMP_rel_mib_dir = device_property(
+ dtype='DevString',
+ mandatory=False
+ )
+
SNMP_timeout = device_property(
dtype='DevDouble',
mandatory=True
@@ -66,43 +73,14 @@ class SNMP(lofar_device):
# Attributes
# ----------
+ # example attributes. mib and name mandatory and index optional.
- # octetstring
- sysDescr_R = attribute_wrapper(comms_annotation={"mib": "SNMPv2-MIB", "name": "sysDescr"}, datatype=numpy.str)
- sysName_R = attribute_wrapper(comms_annotation={"mib": "SNMPv2-MIB", "name": "sysName"}, datatype=numpy.str)
-
- # get a table element with the oid
- ifDescr31_R = attribute_wrapper(comms_annotation={"oids": "1.3.6.1.2.1.2.2.1.2.31"}, datatype=numpy.str)
-
- # get 10 table elements with the oid and dimension
- ifDescr_R = attribute_wrapper(comms_annotation={"oids": "1.3.6.1.2.1.2.2.1.2"}, dims=(10,), datatype=numpy.str)
-
- #timeticks
- sysUpTime_R = attribute_wrapper(comms_annotation={"mib": "SNMPv2-MIB", "name": "sysUpTime"}, datatype=numpy.int64)
-
- # OID
- sysObjectID_R = attribute_wrapper(comms_annotation={"mib": "SNMPv2-MIB", "name": "sysObjectID"}, datatype=numpy.int64)
-
- # integer
- sysServices_R = attribute_wrapper(comms_annotation={"mib": "SNMPv2-MIB", "name": "sysServices"}, datatype=numpy.int64)
- tcpRtoAlgorithm_R = attribute_wrapper(comms_annotation={"mib": "SNMPv2-MIB", "name": "tcpRtoAlgorithm"}, datatype=numpy.int64)
- snmpEnableAuthenTraps_R = attribute_wrapper(comms_annotation={"mib": "SNMPv2-MIB", "name": "snmpEnableAuthenTraps"}, datatype=numpy.int64)
-
- #gauge
- tcpCurrEstab_R = attribute_wrapper(comms_annotation={"mib": "RFC1213-MIB", "name": "tcpCurrEstab"}, datatype=numpy.int64)
-
- #counter32
- tcpActiveOpens_R = attribute_wrapper(comms_annotation={"mib": "RFC1213-MIB", "name": "tcpActiveOpens"}, datatype=numpy.int64)
- snmpInPkts_R = attribute_wrapper(comms_annotation={"mib": "SNMPv2-MIB", "name": "snmpInPkts"}, datatype=numpy.int64)
-
- #IP address
- ipAdEntAddr_R = attribute_wrapper(comms_annotation={"mib": "RFC1213-MIB", "name": "ipAdEntAddr", "index": (127,0,0,1)}, datatype=numpy.str)
- ipAdEntIfIndex_R = attribute_wrapper(comms_annotation={"mib": "RFC1213-MIB", "name": "ipAdEntIfIndex", "index": (10, 87, 6, 14)}, datatype=numpy.str)
-
- #str RW attribute
- sysContact_obj_R = attribute_wrapper(comms_annotation={"mib": "SNMPv2-MIB", "name": "sysContact"}, datatype=numpy.str)
- sysContact_obj_RW = attribute_wrapper(comms_annotation={"mib": "SNMPv2-MIB", "name": "sysContact"}, datatype=numpy.str, access=AttrWriteType.READ_WRITE)
-
+ # Reads from a table and returns an array of table entries 1 to 10 (note, tables require an index key and start at 1)
+ # test_attr1_R = attribute_wrapper(comms_annotation={"mib": "TEST-MIB", "name": "test_attr1", "index": 1}, dims=(10,), datatype=numpy.str)
+ # indices can also be IP addresses sometimes. Gets a single scalar value
+ # test_attr2_R = attribute_wrapper(comms_annotation={"mib": "TEST-MIB", "name": "test_attr2", "index": (127,0,0,1)}, datatype=numpy.int64)
+ # if the attribute doesn't get the value from a table, then no index is needed, or the default of 0 can be supplied.
+ # test_attr3_R = attribute_wrapper(comms_annotation={"mib": "TEST-MIB", "name": "test_attr3"}, datatype=numpy.int64)
# --------
@@ -125,6 +103,30 @@ class SNMP(lofar_device):
self.snmp_manager.start()
+ @command(dtype_out=str)
+ def get_mib_dir(self):
+
+ if not os.path.isabs(self.SNMP_rel_mib_dir):
+ mib_path = os.path.dirname(__file__) + "/" + self.SNMP_rel_mib_dir
+ else:
+ # if the string does start with
+ mib_path = self.SNMP_rel_mib_dir
+ return mib_path
+
+ def init_device(self):
+ super().init_device()
+
+ # create the mib_loader and set the mib path
+ loader = mib_loader(self.get_mib_dir())
+
+ for i in self.attr_list():
+ try:
+ # for all of the attributes attempt to load the pre-compiled MIB. Skips already loaded ones
+ loader.load_pymib(i.comms_annotation["mib"])
+ except Exception as e:
+ raise Exception(f"Failed to load MIB file: {i.comms_annotation.get('mib')} for attribute {i.get_name()}") from e
+
+
# --------
# Commands
@@ -136,8 +138,5 @@ class SNMP(lofar_device):
# ----------
def main(args=None, **kwargs):
"""Main function of the module."""
+ return entry((SNMP,), args=args, **kwargs)
- from tangostationcontrol.common.lofar_logging import configure_logger
- configure_logger()
-
- return run((SNMP,), args=args, **kwargs)
diff --git a/tangostationcontrol/tangostationcontrol/test/clients/SNMP_mib_loading/TEST-MIB.py b/tangostationcontrol/tangostationcontrol/test/clients/SNMP_mib_loading/TEST-MIB.py
new file mode 100644
index 0000000000000000000000000000000000000000..de190adc7e763c307b2e7548a200a3f22b3f5cf2
--- /dev/null
+++ b/tangostationcontrol/tangostationcontrol/test/clients/SNMP_mib_loading/TEST-MIB.py
@@ -0,0 +1,7 @@
+Integer32, MibScalar, MibTable, MibTableRow, MibTableColumn, TimeTicks, iso, Gauge32, MibIdentifier, Bits, Counter32 = mibBuilder.importSymbols("SNMPv2-SMI", "Integer32", "MibScalar", "MibTable", "MibTableRow", "MibTableColumn", "TimeTicks", "iso", "Gauge32", "MibIdentifier", "Bits","Counter32")
+ConstraintsIntersection, ConstraintsUnion, ValueSizeConstraint, SingleValueConstraint, ValueRangeConstraint = mibBuilder.importSymbols("ASN1-REFINEMENT", "ConstraintsIntersection", "ConstraintsUnion", "ValueSizeConstraint", "SingleValueConstraint", "ValueRangeConstraint")
+NamedValues, = mibBuilder.importSymbols("ASN1-ENUMERATION", "NamedValues")
+
+testNamedValue = MibScalar((9, 8, 7, 6, 5, 4, 3, 2, 1), Integer32().subtype(subtypeSpec=ConstraintsUnion(SingleValueConstraint(1, 2, 3, 4))).clone(namedValues=NamedValues(("A", 1), ("B", 2), ("C", 3), ("D", 4)))).setMaxAccess("readonly")
+mibBuilder.exportSymbols("TEST-MIB", testNamedValue=testNamedValue)
+
diff --git a/tangostationcontrol/tangostationcontrol/test/clients/test_mib_loading.py b/tangostationcontrol/tangostationcontrol/test/clients/test_mib_loading.py
new file mode 100644
index 0000000000000000000000000000000000000000..6abf0f52e6ccda67f5ba482a8c12f811d5421fcb
--- /dev/null
+++ b/tangostationcontrol/tangostationcontrol/test/clients/test_mib_loading.py
@@ -0,0 +1,53 @@
+from tangostationcontrol.test import base
+
+from tangostationcontrol.clients.snmp_client import mib_loader
+from pysnmp.smi import view
+import pysnmp.hlapi as pysnmp
+from pysnmp.smi.rfc1902 import ObjectIdentity
+
+from os import path
+
+
+class TestMibLoading(base.TestCase):
+
+ #name and directory of the pymib file
+ mib = "TEST-MIB"
+
+ # mib file is in a folder that is in the same folder as this test
+ rel_dir = "SNMP_mib_loading"
+
+ def test_content(self):
+ """
+ This file contains a 1 variable named: testNamedValue with oid "9.8.7.6.5.4.3.2.1" with named values: ("A", 1), ("B", 2), ("C", 3), ("D", 4)
+ In order to confirm that the mib is indeed loaded correctly this test has to get the oids, the values and the named values
+
+ """
+
+ abs_dir = path.dirname(__file__) + "/" + self.rel_dir
+ loader = mib_loader(abs_dir)
+ loader.load_pymib(self.mib)
+
+ # used to view mibs client side
+ mibView = view.MibViewController(loader.mibBuilder)
+
+ # The expected testNamedValue parameters as written in TEST-MIB.py
+ testNamedValue = "testNamedValue"
+ testNamedValue_oid = "9.8.7.6.5.4.3.2.1"
+ testNamedValue_named = "A"
+ testNamedValue_value = 1
+
+ # get testValue and set a value of 1
+ obj_T = pysnmp.ObjectType(ObjectIdentity(self.mib, testNamedValue), pysnmp.Integer32(1))
+ obj_T.resolveWithMib(mibView)
+
+ # get the oid
+ self.assertEqual(str(obj_T[0]), testNamedValue_oid)
+
+ # get the name format: mib::name
+ self.assertEqual(obj_T[0].prettyPrint(), f"{self.mib}::{testNamedValue}")
+
+ # get the namedValue
+ self.assertEqual(str(obj_T[1]), testNamedValue_named)
+
+ # get the numerical value
+ self.assertEqual(int(obj_T[1]), testNamedValue_value)
diff --git a/tangostationcontrol/tangostationcontrol/test/clients/test_snmp_client.py b/tangostationcontrol/tangostationcontrol/test/clients/test_snmp_client.py
index 4d3a5c22ab3b7ac61ccbdfd78671f0c9ed4cf56a..9db811338d77f5afab496dc5f5ec1e305cc98a94 100644
--- a/tangostationcontrol/tangostationcontrol/test/clients/test_snmp_client.py
+++ b/tangostationcontrol/tangostationcontrol/test/clients/test_snmp_client.py
@@ -5,7 +5,7 @@ from unittest import mock
from tangostationcontrol.test import base
-from tangostationcontrol.clients.snmp_client import SNMP_client, snmp_attribute, annotation_wrapper
+from tangostationcontrol.clients.snmp_client import SNMP_client, snmp_attribute, SNMP_comm
class server_imitator:
@@ -13,7 +13,7 @@ class server_imitator:
snmp_to_numpy_dict = {
hlapi.Integer32: numpy.int64,
hlapi.TimeTicks: numpy.int64,
- str: str,
+ hlapi.OctetString: str,
hlapi.Counter32: numpy.int64,
hlapi.Gauge32: numpy.int64,
hlapi.IpAddress: str,
@@ -35,6 +35,8 @@ class server_imitator:
read_val = (None, snmp_type("1.3.6.1.2.1.1.1.0"))
elif snmp_type is hlapi.IpAddress:
read_val = (None, snmp_type("1.1.1.1"))
+ elif snmp_type is hlapi.OctetString:
+ read_val = (None, snmp_type("1"))
else:
read_val = (None, snmp_type(1))
@@ -48,12 +50,16 @@ class server_imitator:
read_val = []
for _i in range(dims[0]):
read_val.append((None, snmp_type(f"1.1.1.1")))
+ elif snmp_type is hlapi.OctetString:
+ read_val = []
+ for _i in range(dims[0]):
+ read_val.append((None, snmp_type("1")))
else:
read_val = []
for _i in range(dims[0]):
read_val.append((None, snmp_type(1)))
else:
- raise Exception("Image not yet supported :(")
+ raise Exception("Image not supported :(")
return read_val
@@ -66,14 +72,14 @@ class server_imitator:
if dims == self.dim_list["scalar"]:
snmp_type_dict = {hlapi.ObjectIdentity:"1.3.6.1.2.1.1.1.0.1",
hlapi.IpAddress: "1.1.1.1",
- str: "1"}
+ hlapi.OctetString: "1"}
check_val = 1
for k,v in snmp_type_dict.items():
if snmp_type is k: check_val = v
elif dims == self.dim_list["spectrum"]:
snmp_type_dict = {hlapi.ObjectIdentity:["1.3.6.1.2.1.1.1.0.1"] * dims[0],
hlapi.IpAddress: ["1.1.1.1"] * dims[0],
- str: ["1"] * dims[0]}
+ hlapi.OctetString: ["1"] * dims[0]}
check_val = check_val = [1] * dims[0]
for k,v in snmp_type_dict.items():
if snmp_type is k: check_val = v
@@ -84,39 +90,6 @@ class server_imitator:
class TestSNMP(base.TestCase):
-
- def test_annotation_success(self):
- """
- unit test for the processing of annotation. Has 2 lists. 1 with things that should succeed and 1 with things that should fail.
- """
-
- client = SNMP_client(community='public', host='localhost', timeout=10, fault_func=None, try_interval=2)
-
- test_list = [
- # test name nad MIB type annotation
- {"mib": "SNMPv2-MIB", "name": "sysDescr"},
-
- # test name nad MIB type annotation with index
- {"mib": "RFC1213-MIB", "name": "ipAdEntAddr", "index": (127, 0, 0, 1)},
- {"mib": "random-MIB", "name": "aName", "index": 2},
-
- #oid
- {"oids": "1.3.6.1.2.1.2.2.1.2.31"}
- ]
-
-
- for i in test_list:
- wrapper = client._setup_annotation(annotation=i)
-
- if wrapper.oids is not None:
- self.assertEqual(wrapper.oids, i["oids"])
-
- else:
- self.assertEqual(wrapper.mib, i["mib"], f"expected mib with: {i['mib']}, got: {wrapper.idx} from: {i}")
- self.assertEqual(wrapper.name, i["name"], f"expected name with: {i['name']}, got: {wrapper.idx} from: {i}")
- self.assertEqual(wrapper.idx, i.get('index', 0), f"expected idx with: {i.get('index', 0)}, got: {wrapper.idx} from: {i}")
-
-
def test_annotation_fail(self):
"""
unit test for the processing of annotation. Has 2 lists. 1 with things that should succeed and 1 with things that should fail.
@@ -125,56 +98,19 @@ class TestSNMP(base.TestCase):
client = SNMP_client(community='public', host='localhost', timeout=10, fault_func=None, try_interval=2)
fail_list = [
- # OIDS cant use the index
- {"oids": "1.3.6.1.2.1.2.2.1.2.31", "index": 2},
- # mixed annotation is not allowed
- {"oids": "1.3.6.1.2.1.2.2.1.2.31", "name": "thisShouldFail"},
# no 'name'
{"mib": "random-MIB", "index": 2},
+ # no MIB
+ {"name": "random-name", "index": 2},
]
for i in fail_list:
with self.assertRaises(ValueError):
- client._setup_annotation(annotation=i)
-
- def test_oids_scalar(self):
-
- test_oid = "1.1.1.1"
-
- server = server_imitator()
-
- x, y = server.dim_list['scalar']
-
- # we just need the object to call another function
- wrapper = annotation_wrapper(annotation = {"oids": "Not None lol"})
- # scalar
- scalar_expected = [test_oid]
- ret_oids = wrapper._get_oids(x, y, test_oid)
- self.assertEqual(ret_oids, scalar_expected, f"Expected: {scalar_expected}, got: {ret_oids}")
-
- def test_oids_spectrum(self):
- """
- Tests the "get_oids" function, which is for getting lists of sequential oids.
-
- Results should basically be an incrementing list of oids with the final number incremented by 1 each time.
- So "1.1" with dims of 3x1 might become ["1.1.1", "1.1.2", "1.1.3"]
- """
- server = server_imitator()
-
- test_oid = "1.1.1.1"
- x, y = server.dim_list['spectrum']
-
- # we just need the object to call another function
- wrapper = annotation_wrapper(annotation={"oids": "Not None lol"})
-
- # spectrum
- spectrum_expected = [test_oid + ".1", test_oid + ".2", test_oid + ".3", test_oid + ".4"]
- ret_oids = wrapper._get_oids(x, y, test_oid)
- self.assertListEqual(ret_oids, spectrum_expected, f"Expected: {spectrum_expected}, got: {ret_oids}")
+ client._process_annotation(annotation=i)
@mock.patch('pysnmp.hlapi.ObjectIdentity')
@mock.patch('pysnmp.hlapi.ObjectType')
- @mock.patch('tangostationcontrol.clients.snmp_client.snmp_attribute.next_wrap')
+ @mock.patch('tangostationcontrol.clients.snmp_client.SNMP_comm.getter')
def test_snmp_obj_get(self, m_next, m_obj_T, m_obj_i):
"""
Attempts to read a fake SNMP variable and checks whether it got what it expected
@@ -186,21 +122,24 @@ class TestSNMP(base.TestCase):
for i in server.snmp_to_numpy_dict:
m_next.return_value = (None, None, None, server.get_return_val(i, server.dim_list[j]))
- m_client = mock.Mock()
+ def __fakeInit__(self):
+ pass
+ with mock.patch.object(SNMP_comm, '__init__', __fakeInit__):
+ m_comms = SNMP_comm()
- wrapper = annotation_wrapper(annotation={"oids": "1.3.6.1.2.1.2.2.1.2.31"})
- snmp_attr = snmp_attribute(client=m_client, wrapper=wrapper, dtype=server.snmp_to_numpy_dict[i], dim_x=server.dim_list[j][0], dim_y=server.dim_list[j][1])
+ snmp_attr = snmp_attribute(comm=m_comms, mib="test", name="test", idx=0, dtype=server.snmp_to_numpy_dict[i], dim_x=server.dim_list[j][0], dim_y=server.dim_list[j][1])
- val = snmp_attr.read_function()
+ val = snmp_attr.read_function()
- checkval = server.val_check(i, server.dim_list[j])
- self.assertEqual(checkval, val, f"Expected: {checkval}, got: {val}")
+ checkval = server.val_check(i, server.dim_list[j])
+ self.assertEqual(checkval, val, f"During test {j} {i}; Expected: {checkval} of type {i}, got: {val} of type {type(val)}")
@mock.patch('pysnmp.hlapi.ObjectIdentity')
+ @mock.patch('pysnmp.hlapi.ObjectType')
@mock.patch('pysnmp.hlapi.setCmd')
- @mock.patch('tangostationcontrol.clients.snmp_client.snmp_attribute.next_wrap')
- def test_snmp_obj_set(self, m_next, m_nextCmd, m_obj_i):
+ @mock.patch('tangostationcontrol.clients.snmp_client.SNMP_comm.setter')
+ def test_snmp_obj_set(self, m_next, m_nextCmd, m_obj_T, m_obj_ID):
"""
Attempts to write a value to an SNMP server, but instead intercepts it and compared whether the values is as expected.
"""
@@ -211,27 +150,53 @@ class TestSNMP(base.TestCase):
for i in server.snmp_to_numpy_dict:
m_next.return_value = (None, None, None, server.get_return_val(i, server.dim_list[j]))
- m_client = mock.Mock()
- set_val = server.val_check(i, server.dim_list[j])
+ def __fakeInit__(self):
+ pass
+
+ with mock.patch.object(SNMP_comm, '__init__', __fakeInit__):
+ m_comms = SNMP_comm()
+
+ set_val = server.val_check(i, server.dim_list[j])
+
+ snmp_attr = snmp_attribute(comm=m_comms, mib="test", name="test", idx=0, dtype=server.snmp_to_numpy_dict[i], dim_x=server.dim_list[j][0], dim_y=server.dim_list[j][1])
+
+ res_lst = []
+ def test(*value):
+ res_lst.append(value[1])
+ return None, None, None, server.get_return_val(i, server.dim_list[j])
+
+ hlapi.ObjectType = test
+
+ snmp_attr.write_function(set_val)
+
+ if len(res_lst) == 1:
+ res_lst = res_lst[0]
- wrapper = annotation_wrapper(annotation={"oids": "1.3.6.1.2.1.2.2.1.2.31"})
- snmp_attr = snmp_attribute(client=m_client, wrapper=wrapper, dtype=server.snmp_to_numpy_dict[i], dim_x=server.dim_list[j][0], dim_y=server.dim_list[j][1])
+ checkval = server.val_check(i, server.dim_list[j])
+ self.assertEqual(checkval, res_lst, f"During test {j} {i}; Expected: {checkval}, got: {res_lst}")
- res_lst = []
- def test(*value):
- res_lst.append(value[1])
- return None, None, None, server.get_return_val(i, server.dim_list[j])
+ @mock.patch('tangostationcontrol.clients.snmp_client.SNMP_comm.getter')
+ def test_named_value(self, m_next):
+ # # {1: "other", 2: "invalid", 3: "dynamic", 4: "static",}
+ # test_val = hlapi.Integer.withNamedValues(enable=1, disable=0)
+ # test_val(1)
- hlapi.ObjectType = test
+ m_comms = mock.Mock()
+ snmp_attr = snmp_attribute(comm=m_comms, mib="test", name="test", idx=0, dtype=str, dim_x=1, dim_y=0)
- snmp_attr.write_function(set_val)
- if len(res_lst) == 1:
- res_lst = res_lst[0]
+ # create a named integer with the values: 'enable' for 1 and 'disable' for 0
+ test_val = ((None, hlapi.Integer.withNamedValues(enable=1, disable=0)(1)),)
+ ret_val = snmp_attr.convert(test_val)
- checkval = server.val_check(i, server.dim_list[j])
- self.assertEqual(checkval, res_lst, f"Expected: {checkval}, got: {res_lst}")
+ # should return 'enable' since we supplied the value 1
+ self.assertEqual(ret_val, "enable", f"Expected: to get 'enable', got: {ret_val} of type {type(ret_val)}")
+ # create an unnamed integer with a value of 2
+ test_val = ((None, hlapi.Integer(2)),)
+ ret_val = snmp_attr.convert(test_val)
+ # check to make sure the value is indeed 2
+ self.assertEqual(ret_val, 2, f"Expected: to get {2}, got: {ret_val} of type {type(ret_val)}")
diff --git a/tangostationcontrol/tangostationcontrol/test/devices/test_snmp_device.py b/tangostationcontrol/tangostationcontrol/test/devices/test_snmp_device.py
new file mode 100644
index 0000000000000000000000000000000000000000..6289b2a33162031b01998aeeb84cc2119fd78860
--- /dev/null
+++ b/tangostationcontrol/tangostationcontrol/test/devices/test_snmp_device.py
@@ -0,0 +1,41 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of the LOFAR 2.0 Station Software
+#
+#
+#
+# Distributed under the terms of the APACHE license.
+# See LICENSE.txt for more info.
+
+from tango.test_context import DeviceTestContext
+
+from tangostationcontrol.devices import snmp_device, lofar_device
+
+import mock
+from os import path
+
+from tangostationcontrol.test import base
+
+
+class TestSNMPDevice(base.TestCase):
+
+ # some dummy values for mandatory properties
+ snmp_properties = {'SNMP_community': 'localhost', 'SNMP_host': 161, 'SNMP_rel_mib_dir': "SNMP_mib_loading", 'SNMP_timeout': 5.0}
+
+ def setUp(self):
+ super(TestSNMPDevice, self).setUp()
+
+ # Patch DeviceProxy to allow making the proxies during initialisation
+ # that we otherwise avoid using
+ for device in [lofar_device]:
+ proxy_patcher = mock.patch.object(
+ device, 'DeviceProxy')
+ proxy_patcher.start()
+ self.addCleanup(proxy_patcher.stop)
+
+ def test_get_mib_dir(self):
+ with DeviceTestContext(snmp_device.SNMP, properties=self.snmp_properties, process=True) as proxy:
+
+ mib_dir = proxy.get_mib_dir()
+
+ self.assertEqual(mib_dir, f"{path.dirname(snmp_device.__file__)}/{self.snmp_properties['SNMP_rel_mib_dir']}")
diff --git a/tangostationcontrol/tangostationcontrol/test/toolkit/test_mib_compiler.py b/tangostationcontrol/tangostationcontrol/test/toolkit/test_mib_compiler.py
new file mode 100644
index 0000000000000000000000000000000000000000..8641f6483f04ef9e21c27b5bcaaaa4aff4f6587d
--- /dev/null
+++ b/tangostationcontrol/tangostationcontrol/test/toolkit/test_mib_compiler.py
@@ -0,0 +1,31 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of the LOFAR 2.0 Station Software
+#
+#
+#
+# Distributed under the terms of the APACHE license.
+# See LICENSE.txt for more info.
+
+from tangostationcontrol.test import base
+from tangostationcontrol.toolkit.mib_compiler import mib_compiler
+
+import sys
+from os.path import isfile
+from os import getcwd
+from tempfile import TemporaryDirectory
+from unittest import mock
+
+class TestCompiler(base.TestCase):
+ def test_compile(self):
+
+ with TemporaryDirectory() as tmpdir:
+ new_sys_argv = [sys.argv[0], "--mibs", "TEST-MIB",
+ "--source", f"{getcwd()}/tangostationcontrol/toolkit/mib_compiler/mibs",
+ "--destination", f"{tmpdir}", "-v"]
+ with mock.patch.object(mib_compiler.sys, 'argv', new_sys_argv):
+ with self.assertRaises(SystemExit):
+ mib_compiler.main()
+
+ # check if file was written
+ self.assertTrue(isfile(f"{tmpdir}/TEST-MIB.py"))
diff --git a/tangostationcontrol/tangostationcontrol/toolkit/mib_compiler/README.md b/tangostationcontrol/tangostationcontrol/toolkit/mib_compiler/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..d99a55af6738b5556e72a8655e607a2a6641acd7
--- /dev/null
+++ b/tangostationcontrol/tangostationcontrol/toolkit/mib_compiler/README.md
@@ -0,0 +1,28 @@
+#MIB Compiler
+
+The MIB compiler script 'compiles' .mib files to a custom python representation that pysnmp can load immediately.
+
+In order to compile scripts there must be a valid mib file in the source directory as well as any potential imported files.
+You can find out which mib files need to be imported by opening the file and looking at the `IMPORTS` section, where imported mib files are listed.
+These mibs may also have subsequent mib files that need to be imported. Alternatively these imports may also be found in the verbose debug log.
+
+This script will also generate pymib files for all the imported mib files.
+
+`--mibs`: A list of mib files that need to be compiled.
+
+`--destination`: The output folder for the compiled mibs. This argument is optional. The default destination folder is `~/output_pymibs`
+
+`--source`: A list of source folders and addresses from where the mib files are sourced. This argument is optional. The default source folder is `~/mibs`
+It can be useful to also list a web address as source, as there exist various sites that host mib files.
+
+`--debug`: enable verbose debugging. Useful for figuring out errors.
+
+example usage:
+To source the mib TEST-MIB from the default `/mibs` location
+`python3 mib_compiler.py --mibs TEST-MIB`
+
+To source the mib TEST-MIB from the default `/mibs` location but to a custom output folder
+`python3 mib_compiler.py --mibs TEST-MIB --destination home/user/output`
+
+To source te mib TEST-MIB and all its imports from the path `home/user/mibs` and web address `http://www.net-snmp.org/docs/mibs/`
+`python3 mib_compiler.py --mibs TEST-MIB --source home/user/mibs http://www.net-snmp.org/docs/mibs/`
diff --git a/tangostationcontrol/tangostationcontrol/toolkit/mib_compiler/mib_compiler.py b/tangostationcontrol/tangostationcontrol/toolkit/mib_compiler/mib_compiler.py
new file mode 100644
index 0000000000000000000000000000000000000000..a96f2c34670d900665dce697c048e1460866c89f
--- /dev/null
+++ b/tangostationcontrol/tangostationcontrol/toolkit/mib_compiler/mib_compiler.py
@@ -0,0 +1,66 @@
+import argparse
+import sys
+
+from pysnmp.smi import builder, compiler
+
+from pathlib import Path
+
+from pysmi import debug
+import logging
+logging.basicConfig(level=logging.INFO)
+logger = logging.getLogger("mib_compiler")
+
+
+def mib_compile(mib_list : list, src, dst):
+
+ mibBuilder = builder.MibBuilder()
+
+ # set the compiler, the source path and set the www.net-snmp.org site as mib source as well.
+ compiler.addMibCompiler(mibBuilder, sources=src, destination=dst)
+
+ for i in mib_list:
+ # compile it
+ try:
+ mibBuilder.loadModules(i)
+ logger.debug(f"loaded {i}")
+ except Exception as e:
+ raise Exception(f"Something went wrong, try checking whether all the mib fills imported by the provided mib files are present in the source locations ({src}) \r\n (To do this enable debug options and scroll up) ") from e
+
+def main():
+ abs_path = str(Path().absolute()).replace("\\", "/")
+ out_path = f"{abs_path}/output_pymibs"
+ in_path = f"{abs_path}/mibs"
+
+ parser = argparse.ArgumentParser(
+ description='Compiles .mib files in to the easy to load pysnmp format')
+ parser.add_argument(
+ '-m', '--mibs', type=str, required=True, nargs='+', help='list of mib names to compile')
+ parser.add_argument(
+ '-d', '--destination', type=str, required=False, default=out_path,
+ help='sets the output directory for the compiled mibs. (default: '
+ '%(default)s)')
+ parser.add_argument(
+ '-s', '--source', type=str, required=False, nargs='+', default=in_path,
+ help='sets the input paths or addresses to read the .mib files from (default: '
+ '%(default)s)')
+ parser.add_argument(
+ '-v', '--debug', dest='debug', action='store_true', default=False,
+ help='increase log output')
+
+ args = parser.parse_args()
+
+ # argparse arguments
+ mibs = args.mibs
+ destination = args.destination
+ source = args.source
+ debug_option = args.debug
+
+ if debug_option:
+ debug.setLogger(debug.Debug('compiler'))
+
+ mib_compile(mib_list=mibs, src=source, dst=destination)
+
+ sys.exit(1)
+
+if __name__ == "__main__":
+ main()
diff --git a/tangostationcontrol/tangostationcontrol/toolkit/mib_compiler/mibs/SNMPv2-CONF b/tangostationcontrol/tangostationcontrol/toolkit/mib_compiler/mibs/SNMPv2-CONF
new file mode 100644
index 0000000000000000000000000000000000000000..24a1eed95d62f81ea88c3a78017696fa05400340
--- /dev/null
+++ b/tangostationcontrol/tangostationcontrol/toolkit/mib_compiler/mibs/SNMPv2-CONF
@@ -0,0 +1,322 @@
+SNMPv2-CONF DEFINITIONS ::= BEGIN
+
+IMPORTS ObjectName, NotificationName, ObjectSyntax
+ FROM SNMPv2-SMI;
+
+-- definitions for conformance groups
+
+OBJECT-GROUP MACRO ::=
+BEGIN
+ TYPE NOTATION ::=
+ ObjectsPart
+ "STATUS" Status
+ "DESCRIPTION" Text
+ ReferPart
+
+ VALUE NOTATION ::=
+ value(VALUE OBJECT IDENTIFIER)
+
+ ObjectsPart ::=
+ "OBJECTS" "{" Objects "}"
+ Objects ::=
+ Object
+ | Objects "," Object
+ Object ::=
+
+ value(ObjectName)
+
+ Status ::=
+ "current"
+ | "deprecated"
+ | "obsolete"
+
+ ReferPart ::=
+ "REFERENCE" Text
+ | empty
+
+ -- a character string as defined in [2]
+ Text ::= value(IA5String)
+END
+
+-- more definitions for conformance groups
+
+NOTIFICATION-GROUP MACRO ::=
+BEGIN
+ TYPE NOTATION ::=
+ NotificationsPart
+ "STATUS" Status
+ "DESCRIPTION" Text
+ ReferPart
+
+ VALUE NOTATION ::=
+ value(VALUE OBJECT IDENTIFIER)
+
+ NotificationsPart ::=
+ "NOTIFICATIONS" "{" Notifications "}"
+ Notifications ::=
+ Notification
+ | Notifications "," Notification
+ Notification ::=
+ value(NotificationName)
+
+ Status ::=
+ "current"
+ | "deprecated"
+ | "obsolete"
+
+ ReferPart ::=
+ "REFERENCE" Text
+ | empty
+
+ -- a character string as defined in [2]
+ Text ::= value(IA5String)
+END
+
+-- definitions for compliance statements
+
+MODULE-COMPLIANCE MACRO ::=
+BEGIN
+ TYPE NOTATION ::=
+ "STATUS" Status
+ "DESCRIPTION" Text
+ ReferPart
+ ModulePart
+
+ VALUE NOTATION ::=
+ value(VALUE OBJECT IDENTIFIER)
+
+ Status ::=
+ "current"
+ | "deprecated"
+ | "obsolete"
+
+ ReferPart ::=
+ "REFERENCE" Text
+ | empty
+
+ ModulePart ::=
+ Modules
+ Modules ::=
+ Module
+ | Modules Module
+ Module ::=
+ -- name of module --
+ "MODULE" ModuleName
+ MandatoryPart
+ CompliancePart
+
+ ModuleName ::=
+ -- identifier must start with uppercase letter
+ identifier ModuleIdentifier
+ -- must not be empty unless contained
+ -- in MIB Module
+ | empty
+ ModuleIdentifier ::=
+ value(OBJECT IDENTIFIER)
+ | empty
+
+ MandatoryPart ::=
+ "MANDATORY-GROUPS" "{" Groups "}"
+ | empty
+
+ Groups ::=
+
+ Group
+ | Groups "," Group
+ Group ::=
+ value(OBJECT IDENTIFIER)
+
+ CompliancePart ::=
+ Compliances
+ | empty
+
+ Compliances ::=
+ Compliance
+ | Compliances Compliance
+ Compliance ::=
+ ComplianceGroup
+ | Object
+
+ ComplianceGroup ::=
+ "GROUP" value(OBJECT IDENTIFIER)
+ "DESCRIPTION" Text
+
+ Object ::=
+ "OBJECT" value(ObjectName)
+ SyntaxPart
+ WriteSyntaxPart
+ AccessPart
+ "DESCRIPTION" Text
+
+ -- must be a refinement for object's SYNTAX clause
+ SyntaxPart ::= "SYNTAX" Syntax
+ | empty
+
+ -- must be a refinement for object's SYNTAX clause
+ WriteSyntaxPart ::= "WRITE-SYNTAX" Syntax
+ | empty
+
+ Syntax ::= -- Must be one of the following:
+ -- a base type (or its refinement),
+ -- a textual convention (or its refinement), or
+ -- a BITS pseudo-type
+ type
+ | "BITS" "{" NamedBits "}"
+
+ NamedBits ::= NamedBit
+ | NamedBits "," NamedBit
+
+ NamedBit ::= identifier "(" number ")" -- number is nonnegative
+
+ AccessPart ::=
+ "MIN-ACCESS" Access
+ | empty
+ Access ::=
+ "not-accessible"
+ | "accessible-for-notify"
+ | "read-only"
+ | "read-write"
+ | "read-create"
+
+ -- a character string as defined in [2]
+ Text ::= value(IA5String)
+END
+
+-- definitions for capabilities statements
+
+AGENT-CAPABILITIES MACRO ::=
+BEGIN
+ TYPE NOTATION ::=
+ "PRODUCT-RELEASE" Text
+ "STATUS" Status
+ "DESCRIPTION" Text
+ ReferPart
+ ModulePart
+
+ VALUE NOTATION ::=
+ value(VALUE OBJECT IDENTIFIER)
+
+ Status ::=
+ "current"
+ | "obsolete"
+
+ ReferPart ::=
+ "REFERENCE" Text
+ | empty
+
+ ModulePart ::=
+ Modules
+ | empty
+ Modules ::=
+ Module
+ | Modules Module
+ Module ::=
+ -- name of module --
+ "SUPPORTS" ModuleName
+ "INCLUDES" "{" Groups "}"
+ VariationPart
+
+ ModuleName ::=
+
+ -- identifier must start with uppercase letter
+ identifier ModuleIdentifier
+ ModuleIdentifier ::=
+ value(OBJECT IDENTIFIER)
+ | empty
+
+ Groups ::=
+ Group
+ | Groups "," Group
+ Group ::=
+ value(OBJECT IDENTIFIER)
+
+ VariationPart ::=
+ Variations
+ | empty
+ Variations ::=
+ Variation
+ | Variations Variation
+
+ Variation ::=
+ ObjectVariation
+ | NotificationVariation
+
+ NotificationVariation ::=
+ "VARIATION" value(NotificationName)
+ AccessPart
+ "DESCRIPTION" Text
+
+ ObjectVariation ::=
+ "VARIATION" value(ObjectName)
+ SyntaxPart
+ WriteSyntaxPart
+ AccessPart
+ CreationPart
+ DefValPart
+ "DESCRIPTION" Text
+
+ -- must be a refinement for object's SYNTAX clause
+ SyntaxPart ::= "SYNTAX" Syntax
+ | empty
+
+ WriteSyntaxPart ::= "WRITE-SYNTAX" Syntax
+ | empty
+
+ Syntax ::= -- Must be one of the following:
+ -- a base type (or its refinement),
+ -- a textual convention (or its refinement), or
+ -- a BITS pseudo-type
+
+ type
+ | "BITS" "{" NamedBits "}"
+
+ NamedBits ::= NamedBit
+ | NamedBits "," NamedBit
+
+ NamedBit ::= identifier "(" number ")" -- number is nonnegative
+
+ AccessPart ::=
+ "ACCESS" Access
+ | empty
+
+ Access ::=
+ "not-implemented"
+ -- only "not-implemented" for notifications
+ | "accessible-for-notify"
+ | "read-only"
+ | "read-write"
+ | "read-create"
+ -- following is for backward-compatibility only
+ | "write-only"
+
+ CreationPart ::=
+ "CREATION-REQUIRES" "{" Cells "}"
+ | empty
+ Cells ::=
+ Cell
+ | Cells "," Cell
+ Cell ::=
+ value(ObjectName)
+
+ DefValPart ::= "DEFVAL" "{" Defvalue "}"
+ | empty
+
+ Defvalue ::= -- must be valid for the object's syntax
+ -- in this macro's SYNTAX clause, if present,
+ -- or if not, in object's OBJECT-TYPE macro
+ value(ObjectSyntax)
+ | "{" BitsValue "}"
+
+ BitsValue ::= BitNames
+ | empty
+
+ BitNames ::= BitName
+ | BitNames "," BitName
+
+ BitName ::= identifier
+
+ -- a character string as defined in [2]
+ Text ::= value(IA5String)
+END
+
+END
diff --git a/tangostationcontrol/tangostationcontrol/toolkit/mib_compiler/mibs/SNMPv2-SMI b/tangostationcontrol/tangostationcontrol/toolkit/mib_compiler/mibs/SNMPv2-SMI
new file mode 100644
index 0000000000000000000000000000000000000000..2132646cab00e28cf2f679fc1bb308ee2d12a1a1
--- /dev/null
+++ b/tangostationcontrol/tangostationcontrol/toolkit/mib_compiler/mibs/SNMPv2-SMI
@@ -0,0 +1,352 @@
+SNMPv2-SMI DEFINITIONS ::= BEGIN
+
+
+-- the path to the root
+
+org OBJECT IDENTIFIER ::= { iso 3 } -- "iso" = 1
+dod OBJECT IDENTIFIER ::= { org 6 }
+internet OBJECT IDENTIFIER ::= { dod 1 }
+
+directory OBJECT IDENTIFIER ::= { internet 1 }
+
+mgmt OBJECT IDENTIFIER ::= { internet 2 }
+mib-2 OBJECT IDENTIFIER ::= { mgmt 1 }
+transmission OBJECT IDENTIFIER ::= { mib-2 10 }
+
+experimental OBJECT IDENTIFIER ::= { internet 3 }
+
+private OBJECT IDENTIFIER ::= { internet 4 }
+enterprises OBJECT IDENTIFIER ::= { private 1 }
+
+security OBJECT IDENTIFIER ::= { internet 5 }
+
+snmpV2 OBJECT IDENTIFIER ::= { internet 6 }
+
+-- transport domains
+snmpDomains OBJECT IDENTIFIER ::= { snmpV2 1 }
+
+-- transport proxies
+snmpProxys OBJECT IDENTIFIER ::= { snmpV2 2 }
+
+-- module identities
+snmpModules OBJECT IDENTIFIER ::= { snmpV2 3 }
+
+-- Extended UTCTime, to allow dates with four-digit years
+-- (Note that this definition of ExtUTCTime is not to be IMPORTed
+-- by MIB modules.)
+ExtUTCTime ::= OCTET STRING(SIZE(11 | 13))
+ -- format is YYMMDDHHMMZ or YYYYMMDDHHMMZ
+ -- where: YY - last two digits of year (only years
+ -- between 1900-1999)
+ -- YYYY - last four digits of the year (any year)
+ -- MM - month (01 through 12)
+ -- DD - day of month (01 through 31)
+ -- HH - hours (00 through 23)
+ -- MM - minutes (00 through 59)
+ -- Z - denotes GMT (the ASCII character Z)
+ --
+ -- For example, "9502192015Z" and "199502192015Z" represent
+ -- 8:15pm GMT on 19 February 1995. Years after 1999 must use
+ -- the four digit year format. Years 1900-1999 may use the
+ -- two or four digit format.
+
+-- definitions for information modules
+
+MODULE-IDENTITY MACRO ::=
+BEGIN
+ TYPE NOTATION ::=
+ "LAST-UPDATED" value(Update ExtUTCTime)
+ "ORGANIZATION" Text
+ "CONTACT-INFO" Text
+ "DESCRIPTION" Text
+ RevisionPart
+
+ VALUE NOTATION ::=
+ value(VALUE OBJECT IDENTIFIER)
+
+ RevisionPart ::=
+ Revisions
+ | empty
+ Revisions ::=
+ Revision
+ | Revisions Revision
+ Revision ::=
+ "REVISION" value(Update ExtUTCTime)
+ "DESCRIPTION" Text
+
+ -- a character string as defined in section 3.1.1
+ Text ::= value(IA5String)
+END
+
+
+OBJECT-IDENTITY MACRO ::=
+BEGIN
+ TYPE NOTATION ::=
+ "STATUS" Status
+ "DESCRIPTION" Text
+ ReferPart
+
+ VALUE NOTATION ::=
+ value(VALUE OBJECT IDENTIFIER)
+
+ Status ::=
+ "current"
+ | "deprecated"
+ | "obsolete"
+
+ ReferPart ::=
+ "REFERENCE" Text
+ | empty
+
+ -- a character string as defined in section 3.1.1
+ Text ::= value(IA5String)
+END
+
+
+-- names of objects
+-- (Note that these definitions of ObjectName and NotificationName
+-- are not to be IMPORTed by MIB modules.)
+
+ObjectName ::=
+ OBJECT IDENTIFIER
+
+NotificationName ::=
+ OBJECT IDENTIFIER
+
+-- syntax of objects
+
+-- the "base types" defined here are:
+-- 3 built-in ASN.1 types: INTEGER, OCTET STRING, OBJECT IDENTIFIER
+-- 8 application-defined types: Integer32, IpAddress, Counter32,
+-- Gauge32, Unsigned32, TimeTicks, Opaque, and Counter64
+
+ObjectSyntax ::=
+ CHOICE {
+ simple
+ SimpleSyntax,
+
+ -- note that SEQUENCEs for conceptual tables and
+ -- rows are not mentioned here...
+
+ application-wide
+ ApplicationSyntax
+ }
+
+-- built-in ASN.1 types
+
+SimpleSyntax ::=
+ CHOICE {
+ -- INTEGERs with a more restrictive range
+ -- may also be used
+ integer-value -- includes Integer32
+ INTEGER (-2147483648..2147483647),
+
+ -- OCTET STRINGs with a more restrictive size
+ -- may also be used
+ string-value
+ OCTET STRING (SIZE (0..65535)),
+
+ objectID-value
+ OBJECT IDENTIFIER
+ }
+
+-- indistinguishable from INTEGER, but never needs more than
+-- 32-bits for a two's complement representation
+Integer32 ::=
+ INTEGER (-2147483648..2147483647)
+
+
+-- application-wide types
+
+ApplicationSyntax ::=
+ CHOICE {
+ ipAddress-value
+ IpAddress,
+
+ counter-value
+ Counter32,
+
+ timeticks-value
+ TimeTicks,
+
+ arbitrary-value
+ Opaque,
+
+ big-counter-value
+ Counter64,
+
+ unsigned-integer-value -- includes Gauge32
+ Unsigned32
+ }
+
+-- in network-byte order
+-- (this is a tagged type for historical reasons)
+IpAddress ::=
+ [APPLICATION 0]
+ IMPLICIT OCTET STRING (SIZE (4))
+
+-- this wraps
+Counter32 ::=
+ [APPLICATION 1]
+ IMPLICIT INTEGER (0..4294967295)
+
+-- this doesn't wrap
+Gauge32 ::=
+ [APPLICATION 2]
+ IMPLICIT INTEGER (0..4294967295)
+
+-- an unsigned 32-bit quantity
+-- indistinguishable from Gauge32
+Unsigned32 ::=
+ [APPLICATION 2]
+ IMPLICIT INTEGER (0..4294967295)
+
+-- hundredths of seconds since an epoch
+TimeTicks ::=
+ [APPLICATION 3]
+ IMPLICIT INTEGER (0..4294967295)
+
+-- for backward-compatibility only
+Opaque ::=
+ [APPLICATION 4]
+ IMPLICIT OCTET STRING
+
+-- for counters that wrap in less than one hour with only 32 bits
+Counter64 ::=
+ [APPLICATION 6]
+ IMPLICIT INTEGER (0..18446744073709551615)
+
+
+-- definition for objects
+
+OBJECT-TYPE MACRO ::=
+BEGIN
+ TYPE NOTATION ::=
+ "SYNTAX" Syntax
+ UnitsPart
+ "MAX-ACCESS" Access
+ "STATUS" Status
+ "DESCRIPTION" Text
+ ReferPart
+ IndexPart
+ DefValPart
+
+ VALUE NOTATION ::=
+ value(VALUE ObjectName)
+
+ Syntax ::= -- Must be one of the following:
+ -- a base type (or its refinement),
+ -- a textual convention (or its refinement), or
+ -- a BITS pseudo-type
+ type
+ | "BITS" "{" NamedBits "}"
+
+ NamedBits ::= NamedBit
+ | NamedBits "," NamedBit
+
+ NamedBit ::= identifier "(" number ")" -- number is nonnegative
+
+ UnitsPart ::=
+ "UNITS" Text
+ | empty
+
+ Access ::=
+ "not-accessible"
+ | "accessible-for-notify"
+ | "read-only"
+ | "read-write"
+ | "read-create"
+
+ Status ::=
+ "current"
+ | "deprecated"
+ | "obsolete"
+
+ ReferPart ::=
+ "REFERENCE" Text
+ | empty
+
+ IndexPart ::=
+ "INDEX" "{" IndexTypes "}"
+ | "AUGMENTS" "{" Entry "}"
+ | empty
+ IndexTypes ::=
+ IndexType
+ | IndexTypes "," IndexType
+ IndexType ::=
+ "IMPLIED" Index
+ | Index
+ Index ::=
+ -- use the SYNTAX value of the
+ -- correspondent OBJECT-TYPE invocation
+ value(ObjectName)
+ Entry ::=
+ -- use the INDEX value of the
+ -- correspondent OBJECT-TYPE invocation
+ value(ObjectName)
+
+ DefValPart ::= "DEFVAL" "{" Defvalue "}"
+ | empty
+
+ Defvalue ::= -- must be valid for the type specified in
+ -- SYNTAX clause of same OBJECT-TYPE macro
+ value(ObjectSyntax)
+ | "{" BitsValue "}"
+
+ BitsValue ::= BitNames
+ | empty
+
+ BitNames ::= BitName
+ | BitNames "," BitName
+
+ BitName ::= identifier
+
+ -- a character string as defined in section 3.1.1
+ Text ::= value(IA5String)
+END
+
+
+-- definitions for notifications
+
+NOTIFICATION-TYPE MACRO ::=
+BEGIN
+ TYPE NOTATION ::=
+ ObjectsPart
+ "STATUS" Status
+ "DESCRIPTION" Text
+ ReferPart
+
+ VALUE NOTATION ::=
+ value(VALUE NotificationName)
+
+ ObjectsPart ::=
+ "OBJECTS" "{" Objects "}"
+ | empty
+ Objects ::=
+ Object
+ | Objects "," Object
+ Object ::=
+ value(ObjectName)
+
+ Status ::=
+ "current"
+ | "deprecated"
+ | "obsolete"
+
+ ReferPart ::=
+ "REFERENCE" Text
+ | empty
+
+ -- a character string as defined in section 3.1.1
+ Text ::= value(IA5String)
+END
+
+-- definitions of administrative identifiers
+
+zeroDotZero OBJECT-IDENTITY
+ STATUS current
+ DESCRIPTION
+ "A value used for null identifiers."
+ ::= { 0 0 }
+
+END
diff --git a/tangostationcontrol/tangostationcontrol/toolkit/mib_compiler/mibs/SNMPv2-TC b/tangostationcontrol/tangostationcontrol/toolkit/mib_compiler/mibs/SNMPv2-TC
new file mode 100644
index 0000000000000000000000000000000000000000..a68f9690d198b2533905c8ab9baa604c7a7a9a54
--- /dev/null
+++ b/tangostationcontrol/tangostationcontrol/toolkit/mib_compiler/mibs/SNMPv2-TC
@@ -0,0 +1,786 @@
+SNMPv2-TC DEFINITIONS ::= BEGIN
+
+IMPORTS
+ TimeTicks FROM SNMPv2-SMI;
+
+
+-- definition of textual conventions
+
+TEXTUAL-CONVENTION MACRO ::=
+BEGIN
+ TYPE NOTATION ::=
+ DisplayPart
+ "STATUS" Status
+ "DESCRIPTION" Text
+ ReferPart
+ "SYNTAX" Syntax
+
+ VALUE NOTATION ::=
+ value(VALUE Syntax) -- adapted ASN.1
+
+ DisplayPart ::=
+ "DISPLAY-HINT" Text
+ | empty
+
+ Status ::=
+ "current"
+ | "deprecated"
+ | "obsolete"
+
+ ReferPart ::=
+ "REFERENCE" Text
+ | empty
+
+ -- a character string as defined in [2]
+ Text ::= value(IA5String)
+
+ Syntax ::= -- Must be one of the following:
+ -- a base type (or its refinement), or
+ -- a BITS pseudo-type
+ type
+ | "BITS" "{" NamedBits "}"
+
+ NamedBits ::= NamedBit
+ | NamedBits "," NamedBit
+
+ NamedBit ::= identifier "(" number ")" -- number is nonnegative
+
+END
+
+
+
+
+DisplayString ::= TEXTUAL-CONVENTION
+ DISPLAY-HINT "255a"
+ STATUS current
+ DESCRIPTION
+ "Represents textual information taken from the NVT ASCII
+ character set, as defined in pages 4, 10-11 of RFC 854.
+
+ To summarize RFC 854, the NVT ASCII repertoire specifies:
+
+ - the use of character codes 0-127 (decimal)
+
+ - the graphics characters (32-126) are interpreted as
+ US ASCII
+
+ - NUL, LF, CR, BEL, BS, HT, VT and FF have the special
+ meanings specified in RFC 854
+
+ - the other 25 codes have no standard interpretation
+
+ - the sequence 'CR LF' means newline
+
+ - the sequence 'CR NUL' means carriage-return
+
+ - an 'LF' not preceded by a 'CR' means moving to the
+ same column on the next line.
+
+ - the sequence 'CR x' for any x other than LF or NUL is
+ illegal. (Note that this also means that a string may
+ end with either 'CR LF' or 'CR NUL', but not with CR.)
+
+ Any object defined using this syntax may not exceed 255
+ characters in length."
+ SYNTAX OCTET STRING (SIZE (0..255))
+
+PhysAddress ::= TEXTUAL-CONVENTION
+ DISPLAY-HINT "1x:"
+ STATUS current
+ DESCRIPTION
+ "Represents media- or physical-level addresses."
+ SYNTAX OCTET STRING
+
+
+MacAddress ::= TEXTUAL-CONVENTION
+ DISPLAY-HINT "1x:"
+ STATUS current
+ DESCRIPTION
+ "Represents an 802 MAC address represented in the
+ `canonical' order defined by IEEE 802.1a, i.e., as if it
+ were transmitted least significant bit first, even though
+ 802.5 (in contrast to other 802.x protocols) requires MAC
+ addresses to be transmitted most significant bit first."
+ SYNTAX OCTET STRING (SIZE (6))
+
+TruthValue ::= TEXTUAL-CONVENTION
+ STATUS current
+ DESCRIPTION
+ "Represents a boolean value."
+ SYNTAX INTEGER { true(1), false(2) }
+
+TestAndIncr ::= TEXTUAL-CONVENTION
+ STATUS current
+ DESCRIPTION
+ "Represents integer-valued information used for atomic
+ operations. When the management protocol is used to specify
+ that an object instance having this syntax is to be
+ modified, the new value supplied via the management protocol
+ must precisely match the value presently held by the
+ instance. If not, the management protocol set operation
+ fails with an error of `inconsistentValue'. Otherwise, if
+ the current value is the maximum value of 2^31-1 (2147483647
+ decimal), then the value held by the instance is wrapped to
+ zero; otherwise, the value held by the instance is
+ incremented by one. (Note that regardless of whether the
+ management protocol set operation succeeds, the variable-
+ binding in the request and response PDUs are identical.)
+
+ The value of the ACCESS clause for objects having this
+ syntax is either `read-write' or `read-create'. When an
+ instance of a columnar object having this syntax is created,
+ any value may be supplied via the management protocol.
+
+ When the network management portion of the system is re-
+ initialized, the value of every object instance having this
+ syntax must either be incremented from its value prior to
+ the re-initialization, or (if the value prior to the re-
+ initialization is unknown) be set to a pseudo-randomly
+ generated value."
+ SYNTAX INTEGER (0..2147483647)
+
+AutonomousType ::= TEXTUAL-CONVENTION
+ STATUS current
+ DESCRIPTION
+ "Represents an independently extensible type identification
+ value. It may, for example, indicate a particular sub-tree
+ with further MIB definitions, or define a particular type of
+ protocol or hardware."
+ SYNTAX OBJECT IDENTIFIER
+
+
+InstancePointer ::= TEXTUAL-CONVENTION
+ STATUS obsolete
+ DESCRIPTION
+ "A pointer to either a specific instance of a MIB object or
+ a conceptual row of a MIB table in the managed device. In
+ the latter case, by convention, it is the name of the
+ particular instance of the first accessible columnar object
+ in the conceptual row.
+
+ The two uses of this textual convention are replaced by
+ VariablePointer and RowPointer, respectively."
+ SYNTAX OBJECT IDENTIFIER
+
+
+VariablePointer ::= TEXTUAL-CONVENTION
+ STATUS current
+ DESCRIPTION
+ "A pointer to a specific object instance. For example,
+ sysContact.0 or ifInOctets.3."
+ SYNTAX OBJECT IDENTIFIER
+
+
+RowPointer ::= TEXTUAL-CONVENTION
+ STATUS current
+ DESCRIPTION
+ "Represents a pointer to a conceptual row. The value is the
+ name of the instance of the first accessible columnar object
+ in the conceptual row.
+
+ For example, ifIndex.3 would point to the 3rd row in the
+ ifTable (note that if ifIndex were not-accessible, then
+ ifDescr.3 would be used instead)."
+ SYNTAX OBJECT IDENTIFIER
+
+RowStatus ::= TEXTUAL-CONVENTION
+ STATUS current
+ DESCRIPTION
+ "The RowStatus textual convention is used to manage the
+ creation and deletion of conceptual rows, and is used as the
+ value of the SYNTAX clause for the status column of a
+ conceptual row (as described in Section 7.7.1 of [2].)
+ The status column has six defined values:
+
+ - `active', which indicates that the conceptual row is
+ available for use by the managed device;
+
+ - `notInService', which indicates that the conceptual
+ row exists in the agent, but is unavailable for use by
+ the managed device (see NOTE below); 'notInService' has
+ no implication regarding the internal consistency of
+ the row, availability of resources, or consistency with
+ the current state of the managed device;
+
+ - `notReady', which indicates that the conceptual row
+ exists in the agent, but is missing information
+ necessary in order to be available for use by the
+ managed device (i.e., one or more required columns in
+ the conceptual row have not been instanciated);
+
+ - `createAndGo', which is supplied by a management
+ station wishing to create a new instance of a
+ conceptual row and to have its status automatically set
+ to active, making it available for use by the managed
+ device;
+
+ - `createAndWait', which is supplied by a management
+ station wishing to create a new instance of a
+ conceptual row (but not make it available for use by
+ the managed device); and,
+
+ - `destroy', which is supplied by a management station
+ wishing to delete all of the instances associated with
+ an existing conceptual row.
+
+ Whereas five of the six values (all except `notReady') may
+ be specified in a management protocol set operation, only
+ three values will be returned in response to a management
+ protocol retrieval operation: `notReady', `notInService' or
+ `active'. That is, when queried, an existing conceptual row
+ has only three states: it is either available for use by
+ the managed device (the status column has value `active');
+ it is not available for use by the managed device, though
+ the agent has sufficient information to attempt to make it
+ so (the status column has value `notInService'); or, it is
+ not available for use by the managed device, and an attempt
+ to make it so would fail because the agent has insufficient
+ information (the state column has value `notReady').
+
+ NOTE WELL
+
+ This textual convention may be used for a MIB table,
+ irrespective of whether the values of that table's
+ conceptual rows are able to be modified while it is
+ active, or whether its conceptual rows must be taken
+ out of service in order to be modified. That is, it is
+ the responsibility of the DESCRIPTION clause of the
+ status column to specify whether the status column must
+ not be `active' in order for the value of some other
+ column of the same conceptual row to be modified. If
+ such a specification is made, affected columns may be
+ changed by an SNMP set PDU if the RowStatus would not
+ be equal to `active' either immediately before or after
+ processing the PDU. In other words, if the PDU also
+ contained a varbind that would change the RowStatus
+ value, the column in question may be changed if the
+ RowStatus was not equal to `active' as the PDU was
+ received, or if the varbind sets the status to a value
+ other than 'active'.
+
+
+ Also note that whenever any elements of a row exist, the
+ RowStatus column must also exist.
+
+ To summarize the effect of having a conceptual row with a
+ status column having a SYNTAX clause value of RowStatus,
+ consider the following state diagram:
+
+
+ STATE
+ +--------------+-----------+-------------+-------------
+ | A | B | C | D
+ | |status col.|status column|
+ |status column | is | is |status column
+ ACTION |does not exist| notReady | notInService| is active
+--------------+--------------+-----------+-------------+-------------
+set status |noError ->D|inconsist- |inconsistent-|inconsistent-
+column to | or | entValue| Value| Value
+createAndGo |inconsistent- | | |
+ | Value| | |
+--------------+--------------+-----------+-------------+-------------
+set status |noError see 1|inconsist- |inconsistent-|inconsistent-
+column to | or | entValue| Value| Value
+createAndWait |wrongValue | | |
+--------------+--------------+-----------+-------------+-------------
+set status |inconsistent- |inconsist- |noError |noError
+column to | Value| entValue| |
+active | | | |
+ | | or | |
+ | | | |
+ | |see 2 ->D|see 8 ->D| ->D
+--------------+--------------+-----------+-------------+-------------
+set status |inconsistent- |inconsist- |noError |noError ->C
+column to | Value| entValue| |
+notInService | | | |
+ | | or | | or
+ | | | |
+ | |see 3 ->C| ->C|see 6
+--------------+--------------+-----------+-------------+-------------
+set status |noError |noError |noError |noError ->A
+column to | | | | or
+destroy | ->A| ->A| ->A|see 7
+--------------+--------------+-----------+-------------+-------------
+set any other |see 4 |noError |noError |see 5
+column to some| | | |
+value | | see 1| ->C| ->D
+--------------+--------------+-----------+-------------+-------------
+
+ (1) goto B or C, depending on information available to the
+ agent.
+
+ (2) if other variable bindings included in the same PDU,
+ provide values for all columns which are missing but
+ required, and all columns have acceptable values, then
+ return noError and goto D.
+
+ (3) if other variable bindings included in the same PDU,
+ provide legal values for all columns which are missing but
+ required, then return noError and goto C.
+
+ (4) at the discretion of the agent, the return value may be
+ either:
+
+ inconsistentName: because the agent does not choose to
+ create such an instance when the corresponding
+ RowStatus instance does not exist, or
+
+ inconsistentValue: if the supplied value is
+ inconsistent with the state of some other MIB object's
+ value, or
+
+ noError: because the agent chooses to create the
+ instance.
+
+ If noError is returned, then the instance of the status
+ column must also be created, and the new state is B or C,
+ depending on the information available to the agent. If
+ inconsistentName or inconsistentValue is returned, the row
+ remains in state A.
+
+ (5) depending on the MIB definition for the column/table,
+ either noError or inconsistentValue may be returned.
+
+ (6) the return value can indicate one of the following
+ errors:
+
+ wrongValue: because the agent does not support
+ notInService (e.g., an agent which does not support
+ createAndWait), or
+
+ inconsistentValue: because the agent is unable to take
+ the row out of service at this time, perhaps because it
+ is in use and cannot be de-activated.
+
+ (7) the return value can indicate the following error:
+
+ inconsistentValue: because the agent is unable to
+ remove the row at this time, perhaps because it is in
+ use and cannot be de-activated.
+
+ (8) the transition to D can fail, e.g., if the values of the
+ conceptual row are inconsistent, then the error code would
+ be inconsistentValue.
+
+ NOTE: Other processing of (this and other varbinds of) the
+ set request may result in a response other than noError
+ being returned, e.g., wrongValue, noCreation, etc.
+
+
+ Conceptual Row Creation
+
+ There are four potential interactions when creating a
+ conceptual row: selecting an instance-identifier which is
+ not in use; creating the conceptual row; initializing any
+ objects for which the agent does not supply a default; and,
+ making the conceptual row available for use by the managed
+ device.
+
+ Interaction 1: Selecting an Instance-Identifier
+
+ The algorithm used to select an instance-identifier varies
+ for each conceptual row. In some cases, the instance-
+ identifier is semantically significant, e.g., the
+ destination address of a route, and a management station
+ selects the instance-identifier according to the semantics.
+
+ In other cases, the instance-identifier is used solely to
+ distinguish conceptual rows, and a management station
+ without specific knowledge of the conceptual row might
+ examine the instances present in order to determine an
+ unused instance-identifier. (This approach may be used, but
+ it is often highly sub-optimal; however, it is also a
+ questionable practice for a naive management station to
+ attempt conceptual row creation.)
+
+ Alternately, the MIB module which defines the conceptual row
+ might provide one or more objects which provide assistance
+ in determining an unused instance-identifier. For example,
+ if the conceptual row is indexed by an integer-value, then
+ an object having an integer-valued SYNTAX clause might be
+ defined for such a purpose, allowing a management station to
+ issue a management protocol retrieval operation. In order
+ to avoid unnecessary collisions between competing management
+ stations, `adjacent' retrievals of this object should be
+ different.
+
+ Finally, the management station could select a pseudo-random
+ number to use as the index. In the event that this index
+ was already in use and an inconsistentValue was returned in
+ response to the management protocol set operation, the
+ management station should simply select a new pseudo-random
+ number and retry the operation.
+
+ A MIB designer should choose between the two latter
+ algorithms based on the size of the table (and therefore the
+ efficiency of each algorithm). For tables in which a large
+ number of entries are expected, it is recommended that a MIB
+ object be defined that returns an acceptable index for
+ creation. For tables with small numbers of entries, it is
+ recommended that the latter pseudo-random index mechanism be
+ used.
+
+ Interaction 2: Creating the Conceptual Row
+
+ Once an unused instance-identifier has been selected, the
+ management station determines if it wishes to create and
+ activate the conceptual row in one transaction or in a
+ negotiated set of interactions.
+
+ Interaction 2a: Creating and Activating the Conceptual Row
+
+ The management station must first determine the column
+ requirements, i.e., it must determine those columns for
+ which it must or must not provide values. Depending on the
+ complexity of the table and the management station's
+ knowledge of the agent's capabilities, this determination
+ can be made locally by the management station. Alternately,
+ the management station issues a management protocol get
+ operation to examine all columns in the conceptual row that
+ it wishes to create. In response, for each column, there
+ are three possible outcomes:
+
+ - a value is returned, indicating that some other
+ management station has already created this conceptual
+ row. We return to interaction 1.
+
+ - the exception `noSuchInstance' is returned,
+ indicating that the agent implements the object-type
+ associated with this column, and that this column in at
+ least one conceptual row would be accessible in the MIB
+ view used by the retrieval were it to exist. For those
+ columns to which the agent provides read-create access,
+ the `noSuchInstance' exception tells the management
+ station that it should supply a value for this column
+ when the conceptual row is to be created.
+
+ - the exception `noSuchObject' is returned, indicating
+ that the agent does not implement the object-type
+ associated with this column or that there is no
+ conceptual row for which this column would be
+ accessible in the MIB view used by the retrieval. As
+ such, the management station can not issue any
+ management protocol set operations to create an
+ instance of this column.
+
+ Once the column requirements have been determined, a
+ management protocol set operation is accordingly issued.
+ This operation also sets the new instance of the status
+ column to `createAndGo'.
+
+ When the agent processes the set operation, it verifies that
+ it has sufficient information to make the conceptual row
+ available for use by the managed device. The information
+ available to the agent is provided by two sources: the
+ management protocol set operation which creates the
+ conceptual row, and, implementation-specific defaults
+ supplied by the agent (note that an agent must provide
+ implementation-specific defaults for at least those objects
+ which it implements as read-only). If there is sufficient
+ information available, then the conceptual row is created, a
+ `noError' response is returned, the status column is set to
+ `active', and no further interactions are necessary (i.e.,
+ interactions 3 and 4 are skipped). If there is insufficient
+ information, then the conceptual row is not created, and the
+ set operation fails with an error of `inconsistentValue'.
+ On this error, the management station can issue a management
+ protocol retrieval operation to determine if this was
+ because it failed to specify a value for a required column,
+ or, because the selected instance of the status column
+ already existed. In the latter case, we return to
+ interaction 1. In the former case, the management station
+ can re-issue the set operation with the additional
+ information, or begin interaction 2 again using
+ `createAndWait' in order to negotiate creation of the
+ conceptual row.
+
+ NOTE WELL
+
+ Regardless of the method used to determine the column
+ requirements, it is possible that the management
+ station might deem a column necessary when, in fact,
+ the agent will not allow that particular columnar
+ instance to be created or written. In this case, the
+ management protocol set operation will fail with an
+ error such as `noCreation' or `notWritable'. In this
+ case, the management station decides whether it needs
+ to be able to set a value for that particular columnar
+ instance. If not, the management station re-issues the
+ management protocol set operation, but without setting
+ a value for that particular columnar instance;
+ otherwise, the management station aborts the row
+ creation algorithm.
+
+ Interaction 2b: Negotiating the Creation of the Conceptual
+ Row
+
+ The management station issues a management protocol set
+ operation which sets the desired instance of the status
+ column to `createAndWait'. If the agent is unwilling to
+ process a request of this sort, the set operation fails with
+ an error of `wrongValue'. (As a consequence, such an agent
+ must be prepared to accept a single management protocol set
+ operation, i.e., interaction 2a above, containing all of the
+ columns indicated by its column requirements.) Otherwise,
+ the conceptual row is created, a `noError' response is
+ returned, and the status column is immediately set to either
+ `notInService' or `notReady', depending on whether it has
+ sufficient information to (attempt to) make the conceptual
+ row available for use by the managed device. If there is
+ sufficient information available, then the status column is
+ set to `notInService'; otherwise, if there is insufficient
+ information, then the status column is set to `notReady'.
+ Regardless, we proceed to interaction 3.
+
+ Interaction 3: Initializing non-defaulted Objects
+
+ The management station must now determine the column
+ requirements. It issues a management protocol get operation
+ to examine all columns in the created conceptual row. In
+ the response, for each column, there are three possible
+ outcomes:
+
+ - a value is returned, indicating that the agent
+ implements the object-type associated with this column
+ and had sufficient information to provide a value. For
+ those columns to which the agent provides read-create
+ access (and for which the agent allows their values to
+ be changed after their creation), a value return tells
+ the management station that it may issue additional
+ management protocol set operations, if it desires, in
+ order to change the value associated with this column.
+
+ - the exception `noSuchInstance' is returned,
+ indicating that the agent implements the object-type
+ associated with this column, and that this column in at
+ least one conceptual row would be accessible in the MIB
+ view used by the retrieval were it to exist. However,
+ the agent does not have sufficient information to
+ provide a value, and until a value is provided, the
+ conceptual row may not be made available for use by the
+ managed device. For those columns to which the agent
+ provides read-create access, the `noSuchInstance'
+ exception tells the management station that it must
+ issue additional management protocol set operations, in
+ order to provide a value associated with this column.
+
+ - the exception `noSuchObject' is returned, indicating
+ that the agent does not implement the object-type
+ associated with this column or that there is no
+ conceptual row for which this column would be
+ accessible in the MIB view used by the retrieval. As
+ such, the management station can not issue any
+ management protocol set operations to create an
+ instance of this column.
+
+ If the value associated with the status column is
+ `notReady', then the management station must first deal with
+ all `noSuchInstance' columns, if any. Having done so, the
+ value of the status column becomes `notInService', and we
+ proceed to interaction 4.
+
+ Interaction 4: Making the Conceptual Row Available
+
+ Once the management station is satisfied with the values
+ associated with the columns of the conceptual row, it issues
+ a management protocol set operation to set the status column
+ to `active'. If the agent has sufficient information to
+ make the conceptual row available for use by the managed
+ device, the management protocol set operation succeeds (a
+ `noError' response is returned). Otherwise, the management
+ protocol set operation fails with an error of
+ `inconsistentValue'.
+
+ NOTE WELL
+
+ A conceptual row having a status column with value
+ `notInService' or `notReady' is unavailable to the
+ managed device. As such, it is possible for the
+ managed device to create its own instances during the
+ time between the management protocol set operation
+ which sets the status column to `createAndWait' and the
+ management protocol set operation which sets the status
+ column to `active'. In this case, when the management
+ protocol set operation is issued to set the status
+ column to `active', the values held in the agent
+ supersede those used by the managed device.
+
+ If the management station is prevented from setting the
+ status column to `active' (e.g., due to management station
+ or network failure) the conceptual row will be left in the
+ `notInService' or `notReady' state, consuming resources
+ indefinitely. The agent must detect conceptual rows that
+ have been in either state for an abnormally long period of
+ time and remove them. It is the responsibility of the
+ DESCRIPTION clause of the status column to indicate what an
+ abnormally long period of time would be. This period of
+ time should be long enough to allow for human response time
+ (including `think time') between the creation of the
+ conceptual row and the setting of the status to `active'.
+ In the absence of such information in the DESCRIPTION
+ clause, it is suggested that this period be approximately 5
+ minutes in length. This removal action applies not only to
+ newly-created rows, but also to previously active rows which
+ are set to, and left in, the notInService state for a
+ prolonged period exceeding that which is considered normal
+ for such a conceptual row.
+
+ Conceptual Row Suspension
+
+ When a conceptual row is `active', the management station
+ may issue a management protocol set operation which sets the
+ instance of the status column to `notInService'. If the
+ agent is unwilling to do so, the set operation fails with an
+ error of `wrongValue' or `inconsistentValue'. Otherwise,
+ the conceptual row is taken out of service, and a `noError'
+ response is returned. It is the responsibility of the
+ DESCRIPTION clause of the status column to indicate under
+ what circumstances the status column should be taken out of
+ service (e.g., in order for the value of some other column
+ of the same conceptual row to be modified).
+
+
+ Conceptual Row Deletion
+
+ For deletion of conceptual rows, a management protocol set
+ operation is issued which sets the instance of the status
+ column to `destroy'. This request may be made regardless of
+ the current value of the status column (e.g., it is possible
+ to delete conceptual rows which are either `notReady',
+ `notInService' or `active'.) If the operation succeeds,
+ then all instances associated with the conceptual row are
+ immediately removed."
+ SYNTAX INTEGER {
+ -- the following two values are states:
+ -- these values may be read or written
+ active(1),
+ notInService(2),
+
+ -- the following value is a state:
+ -- this value may be read, but not written
+ notReady(3),
+
+ -- the following three values are
+ -- actions: these values may be written,
+ -- but are never read
+ createAndGo(4),
+ createAndWait(5),
+ destroy(6)
+ }
+
+TimeStamp ::= TEXTUAL-CONVENTION
+ STATUS current
+ DESCRIPTION
+ "The value of the sysUpTime object at which a specific
+ occurrence happened. The specific occurrence must be
+ defined in the description of any object defined using this
+ type.
+
+ If sysUpTime is reset to zero as a result of a re-
+ initialization of the network management (sub)system, then
+ the values of all TimeStamp objects are also reset.
+ However, after approximately 497 days without a re-
+ initialization, the sysUpTime object will reach 2^^32-1 and
+ then increment around to zero; in this case, existing values
+ of TimeStamp objects do not change. This can lead to
+ ambiguities in the value of TimeStamp objects."
+ SYNTAX TimeTicks
+
+
+TimeInterval ::= TEXTUAL-CONVENTION
+ STATUS current
+ DESCRIPTION
+ "A period of time, measured in units of 0.01 seconds."
+ SYNTAX INTEGER (0..2147483647)
+
+DateAndTime ::= TEXTUAL-CONVENTION
+ DISPLAY-HINT "2d-1d-1d,1d:1d:1d.1d,1a1d:1d"
+ STATUS current
+ DESCRIPTION
+ "A date-time specification.
+
+ field octets contents range
+ ----- ------ -------- -----
+ 1 1-2 year* 0..65536
+ 2 3 month 1..12
+ 3 4 day 1..31
+ 4 5 hour 0..23
+ 5 6 minutes 0..59
+ 6 7 seconds 0..60
+ (use 60 for leap-second)
+ 7 8 deci-seconds 0..9
+ 8 9 direction from UTC '+' / '-'
+ 9 10 hours from UTC* 0..13
+ 10 11 minutes from UTC 0..59
+
+ * Notes:
+ - the value of year is in network-byte order
+ - daylight saving time in New Zealand is +13
+
+ For example, Tuesday May 26, 1992 at 1:30:15 PM EDT would be
+ displayed as:
+
+ 1992-5-26,13:30:15.0,-4:0
+
+ Note that if only local time is known, then timezone
+ information (fields 8-10) is not present."
+ SYNTAX OCTET STRING (SIZE (8 | 11))
+
+
+StorageType ::= TEXTUAL-CONVENTION
+ STATUS current
+ DESCRIPTION
+ "Describes the memory realization of a conceptual row. A
+ row which is volatile(2) is lost upon reboot. A row which
+ is either nonVolatile(3), permanent(4) or readOnly(5), is
+ backed up by stable storage. A row which is permanent(4)
+ can be changed but not deleted. A row which is readOnly(5)
+ cannot be changed nor deleted.
+
+ If the value of an object with this syntax is either
+ permanent(4) or readOnly(5), it cannot be written.
+ Conversely, if the value is either other(1), volatile(2) or
+ nonVolatile(3), it cannot be modified to be permanent(4) or
+ readOnly(5). (All illegal modifications result in a
+ 'wrongValue' error.)
+
+ Every usage of this textual convention is required to
+ specify the columnar objects which a permanent(4) row must
+ at a minimum allow to be writable."
+ SYNTAX INTEGER {
+ other(1), -- eh?
+ volatile(2), -- e.g., in RAM
+ nonVolatile(3), -- e.g., in NVRAM
+ permanent(4), -- e.g., partially in ROM
+ readOnly(5) -- e.g., completely in ROM
+ }
+
+TDomain ::= TEXTUAL-CONVENTION
+ STATUS current
+ DESCRIPTION
+ "Denotes a kind of transport service.
+
+ Some possible values, such as snmpUDPDomain, are defined in
+ the SNMPv2-TM MIB module. Other possible values are defined
+ in other MIB modules."
+ REFERENCE "The SNMPv2-TM MIB module is defined in RFC 1906."
+ SYNTAX OBJECT IDENTIFIER
+
+
+TAddress ::= TEXTUAL-CONVENTION
+ STATUS current
+ DESCRIPTION
+ "Denotes a transport service address.
+
+ A TAddress value is always interpreted within the context of a
+ TDomain value. Thus, each definition of a TDomain value must
+ be accompanied by a definition of a textual convention for use
+ with that TDomain. Some possible textual conventions, such as
+ SnmpUDPAddress for snmpUDPDomain, are defined in the SNMPv2-TM
+ MIB module. Other possible textual conventions are defined in
+ other MIB modules."
+ REFERENCE "The SNMPv2-TM MIB module is defined in RFC 1906."
+ SYNTAX OCTET STRING (SIZE (1..255))
+
+
+END
diff --git a/tangostationcontrol/tangostationcontrol/toolkit/mib_compiler/mibs/TEST-MIB.txt b/tangostationcontrol/tangostationcontrol/toolkit/mib_compiler/mibs/TEST-MIB.txt
new file mode 100644
index 0000000000000000000000000000000000000000..d0ea67e2730c46edcc175a5326cf4d44e29a4dc3
--- /dev/null
+++ b/tangostationcontrol/tangostationcontrol/toolkit/mib_compiler/mibs/TEST-MIB.txt
@@ -0,0 +1,36 @@
+TEST-MIB DEFINITIONS ::= BEGIN
+
+--
+-- A simple MIB objects for testing
+--
+
+IMPORTS
+ MODULE-IDENTITY, OBJECT-TYPE, Integer32, org FROM SNMPv2-SMI
+ ;
+
+testMib MODULE-IDENTITY
+ LAST-UPDATED "202004060000Z"
+ ORGANIZATION "astron"
+ CONTACT-INFO "astron"
+ DESCRIPTION "Test mib"
+ ::= { org 2 }
+
+--
+-- top level structure
+--
+TestVal OBJECT IDENTIFIER ::= { testMib 1 }
+
+--
+-- Example scalars
+--
+
+testValue OBJECT-TYPE
+ SYNTAX Integer32
+ MAX-ACCESS read-write
+ STATUS current
+ DESCRIPTION
+ "This is simply a test value."
+ DEFVAL { 1 }
+ ::= { TestVal 1 }
+
+END