def __init__(self, objectIdentity, objectSyntax=rfc1905.unSpecified):
if not isinstance(objectIdentity, ObjectIdentity):
raise SmiError(
'initializer should be ObjectIdentity instance, not %r' %
(objectIdentity, ))
self.__args = [objectIdentity, objectSyntax]
self.__state = self.stDirty
def cloneAsName(self, impliedFlag, parentRow, parentIndices):
kind = self.getName()
component = self.getComponent()
if kind == 'internet':
return (1,) + tuple(component.asNumbers())
else:
raise SmiError('unknown NetworkAddress type %r' % (kind,))
def getMibSymbol(self):
"""Returns MIB variable symbolic identification.
Returns
-------
str
MIB module name
str
MIB variable symbolic name
: :py:class:`~pysnmp.proto.rfc1902.ObjectName`
class instance representing MIB variable instance index.
Raises
------
SmiError
If MIB variable conversion has not been performed.
Examples
--------
>>> objectIdentity = ObjectIdentity('1.3.6.1.2.1.1.1.0')
>>> objectIdentity.resolveWithMib(mibViewController)
>>> objectIdentity.getMibSymbol()
('SNMPv2-MIB', 'sysDescr', (0,))
>>>
"""
if self.__state & self.stClean:
return self.__modName, self.__symName, self.__indices
else:
raise SmiError('%s object not fully initialized' % self.__class__.__name__)
def getTargetParams(snmpEngine, paramsName):
mibInstrumController = snmpEngine.msgAndPduDsp.mibInstrumController
snmpTargetParamsEntry, = mibInstrumController.mibBuilder.importSymbols(
'SNMP-TARGET-MIB', 'snmpTargetParamsEntry'
)
tblIdx = snmpTargetParamsEntry.getInstIdFromIndices(
paramsName
)
((v, snmpTargetParamsMPModel),
(v, snmpTargetParamsSecurityModel),
(v, snmpTargetParamsSecurityName),
(v, snmpTargetParamsSecurityLevel)) = mibInstrumController.readVars(
((snmpTargetParamsEntry.name + (2,) + tblIdx, None),
(snmpTargetParamsEntry.name + (3,) + tblIdx, None),
(snmpTargetParamsEntry.name + (4,) + tblIdx, None),
(snmpTargetParamsEntry.name + (5,) + tblIdx, None))
)
if noSuchInstance.isSameTypeWith(snmpTargetParamsMPModel):
raise SmiError('Parameters %s not configured at SMI' % paramsName)
return ( snmpTargetParamsMPModel,
snmpTargetParamsSecurityModel,
snmpTargetParamsSecurityName,
snmpTargetParamsSecurityLevel )
def __hash__(self):
if self._state & self.ST_CLEAN:
return hash(self._oid)
else:
raise SmiError('%s object not properly '
'initialized' % self.__class__.__name__)
def getLabel(self):
"""Returns symbolic path to this MIB variable.
Meaning a sequence of symbolic identifications for each of parent
MIB objects in MIB tree.
Returns
-------
tuple
sequence of names of nodes in a MIB tree from the top of the tree
towards this MIB variable.
Raises
------
SmiError
If MIB variable conversion has not been performed.
Notes
-----
Returned sequence may not contain full path to this MIB variable
if some symbols are now known at the moment of MIB look up.
Examples
--------
>>> objectIdentity = ObjectIdentity('SNMPv2-MIB', 'sysDescr', 0)
>>> objectIdentity.resolveWithMib(mibViewController)
>>> objectIdentity.getOid()
('iso', 'org', 'dod', 'internet', 'mgmt', 'mib-2', 'system', 'sysDescr')
>>>
"""
if self.__state & self.stClean:
return self.__label
else:
raise SmiError('%s object not fully initialized' % self.__class__.__name__)
def __getitem__(self, i):
if self._state & self.ST_CLEAM:
return self._args[i]
else:
raise SmiError('%s object not fully initialized' %
self.__class__.__name__)
def __getitem__(self, i):
if self._state & self.ST_CLEAN:
return self._oid[i]
else:
raise SmiError('%s object not properly '
'initialized' % self.__class__.__name__)
def __radd__(self, other):
if self._state & self.ST_CLEAN:
return other + self._oid
else:
raise SmiError('%s object not properly '
'initialized' % self.__class__.__name__)
def addVarBinds(self, *varBinds):
"""Appends variable-binding to notification.
Parameters
----------
*varBinds : :py:class:`~pysnmp.smi.rfc1902.ObjectType`
One or more :py:class:`~pysnmp.smi.rfc1902.ObjectType` class
instances.
Returns
-------
: :py:class:`~pysnmp.smi.rfc1902.NotificationType`
reference to itself
Notes
-----
This method can be used to add custom variable-bindings to
notification message in addition to MIB variables specified
in NOTIFICATION-TYPE->OBJECTS clause.
Examples
--------
>>> nt = NotificationType(ObjectIdentity('IP-MIB', 'linkDown'))
>>> nt.addVarBinds(ObjectType(ObjectIdentity('SNMPv2-MIB', 'sysDescr', 0)))
NotificationType(ObjectIdentity('IP-MIB', 'linkDown'), (), {})
>>>
"""
debug.logger & debug.flagMIB and debug.logger('additional var-binds: %r' % (varBinds,))
if self.__state & self.stClean:
raise SmiError('%s object is already sealed' % self.__class__.__name__)
else:
self.__additionalVarBinds.extend(varBinds)
return self
def getMibNode(self):
if self._state & self.ST_CLEAN:
return self._mibNode
else:
raise SmiError('%s object not fully initialized' %
self.__class__.__name__)
def getOid(self):
"""Returns OID identifying MIB variable.
Returns
-------
: :py:class:`~pysnmp.proto.rfc1902.ObjectName`
full OID identifying MIB variable including possible index part.
Raises
------
SmiError
If MIB variable conversion has not been performed.
Examples
--------
>>> objectIdentity = ObjectIdentity('SNMPv2-MIB', 'sysDescr', 0)
>>> objectIdentity.resolveWithMib(mibViewController)
>>> objectIdentity.getOid()
ObjectName('1.3.6.1.2.1.1.1.0')
>>>
"""
if self.__state & self.stClean:
return self.__oid
else:
raise SmiError('%s object not fully initialized' % self.__class__.__name__)
def prettyPrint(self):
if self.__state & self.stClean:
return '%s = %s' % (self.__args[0].prettyPrint(),
self.__args[1].prettyPrint())
else:
raise SmiError('%s object not fully initialized' %
self.__class__.__name__)
def cloneFromName(self, value, impliedFlag, parentRow, parentIndices):
kind = value[0]
clone = self.clone()
if kind == 1:
clone['internet'] = tuple(value[1:5])
return clone, value[5:]
else:
raise SmiError('unknown NetworkAddress type %r' % (kind,))
def prettyPrint(self):
if self.__state & self.stClean:
return '%s::%s%s%s' % (
self.__modName, self.__symName, self.__indices and '.' or '',
'.'.join(['"%s"' % x.prettyPrint() for x in self.__indices]))
else:
raise SmiError('%s object not fully initialized' %
self.__class__.__name__)
def prettyPrint(self):
if self._state & self.ST_CLEAN:
return ' '.join('%s = %s' %
(x[0].prettyPrint(), x[1].prettyPrint())
for x in self._varBinds)
raise SmiError('%s object not fully initialized' %
self.__class__.__name__)
def prettyPrint(self):
if self.__state & self.stClean:
return ' '.join([
'%s = %s' % (x[0].prettyPrint(), x[1].prettyPrint())
for x in self.__varBinds
])
else:
raise SmiError('%s object not fully initialized' %
self.__class__.__name__)
def __init__(self, objectIdentity, instanceIndex=(), objects={}):
if not isinstance(objectIdentity, ObjectIdentity):
raise SmiError('initializer should be ObjectIdentity instance, not %r' % (objectIdentity,))
self.__objectIdentity = objectIdentity
self.__instanceIndex = instanceIndex
self.__objects = objects
self.__varBinds = []
self.__additionalVarBinds = []
self.__state = self.stDirty
def __getattr__(self, attr):
if self.__state & self.stClean:
if attr in ('asTuple', 'clone', 'subtype', 'isPrefixOf',
'isSameTypeWith', 'isSuperTypeOf', 'getTagSet',
'getEffectiveTagSet', 'getTagMap', 'tagSet', 'index'):
return getattr(self.__oid, attr)
raise AttributeError(attr)
else:
raise SmiError('%s object not properly initialized for accessing %s' % (self.__class__.__name__, attr))
def getTargetParams(snmpEngine, paramsName):
mibBuilder = snmpEngine.msgAndPduDsp.mibInstrumController.mibBuilder
snmpTargetParamsEntry, = mibBuilder.importSymbols(
'SNMP-TARGET-MIB', 'snmpTargetParamsEntry'
)
cache = snmpEngine.getUserContext('getTargetParams')
if cache is None:
cache = {'id': -1}
snmpEngine.setUserContext(getTargetParams=cache)
if cache['id'] != snmpTargetParamsEntry.branchVersionId:
cache['nameToParamsMap'] = {}
nameToParamsMap = cache['nameToParamsMap']
if paramsName not in nameToParamsMap:
(snmpTargetParamsMPModel, snmpTargetParamsSecurityModel,
snmpTargetParamsSecurityName,
snmpTargetParamsSecurityLevel) = mibBuilder.importSymbols(
'SNMP-TARGET-MIB', 'snmpTargetParamsMPModel',
'snmpTargetParamsSecurityModel', 'snmpTargetParamsSecurityName',
'snmpTargetParamsSecurityLevel'
)
tblIdx = snmpTargetParamsEntry.getInstIdFromIndices(paramsName)
try:
snmpTargetParamsMPModel = snmpTargetParamsMPModel.getNode(
snmpTargetParamsMPModel.name + tblIdx
).syntax
snmpTargetParamsSecurityModel = snmpTargetParamsSecurityModel.getNode(
snmpTargetParamsSecurityModel.name + tblIdx
).syntax
snmpTargetParamsSecurityName = snmpTargetParamsSecurityName.getNode(
snmpTargetParamsSecurityName.name + tblIdx
).syntax
snmpTargetParamsSecurityLevel = snmpTargetParamsSecurityLevel.getNode(
snmpTargetParamsSecurityLevel.name + tblIdx
).syntax
except NoSuchInstanceError:
raise SmiError('Parameters %s not configured at LCD' % paramsName)
nameToParamsMap[paramsName] = (snmpTargetParamsMPModel,
snmpTargetParamsSecurityModel,
snmpTargetParamsSecurityName,
snmpTargetParamsSecurityLevel)
cache['id'] = snmpTargetParamsEntry.branchVersionId
return nameToParamsMap[paramsName]
def prettyPrint(self):
if self.__state & self.stClean:
s = rfc1902.OctetString()
return '%s::%s%s%s' % (
self.__modName, self.__symName,
self.__indices and '.' or '',
'.'.join([x.isSuperTypeOf(s) and '"%s"' % x.prettyPrint() or x.prettyPrint() for x in self.__indices])
)
else:
raise SmiError('%s object not fully initialized' % self.__class__.__name__)
def getTargetNames(snmpEngine, tag):
mibBuilder = snmpEngine.msgAndPduDsp.mibInstrumController.mibBuilder
snmpTargetAddrEntry, = mibBuilder.importSymbols(
'SNMP-TARGET-MIB', 'snmpTargetAddrEntry')
cache = snmpEngine.getUserContext('getTargetNames')
if cache is None:
cache = {'id': -1}
snmpEngine.setUserContext(getTargetNames=cache)
if cache['id'] == snmpTargetAddrEntry.branchVersionId:
tagToTargetsMap = cache['tagToTargetsMap']
else:
cache['tagToTargetsMap'] = {}
tagToTargetsMap = cache['tagToTargetsMap']
(SnmpTagValue, snmpTargetAddrName,
snmpTargetAddrTagList) = mibBuilder.importSymbols(
'SNMP-TARGET-MIB', 'SnmpTagValue', 'snmpTargetAddrName',
'snmpTargetAddrTagList'
)
mibNode = snmpTargetAddrTagList
while True:
try:
mibNode = snmpTargetAddrTagList.getNextNode(mibNode.name)
except NoSuchInstanceError:
break
idx = mibNode.name[len(snmpTargetAddrTagList.name):]
_snmpTargetAddrName = snmpTargetAddrName.getNode(snmpTargetAddrName.name + idx).syntax
for _tag in mibNode.syntax.asOctets().split():
_tag = SnmpTagValue(_tag)
if _tag not in tagToTargetsMap:
tagToTargetsMap[_tag] = []
tagToTargetsMap[_tag].append(_snmpTargetAddrName)
cache['id'] = snmpTargetAddrEntry.branchVersionId
if tag not in tagToTargetsMap:
raise SmiError('Transport tag %s not configured at LCD' % tag)
return tagToTargetsMap[tag]
def prettyPrint(self):
if self._state & self.ST_CLEAN:
s = rfc1902.OctetString()
return '%s::%s%s%s' % (
self._modName, self._symName, self._indices and '.'
or '', '.'.join(
(x.isSuperTypeOf(s, matchConstraints=False) and '"%s"' %
x.prettyPrint() or x.prettyPrint())
for x in self._indices))
else:
raise SmiError('%s object not fully initialized' %
self.__class__.__name__)
def getNotificationInfo(snmpEngine, notificationTarget):
mibBuilder = snmpEngine.msgAndPduDsp.mibInstrumController.mibBuilder
snmpNotifyEntry, = mibBuilder.importSymbols('SNMP-NOTIFICATION-MIB',
'snmpNotifyEntry')
cache = snmpEngine.getUserContext('getNotificationInfo')
if cache is None:
cache = {'id': -1}
snmpEngine.setUserContext(getNotificationInfo=cache)
if cache['id'] != snmpNotifyEntry.branchVersionId:
cache['targetToNotifyMap'] = {}
targetToNotifyMap = cache['targetToNotifyMap']
if notificationTarget not in targetToNotifyMap:
(snmpNotifyTag,
snmpNotifyType) = mibBuilder.importSymbols('SNMP-NOTIFICATION-MIB',
'snmpNotifyTag',
'snmpNotifyType')
tblIdx = snmpNotifyEntry.getInstIdFromIndices(notificationTarget)
try:
snmpNotifyTag = snmpNotifyTag.getNode(
snmpNotifyTag.name + tblIdx
).syntax
snmpNotifyType = snmpNotifyType.getNode(
snmpNotifyType.name + tblIdx
).syntax
except NoSuchInstanceError:
raise SmiError('Target %s not configured at LCD' % notificationTarget)
targetToNotifyMap[notificationTarget] = (
snmpNotifyTag,
snmpNotifyType
)
cache['id'] = snmpNotifyEntry.branchVersionId
return targetToNotifyMap[notificationTarget]
def getNotificationInfo(snmpEngine, notificationTarget):
mibInstrumController = snmpEngine.msgAndPduDsp.mibInstrumController
# Transport endpoint
snmpNotifyEntry, = mibInstrumController.mibBuilder.importSymbols(
'SNMP-NOTIFICATION-MIB', 'snmpNotifyEntry'
)
tblIdx = snmpNotifyEntry.getInstIdFromIndices(
notificationTarget
)
((v, snmpNotifyTag),
(v, snmpNotifyType)) = mibInstrumController.readVars(
((snmpNotifyEntry.name + (2,) + tblIdx, None),
(snmpNotifyEntry.name + (3,) + tblIdx, None))
)
if noSuchInstance.isSameTypeWith(snmpNotifyTag):
raise SmiError('Target %s not configured at SMI' % notificationTarget)
return snmpNotifyTag, snmpNotifyType
def getTargetInfo(snmpEngine, snmpTargetAddrName):
# Transport endpoint
( snmpTargetAddrTDomain,
snmpTargetAddrTAddress,
snmpTargetAddrTimeout,
snmpTargetAddrRetryCount,
snmpTargetAddrParams ) = getTargetAddr(snmpEngine, snmpTargetAddrName)
mibInstrumController = snmpEngine.msgAndPduDsp.mibInstrumController
# Target params
snmpTargetParamsEntry, = mibInstrumController.mibBuilder.importSymbols(
'SNMP-TARGET-MIB', 'snmpTargetParamsEntry'
)
tblIdx = snmpTargetParamsEntry.getInstIdFromIndices(
snmpTargetAddrParams
)
((v, snmpTargetParamsMPModel),
(v, snmpTargetParamsSecurityModel),
(v, snmpTargetParamsSecurityName),
(v, snmpTargetParamsSecurityLevel)) = mibInstrumController.readVars(
((snmpTargetParamsEntry.name + (2,) + tblIdx, None),
(snmpTargetParamsEntry.name + (3,) + tblIdx, None),
(snmpTargetParamsEntry.name + (4,) + tblIdx, None),
(snmpTargetParamsEntry.name + (5,) + tblIdx, None))
)
if noSuchInstance.isSameTypeWith(snmpTargetParamsSecurityName):
raise SmiError('Parameters %s not configured at SMI' % snmpTargetAddrParams)
return ( snmpTargetAddrTDomain,
snmpTargetAddrTAddress,
snmpTargetAddrTimeout,
snmpTargetAddrRetryCount,
snmpTargetParamsMPModel,
snmpTargetParamsSecurityModel,
snmpTargetParamsSecurityName,
snmpTargetParamsSecurityLevel )
def getTargetAddr(snmpEngine, snmpTargetAddrName):
mibInstrumController = snmpEngine.msgAndPduDsp.mibInstrumController
# Transport endpoint
snmpTargetAddrEntry, = mibInstrumController.mibBuilder.importSymbols(
'SNMP-TARGET-MIB', 'snmpTargetAddrEntry'
)
tblIdx = snmpTargetAddrEntry.getInstIdFromIndices(
snmpTargetAddrName
)
((v, snmpTargetAddrTDomain),
(v, snmpTargetAddrTAddress),
(v, snmpTargetAddrTimeout),
(v, snmpTargetAddrRetryCount),
(v, snmpTargetAddrParams)) = mibInstrumController.readVars(
((snmpTargetAddrEntry.name + (2,) + tblIdx, None),
(snmpTargetAddrEntry.name + (3,) + tblIdx, None),
(snmpTargetAddrEntry.name + (4,) + tblIdx, None),
(snmpTargetAddrEntry.name + (5,) + tblIdx, None),
(snmpTargetAddrEntry.name + (7,) + tblIdx, None))
)
if noSuchInstance.isSameTypeWith(snmpTargetAddrParams):
raise SmiError('Target %s not configured at SMI' % snmpTargetAddrName)
if snmpTargetAddrTDomain == config.snmpUDPDomain:
SnmpUDPAddress, = snmpEngine.msgAndPduDsp.mibInstrumController.mibBuilder.importSymbols('SNMPv2-TM', 'SnmpUDPAddress')
snmpTargetAddrTAddress = tuple(
SnmpUDPAddress(snmpTargetAddrTAddress)
)
return ( snmpTargetAddrTDomain,
snmpTargetAddrTAddress,
snmpTargetAddrTimeout,
snmpTargetAddrRetryCount,
snmpTargetAddrParams )
def __getitem__(self, i):
if self.__state & self.stClean:
return self.__varBinds[i]
else:
raise SmiError('%s object not fully initialized' % self.__class__.__name__)
def __hash__(self):
if self.__state & self.stClean:
return hash(self.__oid)
else:
raise SmiError('%s object not properly initialized' % self.__class__.__name__)
def resolveWithMib(self, mibViewController):
"""Perform MIB variable ID and associated value conversion.
Parameters
----------
mibViewController : :py:class:`~pysnmp.smi.view.MibViewController`
class instance representing MIB browsing functionality.
Returns
-------
: :py:class:`~pysnmp.smi.rfc1902.ObjectType`
reference to itself
Raises
------
SmiError
In case of fatal MIB hanling errora
Notes
-----
Calling this method involves
:py:meth:`~pysnmp.smi.rfc1902.ObjectIdentity.resolveWithMib`
method invocation.
Examples
--------
>>> objectType = ObjectType(ObjectIdentity('SNMPv2-MIB', 'sysDescr'), 'Linux i386')
>>> objectType.resolveWithMib(mibViewController)
ObjectType(ObjectIdentity('SNMPv2-MIB', 'sysDescr'), DisplayString('Linux i386'))
>>> str(objectType)
'SNMPv2-MIB::sysDescr."0" = Linux i386'
>>>
"""
if self.__state & self.stClean:
return self
self.__args[0].resolveWithMib(mibViewController)
MibScalar, MibTableColumn = mibViewController.mibBuilder.importSymbols('SNMPv2-SMI', 'MibScalar',
'MibTableColumn')
if not isinstance(self.__args[0].getMibNode(),
(MibScalar, MibTableColumn)):
if not isinstance(self.__args[1], AbstractSimpleAsn1Item):
raise SmiError('MIB object %r is not OBJECT-TYPE (MIB not loaded?)' % (self.__args[0],))
self.__state |= self.stClean
return self
if isinstance(self.__args[1], (rfc1905.UnSpecified,
rfc1905.NoSuchObject,
rfc1905.NoSuchInstance,
rfc1905.EndOfMibView)):
self.__state |= self.stClean
return self
try:
self.__args[1] = self.__args[0].getMibNode().getSyntax().clone(self.__args[1])
except PyAsn1Error:
raise SmiError('MIB object %r having type %r failed to cast value %r: %s' % (
self.__args[0].prettyPrint(), self.__args[0].getMibNode().getSyntax().__class__.__name__, self.__args[1],
sys.exc_info()[1]))
if self.__args[1].isSuperTypeOf(rfc1902.ObjectIdentifier()):
self.__args[1] = ObjectIdentity(self.__args[1]).resolveWithMib(mibViewController)
self.__state |= self.stClean
debug.logger & debug.flagMIB and debug.logger('resolved %r syntax is %r' % (self.__args[0], self.__args[1]))
return self
