Major overhaul related to PySMI integration and Standard SNMP Applications

API redesign:
* MibVariable becomes ObjectIdentity and moves to pysnmp.smi.rfc1902
* ObjectType and NotificationType classes resempling corresponding MIB MACROs
  implemented
* SNMP Standard Applications and examples modified to support ObjectType
  and NotificationType parameters

16 files changed, 74 insertions, 31 deletions

diff --git a/examples/hlapi/asyncore/sync/manager/cmdgen/coerce-set-value-to-mib-spec.py b/examples/hlapi/asyncore/sync/manager/cmdgen/coerce-set-value-to-mib-spec.py
index d58ad9ca..6732ec29 100644
--- a/examples/hlapi/asyncore/sync/manager/cmdgen/coerce-set-value-to-mib-spec.py
+++ b/examples/hlapi/asyncore/sync/manager/cmdgen/coerce-set-value-to-mib-spec.py
@@ -15,7 +15,10 @@ cmdGen = cmdgen.CommandGenerator()
 errorIndication, errorStatus, errorIndex, varBinds = cmdGen.setCmd(
     cmdgen.CommunityData('public'),
     cmdgen.UdpTransportTarget(('demo.snmplabs.com', 161)),
-    (cmdgen.MibVariable('SNMPv2-MIB', 'sysORDescr', 1), 'new system name')
+    cmdgen.ObjectType(
+        cmdgen.ObjectIdentity('SNMPv2-MIB', 'sysORDescr', 1),
+        'new system name'
+    )
 )
 
 # Check for errors and print out results
diff --git a/examples/hlapi/asyncore/sync/manager/cmdgen/custom-asn1-mib-search-path.py b/examples/hlapi/asyncore/sync/manager/cmdgen/custom-asn1-mib-search-path.py
new file mode 100644
index 00000000..2c696993
--- /dev/null
+++ b/examples/hlapi/asyncore/sync/manager/cmdgen/custom-asn1-mib-search-path.py
@@ -0,0 +1,34 @@
+#
+# Command Generator
+#
+# Send SNMP GET request using the following options:
+#
+# * with SNMPv2c, community 'public'
+# * over IPv4/UDP
+# * to an Agent at demo.snmplabs.com:161
+# * for IF-MIB::ifInOctets.1 MIB object
+#
+from pysnmp.entity.rfc3413.oneliner import cmdgen
+
+cmdGen = cmdgen.CommandGenerator()
+
+errorIndication, errorStatus, errorIndex, varBinds = cmdGen.getCmd(
+    cmdgen.CommunityData('public'),
+    cmdgen.UdpTransportTarget(('demo.snmplabs.com', 161)),
+    cmdgen.ObjectIdentity('IF-MIB', 'ifInOctets', 1).addMibCompiler('file:///usr/share/snmp', 'http://mibs.snmplabs.com/asn1/<mib>'),
+    lookupNames=True, lookupValues=True
+)
+
+# Check for errors and print out results
+if errorIndication:
+    print(errorIndication)
+else:
+    if errorStatus:
+        print('%s at %s' % (
+            errorStatus.prettyPrint(),
+            errorIndex and varBinds[int(errorIndex)-1][0] or '?'
+            )
+        )
+    else:
+        for oid, val in varBinds:
+            print('%s = %s' % (oid.prettyPrint(), val.prettyPrint()))
diff --git a/examples/hlapi/asyncore/sync/manager/cmdgen/custom-contextengineid-and-contextname.py b/examples/hlapi/asyncore/sync/manager/cmdgen/custom-contextengineid-and-contextname.py
index e273bba6..f28063b1 100644
--- a/examples/hlapi/asyncore/sync/manager/cmdgen/custom-contextengineid-and-contextname.py
+++ b/examples/hlapi/asyncore/sync/manager/cmdgen/custom-contextengineid-and-contextname.py
@@ -19,7 +19,10 @@ cmdGen = cmdgen.CommandGenerator()
 errorIndication, errorStatus, errorIndex, varBinds = cmdGen.setCmd(
     cmdgen.UsmUserData('usr-md5-none', 'authkey1'),
     cmdgen.UdpTransportTarget(('demo.snmplabs.com', 161)),
-    (cmdgen.MibVariable('SNMPv2-MIB', 'sysORDescr', 1), 'new system name'),
+    cmdgen.ObjectType(
+        cmdgen.ObjectIdentity('SNMPv2-MIB', 'sysORDescr', 1),
+        'new system name'
+    ),
     contextEngineId=rfc1902.OctetString(hexValue='80004fb805636c6f75644dab22cc'),
     contextName='da761cfc8c94d3aceef4f60f049105ba'
 )
