SetSNMP

Description:

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

Additional Details...

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.

Display NameAPI NameDefault ValueAllowable ValuesDescription
SNMP Agent Hostnamesnmp-hostnamelocalhostHostname or network address of the SNMP Agent.
SNMP Agent Portsnmp-port161Port of the SNMP Agent.
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.

Relationships:

NameDescription
successAll FlowFiles that have been successfully used to perform SNMP Set are routed to this relationship
failureAll FlowFiles that failed during the SNMP Set care routed to this relationship

Reads Attributes:

None specified.

Writes Attributes:

NameDescription
snmp$<OID>Response variable binding: OID (e.g. 1.3.6.1.4.1.343) and its value.
snmp$errorIndexDenotes the variable binding in which the error occured.
snmp$errorStatusThe snmp4j error status of the PDU.
snmp$errorStatusTextThe description of error status.
snmp$nonRepeatersThe number of non repeater variable bindings in a GETBULK PDU (currently not supported).
snmp$requestIDThe request ID associated with the PDU.
snmp$typeThe snmp4j numeric representation of the type of the PDU.
snmp$typeStringThe name of the PDU type.

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component requires an incoming relationship.

System Resource Considerations:

None specified.