MibBrowser Class

Properties   Methods   Events   Config Settings   Errors  

The MIBBrowser class is used to parse SNMP MIB Module definitions.

Syntax

class ipworkssnmp.MibBrowser

Remarks

The MIBBrowser class allows easy loading and querying of definitions in the SNMP Management Information Base (MIB) specifications.

The load_mib method allows loading of MIB modules, which get stored in an internal tree structure for further queries.

If modules reference (import) other modules, recursive loading of modules is performed automatically and/or controlled by the on_import_symbols event.

The MIB tree is navigated through the select_node method, which enables pointing to a node in the tree specified by node_oid and node_label. Other node information is provided through the node_module_name, node_file_name, node_syntax, node_type, and node_access properties.

The node selector parameter in select_node can be a label such as "internet", an OID such as "1.3.6.4", a combination of the two: "iso.3.dod.internet", or a label in a particular module such as "RFC1213-MIB!interfaces".

Node children and successors are provided by the list_children and list_successors methods. The individual node information is provided via the on_mib_node event.

Module traps are listed via the list_traps method. The individual trap information is provided through the on_trap_node event.

Property List

---

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

exact_match Property

Controls the way the OID matching is done (complete or partial).

Syntax

def get_exact_match() -> bool: ...
def set_exact_match(value: bool) -> None: ...

exact_match = property(get_exact_match, set_exact_match)

Default Value

TRUE

Remarks

If exact_match is set to True, the select_node method will try to find an exact match for the supplied selector. If not found, an exception will be thrown.

If exact_match is set to False, the select_node method will start from the root (iso) and will go as far as it can, finding the closest match for the requested node.

For instance, in SNMPv2-MIB sysUpTime is defined as "1.3.6.1.2.1.1.3". If exact_match is False, calling select_node with selector "1.3.6.1.2.1.1.3.0" will populate node_label with "sysUpTime.0" while the same call with exact_match set to True will fail since that exact OID is not defined in the MIB.

node_access Property

The access permissions for the selected node.

Syntax

def get_node_access() -> int: ...

node_access = property(get_node_access, None)

Default Value

0

Remarks

The following is the list of values for node_access:

This property is read-only.

node_description Property

Textual description of the selected node.

Syntax

def get_node_description() -> str: ...

node_description = property(get_node_description, None)

Default Value

""

Remarks

Because loading descriptions can consume unwanted resources, the class can control caching of descriptions in order to keep the memory footprint of the class as small as possible.

To disable caching, set the CacheDescriptions config setting to True. In this case, the class will only save the offset of the description in the MIB file in memory, and will fetch the textual description directly from the file only when required. When using caching, make sure that the path of the loaded modules does not change or the property will be unable to fetch the correct text description.

This property is read-only.

node_file_name Property

The absolute path of the file where the selected node is declared.

Syntax

def get_node_file_name() -> str: ...

node_file_name = property(get_node_file_name, None)

Default Value

""

Remarks

It is possible for a node to be re-declared in other modules. In this case the property contains a comma separated list of file names where the selected node is declared.

This property is read-only.

node_full_label Property

The full label of the selected node.

Syntax

def get_node_full_label() -> str: ...

node_full_label = property(get_node_full_label, None)

Default Value

""

Remarks

This contains the full label of the Oid of the selected node. It is unique within the MIB module where it is declared.

This property is read-only.

node_index Property

The index of the node in a table.

Syntax

def get_node_index() -> str: ...

node_index = property(get_node_index, None)

Default Value

""

Remarks

If the selected node has stxSequence syntax then the NodeIndex represents the column used to distinguish among different table rows.

Example: MibParser.LoadMib(""SNMPv2-MIB"") MibParser.SelectNode("1.3.6.1.2.1.2.2") Debug.Print MibParser1.NodeLabel // prints "ifTable" MibParser.SelectNode("1.3.6.1.2.1.2.2.1") Debug.Print MibParser1.NodeLabel // prints "ifEntry" Debug.Print MibParser1.NodeIndex // prints "ifIndex"

This property is read-only.

node_label Property

The label of the selected node.

Syntax

def get_node_label() -> str: ...

node_label = property(get_node_label, None)

Default Value

"iso"

Remarks

This label is unique within the MIB module where it is declared.

This property is read-only.

node_module_name Property

The name of the module where the selected node is declared.

Syntax

def get_node_module_name() -> str: ...

node_module_name = property(get_node_module_name, None)

Default Value

""

Remarks

It is possible for a node to be redeclared in other modules. In this case the node_module_name contains a comma separated list of module names where the selected node is declared.

This property is read-only.

node_oid Property

The Object ID of the selected node.

Syntax

def get_node_oid() -> str: ...

