pysnmp.proto.rfc1155
index
/home/mcfletch/pylive/pysnmp/proto/rfc1155.py

Implementation of data types defined by SNMP SMI (RFC1155RFC1212)
 
Copyright 1999-2002 by Ilya Etingof <ilya@glas.net>. See LICENSE for
details.

 
Modules
       
pysnmp.asn1.constraints
pysnmp.proto.error
pysnmp
pysnmp.asn1.univ

 
Classes
       
Choice(ChoiceTypeAsn1Object, ChoiceMixIn)
Choice(ChoiceMixIn, ProtoVersionId1MixIn, Choice)
ApplicationSyntax(ProtoVersionId1MixIn, Choice)
NetworkAddress(ProtoVersionId1MixIn, Choice)
ObjectSyntax(ProtoVersionId1MixIn, Choice)
SimpleSyntax(ProtoVersionId1MixIn, Choice)
Integer(SimpleAsn1Object, IntegerMixIn)
Counter(ProtoVersionId1MixIn, Integer)
Gauge(ProtoVersionId1MixIn, Integer)
Integer(ProtoVersionId1MixIn, Integer)
TimeTicks(ProtoVersionId1MixIn, Integer)
Null(SimpleAsn1Object, NullMixIn)
Null(ProtoVersionId1MixIn, Null)
ObjectIdentifier(SimpleAsn1Object, ObjectIdentifierMixIn)
ObjectIdentifier(ProtoVersionId1MixIn, ObjectIdentifier)
ObjectName(ProtoVersionId1MixIn, ObjectIdentifier)
OctetString(SimpleAsn1Object, OctetStringMixIn)
IpAddress(ProtoVersionId1MixIn, OctetString)
OctetString(ProtoVersionId1MixIn, OctetString)
Opaque(ProtoVersionId1MixIn, OctetString)
Sequence(RecordTypeAsn1Object, SequenceMixIn)
Sequence(SequenceMixIn, ProtoVersionId1MixIn, Sequence)
SequenceOf(VariableTypeAsn1Object, SequenceOfMixIn)
SequenceOf(ProtoVersionId1MixIn, SequenceOf)
ChoiceMixIn
Choice(ChoiceMixIn, ProtoVersionId1MixIn, Choice)
ApplicationSyntax(ProtoVersionId1MixIn, Choice)
NetworkAddress(ProtoVersionId1MixIn, Choice)
ObjectSyntax(ProtoVersionId1MixIn, Choice)
SimpleSyntax(ProtoVersionId1MixIn, Choice)
SequenceMixIn
Sequence(SequenceMixIn, ProtoVersionId1MixIn, Sequence)
ProtoVersionId1MixIn(ProtoVersionIdMixInBase)
ApplicationSyntax(ProtoVersionId1MixIn, Choice)
Choice(ChoiceMixIn, ProtoVersionId1MixIn, Choice)
ApplicationSyntax(ProtoVersionId1MixIn, Choice)
NetworkAddress(ProtoVersionId1MixIn, Choice)
ObjectSyntax(ProtoVersionId1MixIn, Choice)
SimpleSyntax(ProtoVersionId1MixIn, Choice)
Counter(ProtoVersionId1MixIn, Integer)
Gauge(ProtoVersionId1MixIn, Integer)
Integer(ProtoVersionId1MixIn, Integer)
IpAddress(ProtoVersionId1MixIn, OctetString)
NetworkAddress(ProtoVersionId1MixIn, Choice)
Null(ProtoVersionId1MixIn, Null)
ObjectIdentifier(ProtoVersionId1MixIn, ObjectIdentifier)
ObjectName(ProtoVersionId1MixIn, ObjectIdentifier)
ObjectName(ProtoVersionId1MixIn, ObjectIdentifier)
ObjectSyntax(ProtoVersionId1MixIn, Choice)
OctetString(ProtoVersionId1MixIn, OctetString)
Opaque(ProtoVersionId1MixIn, OctetString)
Sequence(SequenceMixIn, ProtoVersionId1MixIn, Sequence)
SequenceOf(ProtoVersionId1MixIn, SequenceOf)
SimpleSyntax(ProtoVersionId1MixIn, Choice)
TimeTicks(ProtoVersionId1MixIn, Integer)

 
class ApplicationSyntax(ProtoVersionId1MixIn, Choice)
    Constructed objects
 
 
Method resolution order:
ApplicationSyntax
ProtoVersionId1MixIn
ProtoVersionIdMixInBase
Choice
ChoiceMixIn
Choice
ChoiceTypeAsn1Object
FixedTypeAsn1Object
StructuredAsn1Object
Asn1Object
ChoiceMixIn
SingleFixedTypeAsn1Object
FixedTypeAsn1Object
StructuredAsn1Object
SimpleAsn1Object
BerObject

Data and other attributes defined here:
choiceComponents = [<class pysnmp.proto.rfc1155.NetworkAddress>, <class pysnmp.proto.rfc1155.Counter>, <class pysnmp.proto.rfc1155.Gauge>, <class pysnmp.proto.rfc1155.TimeTicks>, <class pysnmp.proto.rfc1155.Opaque>]
choiceNames = ['address', 'counter', 'gauge', 'ticks', 'arbitrary']

Data and other attributes inherited from ProtoVersionId1MixIn:
apiAlphaProtoVersionId = 0

Methods inherited from ProtoVersionIdMixInBase:
apiAlphaGetProtoVersionId(self)

Methods inherited from ChoiceMixIn:
apiAlphaGetCurrentComponent(self)
apiAlphaGetTerminalValue(self)
apiAlphaSetTerminalValue(self, value)
getTerminal = apiAlphaGetTerminalValue(self)

Data and other attributes inherited from Choice:
tagCategory = 4

Methods inherited from ChoiceTypeAsn1Object:
__delitem__(self, key)
Delete component by key
__init__(self, **kwargs)
Store dictionary args
__setitem__(self, key, value)
Set component by key & value
componentFactoryBorrow(self, key)

Data and other attributes inherited from ChoiceTypeAsn1Object:
initialComponent = None

Methods inherited from FixedTypeAsn1Object:
__cmp__(self, other)
Attempt to compare the payload of instances of the same class
__getitem__(self, key)
Return component by key
__hash__(self)
Returns hash of the payload value
__len__(self)
Get length of the object
__repr__(self)
Return native representation of instance payload
__str__(self)
Return string representation of class instance
get(self, key, default=None)
Lookup by key with default
has_key(self, key)
Return true if key exists
items(self)
Return a list of tuples (key, value)
keys(self)
Return a list of keys
update(self, dict)
Merge dict to ourselves
values(self)
Return a list of values

Data and other attributes inherited from StructuredAsn1Object:
tagFormat = 32

Methods inherited from Asn1Object:
getUnderlyingTag(self)

Data and other attributes inherited from Asn1Object:
allowedTypes = ()
constraints = ()
tagClass = 0
tagId = None

Methods inherited from SingleFixedTypeAsn1Object:
berDecode(self, input)
decode = berDecode(self, input)

Methods inherited from FixedTypeAsn1Object:
berEncode(self)
Choose optimised version of berEncode for this class
berEncodeWOutSub(self)
berEncodeWSub() -> octet string
 
For classes which do *not* have a _berEncode only!
 
Note:
    This should be bound by a metaclass on looking
    at the final class, *not* as is done now by
    binding at time-of-use.
berEncodeWSub(self)
berEncodeWSub() -> octet string
 
For classes which *have* a _berEncode only!
 
Note:
    This should be bound by a metaclass on looking
    at the final class, *not* as is done now by
    binding at time-of-use.
encode = berEncode(self)
Choose optimised version of berEncode for this class

Methods inherited from StructuredAsn1Object:
berUnwrapHeader(self, input)
Decode BER header, return (data, rest)
berWrapHeader(self, input)
Add BER header to data chunk if needed

Methods inherited from BerObject:
berDecodeLength(self, input)
berDecodeLength(input) -> (length, size)
 
Return the data item's length (integer) and the size of length
data (integer).
berEncodeLength(self, length)
berEncodeLength(length) -> octet string
 
BER encode ASN.1 data item length (integer).
berEncodeTag(self, (tagClass, tagFormat, tagId)=(None, None, None))
BER encode ASN.1 type tag

 
class Choice(ChoiceMixIn, ProtoVersionId1MixIn, Choice)
    ASN.1 CHOICE clause
 
 
Method resolution order:
Choice
ChoiceMixIn
ProtoVersionId1MixIn
ProtoVersionIdMixInBase
Choice
ChoiceTypeAsn1Object
FixedTypeAsn1Object
StructuredAsn1Object
Asn1Object
ChoiceMixIn
SingleFixedTypeAsn1Object
FixedTypeAsn1Object
StructuredAsn1Object
SimpleAsn1Object
BerObject

