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.job_raise(flux_handle: Flux, jobid: Union[JobID, int], exc_type: str, severity: int = 0, note: Optional[str] = None)

Raise a job exception.

Parameters

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

  • jobid -- the job ID of the job

  • exc_type -- exception type string (e.g. "scheduler-restart")

  • severity -- severity level; 0 causes the job to abort

  • note -- optional human-readable message

flux.job.kill.job_raise_async(flux_handle: Flux, jobid: Union[JobID, int], exc_type: str, severity: int = 0, note: Optional[str] = None)

Raise a job exception asynchronously.

Parameters

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

  • jobid -- the job ID of the job

  • exc_type -- exception type string (e.g. "scheduler-restart")

  • severity -- severity level; 0 causes the job to abort

  • note -- optional human-readable message

Returns

a future fulfilled when the exception is raised

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 -- 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 -- 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 fulfilled when the signal is delivered

Return type

Future