MibBrowser Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

nsoftware.IPWorksSNMP.MibBrowser

Remarks

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

The LoadMib 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 ImportSymbols event.

The MIB tree is navigated through the SelectNode method, which enables pointing to a node in the tree specified by NodeOid and NodeLabel. Other node information is provided through the NodeModuleName, NodeFileName, NodeSyntax, NodeType, and NodeAccess properties.

The node selector parameter in SelectNode 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 ListChildren and ListSuccessors methods. The individual node information is provided via the MibNode event.

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

Property List

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

Method List

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

Event List

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

Config Settings

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

ExactMatch Property (MibBrowser Component)

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

Syntax

• C#
• VB.NET

public bool ExactMatch { get; set; }

Public Property ExactMatch As Boolean

Default Value

True

Remarks

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

If ExactMatch is set to False, the SelectNode 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 ExactMatch is False, calling SelectNode with selector "1.3.6.1.2.1.1.3.0" will populate NodeLabel with "sysUpTime.0" while the same call with ExactMatch set to True will fail since that exact OID is not defined in the MIB.

NodeAccess Property (MibBrowser Component)

The access permissions for the selected node.

Syntax

• C#
• VB.NET

public MibBrowserNodeAccess NodeAccess { get; }

enum MibBrowserNodeAccess {
  accUnknown,
  accNoAccess,
  accReadOnly,
  accReadCreate,
  accReadWrite,
  accWriteOnly,
  accForNotify
}

Public ReadOnly Property NodeAccess As MibbrowserNodeAccess

Enum MibBrowserNodeAccess
  accUnknown
  accNoAccess
  accReadOnly
  accReadCreate
  accReadWrite
  accWriteOnly
  accForNotify
End Enum

Default Value

0

Remarks

The following is the list of values for NodeAccess:

This property is read-only.

NodeDescription Property (MibBrowser Component)

Textual description of the selected node.

Syntax

• C#
• VB.NET

public string NodeDescription { get; }

Public ReadOnly Property NodeDescription As String

Default Value

""

Remarks

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

To disable caching, set the CacheDescriptions config setting to True. In this case, the component 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.

NodeFileName Property (MibBrowser Component)

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

Syntax

• C#
• VB.NET

public string NodeFileName { get; }

Public ReadOnly Property NodeFileName As String

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.

NodeFullLabel Property (MibBrowser Component)

The full label of the selected node.

Syntax

• C#
• VB.NET

public string NodeFullLabel { get; }

Public ReadOnly Property NodeFullLabel As String

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.

NodeIndex Property (MibBrowser Component)

The index of the node in a table.

Syntax

• C#
• VB.NET

public string NodeIndex { get; }

Public ReadOnly Property NodeIndex As String

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.

NodeLabel Property (MibBrowser Component)

The label of the selected node.

Syntax

• C#
• VB.NET

public string NodeLabel { get; }

Public ReadOnly Property NodeLabel As String

Default Value

"iso"

Remarks

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

This property is read-only.

NodeModuleName Property (MibBrowser Component)

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

Syntax

• C#
• VB.NET

public string NodeModuleName { get; }

Public ReadOnly Property NodeModuleName As String

Default Value

""

Remarks

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

This property is read-only.

NodeOid Property (MibBrowser Component)

The Object ID of the selected node.

Syntax

• C#
• VB.NET

public string NodeOid { get; }

Public ReadOnly Property NodeOid As String

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.

NodeSubId Property (MibBrowser Component)

The SubId of the currently selected node.

Syntax

• C#
• VB.NET

public int NodeSubId { get; }

Public ReadOnly Property NodeSubId As Integer

Default Value

1

Remarks

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

This property is read-only.

NodeSyntax Property (MibBrowser Component)

The syntax of the selected node.

Syntax

• C#
• VB.NET

public MibBrowserNodeSyntaxes NodeSyntax { get; }

enum MibBrowserNodeSyntaxes {
  stxBoolean,
  stxInteger,
  stxBitString,
  stxOctetString,
  stxNull,
  stxObjectId,
  stxEnumerated,
  stxSequenceOf,
  stxSequence,
  stxSet,
  stxChoice,
  stxNetworkAddress,
  stxIpAddress,
  stxCounter,
  stxGauge,
  stxTimeTicks,
  stxOpaque,
  stxNSAP,
  stxCounter64,
  stxUInteger,
  stxUnknown
}

Public ReadOnly Property NodeSyntax As MibbrowserNodeSyntaxes

Enum MibBrowserNodeSyntaxes
  stxBoolean
  stxInteger
  stxBitString
  stxOctetString
  stxNull
  stxObjectId
  stxEnumerated
  stxSequenceOf
  stxSequence
  stxSet
  stxChoice
  stxNetworkAddress
  stxIpAddress
  stxCounter
  stxGauge
  stxTimeTicks
  stxOpaque
  stxNSAP
  stxCounter64
  stxUInteger
  stxUnknown