Methods inherited from ChoiceMixIn:
apiAlphaGetCurrentComponent(self)
apiAlphaGetTerminalValue(self)
apiAlphaSetTerminalValue(self, value)
getTerminal = apiAlphaGetTerminalValue(self)

Data and other attributes inherited from ProtoVersionId1MixIn:
apiAlphaProtoVersionId = 0

Methods inherited from ProtoVersionIdMixInBase:
apiAlphaGetProtoVersionId(self)

Data and other attributes inherited from Choice:
tagCategory = 4

Methods inherited from ChoiceTypeAsn1Object:
__delitem__(self, key)
Delete component by key
__init__(self, **kwargs)
Store dictionary args
__setitem__(self, key, value)
Set component by key & value
componentFactoryBorrow(self, key)

Data and other attributes inherited from ChoiceTypeAsn1Object:
choiceComponents = []
choiceNames = []
initialComponent = None

Methods inherited from FixedTypeAsn1Object:
__cmp__(self, other)
Attempt to compare the payload of instances of the same class
__getitem__(self, key)
Return component by key
__hash__(self)
Returns hash of the payload value
__len__(self)
Get length of the object
__repr__(self)
Return native representation of instance payload
__str__(self)
Return string representation of class instance
get(self, key, default=None)
Lookup by key with default
has_key(self, key)
Return true if key exists
items(self)
Return a list of tuples (key, value)
keys(self)
Return a list of keys
update(self, dict)
Merge dict to ourselves
values(self)
Return a list of values

Data and other attributes inherited from StructuredAsn1Object:
tagFormat = 32

Methods inherited from Asn1Object:
getUnderlyingTag(self)

Data and other attributes inherited from Asn1Object:
allowedTypes = ()
constraints = ()
tagClass = 0
tagId = None

Methods inherited from SingleFixedTypeAsn1Object:
berDecode(self, input)
decode = berDecode(self, input)

Methods inherited from FixedTypeAsn1Object:
berEncode(self)
Choose optimised version of berEncode for this class
berEncodeWOutSub(self)
berEncodeWSub() -> octet string
 
For classes which do *not* have a _berEncode only!
 
Note:
    This should be bound by a metaclass on looking
    at the final class, *not* as is done now by
    binding at time-of-use.
berEncodeWSub(self)
berEncodeWSub() -> octet string
 
For classes which *have* a _berEncode only!
 
Note:
    This should be bound by a metaclass on looking
    at the final class, *not* as is done now by
    binding at time-of-use.
encode = berEncode(self)
Choose optimised version of berEncode for this class

Methods inherited from StructuredAsn1Object:
berUnwrapHeader(self, input)
Decode BER header, return (data, rest)
berWrapHeader(self, input)
Add BER header to data chunk if needed

Methods inherited from BerObject:
berDecodeLength(self, input)
berDecodeLength(input) -> (length, size)
 
Return the data item's length (integer) and the size of length
data (integer).
berEncodeLength(self, length)
berEncodeLength(length) -> octet string
 
BER encode ASN.1 data item length (integer).
berEncodeTag(self, (tagClass, tagFormat, tagId)=(None, None, None))
BER encode ASN.1 type tag

 
class Counter(ProtoVersionId1MixIn, Integer)
    SNMP Counter object
 
 
Method resolution order:
Counter
ProtoVersionId1MixIn
ProtoVersionIdMixInBase
Integer
SimpleAsn1Object
Asn1Object
IntegerMixIn
SimpleAsn1Object
BerObject

Data and other attributes defined here:
constraints = (<function _ValueRangeConstraint>,)
tagClass = 64
tagId = 1

Data and other attributes inherited from ProtoVersionId1MixIn:
apiAlphaProtoVersionId = 0

Methods inherited from ProtoVersionIdMixInBase:
apiAlphaGetProtoVersionId(self)

Methods inherited from Integer:
__add__(self, value)
Add a value
__and__(self, value)
Perform binary AND operation
__div__(self, value)
Divide a value by ourselves
__float__(self)
Return a floating point value of ourselves
__iadd__(self, value)
Add value to ourselves
__iand__(self, value)
Perform binary AND operation against ourselves
__idiv__(self, value)
Divide a value by ourselves
__ilshift__(self, value)
Perform left shift operation
__imod__(self, value)
Take a modulo of ourselves
__imul__(self, value)
Multiply a value to ourselves
__int__(self)
Return an integer value of ourselves
__ior__(self, value)
Perform binary OR operation against ourselves
__ipow__(self, value, modulo)
Provision for x**=y
__irshift__(self, value)
Perform right shift operation
__isub__(self, value)
Subscract value from ourselves
__ixor__(self, value)
Perform binary XOR operation against ourselves
__long__(self)
Return a long integer value of ourselves
__lshift__(self, value)
Perform left shift operation
__mod__(self, value)
Take a modulo of ourselves
__mul__(self, value)
Multiply a value
__or__(self, value)
Perform binary OR operation
__pow__(self, value, modulo)
Provision for pow()
__radd__ = __add__(self, value)
Add a value
__rand__ = __and__(self, value)
Perform binary AND operation
__rdiv__(self, value)
Divide ourselves by value
__rmod__ = __mod__(self, value)
Take a modulo of ourselves
__rmul__ = __mul__(self, value)
Multiply a value
__ror__ = __or__(self, value)
Perform binary OR operation
__rpow__(self, value, modulo)
Provision for rpow()
__rshift__(self, value)
Perform right shift operation
__rsub__(self, value)
Subscract our value from given one
__rxor__ = __xor__(self, value)
Perform binary XOR operation
__sub__(self, value)
Subscract a value
__xor__(self, value)
Perform binary XOR operation
dec = __isub__(self, value)
Subscract value from ourselves
div = __idiv__(self, value)
Divide a value by ourselves
inc = __iadd__(self, value)
Add value to ourselves
mul = __imul__(self, value)
Multiply a value to ourselves

Data and other attributes inherited from Integer:
allowedTypes = (<type 'int'>, <type 'long'>)
initialValue = 0L

Methods inherited from SimpleAsn1Object:
__cmp__(self, other)
Attempt to compare the payload of instances of the same class
__hash__(self)
Returns hash of the payload value
__init__(self, value=None)
Store ASN.1 value
__nonzero__(self)
Returns true if value is true
__repr__(self)
Return native representation of instance payload
__str__(self)
Return string representation of class instance
componentFactoryBorrow(self, value=None)
get(self)
Get a value from object
getTerminal(self)
set(self, value)
Set a value to object

Data and other attributes inherited from SimpleAsn1Object:
NORMAL_STATIC_TYPES = (<type 'int'>, <type 'long'>, <type 'str'>, <type 'NoneType'>, <type 'float'>, <type 'tuple'>)
tagFormat = 0

Methods inherited from Asn1Object:
getUnderlyingTag(self)

Data and other attributes inherited from Asn1Object:
tagCategory = 1

Methods inherited from SimpleAsn1Object:
berDecode(self, input)
berDecode(input) -> (value, rest)
 
BER decode input (octet string) into ASN1 object payload,
return the rest of input stream.
berEncode(self, value=None)
berEncode() -> octet string
 
BER encode object payload whenever possible
decode = berDecode(self, input)
berDecode(input) -> (value, rest)
 
BER decode input (octet string) into ASN1 object payload,
return the rest of input stream.
encode = berEncode(self, value=None)
berEncode() -> octet string
 
BER encode object payload whenever possible

Methods inherited from BerObject:
berDecodeLength(self, input)
berDecodeLength(input) -> (length, size)
 
Return the data item's length (integer) and the size of length
data (integer).
berEncodeLength(self, length)
berEncodeLength(length) -> octet string
 
BER encode ASN.1 data item length (integer).
berEncodeTag(self, (tagClass, tagFormat, tagId)=(None, None, None))
BER encode ASN.1 type tag

 
class Gauge(ProtoVersionId1MixIn, Integer)
    SNMP Gauge object
 
 
Method resolution order:
Gauge
ProtoVersionId1MixIn
ProtoVersionIdMixInBase
Integer
SimpleAsn1Object
Asn1Object
IntegerMixIn
SimpleAsn1Object
BerObject

Data and other attributes defined here:
constraints = (<function _ValueRangeConstraint>,)
tagClass = 64
tagId = 2

Data and other attributes inherited from ProtoVersionId1MixIn:
apiAlphaProtoVersionId = 0

Methods inherited from ProtoVersionIdMixInBase:
apiAlphaGetProtoVersionId(self)

