-
Processors
- AttributeRollingWindow
- AttributesToCSV
- AttributesToJSON
- CalculateRecordStats
- CaptureChangeMySQL
- CompressContent
- ConnectWebSocket
- ConsumeAMQP
- ConsumeAzureEventHub
- ConsumeElasticsearch
- ConsumeGCPubSub
- ConsumeIMAP
- ConsumeJMS
- ConsumeKafka
- ConsumeKinesisStream
- ConsumeMQTT
- ConsumePOP3
- ConsumeSlack
- ConsumeTwitter
- ConsumeWindowsEventLog
- ControlRate
- ConvertCharacterSet
- ConvertRecord
- CopyAzureBlobStorage_v12
- CopyS3Object
- CountText
- CryptographicHashContent
- DebugFlow
- DecryptContentAge
- DecryptContentPGP
- DeduplicateRecord
- DeleteAzureBlobStorage_v12
- DeleteAzureDataLakeStorage
- DeleteByQueryElasticsearch
- DeleteDynamoDB
- DeleteFile
- DeleteGCSObject
- DeleteGridFS
- DeleteMongo
- DeleteS3Object
- DeleteSFTP
- DeleteSQS
- DetectDuplicate
- DistributeLoad
- DuplicateFlowFile
- EncodeContent
- EncryptContentAge
- EncryptContentPGP
- EnforceOrder
- EvaluateJsonPath
- EvaluateXPath
- EvaluateXQuery
- ExecuteGroovyScript
- ExecuteProcess
- ExecuteScript
- ExecuteSQL
- ExecuteSQLRecord
- ExecuteStreamCommand
- ExtractAvroMetadata
- ExtractEmailAttachments
- ExtractEmailHeaders
- ExtractGrok
- ExtractHL7Attributes
- ExtractRecordSchema
- ExtractText
- FetchAzureBlobStorage_v12
- FetchAzureDataLakeStorage
- FetchBoxFile
- FetchDistributedMapCache
- FetchDropbox
- FetchFile
- FetchFTP
- FetchGCSObject
- FetchGoogleDrive
- FetchGridFS
- FetchS3Object
- FetchSFTP
- FetchSmb
- FilterAttribute
- FlattenJson
- ForkEnrichment
- ForkRecord
- GenerateFlowFile
- GenerateRecord
- GenerateTableFetch
- GeoEnrichIP
- GeoEnrichIPRecord
- GeohashRecord
- GetAsanaObject
- GetAwsPollyJobStatus
- GetAwsTextractJobStatus
- GetAwsTranscribeJobStatus
- GetAwsTranslateJobStatus
- GetAzureEventHub
- GetAzureQueueStorage_v12
- GetDynamoDB
- GetElasticsearch
- GetFile
- GetFTP
- GetGcpVisionAnnotateFilesOperationStatus
- GetGcpVisionAnnotateImagesOperationStatus
- GetHubSpot
- GetMongo
- GetMongoRecord
- GetS3ObjectMetadata
- GetSFTP
- GetShopify
- GetSmbFile
- GetSNMP
- GetSplunk
- GetSQS
- GetWorkdayReport
- GetZendesk
- HandleHttpRequest
- HandleHttpResponse
- IdentifyMimeType
- InvokeHTTP
- InvokeScriptedProcessor
- ISPEnrichIP
- JoinEnrichment
- JoltTransformJSON
- JoltTransformRecord
- JSLTTransformJSON
- JsonQueryElasticsearch
- ListAzureBlobStorage_v12
- ListAzureDataLakeStorage
- ListBoxFile
- ListDatabaseTables
- ListDropbox
- ListenFTP
- ListenHTTP
- ListenOTLP
- ListenSlack
- ListenSyslog
- ListenTCP
- ListenTrapSNMP
- ListenUDP
- ListenUDPRecord
- ListenWebSocket
- ListFile
- ListFTP
- ListGCSBucket
- ListGoogleDrive
- ListS3
- ListSFTP
- ListSmb
- LogAttribute
- LogMessage
- LookupAttribute
- LookupRecord
- MergeContent
- MergeRecord
- ModifyBytes
- ModifyCompression
- MonitorActivity
- MoveAzureDataLakeStorage
- Notify
- PackageFlowFile
- PaginatedJsonQueryElasticsearch
- ParseEvtx
- ParseNetflowv5
- ParseSyslog
- ParseSyslog5424
- PartitionRecord
- PublishAMQP
- PublishGCPubSub
- PublishJMS
- PublishKafka
- PublishMQTT
- PublishSlack
- PutAzureBlobStorage_v12
- PutAzureCosmosDBRecord
- PutAzureDataExplorer
- PutAzureDataLakeStorage
- PutAzureEventHub
- PutAzureQueueStorage_v12
- PutBigQuery
- PutBoxFile
- PutCloudWatchMetric
- PutDatabaseRecord
- PutDistributedMapCache
- PutDropbox
- PutDynamoDB
- PutDynamoDBRecord
- PutElasticsearchJson
- PutElasticsearchRecord
- PutEmail
- PutFile
- PutFTP
- PutGCSObject
- PutGoogleDrive
- PutGridFS
- PutKinesisFirehose
- PutKinesisStream
- PutLambda
- PutMongo
- PutMongoBulkOperations
- PutMongoRecord
- PutRecord
- PutRedisHashRecord
- PutS3Object
- PutSalesforceObject
- PutSFTP
- PutSmbFile
- PutSNS
- PutSplunk
- PutSplunkHTTP
- PutSQL
- PutSQS
- PutSyslog
- PutTCP
- PutUDP
- PutWebSocket
- PutZendeskTicket
- QueryAirtableTable
- QueryAzureDataExplorer
- QueryDatabaseTable
- QueryDatabaseTableRecord
- QueryRecord
- QuerySalesforceObject
- QuerySplunkIndexingStatus
- RemoveRecordField
- RenameRecordField
- ReplaceText
- ReplaceTextWithMapping
- RetryFlowFile
- RouteHL7
- RouteOnAttribute
- RouteOnContent
- RouteText
- RunMongoAggregation
- SampleRecord
- ScanAttribute
- ScanContent
- ScriptedFilterRecord
- ScriptedPartitionRecord
- ScriptedTransformRecord
- ScriptedValidateRecord
- SearchElasticsearch
- SegmentContent
- SendTrapSNMP
- SetSNMP
- SignContentPGP
- SplitAvro
- SplitContent
- SplitExcel
- SplitJson
- SplitPCAP
- SplitRecord
- SplitText
- SplitXml
- StartAwsPollyJob
- StartAwsTextractJob
- StartAwsTranscribeJob
- StartAwsTranslateJob
- StartGcpVisionAnnotateFilesOperation
- StartGcpVisionAnnotateImagesOperation
- TagS3Object
- TailFile
- TransformXml
- UnpackContent
- UpdateAttribute
- UpdateByQueryElasticsearch
- UpdateCounter
- UpdateDatabaseTable
- UpdateRecord
- ValidateCsv
- ValidateJson
- ValidateRecord
- ValidateXml
- VerifyContentMAC
- VerifyContentPGP
- Wait
-
Controller Services
- ADLSCredentialsControllerService
- ADLSCredentialsControllerServiceLookup
- AmazonGlueSchemaRegistry
- ApicurioSchemaRegistry
- AvroReader
- AvroRecordSetWriter
- AvroSchemaRegistry
- AWSCredentialsProviderControllerService
- AzureBlobStorageFileResourceService
- AzureCosmosDBClientService
- AzureDataLakeStorageFileResourceService
- AzureEventHubRecordSink
- AzureStorageCredentialsControllerService_v12
- AzureStorageCredentialsControllerServiceLookup_v12
- CEFReader
- ConfluentEncodedSchemaReferenceReader
- ConfluentEncodedSchemaReferenceWriter
- ConfluentSchemaRegistry
- CSVReader
- CSVRecordLookupService
- CSVRecordSetWriter
- DatabaseRecordLookupService
- DatabaseRecordSink
- DatabaseTableSchemaRegistry
- DBCPConnectionPool
- DBCPConnectionPoolLookup
- DistributedMapCacheLookupService
- ElasticSearchClientServiceImpl
- ElasticSearchLookupService
- ElasticSearchStringLookupService
- EmailRecordSink
- EmbeddedHazelcastCacheManager
- ExcelReader
- ExternalHazelcastCacheManager
- FreeFormTextRecordSetWriter
- GCPCredentialsControllerService
- GCSFileResourceService
- GrokReader
- HazelcastMapCacheClient
- HikariCPConnectionPool
- HttpRecordSink
- IPLookupService
- JettyWebSocketClient
- JettyWebSocketServer
- JMSConnectionFactoryProvider
- JndiJmsConnectionFactoryProvider
- JsonConfigBasedBoxClientService
- JsonPathReader
- JsonRecordSetWriter
- JsonTreeReader
- Kafka3ConnectionService
- KerberosKeytabUserService
- KerberosPasswordUserService
- KerberosTicketCacheUserService
- LoggingRecordSink
- MapCacheClientService
- MapCacheServer
- MongoDBControllerService
- MongoDBLookupService
- PropertiesFileLookupService
- ProtobufReader
- ReaderLookup
- RecordSetWriterLookup
- RecordSinkServiceLookup
- RedisConnectionPoolService
- RedisDistributedMapCacheClientService
- RestLookupService
- S3FileResourceService
- ScriptedLookupService
- ScriptedReader
- ScriptedRecordSetWriter
- ScriptedRecordSink
- SetCacheClientService
- SetCacheServer
- SimpleCsvFileLookupService
- SimpleDatabaseLookupService
- SimpleKeyValueLookupService
- SimpleRedisDistributedMapCacheClientService
- SimpleScriptedLookupService
- SiteToSiteReportingRecordSink
- SlackRecordSink
- SmbjClientProviderService
- StandardAsanaClientProviderService
- StandardAzureCredentialsControllerService
- StandardDropboxCredentialService
- StandardFileResourceService
- StandardHashiCorpVaultClientService
- StandardHttpContextMap
- StandardJsonSchemaRegistry
- StandardKustoIngestService
- StandardKustoQueryService
- StandardOauth2AccessTokenProvider
- StandardPGPPrivateKeyService
- StandardPGPPublicKeyService
- StandardPrivateKeyService
- StandardProxyConfigurationService
- StandardRestrictedSSLContextService
- StandardS3EncryptionService
- StandardSSLContextService
- StandardWebClientServiceProvider
- Syslog5424Reader
- SyslogReader
- UDPEventRecordSink
- VolatileSchemaCache
- WindowsEventLogReader
- XMLFileLookupService
- XMLReader
- XMLRecordSetWriter
- YamlTreeReader
- ZendeskRecordSink
SendTrapSNMP 2.0.0
- Bundle
- org.apache.nifi | nifi-snmp-nar
- Description
- Sends information to SNMP Manager.
- Tags
- send, snmp, trap
- Input Requirement
- ALLOWED
- Supports Sensitive Dynamic Properties
- false
-
Additional Details for SendTrapSNMP 2.0.0
SendTrapSNMP
Summary
This processor generates and transmits SNMP Traps to the specified SNMP manager. Attributes can be given as processor properties, either predefined or dynamically using Expression Language from flowfiles. Flowfile properties with snmp prefix (e.g. snmp$1.2.3.4.5 - OID) value can be used to define additional PDU variables.
The allowable Generic Trap Types are:
- Cold Start
- Warm Start
- Link Down
- Link Up
- Authentication Failure
- EGP Neighbor Loss
- Enterprise Specific
Specific trap type can set in case of Enterprise Specific generic trap type is chosen.
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 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]
-
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 Trap Agent Address
The address where the SNMP Manager sends the trap.
- Display Name
- SNMP Trap Agent Address
- Description
- The address where the SNMP Manager sends the trap.
- API Name
- snmp-trap-agent-address
- Expression Language Scope
- Environment variables and FlowFile Attributes
- Sensitive
- false
- Required
- true
- Dependencies
-
- SNMP Version is set to any of [SNMPv1]
-
Enterprise OID
Enterprise is the vendor identification (OID) for the network management sub-system that generated the trap.
- Display Name
- Enterprise OID
- Description
- Enterprise is the vendor identification (OID) for the network management sub-system that generated the trap.
- API Name
- snmp-trap-enterprise-oid
- Expression Language Scope
- Environment variables and FlowFile Attributes
- Sensitive
- false
- Required
- true
- Dependencies
-
- SNMP Version is set to any of [SNMPv1]
-
Generic Trap Type
Generic trap type is an integer in the range of 0 to 6. See processor usage for details.
- Display Name
- Generic Trap Type
- Description
- Generic trap type is an integer in the range of 0 to 6. See processor usage for details.
- API Name
- snmp-trap-generic-type
- Allowable Values
-
- Cold Start
- Warm Start
- Link Down
- Link Up
- Authentication Failure
- EGP Neighborloss
- Enterprise Specific
- With "generic-trap-type" FlowFile Attribute
- Expression Language Scope
- Not Supported
- Sensitive
- false
- Required
- true
- Dependencies
-
- SNMP Version is set to any of [SNMPv1]
-
SNMP Manager Host
The host of the SNMP Manager where the trap is sent.
- Display Name
- SNMP Manager Host
- Description
- The host of the SNMP Manager where the trap is sent.
- API Name
- snmp-trap-manager-host
- Default Value
- localhost
- Expression Language Scope
- Environment variables and FlowFile Attributes
- Sensitive
- false
- Required
- true
-
SNMP Manager Port
The port of the SNMP Manager where the trap is sent.
- Display Name
- SNMP Manager Port
- Description
- The port of the SNMP Manager where the trap is sent.
- API Name
- snmp-trap-manager-port
- Expression Language Scope
- Environment variables and FlowFile Attributes
- Sensitive
- false
- Required
- true
-
Trap OID Value
The value of the trap OID.
- Display Name
- Trap OID Value
- Description
- The value of the trap OID.
- API Name
- snmp-trap-oid-value
- Expression Language Scope
- Environment variables and FlowFile Attributes
- Sensitive
- false
- Required
- true
- Dependencies
-
- SNMP Version is set to any of [SNMPv3, SNMPv2c]
-
Specific Trap Type
Specific 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.
- Display Name
- Specific Trap Type
- Description
- Specific 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.
- API Name
- snmp-trap-specific-type
- Expression Language Scope
- Environment variables and FlowFile Attributes
- Sensitive
- false
- Required
- false
- Dependencies
-
- SNMP Version is set to any of [SNMPv1]
- Generic Trap Type is set to any of [6]
-
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 have been successfully used to perform SNMP Set are routed to this relationship |
| failure | All FlowFiles that cannot received from the SNMP agent are routed to this relationship |