ListenTrapSNMP

ListenTrapSNMP 2.4.0

Bundle: org.apache.nifi | nifi-snmp-nar
Description: Receives information from SNMP Agent and outputs a FlowFile with information in attributes and without any content
Tags: listen, snmp, trap
Input Requirement: FORBIDDEN
Supports Sensitive Dynamic Properties: false

Additional Details for ListenTrapSNMP 2.4.0
ListenTrapSNMP

Summary

The ListenTrapSNMP processor listens for incoming SNMP traps and generates a FlowFile from the received Protocol Data Unit (PDU). It supports SNMPv1, SNMPv2c, and SNMPv3, utilizing the SNMP4J library.

When configured to use SNMPv3, SNMPv1 and SNMPv2c are automatically disabled. As a result, traps using SNMPv1 or SNMPv2c message models will not be received or processed. This is done to enforce a higher level of security, as SNMPv1 and SNMPv2c transmit community strings in plaintext, making them vulnerable to interception and unauthorized access.

For SNMPv3, security is based on a User-Based Security Model (USM). The ‘USM Users Input Method’ property allows users to configure the USM user database in different ways. Below is an example JSON file defining two users as “Json Content”:
```
[
  {
    "securityName": "user1",
    "authProtocol": "HMAC384SHA512",
    "authPassphrase": "authPassphrase1",
    "privProtocol": "AES192",
    "privPassphrase": "privPassphrase1"
  },
  {
    "securityName": "user2",
    "authProtocol": "HMAC192SHA256",
    "authPassphrase": "authPassphrase2",
    "privProtocol": "AES256",
    "privPassphrase": "privPassphrase2"
  }
]
```

Properties

SNMP Community
SNMPv1 and SNMPv2 use communities to establish trust between managers and agents. Most agents support three community names, one each for read-only, read-write and trap. These three community strings control different types of activities. The read-only community applies to get requests. The read-write community string applies to set requests. The trap community string applies to receipt of traps.
Display Name

SNMP Community

Description

SNMPv1 and SNMPv2 use communities to establish trust between managers and agents. Most agents support three community names, one each for read-only, read-write and trap. These three community strings control different types of activities. The read-only community applies to get requests. The read-write community string applies to set requests. The trap community string applies to receipt of traps.

API Name

snmp-community

Default Value

public

Expression Language Scope

Not Supported

Sensitive

true

Required

true

Dependencies
- SNMP Version is set to any of [SNMPv1, SNMPv2c]
SNMP Manager Port
The port where the SNMP Manager listens to the incoming traps.

Display Name

SNMP Manager Port

Description

The port where the SNMP Manager listens to the incoming traps.

API Name

snmp-manager-port

Expression Language Scope

Not Supported

Sensitive

false

Required

true
SNMP Security Level
SNMP version 3 provides extra security with User Based Security Model (USM). The three levels of security is 1. Communication without authentication and encryption (NoAuthNoPriv). 2. Communication with authentication and without encryption (AuthNoPriv). 3. Communication with authentication and encryption (AuthPriv).
Display Name

SNMP Security Level

Description

SNMP version 3 provides extra security with User Based Security Model (USM). The three levels of security is 1. Communication without authentication and encryption (NoAuthNoPriv). 2. Communication with authentication and without encryption (AuthNoPriv). 3. Communication with authentication and encryption (AuthPriv).

API Name

snmp-security-level

Default Value

noAuthNoPriv

Allowable Values
- noAuthNoPriv
- authNoPriv
- authPriv
Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies
- SNMP Version is set to any of [SNMPv3]
SNMP Users Security Names
Security names listed separated by commas in SNMPv3. Check Usage for more details.
Display Name

SNMP Users Security Names

Description

Security names listed separated by commas in SNMPv3. Check Usage for more details.

API Name

snmp-usm-security-names

Expression Language Scope

Not Supported

Sensitive

false

Required

false

Dependencies
- SNMP Security Level is set to any of [noAuthNoPriv]
- USM Users Input Method is set to any of [usm-security-names]
- SNMP Version is set to any of [SNMPv3]
USM Users JSON File Path
The path of the json file containing the user credentials for SNMPv3. Check Usage for more details.
Display Name

USM Users JSON File Path

Description

The path of the json file containing the user credentials for SNMPv3. Check Usage for more details.

API Name

snmp-usm-users-file-path

Expression Language Scope

Not Supported

Sensitive

false

Required

false

Dependencies
- USM Users Input Method is set to any of [usm-json-file-path]
- SNMP Version is set to any of [SNMPv3]
USM Users JSON content
The JSON containing the user credentials for SNMPv3. Check Usage for more details.
Display Name

USM Users JSON content

Description

The JSON containing the user credentials for SNMPv3. Check Usage for more details.

API Name

snmp-usm-users-json-content

Expression Language Scope

Not Supported

Sensitive

true

Required

false

Dependencies
- USM Users Input Method is set to any of [usm-json-content]
- SNMP Version is set to any of [SNMPv3]
USM Users Input Method
Specifies how USM user data is provided.
Display Name

USM Users Input Method

Description

Specifies how USM user data is provided.

API Name

snmp-usm-users-source

Allowable Values
- Json File Path
- Json Content
- Security Names
Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies
- SNMP Version is set to any of [SNMPv3]
SNMP Version
Three significant versions of SNMP have been developed and deployed. SNMPv1 is the original version of the protocol. More recent versions, SNMPv2c and SNMPv3, feature improvements in performance, flexibility and security.
Display Name

SNMP Version

Description

Three significant versions of SNMP have been developed and deployed. SNMPv1 is the original version of the protocol. More recent versions, SNMPv2c and SNMPv3, feature improvements in performance, flexibility and security.

API Name

snmp-version

Default Value

SNMPv1

Allowable Values
- v1
- v2c
- v3
Expression Language Scope

Not Supported

Sensitive

false

Required

true

Relationships

Name	Description
failure	All FlowFiles that cannot received from the SNMP agent are routed to this relationship
success	All FlowFiles that are received from the SNMP agent are routed to this relationship

Writes Attributes

Name	Description
snmp$*	Attributes retrieved from the SNMP response. It may include: snmp$errorIndex, snmp$errorStatus, snmp$errorStatusText, snmp$nonRepeaters, snmp$requestID, snmp$type, snmp$variableBindings

ListenTrapSNMP 2.4.0

ListenTrapSNMP

Summary