Skip to content

Commit 961bb60

Browse files
authored
Merge pull request #223487 from Shereen-Bhar/refresh-SNMP-MIB-monitoring-page
refresh SNMP MIB monitoring page
2 parents f69c7ac + 1fbcfb3 commit 961bb60

File tree

2 files changed

+65
-37
lines changed

2 files changed

+65
-37
lines changed
Lines changed: 65 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,82 @@
11
---
22
title: Set up SNMP MIB monitoring
3-
description: You can perform sensor health monitoring by using SNMP. The sensor responds to SNMP queries sent from an authorized monitoring server.
3+
description: Perform sensor health monitoring by using SNMP. The sensor responds to SNMP queries sent from an authorized monitoring server.
44
ms.date: 05/31/2022
55
ms.topic: how-to
66
---
77

88
# Set up SNMP MIB monitoring
99

10-
Monitoring sensor health is possible through the Simple Network Management Protocol (SNMP). The sensor responds to SNMP requests sent by an authorized monitoring server. The SNMP monitor polls sensor OIDs periodically (up to 50 times a second).
10+
Monitor sensor health through the Simple Network Management Protocol (SNMP), as the sensor responds to SNMP requests sent by an authorized monitoring server, and the SNMP monitor polls sensor OIDs periodically (up to 50 times a second).
1111

1212
Supported SNMP versions are SNMP version 2 and version 3. The SNMP protocol utilizes UDP as its transport protocol with port 161.
1313