End Enum

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.

NodeSyntaxString Property (MibBrowser Component)

The node syntax of the selected node in text format.

Syntax

• C#
• VB.NET

public string NodeSyntaxString { get; }

Public ReadOnly Property NodeSyntaxString As String

Default Value

""

Remarks

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

This property is read-only.

NodeType Property (MibBrowser Component)

The type of the selected node.

Syntax

• C#
• VB.NET

public MibBrowserNodeTypes NodeType { get; }

enum MibBrowserNodeTypes {
  mcrObjectType,
  mcrObjectIdentity,
  mcrModuleIdentity,
  mcrNotificationType,
  mcrTrapType,
  mcrObjectGroup,
  mcrNotificationGroup,
  mcrCompliance,
  mcrCapabilities
}

Public ReadOnly Property NodeType As MibbrowserNodeTypes

Enum MibBrowserNodeTypes
  mcrObjectType
  mcrObjectIdentity
  mcrModuleIdentity
  mcrNotificationType
  mcrTrapType
  mcrObjectGroup
  mcrNotificationGroup
  mcrCompliance
  mcrCapabilities
End Enum

Default Value

1

Remarks

The following are the possible values for NodeType:

This property is read-only.

NodeTypeString Property (MibBrowser Component)

The node type of the selected node in text format.

Syntax

• C#
• VB.NET

public string NodeTypeString { get; }

Public ReadOnly Property NodeTypeString As String

Default Value

"OBJECT IDENTITY"

Remarks

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

This property is read-only.

Config Method (MibBrowser Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);

Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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.

ListChildren Method (MibBrowser Component)

Lists the immediate children of the selected node.

Syntax

• C#
• VB.NET

public void ListChildren();

Async Version
public async Task ListChildren();
public async Task ListChildren(CancellationToken cancellationToken);

Public Sub ListChildren()

Async Version
Public Sub ListChildren() As Task
Public Sub ListChildren(cancellationToken As CancellationToken) As Task

Remarks

The MibNode 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 MibNode 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

ListSuccessors Method (MibBrowser Component)

Lists all successors of the selected node.

Syntax

• C#
• VB.NET

public void ListSuccessors();

Async Version
public async Task ListSuccessors();
public async Task ListSuccessors(CancellationToken cancellationToken);

Public Sub ListSuccessors()

Async Version
Public Sub ListSuccessors() As Task
Public Sub ListSuccessors(cancellationToken As CancellationToken) As Task

Remarks

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

ListTraps Method (MibBrowser Component)

Lists all the traps defined in the loaded modules.

Syntax

• C#
• VB.NET

public void ListTraps();

Async Version
public async Task ListTraps();
public async Task ListTraps(CancellationToken cancellationToken);

Public Sub ListTraps()

Async Version
Public Sub ListTraps() As Task
Public Sub ListTraps(cancellationToken As CancellationToken) As Task

Remarks

The TrapNode 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 TrapNode event: coldStart 0 snmp warmStart 1 snmp linkDown 2 snmp linkUp 3 snmp authenticationFailure 4 snmp

LoadMib Method (MibBrowser Component)

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

Syntax

• C#
• VB.NET

public void LoadMib(string fileName);

Async Version
public async Task LoadMib(string fileName);
public async Task LoadMib(string fileName, CancellationToken cancellationToken);

Public Sub LoadMib(ByVal FileName As String)

Async Version
Public Sub LoadMib(ByVal FileName As String) As Task
Public Sub LoadMib(ByVal FileName As String, cancellationToken As CancellationToken) As Task

Remarks

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

Some MIB modules contain references to other modules within their imports sections. When loading a MIB that contains external imports, the ImportSymbols 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 component to attempt to find and load any external references included in the current MIB. The component will only find external modules if they reside in the same directory as the current module. Alternatively, the component can load additional modules by calling LoadMib while inside the ImportSymbols event.

If the AutoLoadMibs config setting is set to False, and no explicit action is taken to load necessary modules inside the ImportSymbols 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 component 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 (MibBrowser Component)

Reset all properties of the component.

Syntax

• C#
• VB.NET

public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);

Public Sub Reset()

Async Version
Public Sub Reset() As Task
Public Sub Reset(cancellationToken As CancellationToken) As Task

Remarks

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

SelectNode Method (MibBrowser Component)

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

Syntax

• C#
• VB.NET

public void SelectNode(string selector);

Async Version
public async Task SelectNode(string selector);
public async Task SelectNode(string selector, CancellationToken cancellationToken);

