ssh_job_kill
DestructiveIdempotent
Stop a detached SSH job and its entire process group by job ID. Choose TERM or KILL signal; finished jobs are reported as gone.
Instructions
Stops a detached job and everything it started — the signal reaches the whole process group. A job that had already finished is reported as gone, not as a refusal.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Job id returned by ssh_exec with detach: true. A job started with sudo is reached as root from the id alone — nothing extra to pass. | |
| signal | No | KILL only when TERM was already ignored. | TERM |
| profile | Yes | Machine name. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | ||
| legend | No | What the words in this answer mean. A key names the field before the value — "state=limited", "jobs[].state=lost" — and only the values this answer actually used are listed. | |
| reason | No | ||
| signal | No | What was actually sent, which is not always what was asked for. | |
| outcome | No | signalled — the signal reached the process group of the job; gone — the job had already ended, so there was nothing to stop; nopid — the job recorded no pid, so there was nothing to signal; missing — the server knows no job under this id; no-answer — the server did not answer the stop request, so the job state is unknown. |