Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)Command Path | 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. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
Command Arguments Strategy | argumentsStrategy | Command Arguments Property | - Command Arguments Property
- Dynamic Property Arguments
| Strategy for configuring arguments to be supplied to the command. |
Command Arguments | Command Arguments | | | The arguments to supply to the executable delimited by the ';' character. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
This Property is only considered if the [Command Arguments Strategy] Property has a value of "Command Arguments Property". |
Argument Delimiter | Argument Delimiter | ; | | Delimiter to use to separate arguments for a command [default: ;]. Must be a single character
This Property is only considered if the [Command Arguments Strategy] Property has a value of "Command Arguments Property". |
Ignore STDIN | Ignore STDIN | false | | If true, the contents of the incoming flowfile will not be passed to the executing command |
Output Destination Attribute | 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. |
Max Attribute Length | Max Attribute Length | 256 | | 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. |
Dynamic Properties:
Supports Sensitive Dynamic Properties: Yes
Dynamic Properties allow the user to specify both the name and value of a property.
Name | Value | Description |
---|
An environment variable name | An environment variable value | These environment variables are passed to the process spawned by this Processor Supports Expression Language: false |
command.argument.<commandIndex> | Argument to be supplied to the command | 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. Supports Expression Language: false |
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. |
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. |
original | The original FlowFile will be routed. It will have new attributes detailing the result of the script execution. |
Reads Attributes:
None specified.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 |
State management:
This component does not store state.Restricted:
Required Permission | Explanation |
---|
execute code | Provides operator the ability to execute arbitrary code assuming all permissions that NiFi has. |
Input requirement:
This component requires an incoming relationship.System Resource Considerations:
None specified.