ListenTrapSNMP

ListenTrapSNMP 2.0.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.0.0
ListenTrapSNMP

Summary

This processor listens to SNMP traps and creates a flowfile from the trap PDU. The versions SNMPv1, SNMPv2c and SNMPv3 are supported. The component is based on SNMP4J.

SNMPv3 has user-based security. The USM Users Source property allows users to choose between three different ways to provide the USM user database. An example json file containing two users:
```
[
  {
    "securityName": "user1",
    "authProtocol": "MD5",
    "authPassphrase": "abc12345",
    "privProtocol": "DES",
    "privPassphrase": "abc12345"
  },
  {
    "securityName": "newUser2",
    "authProtocol": "MD5",
    "authPassphrase": "abc12345",
    "privProtocol": "AES256",
    "privPassphrase": "abc12345"
  }
]
```

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 Version is set to any of [SNMPv3]
- USM Users Source is set to any of [usm-security-names]
- SNMP Security Level is set to any of [noAuthNoPriv]
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 Source 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 Source is set to any of [usm-json-content]
- SNMP Version is set to any of [SNMPv3]
USM Users Source
The ways to provide USM User data
Display Name

USM Users Source

Description

The ways to provide USM User data

API Name

snmp-usm-users-source

Allowable Values
- Json Content
- Json File Path
- 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
success	All FlowFiles that are received from the SNMP agent are routed to this relationship
failure	All FlowFiles that cannot 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.0.0

ListenTrapSNMP

Summary