SendTrapSNMP

Description:

Sends information to SNMP Manager.

Additional Details...

Tags:

snmp, send, 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, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
SNMP Manager Hostsnmp-trap-manager-hostlocalhostThe host where the SNMP Manager sends the trap.
SNMP Manager Portsnmp-trap-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".
SNMP Security Namesnmp-security-nameUser name used for SNMP v3 Authentication.

This Property is only considered if the [SNMP Version] Property has a value of "v3".
SNMP Authentication Protocolsnmp-authentication-protocol
  • MD5 Provides authentication based on the HMAC-MD5 algorithm.
  • SHA Provides authentication based on the HMAC-SHA algorithm.
  • SHA224 Provides authentication based on the HMAC-SHA-2 algorithm.
  • SHA256 Provides authentication based on the HMAC-SHA-2 algorithm.
  • SHA384 Provides authentication based on the HMAC-SHA-2 algorithm.
  • SHA512 Provides authentication based on the HMAC-SHA-2 algorithm.
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 Passphrasesnmp-authentication-passphrasePassphrase 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 Protocolsnmp-private-protocol
  • DES Symmetric-key algorithm for the encryption of digital data. DES has been considered insecurebecause of the feasilibity of brute-force attacks. We recommend using the AES encryption protocol.
  • 3DES Symmetric-key block cipher, which applies the DES cipher algorithm three times to each data block. 3DES has been considered insecure has been deprecated by NIST in 2017. We recommend using the AES encryption protocol.
  • AES128 AES is a symmetric algorithm which uses the same 128, 192, or 256 bit key for both encryption and decryption (the security of an AES system increases exponentially with key length).
  • AES192 AES is a symmetric algorithm which uses the same 128, 192, or 256 bit key for both encryption and decryption (the security of an AES system increases exponentially with key length).
  • AES256 AES is a symmetric algorithm which uses the same 128, 192, or 256 bit key for both encryption and decryption (the security of an AES system increases exponentially with key length).
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 Passphrasesnmp-private-protocol-passphrasePassphrase 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 Retriessnmp-retries0Set the number of retries when requesting the SNMP Agent.
Timeout (ms)snmp-timeout5000Set the timeout in ms when requesting the SNMP Agent.
Enterprise OIDsnmp-trap-enterprise-oidEnterprise 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 Addresssnmp-trap-agent-addressThe 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 Typesnmp-trap-generic-type
  • Cold Start A coldStart trap signifies that the sending protocol entity is reinitializing itself such that the agent's configuration or the protocol entity implementation may be altered
  • Warm Start A warmStart trap signifies that the sending protocol entity is reinitializing itself such that neither the agent configuration nor the protocol entity implementation is altered.
  • Link Down A linkDown trap signifies that the sending protocol entity recognizes a failure in one of the communication links represented in the agent's configuration.
  • Link Up A linkUp trap signifies that the sending protocol entity recognizes that one of the communication links represented in the agent's configuration has come up.
  • Authentication Failure An authenticationFailure trap signifies that the sending protocol entity is the addressee of a protocol message that is not properly authenticated. While implementations of the SNMP must be capable of generating this trap, they must also be capable of suppressing the emission of such traps via an implementation- specific mechanism.
  • EGP Neighborloss An egpNeighborLoss trap signifies that an EGP neighbor for whom the sending protocol entity was an EGP peer has been marked down and the peer relationship no longer obtains
  • Enterprise Specific An enterpriseSpecific trap signifies that a particular enterprise-specific trap has occurred which can be defined in the Specific Trap Type field.
  • With "generic-trap-type" FlowFile Attribute Provide the Generic Trap Type with the "generic-trap-type" flowfile attribute.
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 Typesnmp-trap-specific-typeSpecific 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:
  • The [Generic Trap Type] Property has a value of "Enterprise Specific".
  • The [SNMP Version] Property has a value of "v1".
Trap OID Valuesnmp-trap-oid-valueThe 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]

Relationships:

NameDescription
successAll FlowFiles that have been successfully used to perform SNMP Set 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:

None specified.

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component allows an incoming relationship.

System Resource Considerations:

None specified.