Sends information to SNMP Manager.
snmp, send, 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, and whether a property supports the NiFi Expression Language.
Display Name | API Name | Default Value | Allowable Values | Description |
---|---|---|---|---|
SNMP Manager Host | snmp-trap-manager-host | localhost | The host where the SNMP Manager sends the trap. | |
SNMP Manager Port | snmp-trap-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". |
SNMP Security Name | snmp-security-name | User name used for SNMP v3 Authentication. This Property is only considered if the [SNMP Version] Property has a value of "v3". | ||
SNMP Authentication Protocol | snmp-authentication-protocol |
| Hash based authentication protocol for secure authentication. This Property is only considered if the [SNMP Security Level] Property is set to one of the following values: [authPriv], [authNoPriv] | |
SNMP Authentication Passphrase | snmp-authentication-passphrase | Passphrase used for SNMP authentication protocol. Sensitive Property: true This Property is only considered if the [SNMP Security Level] Property is set to one of the following values: [authPriv], [authNoPriv] | ||
SNMP Privacy Protocol | snmp-private-protocol |
| Privacy allows for encryption of SNMP v3 messages to ensure confidentiality of data. This Property is only considered if the [SNMP Security Level] Property has a value of "authPriv". | |
SNMP Privacy Passphrase | snmp-private-protocol-passphrase | Passphrase used for SNMP privacy protocol. Sensitive Property: true This Property is only considered if the [SNMP Security Level] Property has a value of "authPriv". | ||
Number of Retries | snmp-retries | 0 | Set the number of retries when requesting the SNMP Agent. | |
Timeout (ms) | snmp-timeout | 5000 | Set the timeout in ms when requesting the SNMP Agent. | |
Enterprise OID | snmp-trap-enterprise-oid | Enterprise is the vendor identification (OID) for the network management sub-system that generated the trap. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) This Property is only considered if the [SNMP Version] Property has a value of "v1". | ||
SNMP Trap Agent Address | snmp-trap-agent-address | The address where the SNMP Manager sends the trap. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) This Property is only considered if the [SNMP Version] Property has a value of "v1". | ||
Generic Trap Type | snmp-trap-generic-type |
| Generic trap type is an integer in the range of 0 to 6. See processor usage for details. This Property is only considered if the [SNMP Version] Property has a value of "v1". | |
Specific Trap Type | snmp-trap-specific-type | Specific trap type is a number that further specifies the nature of the event that generated the trap in the case of traps of generic type 6 (enterpriseSpecific). The interpretation of this code is vendor-specific. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) This Property is only considered if all of the following conditions are met:
| ||
Trap OID Value | snmp-trap-oid-value | The value of the trap OID. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) This Property is only considered if the [SNMP Version] Property is set to one of the following values: [v3], [v2c] |
Name | Description |
---|---|
success | All FlowFiles that have been successfully used to perform SNMP Set are routed to this relationship |
failure | All FlowFiles that cannot received from the SNMP agent are routed to this relationship |