GetSplunk 2025.10.9.21

Bundle

org.apache.nifi | nifi-splunk-nar

Description

Retrieves data from Splunk Enterprise.

Tags

get, logs, splunk

Input Requirement

FORBIDDEN

Supports Sensitive Dynamic Properties

false

Properties

PropertyDescription
API VersionSelect which version of the Splunk Search API to use for search operations. Version 2 is recommended for newer Splunk instances.
ApplicationThe Splunk Application to query.
Connection TimeoutMax wait time for connection to the Splunk server.
Earliest TimeThe value to use for the earliest time when querying. Only used with a Time Range Strategy of Provided. See Splunk’s documentation on Search Time Modifiers for guidance in populating this field.
HostnameThe ip address or hostname of the Splunk server.
Latest TimeThe value to use for the latest time when querying. Only used with a Time Range Strategy of Provided. See Splunk’s documentation on Search Time Modifiers for guidance in populating this field.
Output ModeThe output mode for the results.
OwnerThe owner to pass to Splunk.
PasswordThe password to authenticate to Splunk.
PortThe port of the Splunk server.
QueryThe query to execute. Typically beginning with a <search> command followed by a search clause, such as <search source=”tcp:7689”> to search for messages received on TCP port 7689.
Read TimeoutMax wait time for response from the Splunk server.
SSL Context ServiceThe SSL Context Service used to provide client certificate information for TLS/SSL connections.
SchemeThe scheme for connecting to Splunk.
Security ProtocolThe security protocol to use for communicating with Splunk.
Time Field StrategyIndicates whether to search by the time attached to the event, or by the time the event was indexed in Splunk.
Time Range StrategyIndicates how to apply time ranges to each execution of the query. Selecting a managed option allows the processor to apply a time range from the last execution time to the current execution time. When using <Managed from Beginning>, an earliest time will not be applied on the first execution, and thus all records searched. When using <Managed from Current> the earliest time of the first execution will be the initial execution time. When using <Provided>, the time range will come from the Earliest Time and Latest Time properties, or no time range will be applied if these properties are left blank.
Time ZoneThe Time Zone to use for formatting dates when performing a search. Only used with Managed time strategies.
TokenThe token to pass to Splunk.
UsernameThe username to authenticate to Splunk.

State management

ScopesDescription
CLUSTERIf using one of the managed Time Range Strategies, this processor will store the values of the latest and earliest times from the previous execution so that the next execution of the can pick up where the last execution left off. The state will be cleared and start over if the query is changed.

Relationships

NameDescription
successResults retrieved from Splunk are sent out this relationship.

Writes attributes

NameDescription
splunk.queryThe query that performed to produce the FlowFile.
splunk.earliest.timeThe value of the earliest time that was used when performing the query.
splunk.latest.timeThe value of the latest time that was used when performing the query.