SSH

core.ssh.execute_command

Execute a command over SSH and return stdout, stderr, and exit status.

Secrets

Required secrets:

• ssh: required values PRIVATE_KEY.

Inputs

command · string · required

Command to execute on the remote host.

host · string · required

SSH host to connect to.

username · string · required

SSH username.

host_key_checking · boolean

Whether to verify the remote host key before connecting. Disable only for first-contact or otherwise trusted hosts; PID isolation and nsjail do not protect against SSH man-in-the-middle attacks.

Default: true.

host_public_key · string | null

Expected public host key for the target host in ‘<key_type> <base64>’ format. Required when host_key_checking is enabled. For non-22 ports, the entry is stored as [host]:port.

Default: null.

password · string | null

Password for the SSH user.

Default: null.

port · integer

SSH port. Defaults to 22.

Default: 22.

timeout_seconds · number

Timeout in seconds for connection and command execution.

Default: 30.0.

Examples

Execute a remote command

- ref: collect_uptime
  action: core.ssh.execute_command
  args:
    host: 10.0.10.15
    port: 22
    username: tracecat
    host_public_key: "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIBEXAMPLEHOSTKEY"
    command: uptime
    timeout_seconds: 20