SSH command

Node catalog Actions

On this page

Execute a command on an SSH server

Usage and specifics

The remote server must be reachable from the backend. workingDirectory sets the command directory. Timeout uses milliseconds; failOnNonZeroExit controls nonzero exit codes.

Technical type : ssh. Runtime : nodulz.

Credentials and prerequisites

Create and configure the credential : ssh

Create credentials in your nodulz instance’s Credentials area, then select them on the node. Availability depends on ownership and sharing. See the credentials guide for access and rotation.

Parameters

Names below are technical keys. Defaults are not a ready-to-run configuration: complete fields required by your operation. Paths containing [] describe list items; some fields depend on the selected mode.

Parameter	Type	Default	Values / limits
`credentialId`	`string`	`""`	-
`command`	`string`	`""`	-
`workingDirectory`	`string`	`""`	-
`timeoutMs`	`number`	`120000`	-; ≥ 1000, ≤ 3600000
`failOnNonZeroExit`	`boolean`	`true`	-

Configuration help

credentialId Server: Server SSH credential for remote execution.
command Command: Command executed by the remote shell. Expressions are substituted verbatim: escape untrusted values.
workingDirectory Working directory: Optional absolute remote path. Empty: the server default directory.
timeoutMs Timeout (ms): SSH command limit, from 1 second to 1 hour.
failOnNonZeroExit Fail on nonzero exit code: Disable to handle the exit code in subsequent nodes.

Initial configuration

Initial catalog configuration example, to adapt before running. Keep secrets in credentials.

json

{
  "credentialId": "",
  "command": "",
  "workingDirectory": "",
  "timeoutMs": 120000,
  "failOnNonZeroExit": true
}

Verification

Test with representative data. Check node output in the inspector and logs, then use editor mapping for downstream fields. A trigger test with a simulated payload does not validate external service delivery.