node_oid = property(get_node_oid, None)

Default Value

"1"

Remarks

Contains the Object Id (OID) of the currently selected node. The OID uniquely identifies the selected node within the entire object hierarchy.

This property is read-only.

node_sub_id Property

The SubId of the currently selected node.

Syntax

def get_node_sub_id() -> int: ...

node_sub_id = property(get_node_sub_id, None)

Default Value

1

Remarks

For instance, if you select the node "dod" in "rfc1155.smi", the node_sub_id value will be 6.

This property is read-only.

node_syntax Property

The syntax of the selected node.

Syntax

def get_node_syntax() -> int: ...

node_syntax = property(get_node_syntax, None)

Default Value

6

Remarks

The syntax defines what type of data the selected node contains. Common data types include:

Additional type definitions can be found in the SNMP RFC's.

This property is read-only.

node_syntax_string Property

The node syntax of the selected node in text format.

Syntax

def get_node_syntax_string() -> str: ...

node_syntax_string = property(get_node_syntax_string, None)

Default Value

""

Remarks

For instance, for the node "system" in "SNMPv2-MIB", node_syntax returns 6 (stxObjectId), while node_syntax_string returns "OBJECT IDENTIFIER".

This property is read-only.

node_type Property

The type of the selected node.

Syntax

def get_node_type() -> int: ...

node_type = property(get_node_type, None)

Default Value

1

Remarks

The following are the possible values for node_type:

This property is read-only.

node_type_string Property

The node type of the selected node in text format.

Syntax

def get_node_type_string() -> str: ...

node_type_string = property(get_node_type_string, None)

Default Value

"OBJECT IDENTITY"

Remarks

For instance, for the node "system" in "SNMPv2-MIB", node_type returns 2 (mcrObjectIdentity), while node_type_string returns "OBJECT-IDENTITY".

This property is read-only.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

list_children Method

Lists the immediate children of the selected node.

Syntax

def list_children() -> None: ...

Remarks

The on_mib_node event fires once for every SubId of the selected node and provides all info related to that SubId.

For instance, the following code: MibParser.LoadMib("RFC1155-SMI") MibParser.SelectNode("internet") MibParser.ListChildren() will generate the following output through the on_mib_node event:

  directory    1.3.6.1.1
  mgmt         1.3.6.1.2
  experimental 1.3.6.1.3
  private      1.3.6.1.4

list_successors Method

Lists all successors of the selected node.

Syntax

def list_successors() -> None: ...

Remarks

The on_mib_node event fires once for each successor of the selected node and provides all information related to it.

list_traps Method

Lists all the traps defined in the loaded modules.

Syntax

def list_traps() -> None: ...

Remarks

The on_trap_node event fires once for every trap and provides all info related to it.

For instance, the following code:

MibParser.LoadMib("mib_ii.mib") MibParser.ListTraps() will generate the following output through the on_trap_node event: coldStart 0 snmp warmStart 1 snmp linkDown 2 snmp linkUp 3 snmp authenticationFailure 4 snmp

load_mib Method

Parses the file FileName and adds the parsed nodes to the collection of existing nodes.

Syntax

def load_mib(file_name: str) -> None: ...

Remarks

This method can be used to load and parse a MIB file into the class.

Some MIB modules contain references to other modules within their imports sections. When loading a MIB that contains external imports, the on_import_symbols event will fire for each external reference. These modules must be loaded if possible to generate a complete representation for the loaded MIB.

It is possible for the component to attempt to load all external references automatically. To do this, use config and set "AutoLoadMibs=True". Setting this configuration property causes the class to attempt to find and load any external references included in the current MIB. The class will only find external modules if they reside in the same directory as the current module. Alternatively, the class can load additional modules by calling load_mib while inside the on_import_symbols event.

If the AutoLoadMibs config setting is set to False, and no explicit action is taken to load necessary modules inside the on_import_symbols event, some symbols may remain unresolved. These symbols will not appear in the MibNode hierarchy until the module containing their definition is loaded. Order is unimportant when loading additional MIB modules. A complete list of unresolved symbols can be found by retrieving the UndefinedSymbols config setting (comma separated list of symbols).

Note that FileName also accepts MIB data. If MIB data is used, the class will expect the NodeFileName to be at the beginning of the string, surrounded by "[]". For example:

[RFC-1215]RFC-1215 DEFINITIONS ::= BEGIN......END

reset Method

Reset all properties of the class.

Syntax

def reset() -> None: ...

Remarks

This method resets all of the node properties as well as the internal collection of parsed nodes.

select_node Method

Used to select individual nodes in the loaded MIB module(s).

Syntax

def select_node(selector: str) -> None: ...

Remarks

select_node is used for selecting individual nodes and should be called before querying node information.

