scancel

Section: Slurm Commands (1)
Updated: Slurm Commands
Index

NAME

scancel - Used to signal jobs or job steps that are under the control of Slurm.
scancel-Slurmの制御下にあるジョブまたはジョブステップを通知するために使用されます。

SYNOPSIS

scancel [OPTIONS...] [job_id[_array_id][.step_id]] [job_id[_array_id][.step_id]...]

DESCRIPTION

scancel is used to signal or cancel jobs, job arrays or job steps.
scancelは、ジョブ、ジョブ配列、またはジョブステップを通知またはキャンセルするために使用されます。
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.
任意の数のジョブまたはジョブステップは、ジョブ仕様フィルタまたは特定のジョブおよび/またはジョブステップIDのスペース区切りリストを使用して通知できます。
If the job ID of a job array is specified with an array ID value then only that job array element will be cancelled.
ジョブ配列のジョブIDが配列ID値で指定されている場合、そのジョブ配列要素のみがキャンセルされます。
If the job ID of a job array is specified without an array ID value then all job array elements will be cancelled.
ジョブ配列のジョブIDが配列ID値なしで指定された場合、すべてのジョブ配列要素が取り消されます。
While a heterogeneous job is in pending state, only the entire job can be cancelled rather than its individual components.
異種ジョブが保留状態にある間は、個々のコンポーネントではなく、ジョブ全体のみをキャンセルできます。
A request to cancel an individual component of a heterogeneous job not in pending state will return an error.
保留状態にない異種ジョブの個々のコンポーネントをキャンセルする要求は、エラーを返します。
After the job has begun execution, the individual component can be cancelled.
ジョブの実行が開始された後、個々のコンポーネントをキャンセルできます。
A job or job step can only be signaled by the owner of that job or user root.
ジョブまたはジョブステップは、そのジョブの所有者またはユーザー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

-A, --account=account

Restrict the scancel operation to jobs under this charge account.
scancelの操作をこの課金アカウントのジョブに制限します。

-b, --batch

By default, signals other than SIGKILL are not sent to the batch step (the shell script).
デフォルトでは、SIGKILL以外のシグナルはバッチステップ（シェルスクリプト）に送信されません。
With this option scancel signals only the batch step, but not any other steps.
このオプションを使用すると、scancelはバッチステップのみを通知し、他のステップは通知しません。
This is useful when the shell script has to trap the signal and take some application defined action.
これは、シェルスクリプトがシグナルをトラップし、アプリケーションで定義されたアクションを実行する必要がある場合に役立ちます。
Note that most shells cannot handle signals while a command is running (child process of the batch step), the shell use to wait wait until the command ends to then handle the signal.
ほとんどのシェルは、コマンドの実行中（バッチステップの子プロセス）はシグナルを処理できないことに注意してください。シェルは、コマンドが終了するまで待機してからシグナルを処理するために使用します。
Children of the batch step are not signaled with this option, use -f, --full instead.
バッチステップの子はこのオプションでは通知されません。代わりに-f、-fullを使用してください。
NOTE: If used with -f, --full, this option ignored.
注：-f、-fullと一緒に使用すると、このオプションは無視されます。
NOTE: This option is not applicable if step_id is specified.
注：step_idが指定されている場合、このオプションは適用されません。
NOTE: The shell itself may exit upon receipt of many signals.
注：シェル自体は、多くの信号を受信すると終了する場合があります。
You may avoid this by explicitly trap signals within the shell script (e.g. "trap <arg> <signals>").
シェルスクリプト内でシグナルを明示的にトラップすることで、これを回避できます（例：「trap ＜arg＞＜signals＞」）。
See the shell documentation for details.
詳細については、シェルのドキュメントを参照してください。

--ctld

Send the job signal request to the slurmctld daemon rather than directly to the slurmd daemons.
ジョブシグナル要求を、slurmdデーモンに直接送信するのではなく、slurmctldデーモンに送信します。
This increases overhead, but offers better fault tolerance.
これによりオーバーヘッドが増加しますが、フォールトトレランスが向上します。
This is the default behavior on architectures using front end nodes (e.g. Cray ALPS computers) or when the --clusters option is used.
これは、フロントエンドノード（Cray ALPSコンピューターなど）を使用するアーキテクチャー、または--clustersオプションが使用される場合のデフォルトの動作です。

