MibBrowser Class
Properties Methods Events Configuration 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.
| exact_match | Controls the way the OID matching is done (complete or partial). |
| node_access | The access permissions for the selected node. |
| node_description | Textual description of the selected node. |
| node_file_name | The absolute path of the file where the selected node is declared. |
| node_full_label | The full label of the selected node. |
| node_index | The index of the node in a table. |
| node_label | The label of the selected node. |
| node_module_name | The name of the module where the selected node is declared. |
| node_oid | The Object ID of the selected node. |
| node_sub_id | The SubId of the currently selected node. |
| node_syntax | The syntax of the selected node. |
| node_syntax_string | The node syntax of the selected node in text format. |
| node_type | The type of the selected node. |
| node_type_string | The node type of the selected node in text format. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| config | Sets or retrieves a configuration setting. |
| list_children | Lists the immediate children of the selected node. |
| list_successors | Lists all successors of the selected node. |
| list_traps | Lists all the traps defined in the loaded modules. |
| load_mib | Parses the file FileName and adds the parsed nodes to the collection of existing nodes. |
| reset | Reset all properties of the class. |
| select_node | Used to select individual nodes in the loaded MIB module(s). |
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.
| on_error | Errors that occur while loading/parsing MIB modules are fired through this event. |
| on_import_symbols | List of imported symbols and the respective modules where they are declared. |
| on_mib_node | This event fires once for every child or successor of the currently selected node when invoking ListChildren or ListSuccessors . |
| on_trap_node | Lists module trap information. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
| AutoLoadMibs | Determines whether imported MIB modules are loaded automatically. |
| CacheDescriptions | Controls caching of Node descriptions. |
| CacheMibs | Controls MIB module caching. |
| CheckNoKnownRoots | Controls whether or not the class fails when a file with no known root is loaded. |
| DisplayHint | The DISPLAY-HINT property for the current node. |
| MibExtensions | Controls the file extensions that the class will search for. |
| NodeIsColumnar | Whether the current node is columnar. |
| NodeIsScalar | Whether the current node is scalar. |
| ReleaseTempNodes | Will release any temporary nodes stored by the class. |
| ReturnEnumValues | Comma-separated list of the current node's enumeration textual-conventions. |
| UndefinedSymbols | Comma-separated list of nodes that have not been resolved. |
| BuildInfo | Information about the product's build. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| LicenseInfo | Information about the current license. |
| ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
| SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
| UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |