GetSNMP

Description:

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

Additional Details...

Tags:

snmp, get, oid, walk

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.

NameDefault ValueAllowable ValuesDescription
OIDThe OID to request
Textual OIDThe textual OID to request
SNMP strategy (GET/WALK)GET
  • GET
  • WALK
SNMP strategy to use (SNMP Get or SNMP Walk)
Host NamelocalhostNetwork address of SNMP Agent (e.g., localhost)
Port161Numeric value identifying Port of SNMP Agent (e.g., 161)
SNMP VersionSNMPv1
  • SNMPv1
  • SNMPv2c
  • SNMPv3
SNMP Version to use
SNMP Community (v1 & v2c)publicSNMP Community to use (e.g., public)
SNMP Security LevelauthPriv
  • noAuthNoPriv
  • authNoPriv
  • authPriv
SNMP Security Level to use
SNMP Security name / user nameSecurity name used for SNMP exchanges
SNMP Authentication Protocol
  • MD5
  • SHA
SNMP Authentication Protocol to use
SNMP Authentication pass phrasePass 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 phrasePass phrase used for SNMP private protocol
Sensitive Property: true
Number of retries0Set the number of retries when requesting the SNMP Agent
Timeout (ms)5000Set the timeout (in milliseconds) when requesting the SNMP Agent

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
snmp$textualOidThis attribute will exist if and only if the strategy is GET and will be equal to the value given in Textual Oid property.

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component does not allow an incoming relationship.