Skip to content

Commit 4fb7d39

Browse files
authored
Merge pull request SkylineCommunications#636 from mariacorrea00/main
Added Generic Trap Processor and Generic Trap Receiver docs
2 parents c72ad57 + 0a28383 commit 4fb7d39

7 files changed

+134
-103
lines changed

connector/doc/Generic_Trap_Processor.md

+20-37
Original file line numberDiff line numberDiff line change
@@ -4,52 +4,35 @@ uid: Connector_help_Generic_Trap_Processor
44

55
# Generic Trap Processor
66

7-
This connector will receive traps on a DMA. It allows you to specify rules that received traps need to match. Traps matching these rules will be logged with information that is generated based on the rule and trap data.
8-
97
## About
108

11-
### Version Info
12-
13-
| Range | Key Features | Based on | System Impact |
14-
|----------------------|------------------|--------------|-------------------|
15-
| 1.0.0.x [SLC Main] | Initial version | - | - |
16-
17-
### Product Info
18-
19-
| Range | Supported Firmware |
20-
|-----------|------------------------|
21-
| 1.0.0.x | N/A |
22-
23-
### System Info
24-
25-
| Range | DCF Integration | Cassandra Compliant | Linked Components | Exported Components |
26-
|-----------|---------------------|-------------------------|-----------------------|-------------------------|
27-
| 1.0.0.x | No | Yes | - | - |
28-
29-
## Configuration
30-
31-
### Connections
32-
33-
#### SNMP Main Connection
9+
The **Generic Trap Processor** is a powerful tool that allows you to define rules for collecting and processing SNMP traps from various sources. With this tool, you can specify which traps to capture, filter, transform, and display via a user-friendly connector. The Generic Trap Processor simplifies the monitoring of the most important system events and ensures appropriate alarm levels are assigned. By enabling the team to control message volume, this tool also helps to prevent alert fatigue.
3410

35-
This connector uses a Simple Network Management Protocol (SNMP) connection and requires the following input during element creation:
11+
![Generic Trap Processor Overview](~/connector/images/GenericTrapProcessor_Overview.png)
3612

