User Guide: SNMP plug-in version 2.8.1 for VST-APL

Device List




Device List

This page lists all devices stored in the SNMP Plug-in's database.


Table 1: Device Search
Item Name Description
Number of items displayed on the page Lets you select a number of devices displayed on a single page.
"Create" button Lets you add a new device to monitor.

Copy to Clipboard
Copies the device list (name, status, network address, MAC address, vendor name, model name and comment) to clipboard as a tab-delimited text.
It is useful when you want to copy a list to your text editor.
You can filter target subnets with "Search" box. "Number of items on the page" and the current page do not affect an output.

Export to CSV file
Exports the device list (name, status, network address, MAC address, vendor name, model name and comment) to a CSV file.
You can filter target subnets with "Search" box. "Number of items on the page" and the current page do not affect an output.

Export to Excel
Exports the device list (name, status, network address, MAC address, vendor name, model name and comment) to an Excel book file (.xlsx for Microsoft Excel 2007 or later).
You can filter target subnets with "Search" box. "Number of items on the page" and the current page do not affect an output.

Print
Shows the device list (name, status, network address, MAC address, vendor name, model name and comment) on another browser window or tab and opens a print dialog box.
You can filter target subnets with "Search" box. "Number of items on the page" and the current page do not affect an output.
Search field Lets you filter target subnets by keywords.
The search ignores case. "." and "/" in the search keywords do not match them in the network address ("." and "/" in "192.168.1.0/24").
Subnet Name Shows the device name.
Status Shows the status of ping test from the SNMP Plug-in to the device.
Network Address Shows a subnet address block by an IPv4 address and a prefix length (xxx.xxx.xxx.xxx/xx format).
MAC Address Shows the device MAC address.
Vendor Name Shows the vendor name of the device.
Model Name Shows the model information (SysObjectID).
Notes Shows a comment configured for the device.
"Edit" button Open the Edit Device page for the device.
"Details" button Open the Device Details page for the device.
"Delete" button The Delete Device dialog is displayed.
Click the "Yes" button to delete the device. Click the "No" button or the "Close (x)" button at the top left of the dialog to return to the Device List.
Displayed Range Currently displayed range of the list is shown as "From Xth to Yth out of Z items".
Page Navigation
Lets you view a specific page of the list.
  • First
    The first page is displayed.
  • Previous
    Displays the page immediately before the current display page.
  • Page Number
    Click the number to display the corresponding page. The currently displayed page is highlighted with a gray button background.
  • Next
    Displays the next page after the currently displayed page.
  • Last
    Display the final page.


Device

Create devices, view details, and change settings.

Device Details

You can open the Device Details page by selecting a device on the Tree View and clicking a device name in the node attributes section on the Device Tree View page.
The "Device Details page shows its attributes and an event list.


Node Attributes


Table 2: Node Attributes
Item Name Contents
"Gear" icon
Clicking "Gear" icon shows the operation submenu for the device.
  • MIB Monitor:
    The MIB Monitor that you want to monitor by selecting the device's MIB Variable is displayed to the right of Node Attribute.

  • Refresh:
    Refresh the information on the Device Details page.

  • Clear Notification Flags:
    This menu item is not supported.

  • Go to the Device's Management Page:
    This menu item is not supported.
Subnet Name Shows a name of the device.
Hostname Shows the hostname of the device.
Network Address IPv4 address and prefix length (xxx.xxx.xxx.xxx/xx format)
MAC Address Shows the device MAC address.
Vendor Name Shows the vendor name of the device.
Model Name Shows the model information (SysObjectID).
Community Name (Get) The community name used to retrieve information from the device via SNMP.
Community Name (Set) The community name used to write information to the device via SNMP.
Status The response status of the device to Ping sent from the SNMP plug-in.
Edit Click to open the Edit Device page for that device.
Delete Click to open the Delete Device dialog.
Click the "Yes" button to delete the device. Click the "No" button or the "Close (x)" button at the top left of the dialog to return to the Device Details.

MIB Monitor

Get the information for the device and select the individual MIB node to display the information.
In addition to the standard MIB specified by RFC and the private MIB of our product, the MIB compiled by the MIB Compiler from the obtained MIB file can be selected from the MIB tree and added to the list.


Table 3: MIB Monitor
Item Name Contents
Number of items displayed on the page Lets you select a number of devices displayed on a single page.
Search field Lets you filter target subnets by keywords.
The search ignores case. "." and "/" in the search keywords do not match them in the network address ("." and "/" in "192.168.1.0/24").
"Select All" button Select all the MIB Variables you have added to the MIB monitor.
"Clear All" button Deselect the MIB Variable you added to the MIB Monitor.
"Add" button Display the MIB Browser dialog and select the MIB Variable to display on the MIB Monitor.
"Delete" button Deletes the selected MIB Variable from the MIB Monitor.
Copy to Clipboard Saves the device's MIB Variable, MIB Value, and Units added to the MIB monitor to the clipboard in tab-delimited text format.
It is useful when you want to copy a list to your text editor.
You can filter target subnets with "Search" box. "Number of items on the page" and the current page do not affect an output.
Export to CSV file Downloads the device's MIB Variable, MIB Value, and Units added to the MIB monitor as CSV (comma-separated values) files.
You can filter target subnets with "Search" box. "Number of items on the page" and the current page do not affect an output.
Export to Excel Downloads the MIB Variable, MIB Value, and Unit of the device added to the MIB monitor as an Excel book file (extension: xlsx, Microsoft Excel 2007 or later).
You can filter target subnets with "Search" box. "Number of items on the page" and the current page do not affect an output.
Print Lists the MIB Variable, MIB Value, and Units of devices added to the MIB monitor in a pop-up window or new tab in your web browser to display the print dialog.
You can filter target subnets with "Search" box. "Number of items on the page" and the current page do not affect an output.
MIB Variable Displays the name of the MIB Variable for the device added to the MIB Monitor by MIB object name and index.
MIB Value Displays the value of the MIB Variable.
Units If the value of the MIB Variable has Units, that Units is displayed.
Displayed Range Currently displayed range of the list is shown as "From Xth to Yth out of Z items".
Page Navigation
Lets you view a specific page of the list.
  • First
    The first page is displayed.
  • Previous
    Displays the page immediately before the current display page.
  • Page Number
    Click the number to display the corresponding page. The currently displayed page is highlighted with a gray button background.
  • Next
    Displays the next page after the currently displayed page.
  • Last
    Display the final page.

