FailOnError Property

Controls how the component treats error codes returned by command execution.

Data Type

Default Value

Remarks

If set to True, FailOnError will cause the task to stop processing the inbound data and raise an error if the SSHHost returns an unsuccessful error code when executing the Command.

If set to False, the task will return all error information through the CommandExitStatus and CommandErrorMessage. Any standard output from the command's execution will be stored as usual in the message body.

Note: since FailOnError defaults to True, some improper command values may result in unexpected errors. In this case, it is useful to examine the standard output for any hints on proper command usage by setting FailOnError to false and writing the contents of the message to a file.