Methods inherited from Integer:
__add__(self, value)
Add a value
__and__(self, value)
Perform binary AND operation
__div__(self, value)
Divide a value by ourselves
__float__(self)
Return a floating point value of ourselves
__iadd__(self, value)
Add value to ourselves
__iand__(self, value)
Perform binary AND operation against ourselves
__idiv__(self, value)
Divide a value by ourselves
__ilshift__(self, value)
Perform left shift operation
__imod__(self, value)
Take a modulo of ourselves
__imul__(self, value)
Multiply a value to ourselves
__int__(self)
Return an integer value of ourselves
__ior__(self, value)
Perform binary OR operation against ourselves
__ipow__(self, value, modulo)
Provision for x**=y
__irshift__(self, value)
Perform right shift operation
__isub__(self, value)
Subscract value from ourselves
__ixor__(self, value)
Perform binary XOR operation against ourselves
__long__(self)
Return a long integer value of ourselves
__lshift__(self, value)
Perform left shift operation
__mod__(self, value)
Take a modulo of ourselves
__mul__(self, value)
Multiply a value
__or__(self, value)
Perform binary OR operation
__pow__(self, value, modulo)
Provision for pow()
__radd__ = __add__(self, value)
Add a value
__rand__ = __and__(self, value)
Perform binary AND operation
__rdiv__(self, value)
Divide ourselves by value
__rmod__ = __mod__(self, value)
Take a modulo of ourselves
__rmul__ = __mul__(self, value)
Multiply a value
__ror__ = __or__(self, value)
Perform binary OR operation
__rpow__(self, value, modulo)
Provision for rpow()
__rshift__(self, value)
Perform right shift operation
__rsub__(self, value)
Subscract our value from given one
__rxor__ = __xor__(self, value)
Perform binary XOR operation
__sub__(self, value)
Subscract a value
__xor__(self, value)
Perform binary XOR operation
dec = __isub__(self, value)
Subscract value from ourselves
div = __idiv__(self, value)
Divide a value by ourselves
inc = __iadd__(self, value)
Add value to ourselves
mul = __imul__(self, value)
Multiply a value to ourselves

Data and other attributes inherited from Integer:
allowedTypes = (<type 'int'>, <type 'long'>)
initialValue = 0L

Methods inherited from SimpleAsn1Object:
__cmp__(self, other)
Attempt to compare the payload of instances of the same class
__hash__(self)
Returns hash of the payload value
__init__(self, value=None)
Store ASN.1 value
__nonzero__(self)
Returns true if value is true
__repr__(self)
Return native representation of instance payload
__str__(self)
Return string representation of class instance
componentFactoryBorrow(self, value=None)
get(self)
Get a value from object
getTerminal(self)
set(self, value)
Set a value to object

Data and other attributes inherited from SimpleAsn1Object:
NORMAL_STATIC_TYPES = (<type 'int'>, <type 'long'>, <type 'str'>, <type 'NoneType'>, <type 'float'>, <type 'tuple'>)
tagFormat = 0

Methods inherited from Asn1Object:
getUnderlyingTag(self)

Data and other attributes inherited from Asn1Object:
tagCategory = 1

Methods inherited from SimpleAsn1Object:
berDecode(self, input)
berDecode(input) -> (value, rest)
 
BER decode input (octet string) into ASN1 object payload,
return the rest of input stream.
berEncode(self, value=None)
berEncode() -> octet string
 
BER encode object payload whenever possible
decode = berDecode(self, input)
berDecode(input) -> (value, rest)
 
BER decode input (octet string) into ASN1 object payload,
return the rest of input stream.
encode = berEncode(self, value=None)
berEncode() -> octet string
 
BER encode object payload whenever possible

Methods inherited from BerObject:
berDecodeLength(self, input)
berDecodeLength(input) -> (length, size)
 
Return the data item's length (integer) and the size of length
data (integer).
berEncodeLength(self, length)
berEncodeLength(length) -> octet string
 
BER encode ASN.1 data item length (integer).
berEncodeTag(self, (tagClass, tagFormat, tagId)=(None, None, None))
BER encode ASN.1 type tag

 
class Integer(ProtoVersionId1MixIn, Integer)
    SMI INTEGER data type
 
 
Method resolution order:
Integer
ProtoVersionId1MixIn
ProtoVersionIdMixInBase
Integer
SimpleAsn1Object
Asn1Object
IntegerMixIn
SimpleAsn1Object
BerObject

Data and other attributes inherited from ProtoVersionId1MixIn:
apiAlphaProtoVersionId = 0

Methods inherited from ProtoVersionIdMixInBase:
apiAlphaGetProtoVersionId(self)

Methods inherited from Integer:
__add__(self, value)
Add a value
__and__(self, value)
Perform binary AND operation
__div__(self, value)
Divide a value by ourselves
__float__(self)
Return a floating point value of ourselves
__iadd__(self, value)
Add value to ourselves
__iand__(self, value)
Perform binary AND operation against ourselves
__idiv__(self, value)
Divide a value by ourselves
__ilshift__(self, value)
Perform left shift operation
__imod__(self, value)
Take a modulo of ourselves
__imul__(self, value)
Multiply a value to ourselves
__int__(self)
Return an integer value of ourselves
__ior__(self, value)
Perform binary OR operation against ourselves
__ipow__(self, value, modulo)
Provision for x**=y
__irshift__(self, value)
Perform right shift operation
__isub__(self, value)
Subscract value from ourselves
__ixor__(self, value)
Perform binary XOR operation against ourselves
__long__(self)
Return a long integer value of ourselves
__lshift__(self, value)
Perform left shift operation
__mod__(self, value)
Take a modulo of ourselves
__mul__(self, value)
Multiply a value
__or__(self, value)
Perform binary OR operation
__pow__(self, value, modulo)
Provision for pow()
__radd__ = __add__(self, value)
Add a value
__rand__ = __and__(self, value)
Perform binary AND operation
__rdiv__(self, value)
Divide ourselves by value
__rmod__ = __mod__(self, value)
Take a modulo of ourselves
__rmul__ = __mul__(self, value)
Multiply a value
__ror__ = __or__(self, value)
Perform binary OR operation
__rpow__(self, value, modulo)
Provision for rpow()
__rshift__(self, value)
Perform right shift operation
__rsub__(self, value)
Subscract our value from given one
__rxor__ = __xor__(self, value)
Perform binary XOR operation
__sub__(self, value)
Subscract a value
__xor__(self, value)
Perform binary XOR operation
dec = __isub__(self, value)
Subscract value from ourselves
div = __idiv__(self, value)
Divide a value by ourselves
inc = __iadd__(self, value)
Add value to ourselves
mul = __imul__(self, value)
Multiply a value to ourselves

Data and other attributes inherited from Integer:
allowedTypes = (<type 'int'>, <type 'long'>)
initialValue = 0L
tagId = 2

Methods inherited from SimpleAsn1Object:
__cmp__(self, other)
Attempt to compare the payload of instances of the same class
__hash__(self)
Returns hash of the payload value
__init__(self, value=None)
Store ASN.1 value
__nonzero__(self)
Returns true if value is true
__repr__(self)
Return native representation of instance payload
__str__(self)
Return string representation of class instance
componentFactoryBorrow(self, value=None)
get(self)
Get a value from object
getTerminal(self)
set(self, value)
Set a value to object

Data and other attributes inherited from SimpleAsn1Object:
NORMAL_STATIC_TYPES = (<type 'int'>, <type 'long'>, <type 'str'>, <type 'NoneType'>, <type 'float'>, <type 'tuple'>)
tagFormat = 0

Methods inherited from Asn1Object:
getUnderlyingTag(self)

Data and other attributes inherited from Asn1Object:
constraints = ()
tagCategory = 1
tagClass = 0

Methods inherited from SimpleAsn1Object:
berDecode(self, input)
berDecode(input) -> (value, rest)
 
BER decode input (octet string) into ASN1 object payload,
return the rest of input stream.
berEncode(self, value=None)
berEncode() -> octet string
 
BER encode object payload whenever possible
decode = berDecode(self, input)
berDecode(input) -> (value, rest)
 
BER decode input (octet string) into ASN1 object payload,
return the rest of input stream.
encode = berEncode(self, value=None)
berEncode() -> octet string
 
BER encode object payload whenever possible

Methods inherited from BerObject:
berDecodeLength(self, input)
berDecodeLength(input) -> (length, size)
 
Return the data item's length (integer) and the size of length
data (integer).
berEncodeLength(self, length)
berEncodeLength(length) -> octet string
 
BER encode ASN.1 data item length (integer).
berEncodeTag(self, (tagClass, tagFormat, tagId)=(None, None, None))
BER encode ASN.1 type tag

 
class IpAddress(ProtoVersionId1MixIn, OctetString)
    SNMP IP address object (taken and returned as string in conventional
"dotted" representation)
 
 
Method resolution order:
IpAddress
ProtoVersionId1MixIn
ProtoVersionIdMixInBase
OctetString
SimpleAsn1Object
Asn1Object
OctetStringMixIn
SimpleAsn1Object
BerObject