◼ MIB Browser
Select the information (MIB Variable) to be displayed in the MIB Monitor from the MIB tree.


Table 4: MIB Browser
Item Name Contents
MIB Tree
Displays MIB nodes according to the tree structure of MIB nodes.
MIB nodes are displayed in the form of "object name (number)".
Nodes that have child nodes that are further subdivided into specific attributes are represented by folder icons, and end nodes that do not have child nodes (leaf nodes) are represented by file icons.
The object ID (OID) of a node is represented by a numeric string consisting of the node numbers from the first node connected by a period. For example, a MIB node that shows system information traverses the hierarchy of the MIB tree as follows: "Iso (1)-> org (3)-> dod (6)-> internet (1)-> mgmt (2)-> mib-2 (1)-> system (1)" As a result, the object ID is represented as "1.3.6.1.2.1.1".
Leaf nodes may have multiple pieces of the same type of information. For example, ifSpeed (OID 1.3.6.1.2.1.2.2.1.5), which indicates the communication speed of an interface, is stored for each Ethernet interface such as a port. The number that identifies the same type of information is called an index.
Only leaf nodes can be selected in the MIB Monitor. You cannot see the value of a node that has child nodes.
Node Name Represents the name of the selected MIB node.
Access
Displays the access right of the corresponding MIB node as either "Read Only (value is set automatically by the system)" or "Read / Write (value can be set by the user)".
Note
You cannot set the value from the SNMP Plug-in's MIB Monitor and MIB Browser.
Status The implementation status of the MIB node in the specifications is displayed as "mandatory" or "optional".
Syntax Displays the data type of the information stored in the MIB node.
Units Displays the unit of value stored in the MIB node.
OID(dot notation) Displays the object ID of the MIB node.
OID(ASN.1 notation) Displays the MIB object name in the form of the root (top) or MIB node name connected by a period.
Module Name Displays the module name that defines the MIB node.
Description Displays a description of the MIB node.
"Cancel" button Stops selecting the MIB object and closes the MIB Browser dialog.
"OK" button
Adds the MIB object selected in the MIB tree.
In the Select Index dialog, select the index of the information stored in the corresponding MIB node.

◼ Select Index
The MIB node selected in the MIB Browser dialog may contain multiple pieces of the same type of information. Of these, select the index of information to display on the MIB Monitor.


Table 5: Select Index
Item Name Contents
Radio Buttons
Select the information to be displayed on the MIB Monitor while checking the MIB Variable and MIB Value.
Only one index can be selected at a time. If you want to display the information stored in multiple indexes on the MIB Monitor, you need to repeat the selection of MIB node and index from the "Add" button of the MIB Monitor.
MIB Variable Displays the selected MIB node name and index connected by a period.
MIB Value Displays the value stored in the corresponding MIB Variable.
"Cancel" button Stops selecting MIB Variables and closes the Select Index dialog.
"OK" button Adds the selected MIB Variable to the MIB Monitor.


Add Device

Select a subnet in the Tree view of the Tree View and select "Create Device" from the gear icon submenu to display the Add Device page.
The Add Device page creates a new device in the subnet under the management of the SNMP plug-in.
Note
When manually adding a device, the MAC address, IPv4 address, and vendor name may not be displayed on the Device list page depending on the model. In that case, perform an Auto Discovery on the target subnet. Depending on the result of the Auto Discovery, the information is displayed.


Table 6: Add Device
Item Name Contents
Subnet Name Select a subnet to which the new device belongs to.
Add Subnet The Create Subnet page is displayed.
Subnet List The Subnet List page is displayed.
Subnet Name Enter the name of the device. You can specify any character string.
Hostname Enter the hostname of the device. You can specify any character string.
Notes Shows a comment configured for the device.
IPv4 address Enter the IPv4 address of the device (for example, 192.168.1.0).
Subnet Mask Enter the subnet mask of the device (for example, 255.255.255.0).
Community Name (Get) Enter the community name used to retrieve information from the device via SNMP.
Community Name (Set) Enter the community name to use when writing information to the device via SNMP.
"Create" button Saves the specified device information as a new device and moves it to theDevice Tree View.

Edit Device

Click "Edit" in "Node Attributes" on the Device Details page to display the Update Device page.
In the Update Subnet page, you can edit the node attributes of the corresponding subnet.


Table 7: Edit Device
Item Name Contents
Subnet Name Enter the name of the device. You can specify any character string.
Hostname Enter the hostname of the device. You can specify any character string.
IPv4 address Enter the IPv4 address of the device (for example, 192.168.1.0).
Subnet Mask Enter the subnet mask of the device (for example, 255.255.255.0).
Community Name (Get) Enter the community name used to retrieve information from the device via SNMP.
Community Name (Set) Enter the community name to use when writing information to the device via SNMP.
"Save" button Save the changes to the settings for that subnet and go to the Device Details page.


03 Nov 2022 14:15