# SNMP Monitoring

[Domotz](https://www.domotz.com) provides extensive and robust monitoring capabilities for Simple Network Management Protocol (SNMP v1,v2,v3).

**Note**: If you are not familiar with the SNMP protocol, here is a [blog post](https://blog.domotz.com/how-snmp-works-what-is-snmp/) to help get you started.

## SNMP Discovery Lifecycle

After discovering a new device, Domotz promptly verifies if SNMP is enabled on the device. If SNMP is found to be enabled, Domotz attempts to determine if it can read information from the device by utilizing the v2 default community strings (public/private).

If you have set up custom credentials in your device, you might configure Domotz to use them as explained [here](https://help.domotz.com/tips-tricks/how-to-set-custom-snmp-credentials-in-domotz/).

Once Domotz is able to read data from and SNMP service it automatically sets the SNMP Status of the device to 'READ' (see the green label in the following screenshot):

Navigating the SNMP Monitoring Section

1. Identify the device information at the top, including the Netgear model M4250-5 and the online status with IP address 192.168.40.45.
2. Ensure all services are unlocked, indicated by a lock icon and a message.
3. Click the "SNMP" tab to access the SNMP Monitoring section.
4. Notice the status indicator showing "READ" in green, confirming SNMP monitoring is active.
5. Review additional settings such as Authentication set to V2, Agent's Sample Time at 15 minutes, and Metrics Consumption at 0. Adjust these settings as needed for monitoring.

and starts an automatic scan on the SNMP service in order to discover which MIBs it supports and if there are any [SNMP templates](https://help.domotz.com/monitoring-management/pre-configured-snmp-sensors/)available for that specific device.

Any SNMP Template which is discovered to be usable for that specific device, will be listed under the SNMP Status section:

Accessing SNMP Monitoring for a Netgear Device

1. Navigate to the top panel and locate the button labeled "SNMP" in the main menu.
2. Click on "SNMP" to access the SNMP Monitoring section.
3. Review the status information: Status shows "READ," Authentication is "V2," Agent’s Sample Time is "15 Minutes," and Metrics Consumption is "0."
4. In the "Select the metrics that you would start monitoring" section, choose from available metrics.
5. Available options include "Network System Uptime" with 1 metric, "Network Traffic (Extended)" with 12 metrics, and "Network Traffic" with 8 metrics.
6. For custom options, select "Custom SNMP OID Sensors."

Use these steps to configure and monitor your network system metrics effectively.

### Search SNMP Capable Devices

In order to see which devices are SNMP capable and have SNMP in read status you may check in your inventory dashboard, by filtering the Insights column by selecting the SNMP Management property:

Accessing SNMP Management Insights Filter

1. Navigate to the "Devices" tab at the top of the inventory page to view a list of devices.

2. In the "Insights" column, click on the "SNMP Management" filter to open filter options.

3. In the drop-down menu, ensure the "SNMP Management" box is checked under "Services" to apply the filter. This will display devices with SNMP Management insights.

After filtering it, you will be able to see which devices are SNMP capable and in READ status (without the lock icon on the SNMP Management label), and which devices are SNMP capable but they are not in READ status and should be investigated (with the lock icon before the SNMP Management label):

Inventory Management in a Device Dashboard

1. Navigate to the "Devices" section in the inventory dashboard.
2. Use the search bar to filter devices by entering "netgear."
3. The table displays columns for Site, Device Name, Insights, and Sensors.
4. Under "Device Name," specific devices like "Netgear-M4250-3" and "Netgear-M4250-4" are listed.
5. In the "Insights" column, identify devices showing "SNMP Management" with a green label, indicating they are successfully in read status.
6. Devices marked red indicate they are capable but not currently in a read status.
7. Utilize the "Sensors" column for actions such as adding pre-configured SNMP sensors.

## **SNMP Status** Explained

SNMP status is shown in the Device details view. At each point in the process, you can edit the authentication configuration or force a new retry.

### **Status “Checking”**

The status will show as checking, for a newly discovered device. The same status will be displayed when selecting “Retry now”.

SNMP Monitoring Settings Panel

1. Navigate to the "SNMP" tab in the menu bar at the top of the screen.
2. The "SNMP Monitoring" section is displayed.
3. The "Status" field shows "Checking," indicating the current state of SNMP monitoring.
4. The "Authentication" method is set to "V2."
5. The "Sensors Sample Time" is set to "30 Minutes," allowing for periodic sensor data collection.

Use these settings to configure and monitor SNMP communication and data collection. Adjust "Authentication" or "Sensors Sample Time" as needed by selecting the respective options.

### **Status “READ”**

The status “READ” is displayed when Domotz is allowed to read SNMP data from the device, using either the default communities (in case of SNMP v1, v2) or the user-defined authentication configuration (for SNMP v1, v2, v3).

SNMP Monitoring Configuration Panel

1. Navigate to the "SNMP" tab in the main navigation menu.
2. To edit settings, click "Edit SNMP Authentication."
3. Use "Retry now" to attempt re-authentication if needed.
4. Under "Status," ensure it displays "READ" for active monitoring.
5. "Authentication" shows the protocol version in use, such as "V2."
6. "Sensors Sample Time" reflects the current sampling interval, e.g., "30 Minutes." Adjust if needed by selecting the option.

### **SNMP Status “Service not found”**

The status, “Service not found” is displayed if the Agent detects that the required UDP port 161 is closed:

SNMP Monitoring Error Notification

1. The "SNMP Monitoring" section displays a notification about the absence of SNMP service on the device.
2. The error message mentions potential causes: device not supporting SNMP, device configuration issues, or network problems. It notes the last status change occurred 8 hours ago.
3. Options to address the issue are provided: "Edit SNMP Authentication" and "Retry now".
4. Additional details include the status labeled as "NOT FOUND", authentication set to "V2", and sensors sample time listed as "30 Minutes".

**_How to fix:_**

- enter the configuration of your device and enable the SNMP Service
- Depending on the device, sometimes the SNMP Service requires additional configuration, for example you have to allow the IP of the Domotz Collector/Agent to read from that service.

### **Status “Unable to read from SNMP service”**

This status is displayed when the UDP port 161 is opened but the agent is not capable of retrieving data using the current authentication configuration.

Error Message Regarding SNMP Data Retrieval Failure

1. The page shows an alert titled "Domotz cannot fetch SNMP data on this device," indicating a failure to retrieve SNMP data despite the service being present.
2. The alert suggests verifying the SNMP Authentication Credentials or Community Strings and ensuring there are no network connectivity issues.
3. The last status change occurred 8 hours ago.
4. Links labeled "Edit SNMP Authentication" and "Retry now" are available for corrective actions.
5. Below the alert, the status reads "NOT READABLE," and the authentication is set to "V2."
6. The sensors sample time is shown as "30 Minutes."

**_How to fix:_**

- Enter the configuration of your device and check of the authentication credentials as well as SNMP version which has been enabled.
- Click on 'Edit SNMP Authentication' and modify them accordingly
- Depending on the device, sometimes the SNMP Service requires additional configuration, for example you have to allow the IP of the Domotz Collector/Agent to read from that service.

## SNMP Templates

With Domotz Pre-configured SNMP templates you can perform SNMP monitoring with a single click.

We do provide many templates for the following device types:

- Network Appliances (Switches, Routers, Wi-Fi APs, Firewalls)
- Servers and Servers Boards
- Printers
- UPS
- NAS
- and so much more..

For a complete list of the current available templates please see [here](https://help.domotz.com/monitoring-management/pre-configured-snmp-sensors/).

Please note that we also offer ad-hoc SNMP templates upon request. [Contact our Support team](mailto:support@domotz.com) if you need an SNMP template for a specific SNMP-capable device.  

## Monitoring specific SNMP OIDs

Domotz includes a very easy way to use MIB Browser that allows you to search amongst the MIBs which are supported on your device.
By clicking on the **+** button right next to the "Add SNMP Sensors" label,

SNMP Monitoring Interface Overview

1. Ensure the device is online, as indicated by the green "online" status next to the device name “Netgear-M4250-3.”
2. Navigate to the "SNMP" tab within the interface header section.
3. To add SNMP sensors, click the "+ Add SNMP Sensors" option. Choose a pre-configured template or define a custom OID sensor.
4. Review the "Network Traffic Table" for detailed status:
   - Check the "Interface" column for port information (e.g., Slot 0 Port: 1 Gig).
   - View "Operational Status" indicators, with "up" for active and "down" for inactive ports.
   - Monitor data under "Speed" and traffic columns such as "Inbound Traffic" and "Outbound Traffic" showing measurements like 100 Mb/s.
5. For further analysis, download the table data as a CSV file using the "Download CSV" link.

the Domotz MIB Browser will open up allowing you to search for any keyword that could match what you would like to monitor, and it will provide results listed by MIB's provenance:

Monitoring SNMP Objects by Adding Sensors

1. Enter "firmware" into the keyword search field to find relevant SNMP Object Identifiers.
2. Review the results under the "LLDP-EXT-MED-MIB" section.
   - "lldpXMedLocFirmwareRev" is a scalar type. Select the "+" button to add this scalar sensor.
   - "lldpXMedRemInventoryTable" is a table type. Select the ">" button to explore and configure this table sensor.
3. Check the "ENTITY-MIB" section for "entPhysicalTable," which provides information per physical entity. This is useful for detailed physical monitoring.

This interface is really useful because you will be able to preview the output of a single oid before applying it to the device, by clicking the "More.." link:

Monitoring SNMP Objects by Adding Sensors

1. To manually define an SNMP sensor, begin by clicking "Manually define an SNMP Sensor" to provide the object’s identifier.

2. Use the search bar to locate specific SNMP objects.

3. For the object "snmpEngineBoots" with identifier "1.3.6.1.6.3.10.2.1.2," understand that it tracks the number of times the SNMP engine has (re-)initialized since its last configuration. Click "More..." for additional details.

4. For each SNMP object, click the plus icon to add a sensor to monitor that specific metric.

5. Repeat these steps for other SNMP objects such as "snmpEngineTime" and "snmpTargetSpinLock" to track their respective metrics.

Monitor SNMP Objects by Adding Sensors

1. Open the dialog titled "Monitor SNMP objects by adding Sensors on them."
2. Select "Manually define an SNMP Sensor" to input an object's identifier and create a sensor.
3. In the list of SNMP objects, locate "snmpEngineBoots" with OID 1.3.6.1.6.3.10.2.1.2. This represents the number of times the SNMP engine has reinitialized since the snmpEngineID was last configured.
4. Note the "Retrieved Data: 7," indicating the current count of reinitializations.
5. To perform further actions, use the plus icon next to the object names like "snmpEngineTime" and "snmpEngineMaxMessageSize" to expand options or data collection for other SNMP parameters.

### Setup Alerts on Manually Added SNMP Sensors

You can configure alerts on the SNMP sensors you have created from the Alerts section of the device:

Setting Up Personal Alerts in the Software

1. Navigate to the "Alerts" tab in the main menu.
2. Select "Personal Alerts" under the alerts category.
3. Choose the alert mode: "Standard," "Custom," or "No Alerts." Ensure "Custom" is selected by default.
4. Under "Device Status Events," there are four types of alerts: "Device Goes Up," "Device Goes Down," "Heartbeat Lost," and "IP Change." Each event has options to enable alerts via "Mobile" or "Email."
5. In both "TCP Services" and "SNMP Sensors" sections, note that no services or SNMP alerts are currently configured.
6. To manage or configure alerts, click "Manage TCP services" or "Configure an SNMP alert" respectively.

Domotz will ask you to choose one of the sensors you have already created (and it will also prompt you to create a new one if desired):

Options for Choosing or Creating a Sensor

1. Select a predefined sensor by choosing between "Black Toner - Maximum level" or "prtMarkerSuppliesLevel."
2. To create a new SNMP sensor, click "Create Sensor."
3. If you wish to exit, click "Cancel."

After choosing a sensor, you will be able to configure the alert. Assign a Name, Condition, and the Communication Channel for the alert:

Alert Configuration Setup

1. Enter an alert name in the "Alert Name" field, such as "Example: battery level."
2. Choose the alert condition under "Alert Behaviour" by selecting one of the options:
   - is equal to
   - is greater than
   - is greater than or equal to
   - is less than
   - is less than or equal to
   - is included in range
3. Specify how you want to be notified in the "Communication Channel" section. Options include:
   - Mobile
   - Email
4. Click the "Add Alert" button to save the configuration.

And, finally, the alert is configured:

SNMP Sensors Alert Configuration

1. The alert indicates that black ink levels are below 30%, described as "Black Toner - Maximum level is less than '30'."
2. There is a red cross symbol indicating a problem with the ink level.
3. A green checkmark beside the alert description may indicate the alert is acknowledged or resolved.
4. A button labeled "Configure an SNMP alert" allows you to set up or modify the alert settings related to this sensor.

Learn more about [SNMP and TCP usage and sampling configuration](https://help.domotz.com/tips-tricks/domotz-metrics/).

## Other uses of SNMP within Domotz

SNMP is a powerful protocol. It is also used by Domotz to implement [Network mapping algorithms](https://help.domotz.com/knowledge-base/network-topology/), [PoE management](https://help.domotz.com/user-guide/managed-switches-and-poe/) as well as Network Interface Monitoring. Please refer to the respective sections for more details.