Data and other attributes defined here:
constraints = (<function _ValueSizeConstraint>,)
initialValue = '0.0.0.0'
tagClass = 64
tagId = 0

Data and other attributes inherited from ProtoVersionId1MixIn:
apiAlphaProtoVersionId = 0

Methods inherited from ProtoVersionIdMixInBase:
apiAlphaGetProtoVersionId(self)

Methods inherited from OctetString:
__add__(self, other)
Add sub-id  with input verification
__getitem__(self, i)
Get string component by index or slice
__len__(self)
__mul__(self, value)
Multiply a value
__radd__(self, other)
Add sub-id  with input verification
__rmul__ = __mul__(self, value)
Multiply a value

Data and other attributes inherited from OctetString:
allowedTypes = (<type 'str'>,)

Methods inherited from SimpleAsn1Object:
__cmp__(self, other)
Attempt to compare the payload of instances of the same class
__hash__(self)
Returns hash of the payload value
__init__(self, value=None)
Store ASN.1 value
__nonzero__(self)
Returns true if value is true
__repr__(self)
Return native representation of instance payload
__str__(self)
Return string representation of class instance
componentFactoryBorrow(self, value=None)
get(self)
Get a value from object
getTerminal(self)
set(self, value)
Set a value to object

Data and other attributes inherited from SimpleAsn1Object:
NORMAL_STATIC_TYPES = (<type 'int'>, <type 'long'>, <type 'str'>, <type 'NoneType'>, <type 'float'>, <type 'tuple'>)
tagFormat = 0

Methods inherited from Asn1Object:
getUnderlyingTag(self)

Data and other attributes inherited from Asn1Object:
tagCategory = 1

Methods inherited from SimpleAsn1Object:
berDecode(self, input)
berDecode(input) -> (value, rest)
 
BER decode input (octet string) into ASN1 object payload,
return the rest of input stream.
berEncode(self, value=None)
berEncode() -> octet string
 
BER encode object payload whenever possible
decode = berDecode(self, input)
berDecode(input) -> (value, rest)
 
BER decode input (octet string) into ASN1 object payload,
return the rest of input stream.
encode = berEncode(self, value=None)
berEncode() -> octet string
 
BER encode object payload whenever possible

Methods inherited from BerObject:
berDecodeLength(self, input)
berDecodeLength(input) -> (length, size)
 
Return the data item's length (integer) and the size of length
data (integer).
berEncodeLength(self, length)
berEncodeLength(length) -> octet string
 
BER encode ASN.1 data item length (integer).
berEncodeTag(self, (tagClass, tagFormat, tagId)=(None, None, None))
BER encode ASN.1 type tag

 
class NetworkAddress(ProtoVersionId1MixIn, Choice)
    SMI NetworkAddress
 
 
Method resolution order:
NetworkAddress
ProtoVersionId1MixIn
ProtoVersionIdMixInBase
Choice
ChoiceMixIn
Choice
ChoiceTypeAsn1Object
FixedTypeAsn1Object
StructuredAsn1Object
Asn1Object
ChoiceMixIn
SingleFixedTypeAsn1Object
FixedTypeAsn1Object
StructuredAsn1Object
SimpleAsn1Object
BerObject

Data and other attributes defined here:
choiceComponents = [<class pysnmp.proto.rfc1155.IpAddress>]
choiceNames = ['internet']
initialComponent = <class pysnmp.proto.rfc1155.IpAddress>
SNMP IP address object (taken and returned as string in conventional
"dotted" representation)

Data and other attributes inherited from ProtoVersionId1MixIn:
apiAlphaProtoVersionId = 0

Methods inherited from ProtoVersionIdMixInBase:
apiAlphaGetProtoVersionId(self)

Methods inherited from ChoiceMixIn:
apiAlphaGetCurrentComponent(self)
apiAlphaGetTerminalValue(self)
apiAlphaSetTerminalValue(self, value)
getTerminal = apiAlphaGetTerminalValue(self)

Data and other attributes inherited from Choice:
tagCategory = 4

Methods inherited from ChoiceTypeAsn1Object:
__delitem__(self, key)
Delete component by key
__init__(self, **kwargs)
Store dictionary args
__setitem__(self, key, value)
Set component by key & value
componentFactoryBorrow(self, key)

Methods inherited from FixedTypeAsn1Object:
__cmp__(self, other)
Attempt to compare the payload of instances of the same class
__getitem__(self, key)
Return component by key
__hash__(self)
Returns hash of the payload value
__len__(self)
Get length of the object
__repr__(self)
Return native representation of instance payload
__str__(self)
Return string representation of class instance
get(self, key, default=None)
Lookup by key with default
has_key(self, key)
Return true if key exists
items(self)
Return a list of tuples (key, value)
keys(self)
Return a list of keys
update(self, dict)
Merge dict to ourselves
values(self)
Return a list of values

Data and other attributes inherited from StructuredAsn1Object:
tagFormat = 32

Methods inherited from Asn1Object:
getUnderlyingTag(self)

Data and other attributes inherited from Asn1Object:
allowedTypes = ()
constraints = ()
tagClass = 0
tagId = None

Methods inherited from SingleFixedTypeAsn1Object:
berDecode(self, input)
decode = berDecode(self, input)

Methods inherited from FixedTypeAsn1Object:
berEncode(self)
Choose optimised version of berEncode for this class
berEncodeWOutSub(self)
berEncodeWSub() -> octet string
 
For classes which do *not* have a _berEncode only!
 
Note:
    This should be bound by a metaclass on looking
    at the final class, *not* as is done now by
    binding at time-of-use.
berEncodeWSub(self)
berEncodeWSub() -> octet string
 
For classes which *have* a _berEncode only!
 
Note:
    This should be bound by a metaclass on looking
    at the final class, *not* as is done now by
    binding at time-of-use.
encode = berEncode(self)
Choose optimised version of berEncode for this class

Methods inherited from StructuredAsn1Object:
berUnwrapHeader(self, input)
Decode BER header, return (data, rest)
berWrapHeader(self, input)
Add BER header to data chunk if needed

Methods inherited from BerObject:
berDecodeLength(self, input)
berDecodeLength(input) -> (length, size)
 
Return the data item's length (integer) and the size of length
data (integer).
berEncodeLength(self, length)
berEncodeLength(length) -> octet string
 
BER encode ASN.1 data item length (integer).
berEncodeTag(self, (tagClass, tagFormat, tagId)=(None, None, None))
BER encode ASN.1 type tag

 
class Null(ProtoVersionId1MixIn, Null)
    SMI NULL data type
 
 
Method resolution order:
Null
ProtoVersionId1MixIn
ProtoVersionIdMixInBase
Null
SimpleAsn1Object
Asn1Object
NullMixIn
SimpleAsn1Object
BerObject

Data and other attributes inherited from ProtoVersionId1MixIn:
apiAlphaProtoVersionId = 0

Methods inherited from ProtoVersionIdMixInBase:
apiAlphaGetProtoVersionId(self)

Data and other attributes inherited from Null:
allowedTypes = (<type 'int'>, <type 'long'>, <type 'str'>, <type 'NoneType'>)
constraints = (<pysnmp.asn1.constraints.SingleValueConstraint object>,)
initialValue = ''
tagId = 5

Methods inherited from SimpleAsn1Object:
__cmp__(self, other)
Attempt to compare the payload of instances of the same class
__hash__(self)
Returns hash of the payload value
__init__(self, value=None)
Store ASN.1 value
__nonzero__(self)
Returns true if value is true
__repr__(self)
Return native representation of instance payload
__str__(self)
Return string representation of class instance
componentFactoryBorrow(self, value=None)
get(self)
Get a value from object
getTerminal(self)
set(self, value)
Set a value to object

Data and other attributes inherited from SimpleAsn1Object:
NORMAL_STATIC_TYPES = (<type 'int'>, <type 'long'>, <type 'str'>, <type 'NoneType'>, <type 'float'>, <type 'tuple'>)
tagFormat = 0

Methods inherited from Asn1Object:
getUnderlyingTag(self)

Data and other attributes inherited from Asn1Object:
tagCategory = 1
tagClass = 0

Methods inherited from SimpleAsn1Object:
berDecode(self, input)
berDecode(input) -> (value, rest)
 
BER decode input (octet string) into ASN1 object payload,
return the rest of input stream.
berEncode(self, value=None)
berEncode() -> octet string
 
BER encode object payload whenever possible
decode = berDecode(self, input)
berDecode(input) -> (value, rest)
 