-f, --full

By default, signals other than SIGKILL are not sent to the batch step (the shell script).
デフォルトでは、SIGKILL以外のシグナルはバッチステップ（シェルスクリプト）に送信されません。
With this option scancel signals also the batch script and its children processes.
このオプションを使用すると、scancelはバッチスクリプトとその子プロセスにも信号を送ります。
Most shells cannot handle signals while a command is running (child process of the batch step), the shell use to wait until the command ends to then handle the signal.
ほとんどのシェルは、コマンドの実行中（バッチステップの子プロセス）にシグナルを処理できません。シェルは、コマンドが終了するまで待機してからシグナルを処理するために使用します。
Unlike -b, --batch, children of the batch step are also signaled with this option.
-b、-batchとは異なり、バッチステップの子もこのオプションで通知されます。
NOTE: srun steps are also children of the batch step, so steps are also signaled with this option.
注：srunステップもbatchステップの子であるため、ステップもこのオプションで通知されます。

--help

Print a help message describing all scancel options.
すべてのスキャンセルオプションを説明するヘルプメッセージを印刷します。

-H, --hurry

Do not stage out any burst buffer data.
バーストバッファデータをステージアウトしないでください。

-i, --interactive

Interactive mode.
インタラクティブモード。
Confirm each job_id.step_id before performing the cancel operation.
キャンセル操作を実行する前に、各job_id.step_idを確認してください。

-M, --clusters=<string>

Clusters to issue commands to.
コマンドを発行するクラスター。
Note that the SlurmDBD must be up for this option to work properly.
このオプションが正しく機能するには、SlurmDBDが稼働している必要があることに注意してください。

-n, --jobname=job_name, --name=job_name

Restrict the scancel operation to jobs with this job name.
scancel操作をこのジョブ名のジョブに制限します。

-p, --partition=partition_name

Restrict the scancel operation to jobs in this partition.
scancel操作をこのパーティション内のジョブに制限します。

-q, --qos=qos

Restrict the scancel operation to jobs with this quality of service.
scancelの操作を、このサービス品質のジョブに制限します。

-Q, --quiet

Do not report an error if the specified job is already completed.
指定されたジョブがすでに完了している場合は、エラーを報告しないでください。
This option is incompatible with the --verbose option.
このオプションは、-verboseオプションと互換性がありません。

-R, --reservation=reservation_name

Restrict the scancel operation to jobs with this reservation name.
scancel操作をこの予約名のジョブに制限します。

--sibling=cluster_name

Remove an active sibling job from a federated job.
フェデレーションジョブからアクティブな兄弟ジョブを削除します。

-s, --signal=signal_name

The name or number of the signal to send.
送信する信号の名前または番号。
If this option is not used the specified job or step will be terminated.
このオプションを使用しない場合、指定されたジョブまたはステップは終了します。
Note.
注意。
If this option is used the signal is sent directly to the slurmd where the job is running bypassing the slurmctld thus the job state will not change even if the signal is delivered to it.
このオプションを使用すると、信号はslurmctldをバイパスしてジョブが実行されているslurmdに直接送信されるため、信号が配信されてもジョブの状態は変化しません。
Use the scontrol command if you want the job state change be known to slurmctld.
ジョブ状態の変更をslurmctldに認識させたい場合は、scontrolコマンドを使用します。

-t, --state=job_state_name

Restrict the scancel operation to jobs in this state.
scancel操作をこの状態のジョブに制限します。
job_state_name may have a value of either "PENDING", "RUNNING" or "SUSPENDED".
job_state_nameの値は、「PENDING」、「RUNNING」、または「SUSPENDED」のいずれかになります。

-u, --user=user_name

Restrict the scancel operation to jobs owned by this user.
scancel操作をこのユーザーが所有するジョブに制限します。

--usage

Print a brief help message listing the scancel options.
scancelオプションをリストした簡単なヘルプメッセージを印刷します。

-v, --verbose