diff --git a/examples/hlapi/asyncore/sync/manager/cmdgen/custom-contextengineid.py b/examples/hlapi/asyncore/sync/manager/cmdgen/custom-contextengineid.py
index 04ee0bf5..124a26fa 100644
--- a/examples/hlapi/asyncore/sync/manager/cmdgen/custom-contextengineid.py
+++ b/examples/hlapi/asyncore/sync/manager/cmdgen/custom-contextengineid.py
@@ -23,7 +23,10 @@ errorIndication, errorStatus, errorIndex, varBinds = cmdGen.setCmd(
         )
     ),
     cmdgen.UdpTransportTarget(('demo.snmplabs.com', 161)),
-    (cmdgen.MibVariable('SNMPv2-MIB', 'sysORDescr', 1), 'new system name'),
+    cmdgen.ObjectType(
+        cmdgen.ObjectIdentity('SNMPv2-MIB', 'sysORDescr', 1),
+        'new system name'
+    )
 )
 
 # Check for errors and print out results
diff --git a/examples/hlapi/asyncore/sync/manager/cmdgen/custom-pysnmp-mibs-search-path.py b/examples/hlapi/asyncore/sync/manager/cmdgen/custom-pysnmp-mibs-search-path.py
index a0f0f298..4ca6b6e9 100644
--- a/examples/hlapi/asyncore/sync/manager/cmdgen/custom-pysnmp-mibs-search-path.py
+++ b/examples/hlapi/asyncore/sync/manager/cmdgen/custom-pysnmp-mibs-search-path.py
@@ -22,7 +22,7 @@ errorIndication, errorStatus, errorIndex, varBindTable = cmdGen.bulkCmd(
     cmdgen.UsmUserData('usr-none-none'),
     cmdgen.UdpTransportTarget(('demo.snmplabs.com', 161)),
     0, 50,
-    cmdgen.MibVariable('TCP-MIB', 'tcpConnTable').addMibSource('/tmp/mymibs'),
+    cmdgen.ObjectIdentity('TCP-MIB', 'tcpConnTable').addMibSource('/tmp/mibs'),
     lexicographicMode=True, maxRows=100, maxCalls=10,ignoreNonIncreasingOid=True
 )
 
diff --git a/examples/hlapi/asyncore/sync/manager/cmdgen/fetch-variables-over-ipv6.py b/examples/hlapi/asyncore/sync/manager/cmdgen/fetch-variables-over-ipv6.py
index 452c8113..b766fad9 100644
--- a/examples/hlapi/asyncore/sync/manager/cmdgen/fetch-variables-over-ipv6.py
+++ b/examples/hlapi/asyncore/sync/manager/cmdgen/fetch-variables-over-ipv6.py
@@ -6,7 +6,7 @@
 # * with SNMPv3 with user 'usr-md5-des', MD5 auth and DES privacy protocols
 # * over IPv6/UDP
 # * to an Agent at [::1]:161
-# * for three OIDs: one passed as a MibVariable object while others are
+# * for three OIDs: one passed as a ObjectIdentity object while others are
 # * in string form
 #
 from pysnmp.entity.rfc3413.oneliner import cmdgen
@@ -16,7 +16,7 @@ cmdGen = cmdgen.CommandGenerator()
 errorIndication, errorStatus, errorIndex, varBinds = cmdGen.getCmd(
     cmdgen.UsmUserData('usr-md5-des', 'authkey1', 'privkey1'),
     cmdgen.Udp6TransportTarget(('::1', 161)),
-    cmdgen.MibVariable('1.3.6.1.2.1.1.1.0'),
+    cmdgen.ObjectIdentity('1.3.6.1.2.1.1.1.0'),
     '1.3.6.1.2.1.1.2.0',
     '1.3.6.1.2.1.1.3.0'
 )
diff --git a/examples/hlapi/asyncore/sync/manager/cmdgen/get-table-object-by-index.py b/examples/hlapi/asyncore/sync/manager/cmdgen/get-table-object-by-index.py
index 35fe0df4..c6419934 100644
--- a/examples/hlapi/asyncore/sync/manager/cmdgen/get-table-object-by-index.py
+++ b/examples/hlapi/asyncore/sync/manager/cmdgen/get-table-object-by-index.py
@@ -16,7 +16,7 @@ cmdGen = cmdgen.CommandGenerator()
 errorIndication, errorStatus, errorIndex, varBinds = cmdGen.getCmd(
     cmdgen.UsmUserData('usr-none-none'),
     cmdgen.UdpTransportTarget(('demo.snmplabs.com', 161)),
-    cmdgen.MibVariable('IF-MIB', 'ifInOctets', '1'),
+    cmdgen.ObjectIdentity('IF-MIB', 'ifInOctets', 1),
     lookupNames=True, lookupValues=True
 )
 