BER decode input (octet string) into ASN1 object payload,
return the rest of input stream.
encode = berEncode(self, value=None)
berEncode() -> octet string
 
BER encode object payload whenever possible

Methods inherited from BerObject:
berDecodeLength(self, input)
berDecodeLength(input) -> (length, size)
 
Return the data item's length (integer) and the size of length
data (integer).
berEncodeLength(self, length)
berEncodeLength(length) -> octet string
 
BER encode ASN.1 data item length (integer).
berEncodeTag(self, (tagClass, tagFormat, tagId)=(None, None, None))
BER encode ASN.1 type tag

 
class ObjectIdentifier(ProtoVersionId1MixIn, ObjectIdentifier)
    SMI OBJECTIDENTIFIER data type
 
 
Method resolution order:
ObjectIdentifier
ProtoVersionId1MixIn
ProtoVersionIdMixInBase
ObjectIdentifier
SimpleAsn1Object
Asn1Object
ObjectIdentifierMixIn
SimpleAsn1Object
BerObject

Data and other attributes inherited from ProtoVersionId1MixIn:
apiAlphaProtoVersionId = 0

Methods inherited from ProtoVersionIdMixInBase:
apiAlphaGetProtoVersionId(self)

Methods inherited from ObjectIdentifier:
__add__(self, other)
Add sub-id  with input verification
__delitem__(self, i)
Delete sequence component by index or slice
__getitem__(self, i)
Get sequence component by index or slice
__init__(self, value=None)
__len__(self)
__radd__(self, other)
Add sub-id  with input verification
__setitem__(self, i, item)
Set sub-id by index or slice with input verification
append(self, item)
Append sub-id with input verification
attachNode(self, newNode, newOid=None, idx=None)
Attach a new OID node to OIDs tree
extend(self, item)
Append an oid with input verification
index(self, suboid)
Returns index of first occurrence of given sub-identifier
initChildNodes(self)
Initialize possible children
isaprefix(self, other)
isaprefix(other) -> boolean
 
Compare our own OID with the other one (given as a string),
return non-None if ours is a prefix of the other OID.
 
This is intended to be used for MIB tables retrieval.
match(self, subOids, offset=None)
Compare OIDs by numeric or alias values
resolveKeyOid(self, arg)
searchNode(self, oid, idx=None)
Search the tree of OIDs by name
str2num(self, symbolicOid, aliases=None)
str2num(symbolicOid) -> numericOid
 
Convert symbolic Object ID presented in a dotted form into a
numeric Object ID  represented as a list of numeric sub-ID's.
strNode(self, level=0)
Pretty print OID tree

Data and other attributes inherited from ObjectIdentifier:
allowedTypes = (<type 'str'>, <type 'list'>)
initialChildren = []
initialValue = []
tagId = 6

Methods inherited from SimpleAsn1Object:
__cmp__(self, other)
Attempt to compare the payload of instances of the same class
__hash__(self)
Returns hash of the payload value
__nonzero__(self)
Returns true if value is true
__repr__(self)
Return native representation of instance payload
__str__(self)
Return string representation of class instance
componentFactoryBorrow(self, value=None)
get(self)
Get a value from object
getTerminal(self)
set(self, value)
Set a value to object

Data and other attributes inherited from SimpleAsn1Object:
NORMAL_STATIC_TYPES = (<type 'int'>, <type 'long'>, <type 'str'>, <type 'NoneType'>, <type 'float'>, <type 'tuple'>)
tagFormat = 0

Methods inherited from Asn1Object:
getUnderlyingTag(self)

Data and other attributes inherited from Asn1Object:
constraints = ()
tagCategory = 1
tagClass = 0

Class methods inherited from ObjectIdentifierMixIn:
berInternEncoding(cls, oid) from __builtin__.classobj
Given an OID value, cache the BER encoded values for reference

Data and other attributes inherited from ObjectIdentifierMixIn:
BER_BACKWARD_CACHE = {}
BER_FORWARD_CACHE = {}

Methods inherited from SimpleAsn1Object:
berDecode(self, input)
berDecode(input) -> (value, rest)
 
BER decode input (octet string) into ASN1 object payload,
return the rest of input stream.
berEncode(self, value=None)
berEncode() -> octet string
 
BER encode object payload whenever possible
decode = berDecode(self, input)
berDecode(input) -> (value, rest)
 
BER decode input (octet string) into ASN1 object payload,
return the rest of input stream.
encode = berEncode(self, value=None)
berEncode() -> octet string
 
BER encode object payload whenever possible

Methods inherited from BerObject:
berDecodeLength(self, input)
berDecodeLength(input) -> (length, size)
 
Return the data item's length (integer) and the size of length
data (integer).
berEncodeLength(self, length)
berEncodeLength(length) -> octet string
 
BER encode ASN.1 data item length (integer).
berEncodeTag(self, (tagClass, tagFormat, tagId)=(None, None, None))
BER encode ASN.1 type tag

 
class ObjectName(ProtoVersionId1MixIn, ObjectIdentifier)
    Names of objects in MIB
 
 
Method resolution order:
ObjectName
ProtoVersionId1MixIn
ProtoVersionIdMixInBase
ObjectIdentifier
ObjectIdentifier
SimpleAsn1Object
Asn1Object
ObjectIdentifierMixIn
SimpleAsn1Object
BerObject

Data and other attributes inherited from ProtoVersionId1MixIn:
apiAlphaProtoVersionId = 0

Methods inherited from ProtoVersionIdMixInBase:
apiAlphaGetProtoVersionId(self)

Methods inherited from ObjectIdentifier:
__add__(self, other)
Add sub-id  with input verification
__delitem__(self, i)
Delete sequence component by index or slice
__getitem__(self, i)
Get sequence component by index or slice
__init__(self, value=None)
__len__(self)
__radd__(self, other)
Add sub-id  with input verification
__setitem__(self, i, item)
Set sub-id by index or slice with input verification
append(self, item)
Append sub-id with input verification
attachNode(self, newNode, newOid=None, idx=None)
Attach a new OID node to OIDs tree
extend(self, item)
Append an oid with input verification
index(self, suboid)
Returns index of first occurrence of given sub-identifier
initChildNodes(self)
Initialize possible children
isaprefix(self, other)
isaprefix(other) -> boolean
 
Compare our own OID with the other one (given as a string),
return non-None if ours is a prefix of the other OID.
 
This is intended to be used for MIB tables retrieval.
match(self, subOids, offset=None)
Compare OIDs by numeric or alias values
resolveKeyOid(self, arg)
searchNode(self, oid, idx=None)
Search the tree of OIDs by name
str2num(self, symbolicOid, aliases=None)
str2num(symbolicOid) -> numericOid
 
Convert symbolic Object ID presented in a dotted form into a
numeric Object ID  represented as a list of numeric sub-ID's.
strNode(self, level=0)
Pretty print OID tree

Data and other attributes inherited from ObjectIdentifier:
allowedTypes = (<type 'str'>, <type 'list'>)
initialChildren = []
initialValue = []
tagId = 6

Methods inherited from SimpleAsn1Object:
__cmp__(self, other)
Attempt to compare the payload of instances of the same class
__hash__(self)
Returns hash of the payload value
__nonzero__(self)
Returns true if value is true
__repr__(self)
Return native representation of instance payload
__str__(self)
Return string representation of class instance
componentFactoryBorrow(self, value=None)
get(self)
Get a value from object
getTerminal(self)
set(self, value)
Set a value to object

Data and other attributes inherited from SimpleAsn1Object:
NORMAL_STATIC_TYPES = (<type 'int'>, <type 'long'>, <type 'str'>, <type 'NoneType'>, <type 'float'>, <type 'tuple'>)
tagFormat = 0

Methods inherited from Asn1Object:
getUnderlyingTag(self)

Data and other attributes inherited from Asn1Object:
constraints = ()
tagCategory = 1
tagClass = 0

Class methods inherited from ObjectIdentifierMixIn:
berInternEncoding(cls, oid) from __builtin__.classobj
Given an OID value, cache the BER encoded values for reference

Data and other attributes inherited from ObjectIdentifierMixIn:
BER_BACKWARD_CACHE = {}
BER_FORWARD_CACHE = {}

Methods inherited from SimpleAsn1Object:
berDecode(self, input)
berDecode(input) -> (value, rest)
 
BER decode input (octet string) into ASN1 object payload,
return the rest of input stream.
berEncode(self, value=None)
berEncode() -> octet string
 
BER encode object payload whenever possible
decode = berDecode(self, input)
berDecode(input) -> (value, rest)
 
BER decode input (octet string) into ASN1 object payload,
return the rest of input stream.
encode = berEncode(self, value=None)
berEncode() -> octet string
 
