SCANCEL(1)

NAME
scancel - Used to signal jobs or job steps that are under the control of Slurm.

SYNOPSIS
scancel [OPTIONS...] [job_id[.step_id]] [job_id[.step_id]...]

DESCRIPTION
scancel is used to signal or cancel jobs or job steps. An arbitrary number of jobs or job steps may be signaled using job specification filters or a space separated list of specific job and/or job step IDs. A job or job step can only be signaled by the owner of that job or user root. If an attempt is made by an unauthorized user to signal a job or job step, an error message will be printed and the job will not be signaled.

OPTIONS

--help
    Print a help message describing all scancel options.

--usage
    Print a brief help message listing the scancel options.

-i, --interactive
    Interactive mode. Confirm each job_id.step_id before performing the cancel operation.

-n, --name=job_name
    The name of jobs to be signaled.

-p, --partition=partition_name
    The name of the partition from which jobs are to be signaled.

-s, --signal=signal_name
    The name or number of the signal to be send. Default value is "KILL".

-t, --state=job_state_name
    The state of the jobs are to be signaled. job_state_name may have a value of either "PENDING" or "RUNNING".

-u, --user=user_name
    The name of the user whose jobs are to be signaled.

-v, --verbose
    Print additional logging. Multiple v's increase logging detail.

-V, --Version
    Print the version number of the scontrol command.

ARGUMENTS

job_id
    The Slurm job ID of the job to have one of its steps or the entire job signaled.

step_id
    The step ID of the job step to be signaled. If none is provided, then all jobs steps associated with the provided job_id will be signaled.

NOTES

If multiple filters are supplied (e.g. --partition and --name) only the jobs satisfying all of the filtering options will be signaled.

If a signal value of "KILL" (the default value) is to be sent to an entire job, this will result in the job's termination and its resource allocation being released.

EXAMPLES

Send SIGTERM to steps 1 and 3 of job 1234:
    scancel --signal=TERM 1234.1 1234.3

Cancel job 1234 along with all of its steps:
    scancel 1234

Cancel job all pending jobs belonging to user "bob" in partition "debug":
    scancel --state=PENDING --user=bob --partition=debug

COPYING
Copyright (C) 2002 The Regents of the University of California. Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER). UCRL-CODE-2002-040.

This file is part of SLURM, a resource management program. For details, see <http://www.llnl.gov/linux/slurm/>.

SLURM is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

SLURM is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

SEE ALSO
slurm_kill_job(3), slurm_kill_job_step(3)