ListenTrapSNMP

Description:

Receives information from SNMP Agent and outputs a FlowFile with information in attributes and without any content

Additional Details...

Tags:

snmp, listen, trap

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values.

Display NameAPI NameDefault ValueAllowable ValuesDescription
SNMP Manager Portsnmp-manager-portThe port where the SNMP Manager listens to the incoming traps.
SNMP Versionsnmp-versionv1
  • v1 SNMP version 1
  • v2c SNMP version 2c
  • v3 SNMP version 3 with improved security
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.
SNMP Communitysnmp-communitypublicSNMPv1 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.
Sensitive Property: true

This Property is only considered if the [SNMP Version] Property is set to one of the following values: [v1], [v2c]
SNMP Security Levelsnmp-security-levelnoAuthNoPriv
  • noAuthNoPriv Communication without authentication and privacy.
  • authNoPriv Communication with authentication and without privacy.
  • authPriv Communication with authentication and privacy.
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).

This Property is only considered if the [SNMP Version] Property has a value of "v3".
USM Users Sourcesnmp-usm-users-source
  • Json Content The JSON containing the USM users
  • Json File Path The path of the JSON file containing the USM users
  • Security Names In case of noAuthNoPriv security level - the list of security names separated by commas
The ways to provide USM User data

This Property is only considered if the [SNMP Version] Property has a value of "v3".
USM Users JSON File Pathsnmp-usm-users-file-pathThe path of the json file containing the user credentials for SNMPv3. Check Usage for more details.

This property requires exactly one file to be provided..


This Property is only considered if all of the following conditions are met:
  • The [SNMP Version] Property has a value of "v3".
  • The [USM Users Source] Property has a value of "Json File Path".
USM Users JSON contentsnmp-usm-users-json-contentThe JSON containing the user credentials for SNMPv3. Check Usage for more details.

This Property is only considered if all of the following conditions are met:
  • The [SNMP Version] Property has a value of "v3".
  • The [USM Users Source] Property has a value of "Json Content".
SNMP Users Security Namessnmp-usm-security-namesSecurity names listed separated by commas in SNMPv3. Check Usage for more details.

This Property is only considered if all of the following conditions are met:
  • The [USM Users Source] Property has a value of "Security Names".
  • The [SNMP Security Level] Property has a value of "noAuthNoPriv".
  • The [SNMP Version] Property has a value of "v3".

Relationships:

NameDescription
successAll FlowFiles that are received from the SNMP agent are routed to this relationship
failureAll FlowFiles that cannot received from the SNMP agent are routed to this relationship

Reads Attributes:

None specified.

Writes Attributes:

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

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component does not allow an incoming relationship.

System Resource Considerations:

None specified.