BER encode object payload whenever possible

Methods inherited from BerObject:
berDecodeLength(self, input)
berDecodeLength(input) -> (length, size)
 
Return the data item's length (integer) and the size of length
data (integer).
berEncodeLength(self, length)
berEncodeLength(length) -> octet string
 
BER encode ASN.1 data item length (integer).
berEncodeTag(self, (tagClass, tagFormat, tagId)=(None, None, None))
BER encode ASN.1 type tag

 
class ObjectSyntax(ProtoVersionId1MixIn, Choice)
    Syntax of objects in MIB
 
 
Method resolution order:
ObjectSyntax
ProtoVersionId1MixIn
ProtoVersionIdMixInBase
Choice
ChoiceMixIn
Choice
ChoiceTypeAsn1Object
FixedTypeAsn1Object
StructuredAsn1Object
Asn1Object
ChoiceMixIn
SingleFixedTypeAsn1Object
FixedTypeAsn1Object
StructuredAsn1Object
SimpleAsn1Object
BerObject

Data and other attributes defined here:
TableSyntax = <class pysnmp.proto.rfc1155.TableSyntax>
choiceComponents = [<class pysnmp.proto.rfc1155.SimpleSyntax>, <class pysnmp.proto.rfc1155.ApplicationSyntax>, <class pysnmp.proto.rfc1155.TableSyntax>]
choiceNames = ['simple', 'application_wide', 'sequence']
initialComponent = <class pysnmp.proto.rfc1155.SimpleSyntax>
Simple (non-constructed) objects

Data and other attributes inherited from ProtoVersionId1MixIn:
apiAlphaProtoVersionId = 0

Methods inherited from ProtoVersionIdMixInBase:
apiAlphaGetProtoVersionId(self)

Methods inherited from ChoiceMixIn:
apiAlphaGetCurrentComponent(self)
apiAlphaGetTerminalValue(self)
apiAlphaSetTerminalValue(self, value)
getTerminal = apiAlphaGetTerminalValue(self)

Data and other attributes inherited from Choice:
tagCategory = 4

Methods inherited from ChoiceTypeAsn1Object:
__delitem__(self, key)
Delete component by key
__init__(self, **kwargs)
Store dictionary args
__setitem__(self, key, value)
Set component by key & value
componentFactoryBorrow(self, key)

Methods inherited from FixedTypeAsn1Object:
__cmp__(self, other)
Attempt to compare the payload of instances of the same class
__getitem__(self, key)
Return component by key
__hash__(self)
Returns hash of the payload value
__len__(self)
Get length of the object
__repr__(self)
Return native representation of instance payload
__str__(self)
Return string representation of class instance
get(self, key, default=None)
Lookup by key with default
has_key(self, key)
Return true if key exists
items(self)
Return a list of tuples (key, value)
keys(self)
Return a list of keys
update(self, dict)
Merge dict to ourselves
values(self)
Return a list of values

Data and other attributes inherited from StructuredAsn1Object:
tagFormat = 32

Methods inherited from Asn1Object:
getUnderlyingTag(self)

Data and other attributes inherited from Asn1Object:
allowedTypes = ()
constraints = ()
tagClass = 0
tagId = None

Methods inherited from SingleFixedTypeAsn1Object:
berDecode(self, input)
decode = berDecode(self, input)

Methods inherited from FixedTypeAsn1Object:
berEncode(self)
Choose optimised version of berEncode for this class
berEncodeWOutSub(self)
berEncodeWSub() -> octet string
 
For classes which do *not* have a _berEncode only!
 
Note:
    This should be bound by a metaclass on looking
    at the final class, *not* as is done now by
    binding at time-of-use.
berEncodeWSub(self)
berEncodeWSub() -> octet string
 
For classes which *have* a _berEncode only!
 
Note:
    This should be bound by a metaclass on looking
    at the final class, *not* as is done now by
    binding at time-of-use.
encode = berEncode(self)
Choose optimised version of berEncode for this class

Methods inherited from StructuredAsn1Object:
berUnwrapHeader(self, input)
Decode BER header, return (data, rest)
berWrapHeader(self, input)
Add BER header to data chunk if needed

Methods inherited from BerObject:
berDecodeLength(self, input)
berDecodeLength(input) -> (length, size)
 
Return the data item's length (integer) and the size of length
data (integer).
berEncodeLength(self, length)
berEncodeLength(length) -> octet string
 
BER encode ASN.1 data item length (integer).
berEncodeTag(self, (tagClass, tagFormat, tagId)=(None, None, None))
BER encode ASN.1 type tag

 
class OctetString(ProtoVersionId1MixIn, OctetString)
    SMI OCTETSTRING data type
 
 
Method resolution order:
OctetString
ProtoVersionId1MixIn
ProtoVersionIdMixInBase
OctetString
SimpleAsn1Object
Asn1Object
OctetStringMixIn
SimpleAsn1Object
BerObject

Data and other attributes inherited from ProtoVersionId1MixIn:
apiAlphaProtoVersionId = 0

Methods inherited from ProtoVersionIdMixInBase:
apiAlphaGetProtoVersionId(self)

Methods inherited from OctetString:
__add__(self, other)
Add sub-id  with input verification
__getitem__(self, i)
Get string component by index or slice
__len__(self)
__mul__(self, value)
Multiply a value
__radd__(self, other)
Add sub-id  with input verification
__rmul__ = __mul__(self, value)
Multiply a value

Data and other attributes inherited from OctetString:
allowedTypes = (<type 'str'>,)
initialValue = ''
tagId = 4

Methods inherited from SimpleAsn1Object:
__cmp__(self, other)
Attempt to compare the payload of instances of the same class
__hash__(self)
Returns hash of the payload value
__init__(self, value=None)
Store ASN.1 value
__nonzero__(self)
Returns true if value is true
__repr__(self)
Return native representation of instance payload
__str__(self)
Return string representation of class instance
componentFactoryBorrow(self, value=None)
get(self)
Get a value from object
getTerminal(self)
set(self, value)
Set a value to object

Data and other attributes inherited from SimpleAsn1Object:
NORMAL_STATIC_TYPES = (<type 'int'>, <type 'long'>, <type 'str'>, <type 'NoneType'>, <type 'float'>, <type 'tuple'>)
tagFormat = 0

Methods inherited from Asn1Object:
getUnderlyingTag(self)

Data and other attributes inherited from Asn1Object:
constraints = ()
tagCategory = 1
tagClass = 0

Methods inherited from SimpleAsn1Object:
berDecode(self, input)
berDecode(input) -> (value, rest)
 
BER decode input (octet string) into ASN1 object payload,
return the rest of input stream.
berEncode(self, value=None)
berEncode() -> octet string
 
BER encode object payload whenever possible
decode = berDecode(self, input)
berDecode(input) -> (value, rest)
 
BER decode input (octet string) into ASN1 object payload,
return the rest of input stream.
encode = berEncode(self, value=None)
berEncode() -> octet string
 
BER encode object payload whenever possible

Methods inherited from BerObject:
berDecodeLength(self, input)
berDecodeLength(input) -> (length, size)
 
Return the data item's length (integer) and the size of length
data (integer).
berEncodeLength(self, length)
berEncodeLength(length) -> octet string
 
BER encode ASN.1 data item length (integer).
berEncodeTag(self, (tagClass, tagFormat, tagId)=(None, None, None))
BER encode ASN.1 type tag

 
class Opaque(ProtoVersionId1MixIn, OctetString)
    SNMP OPAQUE object
 
 
Method resolution order:
Opaque
ProtoVersionId1MixIn
ProtoVersionIdMixInBase
OctetString
SimpleAsn1Object
Asn1Object
OctetStringMixIn
SimpleAsn1Object
BerObject

Data and other attributes defined here:
tagCategory = 'EXPLICIT'
tagClass = 64
tagId = 4

Data and other attributes inherited from ProtoVersionId1MixIn:
apiAlphaProtoVersionId = 0

Methods inherited from ProtoVersionIdMixInBase:
apiAlphaGetProtoVersionId(self)

Methods inherited from OctetString:
__add__(self, other)
Add sub-id  with input verification
__getitem__(self, i)
Get string component by index or slice
__len__(self)
__mul__(self, value)
Multiply a value
__radd__(self, other)
Add sub-id  with input verification
__rmul__ = __mul__(self, value)
Multiply a value

Data and other attributes inherited from OctetString:
allowedTypes = (<type 'str'>,)
initialValue = ''

Methods inherited from SimpleAsn1Object:
__cmp__(self, other)
Attempt to compare the payload of instances of the same class
__hash__(self)
Returns hash of the payload value
__init__(self, value=None)
Store ASN.1 value
__nonzero__(self)
Returns true if value is true
__repr__(self)
Return native representation of instance payload
__str__(self)
Return string representation of class instance
componentFactoryBorrow(self, value=None)
get(self)
Get a value from object
getTerminal(self)
set(self, value)
Set a value to object

