ExecuteStreamCommand

ExecuteStreamCommand 2.0.0

Bundle: org.apache.nifi | nifi-standard-nar
Description: The ExecuteStreamCommand processor provides a flexible way to integrate external commands and scripts into NiFi data flows. ExecuteStreamCommand can pass the incoming FlowFile's content to the command that it executes similarly how piping works.
Tags: command, command execution, execute, stream
Input Requirement: REQUIRED
Supports Sensitive Dynamic Properties: true

Properties

Argument Delimiter
Delimiter to use to separate arguments for a command [default: ;]. Must be a single character
Display Name

Argument Delimiter

Description

Delimiter to use to separate arguments for a command [default: ;]. Must be a single character

API Name

Argument Delimiter

Default Value

;

Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies
- Command Arguments Strategy is set to any of [Command Arguments Property]
Command Arguments Strategy
Strategy for configuring arguments to be supplied to the command.
Display Name

Command Arguments Strategy

Description

Strategy for configuring arguments to be supplied to the command.

API Name

argumentsStrategy

Default Value

Command Arguments Property

Allowable Values
- Command Arguments Property
- Dynamic Property Arguments
Expression Language Scope

Not Supported

Sensitive

false

Required

false
Command Arguments
The arguments to supply to the executable delimited by the ';' character.
Display Name

Command Arguments

Description

The arguments to supply to the executable delimited by the ';' character.

API Name

Command Arguments

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false

Dependencies
- Command Arguments Strategy is set to any of [Command Arguments Property]
Command Path
Specifies the command to be executed; if just the name of an executable is provided, it must be in the user's environment PATH.

Display Name

Command Path

Description

Specifies the command to be executed; if just the name of an executable is provided, it must be in the user's environment PATH.

API Name

Command Path

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
Ignore STDIN
If true, the contents of the incoming flowfile will not be passed to the executing command
Display Name

Ignore STDIN

Description

If true, the contents of the incoming flowfile will not be passed to the executing command

API Name

Ignore STDIN

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

false
Max Attribute Length
If routing the output of the stream command to an attribute, the number of characters put to the attribute value will be at most this amount. This is important because attributes are held in memory and large attributes will quickly cause out of memory issues. If the output goes longer than this value, it will truncated to fit. Consider making this smaller if able.

Display Name

Max Attribute Length

Description

If routing the output of the stream command to an attribute, the number of characters put to the attribute value will be at most this amount. This is important because attributes are held in memory and large attributes will quickly cause out of memory issues. If the output goes longer than this value, it will truncated to fit. Consider making this smaller if able.

API Name

Max Attribute Length

Default Value

256

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Output Destination Attribute
If set, the output of the stream command will be put into an attribute of the original FlowFile instead of a separate FlowFile. There will no longer be a relationship for 'output stream' or 'nonzero status'. The value of this property will be the key for the output attribute.

Display Name

Output Destination Attribute

Description

If set, the output of the stream command will be put into an attribute of the original FlowFile instead of a separate FlowFile. There will no longer be a relationship for 'output stream' or 'nonzero status'. The value of this property will be the key for the output attribute.

API Name

Output Destination Attribute

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Output MIME Type
Specifies the value to set for the "mime.type" attribute. This property is ignored if 'Output Destination Attribute' is set.

Display Name

Output MIME Type

Description

Specifies the value to set for the "mime.type" attribute. This property is ignored if 'Output Destination Attribute' is set.

API Name

Output MIME Type

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Working Directory
The directory to use as the current working directory when executing the command

Display Name

Working Directory

Description

The directory to use as the current working directory when executing the command

API Name

Working Directory

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false

Dynamic Properties

An environment variable name
These environment variables are passed to the process spawned by this Processor

Name

An environment variable name

Description

These environment variables are passed to the process spawned by this Processor

Value

An environment variable value

Expression Language Scope

NONE
command.argument.<commandIndex>
These arguments are supplied to the process spawned by this Processor when using the Command Arguments Strategy : Dynamic Property Arguments. <commandIndex> is a number and it will determine the order.

Name

command.argument.<commandIndex>

Description

These arguments are supplied to the process spawned by this Processor when using the Command Arguments Strategy : Dynamic Property Arguments. <commandIndex> is a number and it will determine the order.

Value

Argument to be supplied to the command

Expression Language Scope

NONE

Restrictions

Required Permission	Explanation
execute code	Provides operator the ability to execute arbitrary code assuming all permissions that NiFi has.

Relationships

Name	Description
output stream	The destination path for the flow file created from the command's output, if the returned status code is zero.
original	The original FlowFile will be routed. It will have new attributes detailing the result of the script execution.
nonzero status	The destination path for the flow file created from the command's output, if the returned status code is non-zero. All flow files routed to this relationship will be penalized.

Writes Attributes

Name	Description
execution.command	The name of the command executed
execution.command.args	The semi-colon delimited list of arguments. Sensitive properties will be masked
execution.status	The exit status code returned from executing the command
execution.error	Any error messages returned from executing the command
mime.type	Sets the MIME type of the output if the 'Output MIME Type' property is set and 'Output Destination Attribute' is not set