GetSNMP

GetSNMP 2.0.0

Bundle: org.apache.nifi | nifi-snmp-nar
Description: Retrieves information from SNMP Agent with SNMP Get request and outputs a FlowFile with information in attributes and without any content
Tags: get, oid, snmp, walk
Input Requirement: ALLOWED
Supports Sensitive Dynamic Properties: false

Properties

SNMP Authentication Passphrase
Passphrase used for SNMP authentication protocol.
Display Name

SNMP Authentication Passphrase

Description

Passphrase used for SNMP authentication protocol.

API Name

snmp-authentication-passphrase

Expression Language Scope

Not Supported

Sensitive

true

Required

true

Dependencies
- SNMP Security Level is set to any of [authPriv, authNoPriv]
SNMP Authentication Protocol
Hash based authentication protocol for secure authentication.
Display Name

SNMP Authentication Protocol

Description

Hash based authentication protocol for secure authentication.

API Name

snmp-authentication-protocol

Allowable Values
- MD5
- SHA
- SHA224
- SHA256
- SHA384
- SHA512
Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies
- SNMP Security Level is set to any of [authPriv, authNoPriv]
SNMP Community
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.
Display Name

SNMP Community

Description

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.

API Name

snmp-community

Default Value

public

Expression Language Scope

Not Supported

Sensitive

true

Required

true

Dependencies
- SNMP Version is set to any of [SNMPv1, SNMPv2c]
SNMP Agent Hostname
Hostname or network address of the SNMP Agent.

Display Name

SNMP Agent Hostname

Description

Hostname or network address of the SNMP Agent.

API Name

snmp-hostname

Default Value

localhost

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
OID
Each OID (object identifier) identifies a variable that can be read or set via SNMP. This value is not taken into account for an input flowfile and will be omitted. Can be set to emptystring when the OIDs are provided through flowfile.

Display Name

OID

Description

Each OID (object identifier) identifies a variable that can be read or set via SNMP. This value is not taken into account for an input flowfile and will be omitted. Can be set to emptystring when the OIDs are provided through flowfile.

API Name

snmp-oid

Expression Language Scope

Not Supported

Sensitive

false

Required

false
SNMP Agent Port
Port of the SNMP Agent.

Display Name

SNMP Agent Port

Description

Port of the SNMP Agent.

API Name

snmp-port

Default Value

161

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
SNMP Privacy Protocol
Privacy allows for encryption of SNMP v3 messages to ensure confidentiality of data.
Display Name

SNMP Privacy Protocol

Description

Privacy allows for encryption of SNMP v3 messages to ensure confidentiality of data.

API Name

snmp-private-protocol

Allowable Values
- DES
- 3DES
- AES128
- AES192
- AES256
Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies
- SNMP Security Level is set to any of [authPriv]
SNMP Privacy Passphrase
Passphrase used for SNMP privacy protocol.
Display Name

SNMP Privacy Passphrase

Description

Passphrase used for SNMP privacy protocol.

API Name

snmp-private-protocol-passphrase

Expression Language Scope

Not Supported

Sensitive

true

Required

true

Dependencies
- SNMP Security Level is set to any of [authPriv]
Number of Retries
Set the number of retries when requesting the SNMP Agent.

Display Name

Number of Retries

Description

Set the number of retries when requesting the SNMP Agent.

API Name

snmp-retries

Default Value

0

Expression Language Scope

Not Supported

Sensitive

false

Required

false
SNMP Security Level
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).
Display Name

SNMP Security Level

Description

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).

API Name

snmp-security-level

Default Value

noAuthNoPriv

Allowable Values
- noAuthNoPriv
- authNoPriv
- authPriv
Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies
- SNMP Version is set to any of [SNMPv3]
SNMP Security Name
User name used for SNMP v3 Authentication.
Display Name

SNMP Security Name

Description

User name used for SNMP v3 Authentication.

API Name

snmp-security-name

Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies
- SNMP Version is set to any of [SNMPv3]
SNMP Strategy
SNMP strategy to use (SNMP Get or SNMP Walk)
Display Name

SNMP Strategy

Description

SNMP strategy to use (SNMP Get or SNMP Walk)

API Name

snmp-strategy

Default Value

GET

Allowable Values
- GET
- WALK
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Textual OID
The textual form of the numeric OID to request. This property is user defined, not processed and appended to the outgoing flowfile.

Display Name

Textual OID

Description

The textual form of the numeric OID to request. This property is user defined, not processed and appended to the outgoing flowfile.

API Name

snmp-textual-oid

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Timeout (ms)
Set the timeout in ms when requesting the SNMP Agent.

Display Name

Timeout (ms)

Description

Set the timeout in ms when requesting the SNMP Agent.

API Name

snmp-timeout

Default Value

5000

Expression Language Scope

Not Supported

Sensitive

false

Required

false
SNMP Version
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.
Display Name

SNMP Version

Description

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.

API Name

snmp-version

Default Value

SNMPv1

Allowable Values
- v1
- v2c
- v3
Expression Language Scope

Not Supported

Sensitive

false

Required

true

Relationships

Name	Description
success	All FlowFiles that are received from the SNMP agent are routed to this relationship.
failure	All FlowFiles that cannot received from the SNMP agent are routed to this relationship.

Writes Attributes

Name	Description
snmp$<OID>	Response variable binding: OID (e.g. 1.3.6.1.4.1.343) and its value.
snmp$errorIndex	Denotes the variable binding in which the error occured.
snmp$errorStatus	The snmp4j error status of the PDU.
snmp$errorStatusText	The description of error status.
snmp$nonRepeaters	The number of non repeater variable bindings in a GETBULK PDU (currently not supported).
snmp$requestID	The request ID associated with the PDU.
snmp$type	The snmp4j numeric representation of the type of the PDU.
snmp$typeString	The name of the PDU type.
snmp$textualOid	This attribute will exist if and only if the strategy is GET and will be equal to the value given in Textual Oid property.