Data and other attributes inherited from SimpleAsn1Object:
NORMAL_STATIC_TYPES = (<type 'int'>, <type 'long'>, <type 'str'>, <type 'NoneType'>, <type 'float'>, <type 'tuple'>)
tagFormat = 0

Methods inherited from Asn1Object:
getUnderlyingTag(self)

Data and other attributes inherited from Asn1Object:
constraints = ()

Methods inherited from SimpleAsn1Object:
berDecode(self, input)
berDecode(input) -> (value, rest)
 
BER decode input (octet string) into ASN1 object payload,
return the rest of input stream.
berEncode(self, value=None)
berEncode() -> octet string
 
BER encode object payload whenever possible
decode = berDecode(self, input)
berDecode(input) -> (value, rest)
 
BER decode input (octet string) into ASN1 object payload,
return the rest of input stream.
encode = berEncode(self, value=None)
berEncode() -> octet string
 
BER encode object payload whenever possible

Methods inherited from BerObject:
berDecodeLength(self, input)
berDecodeLength(input) -> (length, size)
 
Return the data item's length (integer) and the size of length
data (integer).
berEncodeLength(self, length)
berEncodeLength(length) -> octet string
 
BER encode ASN.1 data item length (integer).
berEncodeTag(self, (tagClass, tagFormat, tagId)=(None, None, None))
BER encode ASN.1 type tag

 
class Sequence(SequenceMixIn, ProtoVersionId1MixIn, Sequence)
    SNMP Sequence
 
 
Method resolution order:
Sequence
SequenceMixIn
ProtoVersionId1MixIn
ProtoVersionIdMixInBase
Sequence
RecordTypeAsn1Object
FixedTypeAsn1Object
StructuredAsn1Object
Asn1Object
SequenceMixIn
OrderedFixedTypeAsn1Object
FixedTypeAsn1Object
StructuredAsn1Object
SimpleAsn1Object
BerObject

Methods inherited from SequenceMixIn:
apiAlphaSetSimpleComponent(self, key, value)

Data and other attributes inherited from ProtoVersionId1MixIn:
apiAlphaProtoVersionId = 0

Methods inherited from ProtoVersionIdMixInBase:
apiAlphaGetProtoVersionId(self)

Data and other attributes inherited from Sequence:
tagId = 16

Methods inherited from RecordTypeAsn1Object:
__init__(self, **kwargs)
Store dictionary args
__setitem__(self, key, value)
Set component by key & value

Data and other attributes inherited from RecordTypeAsn1Object:
fixedComponents = []
fixedNames = []

Methods inherited from FixedTypeAsn1Object:
__cmp__(self, other)
Attempt to compare the payload of instances of the same class
__getitem__(self, key)
Return component by key
__hash__(self)
Returns hash of the payload value
__len__(self)
Get length of the object
__repr__(self)
Return native representation of instance payload
__str__(self)
Return string representation of class instance
get(self, key, default=None)
Lookup by key with default
has_key(self, key)
Return true if key exists
items(self)
Return a list of tuples (key, value)
keys(self)
Return a list of keys
update(self, dict)
Merge dict to ourselves
values(self)
Return a list of values

Data and other attributes inherited from StructuredAsn1Object:
tagFormat = 32

Methods inherited from Asn1Object:
getUnderlyingTag(self)

Data and other attributes inherited from Asn1Object:
allowedTypes = ()
constraints = ()
tagCategory = 1
tagClass = 0

Methods inherited from OrderedFixedTypeAsn1Object:
berDecode(self, input)
berDecode(input) -> rest
 
BER decode input (octet string) into ASN1 object payload,
return the rest of input stream.
decode = berDecode(self, input)
berDecode(input) -> rest
 
BER decode input (octet string) into ASN1 object payload,
return the rest of input stream.

Methods inherited from FixedTypeAsn1Object:
berEncode(self)
Choose optimised version of berEncode for this class
berEncodeWOutSub(self)
berEncodeWSub() -> octet string
 
For classes which do *not* have a _berEncode only!
 
Note:
    This should be bound by a metaclass on looking
    at the final class, *not* as is done now by
    binding at time-of-use.
berEncodeWSub(self)
berEncodeWSub() -> octet string
 
For classes which *have* a _berEncode only!
 
Note:
    This should be bound by a metaclass on looking
    at the final class, *not* as is done now by
    binding at time-of-use.
encode = berEncode(self)
Choose optimised version of berEncode for this class

Methods inherited from StructuredAsn1Object:
berUnwrapHeader(self, input)
Decode BER header, return (data, rest)
berWrapHeader(self, input)
Add BER header to data chunk if needed

Methods inherited from BerObject:
berDecodeLength(self, input)
berDecodeLength(input) -> (length, size)
 
Return the data item's length (integer) and the size of length
data (integer).
berEncodeLength(self, length)
berEncodeLength(length) -> octet string
 
BER encode ASN.1 data item length (integer).
berEncodeTag(self, (tagClass, tagFormat, tagId)=(None, None, None))
BER encode ASN.1 type tag

 
class SequenceOf(ProtoVersionId1MixIn, SequenceOf)
    SNMP SequenceOf
 
 
Method resolution order:
SequenceOf
ProtoVersionId1MixIn
ProtoVersionIdMixInBase
SequenceOf
VariableTypeAsn1Object
StructuredAsn1Object
Asn1Object
SequenceOfMixIn
OrderedVariableTypeAsn1Object
VariableTypeAsn1Object
StructuredAsn1Object
SimpleAsn1Object
BerObject

Data and other attributes inherited from ProtoVersionId1MixIn:
apiAlphaProtoVersionId = 0

Methods inherited from ProtoVersionIdMixInBase:
apiAlphaGetProtoVersionId(self)

Data and other attributes inherited from SequenceOf:
tagId = 16

Methods inherited from VariableTypeAsn1Object:
__cmp__(self, other)
Attempt to compare the payload of instances of the same class
__delitem__(self, idx)
Remove object by subscription
__getitem__(self, idx)
Get object by subscription
__hash__(self)
Returns hash of the payload value
__init__(self, *args)
Store possible components
__len__(self)
__repr__(self)
Return native representation of instance payload
__setitem__(self, idx, value)
Set object by subscription
__str__(self)
Return string representation of class instance
append(self, value)
Append object to end
clear(self)
componentFactoryBorrow(self)
componentFactoryReturn(self, *vals)
extend(self, values)
Extend list by appending list elements
index(self, idx)
insert(self, idx, value)
Insert object before index
pop(self, idx=None)
Remove and return item at index (default last)

Data and other attributes inherited from VariableTypeAsn1Object:
initialValue = []
protoComponent = None

Data and other attributes inherited from StructuredAsn1Object:
tagFormat = 32

Methods inherited from Asn1Object:
getUnderlyingTag(self)

Data and other attributes inherited from Asn1Object:
allowedTypes = ()
constraints = ()
tagCategory = 1
tagClass = 0

Methods inherited from VariableTypeAsn1Object:
berDecode(self, input)
BER decode input (octet string) into ASN1 object payload,
return the rest of input stream.
berEncode(self, args=[])
berEncode() -> octet string
 
BER encode object payload whenever possible
decode = berDecode(self, input)
BER decode input (octet string) into ASN1 object payload,
return the rest of input stream.
encode = berEncode(self, args=[])
berEncode() -> octet string
 
BER encode object payload whenever possible

Methods inherited from StructuredAsn1Object:
berUnwrapHeader(self, input)
Decode BER header, return (data, rest)
berWrapHeader(self, input)
Add BER header to data chunk if needed

Methods inherited from BerObject:
berDecodeLength(self, input)
berDecodeLength(input) -> (length, size)
 
Return the data item's length (integer) and the size of length
data (integer).
berEncodeLength(self, length)
berEncodeLength(length) -> octet string
 
BER encode ASN.1 data item length (integer).
berEncodeTag(self, (tagClass, tagFormat, tagId)=(None, None, None))
BER encode ASN.1 type tag

 
class SimpleSyntax(ProtoVersionId1MixIn, Choice)
    Simple (non-constructed) objects
 
 
Method resolution order:
SimpleSyntax
ProtoVersionId1MixIn
ProtoVersionIdMixInBase
Choice
ChoiceMixIn
Choice
ChoiceTypeAsn1Object
FixedTypeAsn1Object
StructuredAsn1Object
Asn1Object
ChoiceMixIn
SingleFixedTypeAsn1Object
FixedTypeAsn1Object
StructuredAsn1Object
SimpleAsn1Object
BerObject

