DEQUEUES THE HPCJOB¶
Removes (dequeues) a previously submitted HPC job from the platform’s job queue, halting its pending execution. Use this worker when a queued simulation needs to be cancelled or withdrawn before it starts running on the cluster.
When to use¶
Tagged: dequeue, hpc, job_cancel, queue_management, simulation.
Inputs¶
| Label | ID | Type | Default | Required | Description |
|---|---|---|---|---|---|
| HPCJOB | hpcjob_id | remote_lookup | — | ✓ | Remote lookup reference to the HPC job to be dequeued; select the target job from the hpcjobs data source — this field is required and must point to a valid, currently queued job. |
Outputs¶
| Label | ID | Type | Description |
|---|---|---|---|
| Status | status | text | Text status code or message returned by the HPC system indicating whether the dequeue operation succeeded or failed (e.g., ‘OK’, ‘ERROR’). |
| Command | command | text | The exact shell or API command that was issued to the HPC scheduler to remove the job from the queue; useful for auditing and debugging. |
| Output | output | text | Raw stdout/stderr text returned by the scheduler after executing the dequeue command; inspect this for detailed error messages or confirmation details. |
Disciplines¶
- platform.hpc_config
- platform.job_submission
Auto-generated from platform schema. Worker id: hpcjob_dequeue. Schema hash: f6a781cbc16f. Hand-curated docs in workerexamples/ override this page when present.