org.apache.nifinifi-snmp-nar2.2.0org.apache.nifinifi-standard-shared-nar2.2.02.0.0rel/nifi-2.2.0main1org.apache.nifi.snmp.processors.GetSNMPPROCESSORRetrieves information from SNMP Agent with SNMP Get request and outputs a FlowFile with information in attributes and without any contentsnmpgetoidwalksnmp-hostnameSNMP Agent HostnameHostname or network address of the SNMP Agent.localhosttruefalsetrueFLOWFILE_ATTRIBUTESfalsefalsesnmp-portSNMP Agent PortPort of the SNMP Agent.161truefalsetrueFLOWFILE_ATTRIBUTESfalsefalsesnmp-versionSNMP VersionThree 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.SNMPv1v1SNMPv1SNMP version 1v2cSNMPv2cSNMP version 2cv3SNMPv3SNMP version 3 with improved securitytruefalsefalseNONEfalsefalsesnmp-communitySNMP CommunitySNMPv1 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.publictruetruefalseNONEfalsefalsesnmp-versionSNMP VersionSNMPv1SNMPv2csnmp-security-levelSNMP Security LevelSNMP 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).noAuthNoPrivnoAuthNoPrivnoAuthNoPrivCommunication without authentication and privacy.authNoPrivauthNoPrivCommunication with authentication and without privacy.authPrivauthPrivCommunication with authentication and privacy.truefalsefalseNONEfalsefalsesnmp-versionSNMP VersionSNMPv3snmp-security-nameSNMP Security NameUser name used for SNMP v3 Authentication.truefalsefalseNONEfalsefalsesnmp-versionSNMP VersionSNMPv3snmp-authentication-protocolSNMP Authentication ProtocolHash based authentication protocol for secure authentication.SHA224HMAC128SHA224Provides authentication based on the HMAC-SHA-2 algorithm.SHA256HMAC192SHA256Provides authentication based on the HMAC-SHA-2 algorithm.SHA384HMAC256SHA384Provides authentication based on the HMAC-SHA-2 algorithm.SHA512HMAC384SHA512Provides authentication based on the HMAC-SHA-2 algorithm.truefalsefalseNONEfalsefalsesnmp-security-levelSNMP Security LevelauthPrivauthNoPrivsnmp-authentication-passphraseSNMP Authentication PassphrasePassphrase used for SNMP authentication protocol.truetruefalseNONEfalsefalsesnmp-security-levelSNMP Security LevelauthPrivauthNoPrivsnmp-private-protocolSNMP Privacy ProtocolPrivacy allows for encryption of SNMP v3 messages to ensure confidentiality of data.DESDESSymmetric-key algorithm for the encryption of digital data. DES has been considered insecure because of the feasibility of brute-force attacks. We recommend using the AES encryption protocol.AES128AES128AES 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).AES192AES192AES 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).AES256AES256AES 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).truefalsefalseNONEfalsefalsesnmp-security-levelSNMP Security LevelauthPrivsnmp-private-protocol-passphraseSNMP Privacy PassphrasePassphrase used for SNMP privacy protocol.truetruefalseNONEfalsefalsesnmp-security-levelSNMP Security LevelauthPrivsnmp-retriesNumber of RetriesSet the number of retries when requesting the SNMP Agent.0falsefalsefalseNONEfalsefalsesnmp-timeoutTimeout (ms)Set the timeout in ms when requesting the SNMP Agent.5000falsefalsefalseNONEfalsefalsesnmp-oidOIDEach 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.falsefalsefalseNONEfalsefalsesnmp-textual-oidTextual OIDThe textual form of the numeric OID to request. This property is user defined, not processed and appended to the outgoing flowfile.falsefalsefalseNONEfalsefalsesnmp-strategySNMP StrategySNMP strategy to use (SNMP Get or SNMP Walk)GETGETGETA manager-to-agent request to retrieve the value of a variable. A response with the current value returned.WALKWALKA manager-to-agent request to retrieve the value of multiple variables. Snmp WALK also traverses all subnodes under the specified OID.truefalsefalseNONEfalsefalsesuccessAll FlowFiles that are received from the SNMP agent are routed to this relationship.falsefailureAll FlowFiles that cannot received from the SNMP agent are routed to this relationship.falsesnmp$<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.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.INPUT_ALLOWEDorg.apache.nifi.snmp.processors.ListenTrapSNMPPROCESSORReceives information from SNMP Agent and outputs a FlowFile with information in attributes and without any contentsnmplistentrapsnmp-manager-portSNMP Manager PortThe port where the SNMP Manager listens to the incoming traps.truefalsefalseNONEfalsefalsesnmp-versionSNMP VersionThree 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.SNMPv1v1SNMPv1SNMP version 1v2cSNMPv2cSNMP version 2cv3SNMPv3SNMP version 3 with improved securitytruefalsefalseNONEfalsefalsesnmp-communitySNMP CommunitySNMPv1 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.publictruetruefalseNONEfalsefalsesnmp-versionSNMP VersionSNMPv1SNMPv2csnmp-security-levelSNMP Security LevelSNMP 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).noAuthNoPrivnoAuthNoPrivnoAuthNoPrivCommunication without authentication and privacy.authNoPrivauthNoPrivCommunication with authentication and without privacy.authPrivauthPrivCommunication with authentication and privacy.truefalsefalseNONEfalsefalsesnmp-versionSNMP VersionSNMPv3snmp-usm-users-sourceUSM Users SourceThe ways to provide USM User dataJson Contentusm-json-contentThe JSON containing the USM usersJson File Pathusm-json-file-pathThe path of the JSON file containing the USM usersSecurity Namesusm-security-namesIn case of noAuthNoPriv security level - the list of security names separated by commastruefalsefalseNONEfalsefalsesnmp-versionSNMP VersionSNMPv3snmp-usm-users-file-pathUSM Users JSON File PathThe path of the json file containing the user credentials for SNMPv3. Check Usage for more details.falsefalsefalseNONEfalsefalseSINGLEFILEsnmp-versionSNMP VersionSNMPv3snmp-usm-users-sourceUSM Users Sourceusm-json-file-pathsnmp-usm-users-json-contentUSM Users JSON contentThe JSON containing the user credentials for SNMPv3. Check Usage for more details.falsetruefalseNONEfalsefalsesnmp-versionSNMP VersionSNMPv3snmp-usm-users-sourceUSM Users Sourceusm-json-contentsnmp-usm-security-namesSNMP Users Security NamesSecurity names listed separated by commas in SNMPv3. Check Usage for more details.falsefalsefalseNONEfalsefalsesnmp-security-levelSNMP Security LevelnoAuthNoPrivsnmp-usm-users-sourceUSM Users Sourceusm-security-namessnmp-versionSNMP VersionSNMPv3successAll FlowFiles that are received from the SNMP agent are routed to this relationshipfalsefailureAll FlowFiles that cannot received from the SNMP agent are routed to this relationshipfalsesnmp$*Attributes retrieved from the SNMP response. It may include: snmp$errorIndex, snmp$errorStatus, snmp$errorStatusText, snmp$nonRepeaters, snmp$requestID, snmp$type, snmp$variableBindingsINPUT_FORBIDDENorg.apache.nifi.snmp.processors.SendTrapSNMPPROCESSORSends information to SNMP Manager.snmpsendtrapsnmp-trap-manager-hostSNMP Manager HostThe host of the SNMP Manager where the trap is sent.localhosttruefalsetrueFLOWFILE_ATTRIBUTESfalsefalsesnmp-trap-manager-portSNMP Manager PortThe port of the SNMP Manager where the trap is sent.truefalsetrueFLOWFILE_ATTRIBUTESfalsefalsesnmp-versionSNMP VersionThree 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.SNMPv1v1SNMPv1SNMP version 1v2cSNMPv2cSNMP version 2cv3SNMPv3SNMP version 3 with improved securitytruefalsefalseNONEfalsefalsesnmp-communitySNMP CommunitySNMPv1 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.publictruetruefalseNONEfalsefalsesnmp-versionSNMP VersionSNMPv1SNMPv2csnmp-security-levelSNMP Security LevelSNMP 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).noAuthNoPrivnoAuthNoPrivnoAuthNoPrivCommunication without authentication and privacy.authNoPrivauthNoPrivCommunication with authentication and without privacy.authPrivauthPrivCommunication with authentication and privacy.truefalsefalseNONEfalsefalsesnmp-versionSNMP VersionSNMPv3snmp-security-nameSNMP Security NameUser name used for SNMP v3 Authentication.truefalsefalseNONEfalsefalsesnmp-versionSNMP VersionSNMPv3snmp-authentication-protocolSNMP Authentication ProtocolHash based authentication protocol for secure authentication.SHA224HMAC128SHA224Provides authentication based on the HMAC-SHA-2 algorithm.SHA256HMAC192SHA256Provides authentication based on the HMAC-SHA-2 algorithm.SHA384HMAC256SHA384Provides authentication based on the HMAC-SHA-2 algorithm.SHA512HMAC384SHA512Provides authentication based on the HMAC-SHA-2 algorithm.truefalsefalseNONEfalsefalsesnmp-security-levelSNMP Security LevelauthPrivauthNoPrivsnmp-authentication-passphraseSNMP Authentication PassphrasePassphrase used for SNMP authentication protocol.truetruefalseNONEfalsefalsesnmp-security-levelSNMP Security LevelauthPrivauthNoPrivsnmp-private-protocolSNMP Privacy ProtocolPrivacy allows for encryption of SNMP v3 messages to ensure confidentiality of data.DESDESSymmetric-key algorithm for the encryption of digital data. DES has been considered insecure because of the feasibility of brute-force attacks. We recommend using the AES encryption protocol.AES128AES128AES 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).AES192AES192AES 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).AES256AES256AES 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).truefalsefalseNONEfalsefalsesnmp-security-levelSNMP Security LevelauthPrivsnmp-private-protocol-passphraseSNMP Privacy PassphrasePassphrase used for SNMP privacy protocol.truetruefalseNONEfalsefalsesnmp-security-levelSNMP Security LevelauthPrivsnmp-retriesNumber of RetriesSet the number of retries when requesting the SNMP Agent.0falsefalsefalseNONEfalsefalsesnmp-timeoutTimeout (ms)Set the timeout in ms when requesting the SNMP Agent.5000falsefalsefalseNONEfalsefalsesnmp-trap-enterprise-oidEnterprise OIDEnterprise is the vendor identification (OID) for the network management sub-system that generated the trap.truefalsetrueFLOWFILE_ATTRIBUTESfalsefalsesnmp-versionSNMP VersionSNMPv1snmp-trap-agent-addressSNMP Trap Agent AddressThe address where the SNMP Manager sends the trap.truefalsetrueFLOWFILE_ATTRIBUTESfalsefalsesnmp-versionSNMP VersionSNMPv1snmp-trap-generic-typeGeneric Trap TypeGeneric trap type is an integer in the range of 0 to 6. See processor usage for details.Cold Start0A coldStart trap signifies that the sending protocol entity is reinitializing itself such that the agent's configuration or the protocol entity implementation may be alteredWarm Start1A 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 Down2A linkDown trap signifies that the sending protocol entity recognizes a failure in one of the communication links represented in the agent's configuration.Link Up3A 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 Failure4An 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 Neighborloss5An 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 obtainsEnterprise Specific6An 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 Attributegeneric-trap-typeProvide the Generic Trap Type with the "generic-trap-type" flowfile attribute.truefalsefalseNONEfalsefalsesnmp-versionSNMP VersionSNMPv1snmp-trap-specific-typeSpecific Trap 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.falsefalsetrueFLOWFILE_ATTRIBUTESfalsefalsesnmp-trap-generic-typeGeneric Trap Type6snmp-versionSNMP VersionSNMPv1snmp-trap-oid-valueTrap OID ValueThe value of the trap OID.truefalsetrueFLOWFILE_ATTRIBUTESfalsefalsesnmp-versionSNMP VersionSNMPv3SNMPv2csuccessAll FlowFiles that have been successfully used to perform SNMP Set are routed to this relationshipfalsefailureAll FlowFiles that cannot received from the SNMP agent are routed to this relationshipfalseINPUT_ALLOWEDorg.apache.nifi.snmp.processors.SetSNMPPROCESSORBased 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.snmpsetoidsnmp-hostnameSNMP Agent HostnameHostname or network address of the SNMP Agent.localhosttruefalsetrueFLOWFILE_ATTRIBUTESfalsefalsesnmp-portSNMP Agent PortPort of the SNMP Agent.161truefalsetrueFLOWFILE_ATTRIBUTESfalsefalsesnmp-versionSNMP VersionThree 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.SNMPv1v1SNMPv1SNMP version 1v2cSNMPv2cSNMP version 2cv3SNMPv3SNMP version 3 with improved securitytruefalsefalseNONEfalsefalsesnmp-communitySNMP CommunitySNMPv1 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.publictruetruefalseNONEfalsefalsesnmp-versionSNMP VersionSNMPv1SNMPv2csnmp-security-levelSNMP Security LevelSNMP 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).noAuthNoPrivnoAuthNoPrivnoAuthNoPrivCommunication without authentication and privacy.authNoPrivauthNoPrivCommunication with authentication and without privacy.authPrivauthPrivCommunication with authentication and privacy.truefalsefalseNONEfalsefalsesnmp-versionSNMP VersionSNMPv3snmp-security-nameSNMP Security NameUser name used for SNMP v3 Authentication.truefalsefalseNONEfalsefalsesnmp-versionSNMP VersionSNMPv3snmp-authentication-protocolSNMP Authentication ProtocolHash based authentication protocol for secure authentication.SHA224HMAC128SHA224Provides authentication based on the HMAC-SHA-2 algorithm.SHA256HMAC192SHA256Provides authentication based on the HMAC-SHA-2 algorithm.SHA384HMAC256SHA384Provides authentication based on the HMAC-SHA-2 algorithm.SHA512HMAC384SHA512Provides authentication based on the HMAC-SHA-2 algorithm.truefalsefalseNONEfalsefalsesnmp-security-levelSNMP Security LevelauthPrivauthNoPrivsnmp-authentication-passphraseSNMP Authentication PassphrasePassphrase used for SNMP authentication protocol.truetruefalseNONEfalsefalsesnmp-security-levelSNMP Security LevelauthPrivauthNoPrivsnmp-private-protocolSNMP Privacy ProtocolPrivacy allows for encryption of SNMP v3 messages to ensure confidentiality of data.DESDESSymmetric-key algorithm for the encryption of digital data. DES has been considered insecure because of the feasibility of brute-force attacks. We recommend using the AES encryption protocol.AES128AES128AES 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).AES192AES192AES 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).AES256AES256AES 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).truefalsefalseNONEfalsefalsesnmp-security-levelSNMP Security LevelauthPrivsnmp-private-protocol-passphraseSNMP Privacy PassphrasePassphrase used for SNMP privacy protocol.truetruefalseNONEfalsefalsesnmp-security-levelSNMP Security LevelauthPrivsnmp-retriesNumber of RetriesSet the number of retries when requesting the SNMP Agent.0falsefalsefalseNONEfalsefalsesnmp-timeoutTimeout (ms)Set the timeout in ms when requesting the SNMP Agent.5000falsefalsefalseNONEfalsefalsesuccessAll FlowFiles that have been successfully used to perform SNMP Set are routed to this relationshipfalsefailureAll FlowFiles that failed during the SNMP Set care routed to this relationshipfalsesnmp$<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.INPUT_REQUIRED