37-
SNMP CONNECTION:
13+
> [!TIP]
14+
> For an enhanced experience, explore the complete package, which includes this connector and the low-code app: [Smart Trap Processor Package](https://catalog.dataminer.services/details/0c70b4b6-f687-459f-8cc9-bd1c9025dd50).
3815
39-
- **IP address/host**: The polling IP of the device. For this connector, typically 127.0.0.1 is specified.
16+
## Key Features
4017

41-
## How to Use
18+
- **Flexible processing rules**: Customizable rules that can be tailored to suit any system or device sending SNMP traps.
19+
- **Intelligent analytics**: Integration of intelligence and analytics into data sets that typically lack enhanced monitoring capabilities.
20+
- **Automated alarm generation and clearance**: Automatically generating and clearing DataMiner alarms for incoming traps based on Set and Clear OIDs.
21+
- **Centralized monitoring and configuration**: Configuring processing logic and monitoring all processed traps for an entire DataMiner System via a single, user-friendly connector.
4222

43-
The element created with this connector has the following data pages:
23+
## Use Cases
4424

45-
- **General**: Contains 3 tables:
25+
The Smart Trap Processor tool is invaluable for monitoring infrastructure, benefiting NOC personnel, IT professionals, network administrators, and system engineers.
4626

47-
- **Rules table**: Allows you to add matching rules for received traps. A rule contains two OIDs, Alarm and Clear, and also contains binding filters. This is used to determine if a trap matches the rule. You can define the formats for Unique Entry, Alarm and Clear in this table. These formats contain placeholders that will be replaced with the data from the received trap.
48-
- **Source Name Table**: Allows you to specify rules for the name generation based on the trap information.
49-
- **Source IP Name Table**: Allows you to map IP addresses to names. The element will only log traps if the source IP is included in this table.
27+
Common use cases include:
5028

51-
- **Import Operations**: Allows you to import the rule tables from CSV files. In these files, a semicolon (";") should be used as separator. Importing allows you to easily share and reuse rules.
29+
- Alerting network administrators to critical events like link failures, power outages, and authentication issues by processing traps from routers and switches.
30+
- Notifying users about system-related events such as software crashes, hardware failures, and high resource consumption by processing traps from servers and workstations.
31+
- Notifying on-site personnel of HVAC failures, weather-related events, and other environmental issues by processing traps from environmental sensors.
32+
- Filtering out informational or non-critical traps from sources prone to generating excessive noise.
33+
- Filtering different types of traps from a single source into their own processor, when using a central trap manager to aggregate traps for an entire system. The distinction could be based on factors like location or device type.
5234

53-
- **Processed Message**: Contains a table listing the processed messages. Each entry has a matching rule. The information in the entry is based on the received trap and formatted based on the matching rules.
35+
## Technical info
5436

55-
- **Received Traps**: Displays the Received Traps table, which contains an entry per received trap OID for which no match was found with the current rules. This can help you to determine if a new rule needs to be added.
37+
> [!NOTE]
38+
> For detailed technical information, refer to the [Technical help page](xref:Connector_help_Generic_Trap_Processor_Technical).
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
uid: Connector_help_Generic_Trap_Processor_Technical
3+
---
4+
5+
# Generic Trap Processor
6+
7+
## About
8+
9+
This connector will receive traps on a DMA. It allows you to specify rules that received traps need to match. Traps matching these rules will be logged with information that is generated based on the rule and trap data.
10+
11+
## Configuration
12+
13+
### Connections
14+
15+
#### SNMP Main Connection
16+
17+
This connector uses a Simple Network Management Protocol (SNMP) connection and requires the following input during element creation:
18+
19+
SNMP CONNECTION:
20+
21+
- **IP address/host**: The polling IP of the device. For this connector, typically 127.0.0.1 is specified.
22+
23+
## How to Use
24+
25+
The element created with this connector has the following data pages:
26+
27+
- **General**: Contains several tables and allows you to import from CSV:
28+
29+
- **Rules table**: Allows you to add matching rules for received traps. A rule contains two OIDs, Alarm and Clear, and also contains binding filters. This is used to determine if a trap matches the rule. You can define the formats for Unique Entry, Alarm, and Clear in this table. These formats contain placeholders that will be replaced with the data from the received trap.
30+
- **Source Name Table**: Allows you to specify rules for the name generation based on the trap information.
31+
- **Source IP Name Table**: Allows you to map IP addresses to names. The element will only log traps if the source IP is included in this table.
32+
- **Import Operations**: Allows you to import the rule tables from CSV files. In these files, a semicolon (";") should be used as separator. Importing allows you to easily share and reuse rules.
33+
34+
- **Processed Message**: Contains a table listing the processed messages of type *Regular*. Each entry has a matching rule. The information in the entry is based on the received trap and formatted based on the matching rules.
35+
36+
- **Heartbeat Traps**: Contains a table listing all the processed traps of type *Heartbeat*.
37+
38+
- **Received Traps**: Displays the Received Traps table, which contains an entry per received trap OID for which no match was found with the current rules. This can help you to determine if a new rule needs to be added.
39+
40+
- **Auto Clear**: Contains the auto clear logic for all the processed traps. This includes:
41+
42+
- **Event Cleanup Timer**: Allows you to configure the timespan for the cleanup logic.
43+
- **Maximum Age of Events**: Allows you to select a maximum age of events before these are removed from the tables.
44+
- **Max Processed Messages**: Allows you to configure the maximum number of entries to keep in the Processed Messages Table.

connector/doc/Generic_Trap_Receiver.md

+9-66
Original file line numberDiff line numberDiff line change
@@ -4,76 +4,19 @@ uid: Connector_help_Generic_Trap_Receiver
44

55
# Generic Trap Receiver
66

7-
The Generic Trap Receiver is used to capture and display all the traps for a specific IP address.
8-
97
## About
108

11-
### Version Info
12-
13-
| Range | Key Features | Based on | System Impact |
14-
|--------------------|-------------------------------------------------|----------|---------------|
15-
| 1.0.0.x | Initial version | - | - |
16-
| 1.0.1.x | Display traps in a table. Lookup functionality. | - | - |
17-
| 1.0.2.x [SLC Main] | Display trap bindings in a table. | - | - |
18-
19-
### Product Info
20-
21-
| Range | Supported Firmware |
22-
|-----------|------------------------|
23-
| 1.0.0.x | N/A |
24-
| 1.0.1.x | N/A |
25-
| 1.0.2.x | N/A |
26-
27-
### System Info
28-
29-
| Range | DCF Integration | Cassandra Compliant | Linked Components | Exported Components |
30-
|-----------|---------------------|-------------------------|-----------------------|-------------------------|
31-
| 1.0.0.x | No | No | - | - |
32-
| 1.0.1.x | No | No | - | - |
33-
| 1.0.2.x | No | Yes | - | - |
34-
35-
## Configuration
36-
37-
### Connections
38-
39-
#### SNMP Main Connection
40-
41-
This connector uses a Simple Network Management Protocol (SNMP) connection and requires the following input during element creation:
42-
43-
SNMP CONNECTION:
44-
45-
- **IP address/host**: The polling IP of the device.
46-
47-
SNMP Settings:
48-
49-
- **Port number**: The port of the connection device (default: *161*).
50-
51-
## Usage
52-
53-
### General
54-
55-
To capture traps, specify the IP addresses for which traps should be captured in the **Trap IP Sources** parameter, using a comma as separator. This page will then display an overview of the captured traps with their information (**OID**, **Source IP** and **Bindings**) in the **Traps** table.
56-
57-
If you also want an information event to be created on the DMA every time a trap is received, enable the **Information Events** parameter.
58-
59-
Via the **Auto Clear** page button, you can access settings to clean up the Traps table.
60-
61-
### Lookup Configuration
62-
63-
On this page, you can use the **Lookup Table** to have incoming trap OIDs replaced with an alias name. For this purpose, the parameter **Lookup Table State** must be enabled.
64-
65-
With the **Add Raw Value** parameter, you can add an OID to the lookup table. The **Clear Table** button can be used to delete all the raw values from the lookup table, except for some well-known values.
66-
67-
### Filter Trap
68-
69-
On this page, you can configure traps to be filtered so that certain traps will not be received. Regular expressions are supported.
9+
The **Generic Trap Receiver** is a tool used to capture and display SNMP traps for a specific IP address. The overview of the captured traps will be displayed in the **Traps** table alongside the **Traps Number**, which shows the number of traps in the table. Information like **Source IP**, **Trap OID**, and 20 different **bindings** are available for display for each trap in the Traps table.
7010

71-
### Update Trap
11+
![Generic Trap Receiver Overview](~/connector/images/GenericTrapReceiver_Overview.png)
7212

73-
This page allows you to set up rules so that specific traps can update traps with a specific OID and alarm reference. From version 1.0.1.17 onwards, basic regular expressions using "\*" are supported.
13+
## Key Features
7414

75-
From version 1.0.1.24 onwards, with the **Binding Alarm Index**, you can set up rules that are a combination of columns. To do so, specify a backslash ("\\) followed by a comma-separated list of bindings. Also add a row with the same specific OID to the **Filter Trap** page.
15+
- **Displays Traps**: Displays traps coming from the configurable parameter **Trap IP Sources**.
16+
- **Create Information Events**: If you enable the **Information Events** parameter, an information event will be created on the DMA for every trap received.
17+
- **Lookup Table**: If the **Lookup Table State** parameter is enabled, you can configure incoming trap OIDs and replace them with alias names.
7618

77-
### Heartbeat Trap
19+
## Technical info
7820

79-
This page allows you to set up sending and receiving of heartbeat traps. These traps can be used to test and monitor the DataMiner SNMP forwarding function.
21+
> [!NOTE]
22+
> For detailed technical information, refer to the [Technical help page](xref:Connector_help_Generic_Trap_Receiver_Technical).
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
uid: Connector_help_Generic_Trap_Receiver_Technical
3+
---
4+
5+
# Generic Trap Receiver
6+
7+
## About
8+
9+
The Generic Trap Receiver is used to capture and display all the traps for a specific IP address.
10+
11+
## Configuration
12+
13+
### Connections
14+
15+
#### SNMP Main Connection
16+
17+
This connector uses a Simple Network Management Protocol (SNMP) connection and requires the following input during element creation:
18+
19+
SNMP CONNECTION:
20+
21+
- **IP address/host**: The polling IP of the device.
22+
23+
SNMP Settings:
24+
25+
- **Port number**: The port of the connection device (default: *161*).
26+
27+
## Usage
28+
29+
### General
30+
31+
To capture traps, specify the IP addresses for which traps should be captured in the **Trap IP Sources** parameter, using a comma as separator. This page will then display an overview of the captured traps with their information (OID, Source IP, and Bindings) in the **Traps** table.
32+
33+
If you also want an information event to be created on the DMA every time a trap is received, enable the **Information Events** parameter.
34+
35+
Via the **Auto Clear** page button, you can access settings to clean up the Traps table.
36+
37+
### Lookup Configuration
38+
39+
On this page, you can use the **Lookup Table** to have incoming trap OIDs replaced with an alias name. For this purpose, the parameter **Lookup Table State** must be enabled.
40+
41+
With the **Add Raw Value** parameter, you can add an OID to the lookup table. The **Clear Table** button can be used to delete all the raw values from the lookup table, except for some well-known values.
42+
43+
### Filter Trap
44+
45+
On this page, you can configure traps to be filtered so that certain traps will not be received. Regular expressions are supported.
46+
47+
### Update Trap
48+
49+
This page allows you to set up rules so that specific traps can update traps with a specific OID and alarm reference. From version 1.0.1.17 onwards, basic regular expressions using "\*" are supported.
50+
51+
From version 1.0.1.24 onwards, with the **Binding Alarm Index**, you can set up rules that are a combination of columns. To do so, specify a backslash ("\\) followed by a comma-separated list of bindings. Also add a row with the same specific OID to the **Filter Trap** page.
52+
53+
### Heartbeat Trap
54+
55+
This page allows you to set up sending and receiving of heartbeat traps. These traps can be used to test and monitor the DataMiner SNMP forwarding function.
Loading
Loading

connector/toc.yml

+6
Original file line numberDiff line numberDiff line change
@@ -4060,8 +4060,14 @@
40604060
topicUid: Connector_help_Generic_Trap_Forwarder
40614061
- name: Generic Trap Processor
40624062
topicUid: Connector_help_Generic_Trap_Processor
4063+
items:
4064+
- name: Generic Trap Processor Technical
4065+
topicUid: Connector_help_Generic_Trap_Processor_Technical
40634066
- name: Generic Trap Receiver
40644067
topicUid: Connector_help_Generic_Trap_Receiver
4068+
items:
4069+
- name: Generic Trap Receiver Technical
4070+
topicUid: Connector_help_Generic_Trap_Receiver_Technical
40654071
- name: Generic Truck Manager
40664072
topicUid: Connector_help_Generic_Truck_Manager
40674073
- name: Generic TSI-SP-003 VMS

0 commit comments

Comments
 (0)