Public Sub SelectNode(ByVal Selector As String)

Async Version
Public Sub SelectNode(ByVal Selector As String) As Task
Public Sub SelectNode(ByVal Selector As String, cancellationToken As CancellationToken) As Task

Remarks

SelectNode 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 component will operate on the selected node. For example, calling ListSuccessors will only list the successors of the selected node.

Error Event (MibBrowser Component)

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

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, MibBrowserErrorEventArgs e);

public class MibBrowserErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As MibBrowserErrorEventArgs)

Public Class MibBrowserErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

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.

ImportSymbols Event (MibBrowser Component)

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

Syntax

• C#
• VB.NET

public event OnImportSymbolsHandler OnImportSymbols;

public delegate void OnImportSymbolsHandler(object sender, MibBrowserImportSymbolsEventArgs e);

public class MibBrowserImportSymbolsEventArgs : EventArgs {
  public string Symbols { get; }
  public string ModuleName { get; }
}

Public Event OnImportSymbols As OnImportSymbolsHandler

Public Delegate Sub OnImportSymbolsHandler(sender As Object, e As MibBrowserImportSymbolsEventArgs)

Public Class MibBrowserImportSymbolsEventArgs Inherits EventArgs
  Public ReadOnly Property Symbols As String
  Public ReadOnly Property ModuleName As String
End Class

Remarks

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

The module is loaded through the LoadMib method.

MibNode Event (MibBrowser Component)

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

Syntax

• C#
• VB.NET

public event OnMibNodeHandler OnMibNode;

public delegate void OnMibNodeHandler(object sender, MibBrowserMibNodeEventArgs e);

public class MibBrowserMibNodeEventArgs : EventArgs {
  public string NodeLabel { get; }
  public string NodeOid { get; }
  public int NodeType { get; }
  public string NodeTypeString { get; }
  public int NodeSyntax { get; }
  public string NodeSyntaxString { get; }
  public int NodeAccess { get; }
  public string NodeIndex { get; }
  public string NodeParentName { get; }
  public string NodeDescription { get; }
  public string NodeModuleName { get; }
  public string NodeFileName { get; }
}

Public Event OnMibNode As OnMibNodeHandler

Public Delegate Sub OnMibNodeHandler(sender As Object, e As MibBrowserMibNodeEventArgs)

Public Class MibBrowserMibNodeEventArgs Inherits EventArgs
  Public ReadOnly Property NodeLabel As String
  Public ReadOnly Property NodeOid As String
  Public ReadOnly Property NodeType As Integer
  Public ReadOnly Property NodeTypeString As String
  Public ReadOnly Property NodeSyntax As Integer
  Public ReadOnly Property NodeSyntaxString As String
  Public ReadOnly Property NodeAccess As Integer
  Public ReadOnly Property NodeIndex As String
  Public ReadOnly Property NodeParentName As String
  Public ReadOnly Property NodeDescription As String
  Public ReadOnly Property NodeModuleName As String
  Public ReadOnly Property NodeFileName As String
End Class

Remarks

When calling either ListChildren or ListSuccessors, the MibNode event will fire once for every child of the currently selected node. The ListChildren method will cause the event will fire once for each of the immediate children of the current node. ListSuccessors 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 component 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

TrapNode Event (MibBrowser Component)

Lists module trap information.

Syntax

• C#
• VB.NET

public event OnTrapNodeHandler OnTrapNode;

public delegate void OnTrapNodeHandler(object sender, MibBrowserTrapNodeEventArgs e);

public class MibBrowserTrapNodeEventArgs : EventArgs {
  public string TrapName { get; }
  public int SpecificTrap { get; }
  public string TrapEnterprise { get; }
  public string TrapVariables { get; }
  public string TrapDescription { get; }
  public string TrapReferences { get; }
  public string TrapModuleName { get; }
  public string TrapFileName { get; }
}

Public Event OnTrapNode As OnTrapNodeHandler

Public Delegate Sub OnTrapNodeHandler(sender As Object, e As MibBrowserTrapNodeEventArgs)

Public Class MibBrowserTrapNodeEventArgs Inherits EventArgs
  Public ReadOnly Property TrapName As String
  Public ReadOnly Property SpecificTrap As Integer
  Public ReadOnly Property TrapEnterprise As String
  Public ReadOnly Property TrapVariables As String
  Public ReadOnly Property TrapDescription As String
  Public ReadOnly Property TrapReferences As String
  Public ReadOnly Property TrapModuleName As String
  Public ReadOnly Property TrapFileName As String
End Class

Remarks

When calling ListTraps, the TrapNode 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.

Config Settings (MibBrowser Component)

MibBrowser Config Settings

Base Config Settings

Trappable Errors (MibBrowser Component)

MibBrowser Errors