diff --git a/examples/hlapi/asyncore/sync/manager/cmdgen/get-table-object-by-multiple-indices.py b/examples/hlapi/asyncore/sync/manager/cmdgen/get-table-object-by-multiple-indices.py
index 74f31b0e..8bc4562b 100644
--- a/examples/hlapi/asyncore/sync/manager/cmdgen/get-table-object-by-multiple-indices.py
+++ b/examples/hlapi/asyncore/sync/manager/cmdgen/get-table-object-by-multiple-indices.py
@@ -17,7 +17,7 @@ errorIndication, errorStatus, errorIndex, varBinds = cmdGen.getCmd(
                        authProtocol=cmdgen.usmHMACSHAAuthProtocol,
                        privProtocol=cmdgen.usmAesCfb128Protocol ),
     cmdgen.UdpTransportTarget(('demo.snmplabs.com', 161)),
-    cmdgen.MibVariable('TCP-MIB', 'tcpConnLocalAddress', '0.0.0.0', 22, '0.0.0.0', 0)
+    cmdgen.ObjectIdentity('TCP-MIB', 'tcpConnLocalAddress', '0.0.0.0', 22, '0.0.0.0', 0)
 )
 
 # Check for errors and print out results
diff --git a/examples/hlapi/asyncore/sync/manager/cmdgen/getbulk-fetch-scalar-and-table-variables.py b/examples/hlapi/asyncore/sync/manager/cmdgen/getbulk-fetch-scalar-and-table-variables.py
index 7291ee8f..99df3c11 100644
--- a/examples/hlapi/asyncore/sync/manager/cmdgen/getbulk-fetch-scalar-and-table-variables.py
+++ b/examples/hlapi/asyncore/sync/manager/cmdgen/getbulk-fetch-scalar-and-table-variables.py
@@ -22,8 +22,8 @@ errorIndication, errorStatus, errorIndex, varBindTable = cmdGen.bulkCmd(
     cmdgen.UsmUserData('usr-md5-des', 'authkey1', 'privkey1'),
     cmdgen.Udp6TransportTarget(('::1', 161)),
     1, 25,
-    cmdgen.MibVariable('IP-MIB', 'ipAdEntAddr'),
-    cmdgen.MibVariable('IF-MIB', 'ifEntry'),
+    cmdgen.ObjectIdentity('IP-MIB', 'ipAdEntAddr'),
+    cmdgen.ObjectIdentity('IF-MIB', 'ifEntry'),
     lookupNames=True, lookupValues=True, maxRows=20
 )
 
diff --git a/examples/hlapi/asyncore/sync/manager/cmdgen/getnext-limit-number-of-variables.py b/examples/hlapi/asyncore/sync/manager/cmdgen/getnext-limit-number-of-variables.py
index 2e9c9f43..bdeda853 100644
--- a/examples/hlapi/asyncore/sync/manager/cmdgen/getnext-limit-number-of-variables.py
+++ b/examples/hlapi/asyncore/sync/manager/cmdgen/getnext-limit-number-of-variables.py
@@ -21,7 +21,7 @@ errorIndication, errorStatus, errorIndex, varBindTable = cmdGen.nextCmd(
                        authProtocol=cmdgen.usmHMACSHAAuthProtocol,
                        privProtocol=cmdgen.usmAesCfb128Protocol),
     cmdgen.UdpTransportTarget(('demo.snmplabs.com', 161)),
-    cmdgen.MibVariable('IF-MIB', '').loadMibs(),
+    cmdgen.ObjectIdentity('IF-MIB', '').loadMibs(),
     lexicographicMode=True, maxRows=100,
     ignoreNonIncreasingOid=True
 )
diff --git a/examples/hlapi/asyncore/sync/manager/cmdgen/preload-pysnmp-mibs.py b/examples/hlapi/asyncore/sync/manager/cmdgen/preload-pysnmp-mibs.py
index 6354572c..847ba252 100644
--- a/examples/hlapi/asyncore/sync/manager/cmdgen/preload-pysnmp-mibs.py
+++ b/examples/hlapi/asyncore/sync/manager/cmdgen/preload-pysnmp-mibs.py
@@ -19,7 +19,7 @@ cmdGen = cmdgen.CommandGenerator()
 errorIndication, errorStatus, errorIndex, varBindTable = cmdGen.nextCmd(
     cmdgen.UsmUserData('usr-md5-des', 'authkey1', 'privkey1'),
     cmdgen.Udp6TransportTarget(('::1', 161)),
-    cmdgen.MibVariable('IF-MIB', 'ifEntry'),
+    cmdgen.ObjectIdentity('IF-MIB', 'ifEntry'),
     lookupNames=True, lookupValues=True
 )
 