14+
## Prerequisites
15+
16+
- To set up SNMP monitoring, you must be able to access the OT network sensor as an **Admin** user.
17+
18+
For more information, see [On-premises users and roles for OT monitoring with Defender for IoT](roles-on-premises.md).
19+
20+
- To download the SNMP MIB file, make sure you can access the Azure portal as a [Security admin](/azure/role-based-access-control/built-in-roles#security-admin), [Contributor](/azure/role-based-access-control/built-in-roles#contributor), or [Owner](/azure/role-based-access-control/built-in-roles#owner) user.
21+
22+
If you don't already have an Azure account, you can [create your free Azure account today](https://azure.microsoft.com/free/).
23+
24+
### Prerequisites for AES and 3-DES Encryption Support for SNMP Version 3
25+
26+
- The network management station (NMS) must support Simple Network Management Protocol (SNMP) Version 3 to be able to use this feature.
27+
28+
- It's important to understand the SNMP architecture and the terminology of the architecture to understand the security model used and how the security model interacts with the other subsystems in the architecture.
29+
30+
- Before you begin configuring SNMP monitoring, you need to open the port UDP 161 in the firewall.
31+
32+
## Set up SNMP monitoring
33+
34+
Set up SNMP monitoring through the OT sensor console.
35+
36+
You can also download the log that contains all the SNMP queries that the sensor receives, including the connection data and raw data, from the same **SNMP MIB monitoring configuration** pane.
37+
38+
To set up SNMP monitoring:
39+
40+
1. Sign in to your OT sensor as an **Admin** user.
41+
1. Select **System Settings** on the left and then, under **Sensor Management**, select **SNMP MIB Monitoring**.
42+
1. Select **+ Add host** and enter the IP address of the server that performs the system health monitoring. You can add multiple servers.
43+
44+
For example:
45+
46+
:::image type="content" source="media/configure-active-monitoring/set-up-snmp-mib-monitoring.png" alt-text="Screenshot of the SNMP MIB monitoring configuration page." lightbox="media/configure-active-monitoring/set-up-snmp-mib-monitoring.png":::
47+
48+
1. In the **Authentication** section, select the SNMP version:
49+
- If you select **V2**, type a string in **SNMP v2 Community String**.
50+
51+
You can enter up to 32 characters, and include any combination of alphanumeric characters with no spaces.
52+
53+
- If you select **V3**, specify the following parameters:
54+
55+
| Parameter | Description |
56+
|--|--|
57+
| **Username** | Enter a unique username. <br><br> The SNMP username can contain up to 32 characters and include any combination of alphanumeric characters with no spaces. <br><br> The username for the SNMP v3 authentication must be configured on the system and on the SNMP server. |
58+
| **Password** | Enter a case-sensitive authentication password. <br><br> The authentication password can contain 8 to 12 characters and include any combination of alphanumeric characters. <br><br> The password for the SNMP v3 authentication must be configured on the system and on the SNMP server. |
59+
| **Auth Type** | Select **MD5** or **SHA-1**. |
60+
| **Encryption** | Select one of the following: <br>- **DES** (56-bit key size): RFC3414 User-based Security Model (USM) for version 3 of the Simple Network Management Protocol (SNMPv3). <br>- **AES** (AES 128 bits supported): RFC3826 The Advanced Encryption Standard (AES) Cipher Algorithm in the SNMP User-based Security Model. |
61+
| **Secret Key** | The key must contain exactly eight characters and include any combination of alphanumeric characters. |
62+
63+
64+
65+
1. When you're done adding servers, select **Save**.
66+
1467
## Download the SNMP MIB file
1568

16-
Download the SNMP MIB file from Defender for IoT in the Azure portal. Select **Sites and sensors > More actions > Download SNMP MIB file**.
69+
To download the SNMP MIB file from Defender for IoT in the Azure portal:
1770

18-
[!INCLUDE [root-of-trust](includes/root-of-trust.md)]
71+
1. Sign in to the Azure portal.
72+
1. Select **Sites and sensors > More actions > Download SNMP MIB file**.
1973

74+
[!INCLUDE [root-of-trust](includes/root-of-trust.md)]
2075

2176
## Sensor OIDs
2277

78+
Use the following table for reference regarding sensor object identifier values (OIDs):
79+
2380
| Management console and sensor | OID | Format | Description |
2481
|--|--|--|--|
2582
| Appliance name | 1.3.6.1.2.1.1.5.0 | STRING | Appliance name for the on-premises management console |
@@ -28,47 +85,18 @@ Download the SNMP MIB file from Defender for IoT in the Azure portal. Select **S
2885
| Serial number | 1.3.6.1.4.1.53313.1 |STRING | String that the license uses |
2986
| Software version | 1.3.6.1.4.1.53313.2 | STRING | Xsense full-version string and management full-version string |
3087
| CPU usage | 1.3.6.1.4.1.53313.3.1 | GAUGE32 | Indication for zero to 100 |
31-
| CPU temperature | 1.3.6.1.4.1.53313.3.2 | STRING | Celsius indication for zero to 100 based on Linux input. "No sensors found" will be returned from any machine that has no actual physical temperature sensor (for example VMs)|
88+
| CPU temperature | 1.3.6.1.4.1.53313.3.2 | STRING | Celsius indication for zero to 100 based on Linux input. <br><br> Any machine that has no actual physical temperature sensor (for example VMs) will return "No sensors found" |
3289
| Memory usage | 1.3.6.1.4.1.53313.3.3 | GAUGE32 | Indication for zero to 100 |
3390
| Disk Usage | 1.3.6.1.4.1.53313.3.4 | GAUGE32 | Indication for zero to 100 |
3491
| Service Status | 1.3.6.1.4.1.53313.5 |STRING | Online or offline if one of the four crucial components is down |
3592
| Locally/cloud connected | 1.3.6.1.4.1.53313.6 |STRING | Activation mode of this appliance: Cloud Connected / Locally Connected |
3693
| License status | 1.3.6.1.4.1.53313.7 |STRING | Activation period of this appliance: Active / Expiration Date / Expired |
3794

3895
Note that:
39-
- Non-existing keys respond with null, HTTP 200.
40-
- Hardware-related MIBs (CPU usage, CPU temperature, memory usage, disk usage) should be tested on all architectures and physical sensors. CPU temperature on virtual machines is expected to be not applicable.
41-
- You can download the log that contains all the SNMP queries that the sensor receives, including the connection data and raw data.
4296

43-
## Prerequisites for AES and 3-DES Encryption Support for SNMP Version 3
44-
- The network management station (NMS) must support Simple Network Management Protocol (SNMP) Version 3 to be able to use this feature.
45-
- It's important to understand the SNMP architecture and the terminology of the architecture to understand the security model used and how the security model interacts with the other subsystems in the architecture.
46-
- Before you begin configuring SNMP monitoring, you need to open the port UDP 161 in the firewall.
47-
48-
49-
## Set up SNMP monitoring
50-
51-
1. On the side menu, select **System Settings**.
52-
1. Expand **Sensor Management**, and select **SNMP MIB Monitoring** :
53-
1. Select **Add host** and enter the IP address of the server that performs the system health monitoring. You can add multiple servers.
54-
1. In **Authentication** section, select the SNMP version.
55-
- If you select V2, type the string in **SNMP v2 Community String**. You can enter up to 32 characters, and include any combination of alphanumeric characters (uppercase letters, lowercase letters, and numbers). Spaces aren't allowed.
56-
- If you select V3, specify the following:
57-
58-
| Parameter | Description |
59-
|--|--|
60-
| **Username** | The SNMP username can contain up to 32 characters and include any combination of alphanumeric characters (uppercase letters, lowercase letters, and numbers). Spaces aren't allowed. <br /> <br />The username for the SNMP v3 authentication must be configured on the system and on the SNMP server. |
61-
| **Password** | Enter a case-sensitive authentication password. The authentication password can contain 8 to 12 characters and include any combination of alphanumeric characters (uppercase letters, lowercase letters, and numbers). <br /> <br/>The username for the SNMP v3 authentication must be configured on the system and on the SNMP server. |
62-
| **Auth Type** | Select MD5 or SHA-1. |
63-
| **Encryption** | Select DES (56 bit key size)<sup>[1](#1)</sup> or AES (AES 128 bits supported)<sup>[2](#2)</sup>. |
64-
| **Secret Key** | The key must contain exactly eight characters and include any combination of alphanumeric characters (uppercase letters, lowercase letters, and numbers). |
65-
66-
<a name="1"></a><sup>1</sup> RFC3414 User-based Security Model (USM) for version 3 of the Simple Network Management Protocol (SNMPv3)
67-
68-
<a name="2"></a><sup>2</sup> RFC3826 The Advanced Encryption Standard (AES) Cipher Algorithm in the SNMP User-based Security Model
69-
70-
1. Select **Save**.
97+
- Non-existing keys respond with null, HTTP 200.
98+
- Hardware-related MIBs (CPU usage, CPU temperature, memory usage, disk usage) should be tested on all architectures and physical sensors. CPU temperature on virtual machines is expected to be not applicable.
7199

72100
## Next steps
73101

74-
For more information, see [Export troubleshooting logs](how-to-troubleshoot-the-sensor-and-on-premises-management-console.md).
102+
For more information, see [Export troubleshooting logs](how-to-troubleshoot-the-sensor-and-on-premises-management-console.md)
142 KB
Loading

0 commit comments

Comments
 (0)