flux.job.kill module

flux.job.kill.cancel(flux_handle: Flux, jobid: Union[JobID, int], reason: Optional[str] = None)

Cancel a pending or or running job

Parameters

• flux_handle -- handle for Flux broker from flux.Flux()

• jobid -- the job ID of the job to cancel

• reason -- the textual reason associated with the cancelation

flux.job.kill.cancel_async(flux_handle: Flux, jobid: Union[JobID, int], reason: Optional[str] = None)

Cancel a pending or or running job asynchronously

Parameters

• flux_handle -- handle for Flux broker from flux.Flux()

• jobid -- the job ID of the job to cancel

• reason -- the textual reason associated with the cancelation

Returns

a future fulfilled when the cancelation completes

Return type

Future

flux.job.kill.kill(flux_handle: Flux, jobid: Union[JobID, int], signum: Optional[int] = None)

Send a signal to a running job.

Parameters

• flux_handle (Flux) -- handle for Flux broker from flux.Flux()

• jobid -- the job ID of the job to kill

• signum -- signal to send (default SIGTERM)

flux.job.kill.kill_async(flux_handle: Flux, jobid: Union[JobID, int], signum: Optional[int] = None)

Send a signal to a running job asynchronously

Parameters

• flux_handle (Flux) -- handle for Flux broker from flux.Flux()

• jobid -- the job ID of the job to kill

• signum -- signal to send (default SIGTERM)

Returns

a Future

Return type

Future