Receives information from SNMP Agent and outputs a FlowFile with information in attributes and without any content
snmp, listen, trap
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 Name | API Name | Default Value | Allowable Values | Description |
|---|---|---|---|---|
| SNMP Manager Port | snmp-manager-port | The port where the SNMP Manager listens to the incoming traps. | ||
| SNMP Version | snmp-version | v1 |
| 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 Community | snmp-community | public | 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. 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 Level | snmp-security-level | noAuthNoPriv |
| 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 Source | snmp-usm-users-source |
| 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 Path | snmp-usm-users-file-path | The 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:
| ||
| USM Users JSON content | snmp-usm-users-json-content | The 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:
| ||
| SNMP Users Security Names | snmp-usm-security-names | Security 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:
|
| 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 |
| 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 |