diff --git a/examples/hlapi/asyncore/sync/manager/cmdgen/pull-whole-mib.py b/examples/hlapi/asyncore/sync/manager/cmdgen/pull-whole-mib.py
index 25352de8..2d62e85c 100644
--- a/examples/hlapi/asyncore/sync/manager/cmdgen/pull-whole-mib.py
+++ b/examples/hlapi/asyncore/sync/manager/cmdgen/pull-whole-mib.py
@@ -19,7 +19,7 @@ cmdGen = cmdgen.CommandGenerator()
 errorIndication, errorStatus, errorIndex, varBindTable = cmdGen.nextCmd(
     cmdgen.UsmUserData('usr-md5-none', 'authkey1'),
     cmdgen.UdpTransportTarget(('demo.snmplabs.com', 161)),
-    cmdgen.MibVariable('IF-MIB', ''),
+    cmdgen.ObjectIdentity('IF-MIB', ''),
     lookupValues=True
 )
 
diff --git a/examples/hlapi/asyncore/sync/manager/cmdgen/pull-whole-snmp-table.py b/examples/hlapi/asyncore/sync/manager/cmdgen/pull-whole-snmp-table.py
index 2a698959..7be99e22 100644
--- a/examples/hlapi/asyncore/sync/manager/cmdgen/pull-whole-snmp-table.py
+++ b/examples/hlapi/asyncore/sync/manager/cmdgen/pull-whole-snmp-table.py
@@ -18,11 +18,11 @@ cmdGen = cmdgen.CommandGenerator()
 errorIndication, errorStatus, errorIndex, varBindTable = cmdGen.nextCmd(
     cmdgen.CommunityData('public', mpModel=0),
     cmdgen.UdpTransportTarget(('demo.snmplabs.com', 161)),
-    cmdgen.MibVariable('IF-MIB', 'ifDescr'),
-    cmdgen.MibVariable('IF-MIB', 'ifType'),
-    cmdgen.MibVariable('IF-MIB', 'ifMtu'),
-    cmdgen.MibVariable('IF-MIB', 'ifSpeed'),
-    cmdgen.MibVariable('IF-MIB', 'ifPhysAddress')
+    cmdgen.ObjectIdentity('IF-MIB', 'ifDescr'),
+    cmdgen.ObjectIdentity('IF-MIB', 'ifType'),
+    cmdgen.ObjectIdentity('IF-MIB', 'ifMtu'),
+    cmdgen.ObjectIdentity('IF-MIB', 'ifSpeed'),
+    cmdgen.ObjectIdentity('IF-MIB', 'ifPhysAddress')
 )
 
 if errorIndication:
diff --git a/examples/hlapi/asyncore/sync/manager/cmdgen/query-agents-from-multuple-threads.py b/examples/hlapi/asyncore/sync/manager/cmdgen/query-agents-from-multuple-threads.py
index df22afb7..5d589f93 100644
--- a/examples/hlapi/asyncore/sync/manager/cmdgen/query-agents-from-multuple-threads.py
+++ b/examples/hlapi/asyncore/sync/manager/cmdgen/query-agents-from-multuple-threads.py
@@ -28,29 +28,29 @@ targets = (
     # 1-st target (SNMPv1 over IPv4/UDP)
     ( cmdgen.CommunityData('public', mpModel=0),
       cmdgen.UdpTransportTarget(('demo.snmplabs.com', 161)),
-      ( cmdgen.MibVariable('SNMPv2-MIB', 'sysDescr', 0),
-        cmdgen.MibVariable('SNMPv2-MIB', 'sysLocation', 0) ) ),
+      ( cmdgen.ObjectIdentity('SNMPv2-MIB', 'sysDescr', 0),
+        cmdgen.ObjectIdentity('SNMPv2-MIB', 'sysLocation', 0) ) ),
     # 2-nd target (SNMPv2c over IPv4/UDP)
     ( cmdgen.CommunityData('public'),
       cmdgen.UdpTransportTarget(('demo.snmplabs.com', 161)),
-      ( cmdgen.MibVariable('SNMPv2-MIB', 'sysDescr', 0),
-        cmdgen.MibVariable('SNMPv2-MIB', 'sysLocation', 0) ) ),
+      ( cmdgen.ObjectIdentity('SNMPv2-MIB', 'sysDescr', 0),
+        cmdgen.ObjectIdentity('SNMPv2-MIB', 'sysLocation', 0) ) ),
     # 3-nd target (SNMPv2c over IPv4/UDP) - same community and 
     # different transport address.
     ( cmdgen.CommunityData('public'),
       cmdgen.UdpTransportTarget(('localhost', 161)),
-      ( cmdgen.MibVariable('SNMPv2-MIB', 'sysContact', 0),
-        cmdgen.MibVariable('SNMPv2-MIB', 'sysName', 0) ) ),
+      ( cmdgen.ObjectIdentity('SNMPv2-MIB', 'sysContact', 0),
+        cmdgen.ObjectIdentity('SNMPv2-MIB', 'sysName', 0) ) ),
     # 4-nd target (SNMPv3 over IPv4/UDP)
     ( cmdgen.UsmUserData('usr-md5-des', 'authkey1', 'privkey1'),
       cmdgen.UdpTransportTarget(('demo.snmplabs.com', 161)),
-      ( cmdgen.MibVariable('SNMPv2-MIB', 'sysDescr', 0),
-        cmdgen.MibVariable('SNMPv2-MIB', 'sysLocation', 0) ) ),
+      ( cmdgen.ObjectIdentity('SNMPv2-MIB', 'sysDescr', 0),
+        cmdgen.ObjectIdentity('SNMPv2-MIB', 'sysLocation', 0) ) ),
     # 5-th target (SNMPv3 over IPv6/UDP)
     ( cmdgen.UsmUserData('usr-md5-none', 'authkey1'),
       cmdgen.Udp6TransportTarget(('::1', 161)),
-      ( cmdgen.MibVariable('SNMPv2-MIB', 'sysDescr', 0),
-        cmdgen.MibVariable('SNMPv2-MIB', 'sysLocation', 0) ) ),
+      ( cmdgen.ObjectIdentity('SNMPv2-MIB', 'sysDescr', 0),
+        cmdgen.ObjectIdentity('SNMPv2-MIB', 'sysLocation', 0) ) ),
     # N-th target
     # ...
 )
diff --git a/examples/hlapi/asyncore/sync/manager/cmdgen/usm-md5-none.py b/examples/hlapi/asyncore/sync/manager/cmdgen/usm-md5-none.py
index 5392c0c9..47f025f1 100644
--- a/examples/hlapi/asyncore/sync/manager/cmdgen/usm-md5-none.py
+++ b/examples/hlapi/asyncore/sync/manager/cmdgen/usm-md5-none.py
@@ -15,7 +15,7 @@ cmdGen = cmdgen.CommandGenerator()
 errorIndication, errorStatus, errorIndex, varBinds = cmdGen.getCmd(
     cmdgen.UsmUserData('usr-md5-none', 'authkey1'),
     cmdgen.UdpTransportTarget(('demo.snmplabs.com', 161)),
-    cmdgen.MibVariable('IF-MIB', 'ifInOctets', '1')
+    cmdgen.ObjectIdentity('IF-MIB', 'ifInOctets', 1)
 )
 
 # Check for errors and print out results
diff --git a/examples/hlapi/asyncore/sync/manager/cmdgen/v1-get.py b/examples/hlapi/asyncore/sync/manager/cmdgen/v1-get.py
index f05c5f80..664df9dd 100644
--- a/examples/hlapi/asyncore/sync/manager/cmdgen/v1-get.py
+++ b/examples/hlapi/asyncore/sync/manager/cmdgen/v1-get.py
@@ -16,8 +16,8 @@ cmdGen = cmdgen.CommandGenerator()
 errorIndication, errorStatus, errorIndex, varBinds = cmdGen.getCmd(
     cmdgen.CommunityData('public', mpModel=0),
     cmdgen.UdpTransportTarget(('demo.snmplabs.com', 161)),
-    cmdgen.MibVariable('iso.org.dod.internet.mgmt.mib-2.system.sysDescr.0'),
-    cmdgen.MibVariable('SNMPv2-MIB', 'sysDescr', 0)
+    cmdgen.ObjectIdentity('iso.org.dod.internet.mgmt.mib-2.system.sysDescr.0'),
+    cmdgen.ObjectIdentity('SNMPv2-MIB', 'sysDescr', 0)
 )
 
 # Check for errors and print out results