Print additional logging.
追加のログを印刷します。
Multiple v's increase logging detail.
複数のvは、ログの詳細を増やします。
This option is incompatible with the --quiet option.
このオプションは、-quietオプションと互換性がありません。

-V, --version

Print the version number of the scancel command.
scancelコマンドのバージョン番号を出力します。

-w, --nodelist=host1,host2,...

Cancel any jobs using any of the given hosts.
指定されたホストのいずれかを使用しているジョブをキャンセルします。
The list may be specified as a comma-separated list of hosts, a range of hosts (host[1-5,7,...] for example), or a filename.
このリストは、ホストのコンマ区切りリスト、ホストの範囲（たとえば、host [1-5,7、...]）、またはファイル名として指定できます。
The host list will be assumed to be a filename only if it contains a "/" character.
ホストリストは、「/」文字が含まれている場合にのみファイル名であると見なされます。

--wckey=wckey

Restrict the scancel operation to jobs using this workload characterization key.
このワークロード特性キーを使用して、スキャンセル操作をジョブに制限します。

ARGUMENTS

job_id

The Slurm job ID to be signaled.
通知されるSlurmジョブID。

step_id

The step ID of the job step to be signaled.
通知されるジョブステップのステップID。
If not specified, the operation is performed at the level of a job.
指定しない場合、操作はジョブのレベルで実行されます。

If neither --batch nor --signal are used,
--batchも--signalも使用されていない場合、
the entire job will be terminated.
ジョブ全体が終了します。

When --batch is used, the batch shell processes will be signaled.
--batchを使用すると、バッチシェルプロセスに信号が送信されます。
The child processes of the shell will not be signaled by Slurm, but the shell may forward the signal.
シェルの子プロセスはSlurmによって通知されませんが、シェルは信号を転送する場合があります。

When --batch is not used but --signal is used, then all job steps will be signaled, but the batch script itself will not be signaled.
--batchが使用されていないが--signalが使用されている場合、すべてのジョブステップが通知されますが、バッチスクリプト自体は通知されません。

PERFORMANCE

Executing scancel sends a remote procedure call to slurmctld.
scancelを実行すると、リモートプロシージャコールがslurmctldに送信されます。
If enough calls from scancel or other Slurm client commands that send remote procedure calls to the slurmctld daemon come in at once, it can result in a degradation of performance of the slurmctld daemon, possibly resulting in a denial of service.
リモートプロシージャコールをslurmctldデーモンに送信するscancelまたは他のSlurmクライアントコマンドからの十分な呼び出しが一度に着信すると、slurmctldデーモンのパフォーマンスが低下し、サービス拒否が発生する可能性があります。

Do not run scancel or other Slurm client commands that send remote procedure calls to slurmctld from loops in shell scripts or other programs.
シェルスクリプトまたは他のプログラムのループからslurmctldにリモートプロシージャコールを送信するscancelまたは他のSlurmクライアントコマンドを実行しないでください。
Ensure that programs limit calls to scancel to the minimum necessary for the information you are trying to gather.
プログラムがscancelへの呼び出しを、収集しようとしている情報に必要な最小限に制限していることを確認してください。

ENVIRONMENT VARIABLES

Some scancel options may be set via environment variables.
一部のスキャンセルオプションは、環境変数を介して設定できます。
These environment variables, along with their corresponding options, are listed below.
これらの環境変数とそれに対応するオプションを以下に示します。
(Note: commandline options will always override these settings)
（注：コマンドラインオプションは常にこれらの設定を上書きします）

SCANCEL_ACCOUNT: -A, --account=account
SCANCEL_BATCH: -b, --batch
SCANCEL_CTLD: --ctld
SCANCEL_FULL: -f, --full
SCANCEL_HURRY: -H, --hurry
SCANCEL_INTERACTIVE: -i, --interactive
SCANCEL_NAME: -n, --name=job_name
SCANCEL_PARTITION: -p, --partition=partition_name
SCANCEL_QOS: -q, --qos=qos
SCANCEL_STATE: -t, --state=job_state_name
SCANCEL_USER: -u, --user=user_name
SCANCEL_VERBOSE: -v, --verbose
SCANCEL_WCKEY: --wckey=wckey
SLURM_CONF: The location of the Slurm configuration file.
Slurm構成ファイルの場所。