The Selector parameter can be a label such as "internet", an OID such as "1.3.6.4", a combination of the two: "iso.3.dod.internet", or a label in a particular module such as "RFC1213-MIB!interfaces".

Either '.' or ':' can be used to separate SubIds. If a SubId starts with "0x" or follows the ":" separator then its hexadecimal value is used. For instance, "0x1.0x3.0x6.0x1A" is the same as "1:3:6:1A".

All properties and methods of the class will operate on the selected node. For example, calling list_successors will only list the successors of the selected node.

on_error Event

Errors that occur while loading/parsing MIB modules are fired through this event.

Syntax

class MibBrowserErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class MibBrowser:
@property
def on_error() -> Callable[[MibBrowserErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[MibBrowserErrorEventParams], None]) -> None: ...

Remarks

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

on_import_symbols Event

List of imported symbols and the respective modules where they are declared.

Syntax

class MibBrowserImportSymbolsEventParams(object):
  @property
  def symbols() -> str: ...

  @property
  def module_name() -> str: ...

# In class MibBrowser:
@property
def on_import_symbols() -> Callable[[MibBrowserImportSymbolsEventParams], None]: ...
@on_import_symbols.setter
def on_import_symbols(event_hook: Callable[[MibBrowserImportSymbolsEventParams], None]) -> None: ...

Remarks

The Symbols parameter is a comma separated list of all symbols that must be imported from ModuleName.

The module is loaded through the load_mib method.

on_mib_node Event

This event fires once for every child or successor of the currently selected node when invoking ListChildren or ListSuccessors .

Syntax

class MibBrowserMibNodeEventParams(object):
  @property
  def node_label() -> str: ...

  @property
  def node_oid() -> str: ...

  @property
  def node_type() -> int: ...

  @property
  def node_type_string() -> str: ...

  @property
  def node_syntax() -> int: ...

  @property
  def node_syntax_string() -> str: ...

  @property
  def node_access() -> int: ...

  @property
  def node_index() -> str: ...

  @property
  def node_parent_name() -> str: ...

  @property
  def node_description() -> str: ...

  @property
  def node_module_name() -> str: ...

  @property
  def node_file_name() -> str: ...

# In class MibBrowser:
@property
def on_mib_node() -> Callable[[MibBrowserMibNodeEventParams], None]: ...
@on_mib_node.setter
def on_mib_node(event_hook: Callable[[MibBrowserMibNodeEventParams], None]) -> None: ...

Remarks

When calling either list_children or list_successors, the MibNode event will fire once for every child of the currently selected node. The list_children method will cause the event will fire once for each of the immediate children of the current node. list_successors cause this event to fire for each of the immediate children of the current node, as well as the entire tree of successors of those children.

NodeLabel is the name or textual representation of the current node, and is unique to its siblings. The NodeOid is the OID of the listed node and uniquely identifies the node within the entire MIB. The remaining parameters offer additional information about the listed node.

Information about the listed node is only available through the MibNode event parameters. All class properties remain related to the currently selected node.

If a MibNode is declared in more than one file or module, then the NodeFileName and NodeModuleName parameters will contain a comma separated list of files/modules where the node is declared.

For instance, the following code: MibParser.LoadMib("RFC1155-SMI") MibParser.SelectNode("internet") // OID 1.3.6.1 MibParser.ListSuccessors() will generate the following output through the event:

  directory    1.3.6.1.1
  mgmt         1.3.6.1.2
  experimental 1.3.6.1.3
  private      1.3.6.1.4
  enterprises  1.3.6.1.4.1

on_trap_node Event

Lists module trap information.

Syntax

class MibBrowserTrapNodeEventParams(object):
  @property
  def trap_name() -> str: ...

  @property
  def specific_trap() -> int: ...

  @property
  def trap_enterprise() -> str: ...

  @property
  def trap_variables() -> str: ...

  @property
  def trap_description() -> str: ...

  @property
  def trap_references() -> str: ...

  @property
  def trap_module_name() -> str: ...

  @property
  def trap_file_name() -> str: ...

# In class MibBrowser:
@property
def on_trap_node() -> Callable[[MibBrowserTrapNodeEventParams], None]: ...
@on_trap_node.setter
def on_trap_node(event_hook: Callable[[MibBrowserTrapNodeEventParams], None]) -> None: ...

Remarks

When calling list_traps, the on_trap_node event fires once for every trap found in the module.

The following are the descriptions of the event parameters:

If a trap has been defined in more than one module or file, then ModuleName and FileName will contain a comma separated list of values.

MibBrowser Config Settings

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

MibBrowser Config Settings

Base Config Settings

MibBrowser Errors

MibBrowser Errors