Description:

Based on incoming FlowFile attributes, the processor will execute SNMP Set requests. When founding attributes with name like snmp$<OID>, the processor will attempt to set the value of attribute to the corresponding OID given in the attribute name

Tags:

snmp, set, oid

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 is considered “sensitive”, meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the nifi.properties file has an entry for the property nifi.sensitive.props.key.

Name

Default Value

Allowable Values

Description

Host Name

 localhost Network address of SNMP Agent (e.g., localhost)

Port

 161 Numeric value identifying Port of SNMP Agent (e.g., 161)

SNMP Version

 SNMPv1
  • SNMPv1
  • SNMPv2c
  • SNMPv3
 SNMP Version to use
SNMP Community (v1 & v2c) public SNMP Community to use (e.g., public)

SNMP Security Level

 authPriv
  • noAuthNoPriv
  • authNoPriv
  • authPriv
 SNMP Security Level to use
SNMP Security name / user name Security name used for SNMP exchanges

SNMP Authentication Protocol
  • MD5
  • SHA
 SNMP Authentication Protocol to use
SNMP Authentication pass phrase Pass phrase used for SNMP authentication protocol

Sensitive Property: true

SNMP Private Protocol
  • DES
  • 3DES
  • AES128
  • AES192
  • AES256
 SNMP Private Protocol to use
SNMP Private protocol pass phrase Pass phrase used for SNMP private protocol

Sensitive Property: true

Number of retries

 0 Set the number of retries when requesting the SNMP Agent

Timeout (ms)

 5000 Set the timeout (in milliseconds) when requesting the SNMP Agent

Relationships:

Name

Description
success All FlowFiles that have been successfully used to perform SNMP Set are routed to this relationship
failure All FlowFiles that failed during the SNMP Set care routed to this relationship

Summary:

This processor sends SNMP set requests to a SNMP agent in order to update information associated to a given OID. This processor supports SNMPv1, SNMPv2c and SNMPv3. The component is based on SNMP4J.
The processor constructs SNMP Set requests by extracting information from FlowFile attributes. The processor is looking for attributes prefixed with snmp$. If such an attribute is found, the attribute name is split using the $ character. The second element must respect the OID format to be considered as a valid OID. If there is a third element, it must represents the SMI Syntax integer value of the type of data associated to the given OID to allow a correct conversion. If there is no third element, the value is considered as a String and the value will be sent as an OctetString object.


Configuration Details

At the time of writing this document it only defines the essential configuration properties which are suitable for most cases. Other properties will be defined later as this component progresses. Configuring SetSNMP:

  • Host - [REQUIRED] the name of the host where the SNMP agent is running. (default is localhost)
  • Port - [REQUIRED] the port number on which the SNMP agent is listening. (default is 161)
  • Version - [REQUIRED] the SNMP version to use (SNMPv1 [default], or SNMPv2c, or SNMPv3)
  • Community - [REQUIRED if SNMPv1 or SNMPv2c] the SNMP community to use. (default is public)
  • Security Level - [REQUIRED if SNMPv3] the security level to use. (default is authPriv)
  • Security Name - [REQUIRED if SNMPv3] the security name (user name) to use.
  • Authentication Protocol - [REQUIRED if SNMPv3 and authNoPriv or authPriv] the authentication protocol to use.
  • Authentication Password - [REQUIRED if SNMPv3 and authNoPriv or authPriv] the authentication password to use.
  • Private Protocol - [REQUIRED if SNMPv3 and authPriv] the private protocol to use.
  • Private Password - [REQUIRED if SNMPv3 and authPriv] the private password to use.
  • Retries - [REQUIRED] Sets the number of retries to be performed before a request is timed out. (default is 0)
  • Timeout - [REQUIRED] Sets timeout in milliseconds before a confirmed request is resent or timed out. (default is 5000)