NOTES

If multiple filters are supplied (e.g. --partition and --name) only the jobs satisfying all of the filtering options will be signaled.
複数のフィルター（--partitionや--nameなど）が指定されている場合、すべてのフィルターオプションを満たすジョブのみが通知されます。

Cancelling a job step will not result in the job being terminated.
ジョブステップをキャンセルしても、ジョブは終了しません。
The job must be cancelled to release a resource allocation.
リソース割り当てを解放するには、ジョブをキャンセルする必要があります。

To cancel a job, invoke scancel without --signal option.
ジョブをキャンセルするには、-signalオプションを指定せずにscancelを呼び出します。
This will send first a SIGCONT to all steps to eventually wake them up followed by a SIGTERM, then wait the KillWait duration defined in the slurm.conf file and finally if they have not terminated send a SIGKILL.
これにより、最初にすべてのステップにSIGCONTが送信され、最終的にそれらがウェイクアップされ、続いてSIGTERMが送信され、次にslurm.confファイルで定義されたKillWait期間が待機し、最後に終了していない場合はSIGKILLが送信されます。
This gives time for the running job/step(s) to clean up.
これにより、実行中のジョブ/ステップをクリーンアップする時間が与えられます。

If a signal value of "KILL" is sent to an entire job, this will cancel the active job steps but not cancel the job itself.
「KILL」のシグナル値がジョブ全体に送信された場合、これによりアクティブなジョブステップはキャンセルされますが、ジョブ自体はキャンセルされません。

On Cray systems, all signals except SIGCHLD, SIGCONT, SIGSTOP, SIGTSTP, SIGTTIN, SIGTTOU, SIGURG, or SIGWINCH cause the ALPS reservation to be released.
Crayシステムでは、SIGCHLD、SIGCONT、SIGSTOP、SIGTSTP、SIGTTIN、SIGTTOU、SIGURG、またはSIGWINCHを除くすべてのシグナルにより、ALPS予約が解放されます。
The job however will not be terminated except in the case of SIGKILL and may then be used for post processing.
ただし、ジョブはSIGKILLの場合を除いて終了せず、後処理に使用できます。

AUTHORIZATION

When using SlurmDBD, users who have an AdminLevel defined (Operator or Admin) and users who are account coordinators are given the authority to invoke scancel on other users jobs.
SlurmDBDを使用する場合、AdminLevelが定義されているユーザー（OperatorまたはAdmin）およびアカウントコーディネーターであるユーザーには、他のユーザーのジョブでscancelを呼び出す権限が与えられます。

EXAMPLES

Send SIGTERM to steps 1 and 3 of job 1234: ジョブ1234のステップ1および3にSIGTERMを送信します。: scancel --signal=TERM 1234.1 1234.3
Cancel job 1234 along with all of its steps: ジョブ1234とそのすべてのステップをキャンセルします。: scancel 1234
Send SIGKILL to all steps of job 1235, but do not cancel the job itself: ジョブ1235のすべてのステップにSIGKILLを送信しますが、ジョブ自体はキャンセルしないでください。: scancel --signal=KILL 1235
Send SIGUSR1 to the batch shell processes of job 1236: SIGUSR1をジョブ1236のバッチシェルプロセスに送信します。: scancel --signal=USR1 --batch 1236
Cancel job all pending jobs belonging to user "bob" in partition "debug": パーティション「debug」のユーザー「bob」に属するすべての保留中のジョブをキャンセルします。: scancel --state=PENDING --user=bob --partition=debug
Cancel only array ID 4 of job array 1237 ジョブアレイ1237のアレイID4のみをキャンセルします: scancel 1237_4

COPYING

Copyright (C) 2002-2007 The Regents of the University of California. Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
Copyright (C) 2008-2011 Lawrence Livermore National Security.
Copyright (C) 2010-2015 SchedMD LLC.

This file is part of Slurm, a resource management program. For details, see <https://slurm.schedmd.com/>.

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.

This document was created by man2html using the manual pages.
Time: 20:44:46 GMT, May 21, 2020