Data and other attributes defined here:
choiceComponents = [<class pysnmp.proto.rfc1155.Integer>, <class pysnmp.proto.rfc1155.OctetString>, <class pysnmp.proto.rfc1155.ObjectIdentifier>, <class pysnmp.proto.rfc1155.Null>]
choiceNames = ['number', 'string', 'object', 'empty']
initialComponent = <class pysnmp.proto.rfc1155.Null>
SMI NULL data type

Data and other attributes inherited from ProtoVersionId1MixIn:
apiAlphaProtoVersionId = 0

Methods inherited from ProtoVersionIdMixInBase:
apiAlphaGetProtoVersionId(self)

Methods inherited from ChoiceMixIn:
apiAlphaGetCurrentComponent(self)
apiAlphaGetTerminalValue(self)
apiAlphaSetTerminalValue(self, value)
getTerminal = apiAlphaGetTerminalValue(self)

Data and other attributes inherited from Choice:
tagCategory = 4

Methods inherited from ChoiceTypeAsn1Object:
__delitem__(self, key)
Delete component by key
__init__(self, **kwargs)
Store dictionary args
__setitem__(self, key, value)
Set component by key & value
componentFactoryBorrow(self, key)

Methods inherited from FixedTypeAsn1Object:
__cmp__(self, other)
Attempt to compare the payload of instances of the same class
__getitem__(self, key)
Return component by key
__hash__(self)
Returns hash of the payload value
__len__(self)
Get length of the object
__repr__(self)
Return native representation of instance payload
__str__(self)
Return string representation of class instance
get(self, key, default=None)
Lookup by key with default
has_key(self, key)
Return true if key exists
items(self)
Return a list of tuples (key, value)
keys(self)
Return a list of keys
update(self, dict)
Merge dict to ourselves
values(self)
Return a list of values

Data and other attributes inherited from StructuredAsn1Object:
tagFormat = 32

Methods inherited from Asn1Object:
getUnderlyingTag(self)

Data and other attributes inherited from Asn1Object:
allowedTypes = ()
constraints = ()
tagClass = 0
tagId = None

Methods inherited from SingleFixedTypeAsn1Object:
berDecode(self, input)
decode = berDecode(self, input)

Methods inherited from FixedTypeAsn1Object:
berEncode(self)
Choose optimised version of berEncode for this class
berEncodeWOutSub(self)
berEncodeWSub() -> octet string
 
For classes which do *not* have a _berEncode only!
 
Note:
    This should be bound by a metaclass on looking
    at the final class, *not* as is done now by
    binding at time-of-use.
berEncodeWSub(self)
berEncodeWSub() -> octet string
 
For classes which *have* a _berEncode only!
 
Note:
    This should be bound by a metaclass on looking
    at the final class, *not* as is done now by
    binding at time-of-use.
encode = berEncode(self)
Choose optimised version of berEncode for this class

Methods inherited from StructuredAsn1Object:
berUnwrapHeader(self, input)
Decode BER header, return (data, rest)
berWrapHeader(self, input)
Add BER header to data chunk if needed

Methods inherited from BerObject:
berDecodeLength(self, input)
berDecodeLength(input) -> (length, size)
 
Return the data item's length (integer) and the size of length
data (integer).
berEncodeLength(self, length)
berEncodeLength(length) -> octet string
 
BER encode ASN.1 data item length (integer).
berEncodeTag(self, (tagClass, tagFormat, tagId)=(None, None, None))
BER encode ASN.1 type tag

 
class TimeTicks(ProtoVersionId1MixIn, Integer)
    SNMP TIMETICKS object
 
 
Method resolution order:
TimeTicks
ProtoVersionId1MixIn
ProtoVersionIdMixInBase
Integer
SimpleAsn1Object
Asn1Object
IntegerMixIn
SimpleAsn1Object
BerObject

Data and other attributes defined here:
constraints = (<function _ValueRangeConstraint>,)
tagClass = 64
tagId = 3

Data and other attributes inherited from ProtoVersionId1MixIn:
apiAlphaProtoVersionId = 0

Methods inherited from ProtoVersionIdMixInBase:
apiAlphaGetProtoVersionId(self)

Methods inherited from Integer:
__add__(self, value)
Add a value
__and__(self, value)
Perform binary AND operation
__div__(self, value)
Divide a value by ourselves
__float__(self)
Return a floating point value of ourselves
__iadd__(self, value)
Add value to ourselves
__iand__(self, value)
Perform binary AND operation against ourselves
__idiv__(self, value)
Divide a value by ourselves
__ilshift__(self, value)
Perform left shift operation
__imod__(self, value)
Take a modulo of ourselves
__imul__(self, value)
Multiply a value to ourselves
__int__(self)
Return an integer value of ourselves
__ior__(self, value)
Perform binary OR operation against ourselves
__ipow__(self, value, modulo)
Provision for x**=y
__irshift__(self, value)
Perform right shift operation
__isub__(self, value)
Subscract value from ourselves
__ixor__(self, value)
Perform binary XOR operation against ourselves
__long__(self)
Return a long integer value of ourselves
__lshift__(self, value)
Perform left shift operation
__mod__(self, value)
Take a modulo of ourselves
__mul__(self, value)
Multiply a value
__or__(self, value)
Perform binary OR operation
__pow__(self, value, modulo)
Provision for pow()
__radd__ = __add__(self, value)
Add a value
__rand__ = __and__(self, value)
Perform binary AND operation
__rdiv__(self, value)
Divide ourselves by value
__rmod__ = __mod__(self, value)
Take a modulo of ourselves
__rmul__ = __mul__(self, value)
Multiply a value
__ror__ = __or__(self, value)
Perform binary OR operation
__rpow__(self, value, modulo)
Provision for rpow()
__rshift__(self, value)
Perform right shift operation
__rsub__(self, value)
Subscract our value from given one
__rxor__ = __xor__(self, value)
Perform binary XOR operation
__sub__(self, value)
Subscract a value
__xor__(self, value)
Perform binary XOR operation
dec = __isub__(self, value)
Subscract value from ourselves
div = __idiv__(self, value)
Divide a value by ourselves
inc = __iadd__(self, value)
Add value to ourselves
mul = __imul__(self, value)
Multiply a value to ourselves

Data and other attributes inherited from Integer:
allowedTypes = (<type 'int'>, <type 'long'>)
initialValue = 0L

Methods inherited from SimpleAsn1Object:
__cmp__(self, other)
Attempt to compare the payload of instances of the same class
__hash__(self)
Returns hash of the payload value
__init__(self, value=None)
Store ASN.1 value
__nonzero__(self)
Returns true if value is true
__repr__(self)
Return native representation of instance payload
__str__(self)
Return string representation of class instance
componentFactoryBorrow(self, value=None)
get(self)
Get a value from object
getTerminal(self)
set(self, value)
Set a value to object

Data and other attributes inherited from SimpleAsn1Object:
NORMAL_STATIC_TYPES = (<type 'int'>, <type 'long'>, <type 'str'>, <type 'NoneType'>, <type 'float'>, <type 'tuple'>)
tagFormat = 0

Methods inherited from Asn1Object:
getUnderlyingTag(self)

Data and other attributes inherited from Asn1Object:
tagCategory = 1

Methods inherited from SimpleAsn1Object:
berDecode(self, input)
berDecode(input) -> (value, rest)
 
BER decode input (octet string) into ASN1 object payload,
return the rest of input stream.
berEncode(self, value=None)
berEncode() -> octet string
 
BER encode object payload whenever possible
decode = berDecode(self, input)
berDecode(input) -> (value, rest)
 
BER decode input (octet string) into ASN1 object payload,
return the rest of input stream.
encode = berEncode(self, value=None)
berEncode() -> octet string
 
BER encode object payload whenever possible

Methods inherited from BerObject:
berDecodeLength(self, input)
berDecodeLength(input) -> (length, size)
 
Return the data item's length (integer) and the size of length
data (integer).
berEncodeLength(self, length)
berEncodeLength(length) -> octet string
 
BER encode ASN.1 data item length (integer).
berEncodeTag(self, (tagClass, tagFormat, tagId)=(None, None, None))
BER encode ASN.1 type tag

 
Data
        __all__ = ['Integer', 'OctetString', 'Null', 'ObjectIdentifier', 'IpAddress', 'Counter', 'Gauge', 'TimeTicks', 'Opaque', 'Sequence', 'SequenceOf', 'Choice', 'NetworkAddress', 'ObjectName', 'SimpleSyntax', 'ApplicationSyntax', 'ObjectSyntax']
tagClasses = {'APPLICATION': 64, 'CONTEXT': 128, 'PRIVATE': 192, 'UNIVERSAL': 0}