.TH scancel "1" "Slurm Commands" "Slurm 26.05" "Slurm Commands"

.SH "نام (NAME)"
scancel \- برای ارسال سیگنال یا لغو کارها یا گام‌های کاری تحت کنترل Slurm به کار می‌رود.

.SH "خلاصه دستور (SYNOPSIS)"
\fBscancel\fR [\fIOPTIONS\fR...] [\fIjob_id\fR[_\fIarray_id\fR][.\fIstep_id\fR]] [\fIjob_id\fR[_\fIarray_id\fR][.\fIstep_id\fR]...]

.SH "توضیحات (DESCRIPTION)"
دستور \fBscancel\fR برای ارسال سیگنال یا لغو کارها، آرایه‌های کاری یا گام‌های کاری به کار می‌رود.
می‌توان به تعداد دلخواهی از کارها یا گام‌های کاری با استفاده از پالایه‌های مشخصات کار یا فهرستی از شناسه‌های کار و/یا شناسه‌های گام که با فاصله از هم جدا شده‌اند، سیگنال ارسال کرد.
اگر شناسه کار مربوط به یک آرایه کاری همراه با مقدار شناسه آرایه مشخص شود و کار مرتبط با آن شناسه آرایه از آرایه جدا شده باشد، تنها آن عضو از آرایه کاری لغو خواهد شد.
اگر شناسه کار یک آرایه کاری بدون مقدار شناسه آرایه مشخص شود یا مقدار شناسه آرایه با کاری مطابقت داشته باشد که از آرایه جدا نشده است، تمام اعضای آن آرایه کاری لغو خواهند شد.
هنگامی که یک کار ناهمگن (heterogeneous job) در وضعیت PENDING قرار دارد، به جای بخش‌های مجزای آن، فقط کل کار به صورت یکپارچه قابل لغو است.
درخواست برای لغو یک بخش منفرد از یک کار ناهمگن در وضعیت PENDING منجر به بازگرداندن خطا خواهد شد.
پس از آغاز اجرای کار، می‌توان بخش‌های مجزا را به جز جزء صفر لغو کرد. در صورتی که جزء صفر لغو شود، کل کار ناهمگن لغو خواهد شد.
شناسه‌های گام (Step IDs) در سرتاسر کل کار ناهمگن یکتا هستند.
لغو یک گام از طریق رهبر کار، آن گام را در تمام مؤلفه‌هایی که آن را دارند متوقف می‌کند و تخصیص منابع مؤلفه‌ها را در حال اجرا باقی می‌گذارد.
لغو یک گام از طریق یک مؤلفه منفرد، تنها به گام همان مؤلفه سیگنال می‌دهد.
اگر مؤلفه‌ای آن گام را نداشته باشد خطا محسوب نمی‌شود؛ تنها شناسه گامی که هیچ مؤلفه‌ای آن را نداشته باشد به عنوان شناسه کار نامعتبر گزارش می‌شود.
سیگنال‌هایی غیر از SIGKILL پیش‌فرض تنها به گامِ...
شناسه‌های گام در سرتاسر کل کار ناهمگن یکتا هستند.
لغو یک گام از طریق مؤلفه صفر (رهبر کار ناهمگن)، آن گام را در هر مؤلفه‌ای که آن را دارد خاتمه می‌دهد و منابع اختصاص‌یافته به مؤلفه‌ها را در حال اجرا باقی می‌گذارد.
اگر برخی از مؤلفه‌ها آن گام را نداشته باشند خطایی رخ نمی‌دهد؛ تنها شناسه گامی که هیچ مؤلفه‌ای آن را ندارد به عنوان شناسه کار نامعتبر گزارش می‌شود.
لغو یک گام از طریق یک مؤلفه منفرد، تنها به گامِ همان مؤلفه سیگنال می‌فرستد.
اگر آن مؤلفه این گام را نداشته باشد، درخواست به عنوان شناسه کار نامعتبر گزارش خواهد شد.
سیگنال‌هایی به غیر از SIGKILL پیش‌فرض، تنها به گام مؤلفه‌ای ارسال می‌شوند که شناسه کار آن داده شده است.
یک کار یا گام کاری تنها می‌تواند توسط مالک آن کار یا کاربر root سیگنال دریافت کند.
اگر کاربری غیرمجاز برای ارسال سیگنال به یک کار یا گام کاری تلاش کند، پیام خطا چاپ شده و سیگنالی به کار ارسال نخواهد شد.

.SH "گزینه‌ها (OPTIONS)"

.TP
\fB\-A\fR, \fB\-\-account\fR=\fIaccount\fR
عملیات scancel را به کارهای تحت این حساب کاربری مالی (charge account) محدود می‌کند.
.IP

.TP
\fB\-\-admin\-comment\fR=\fIcomment\fR
تنظیم AdminComment روی کار در حین لغو کارها. کاربر باید دارای امتیازات مدیر سیستم (Administrator) در سامانه باشد.
.IP

.TP
\fB\-b\fR, \fB\-\-batch\fR
به‌طور پیش‌فرض، سیگنال‌هایی غیر از SIGKILL به گام دسته‌ای (batch step یا همان اسکریپت شل) ارسال نمی‌شوند. با استفاده از این گزینه، \fBscancel\fR تنها به گام دسته‌ای سیگنال می‌فرستد و نه به هیچ‌یک از گام‌های دیگر.
این قابلیت زمانی مفید است که اسکریپت شل نیاز به دریافت و به دام انداختن (trap) سیگنال و انجام اقداماتی خاص داشته باشد.
بیشتر شل‌ها توانایی مدیریت سیگنال‌ها را در زمان اجرای یک دستور (یعنی زمانی که فرآیند فرزند گام دسته‌ای فعال است) ندارند، بنابراین شل باید تا پایان دستور منتظر بماند تا سیگنال را پردازش کند.
فرآیندهای فرزند گام دسته‌ای با این گزینه سیگنال دریافت نمی‌کنند. در صورت نیاز به این رفتار، به جای آن از \fB\-f\fR یا \fB\-\-full\fR استفاده کنید.
\fBنکته\fR: در صورت استفاده همزمان با \fB\-f\fR یا \fB\-\-full\fR، این گزینه نادیده گرفته می‌شود.
\fBنکته\fR: اگر \fIstep_id\fR مشخص شده باشد، این گزینه قابل استفاده نیست.
\fBنکته\fR: خود شل ممکن است به هنگام دریافت بسیاری از سیگنال‌ها بسته شود. می‌توانید با به دام انداختن صریح سیگنال‌ها در اسکریپت شل (مانند "trap <arg> <signals>") از این اتفاق جلوگیری کنید. برای جزئیات به مستندات شل مراجعه کنید.
.IP

.TP
\fB\-M\fR, \fB\-\-clusters\fR=<\fIstring\fR>
خوشه‌ای که دستورها باید به آن ارسال شوند. متضمن گزینه \fB\-\-ctld\fR است.
توجه داشته باشید که \fBslurmdbd\fR باید فعال و در دسترس باشد تا این گزینه به درستی کار کند، مگر اینکه در یک فدراسیون با تنظیمات \fBFederationParameters=fed_display\fR اجرا شود.
.IP

.TP
\fB\-\-ctld\fR
اگر این گزینه همراه با \fB\-\-interactive\fR، \fB\-\-sibling\fR، شناسه‌های کار فدراسیونی یا شناسه‌های مشخص گام به کار نرود، یک درخواست منفرد به slurmctld ارسال می‌کند تا به تمامی کارهای مطابق با پالایه‌های ارائه‌شده سیگنال دهد. این امر عملکرد slurmctld و scancel را به شکل چشمگیری بهبود می‌بخشد.
در غیر این صورت، این گزینه باعث می‌شود scancel هر درخواست سیگنال‌دهی کار را به جای ارسال مستقیم به دیمن‌های slurmd، به دیمن slurmctld بفرستد؛ این امر بار اضافی (overhead) را افزایش داده ولی پایداری و تحمل خطای بهتری ارائه می‌دهد. هنگامی که از گزینه \fB\-\-clusters\fR استفاده می‌شود، \fB\-\-ctld\fR رفتار پیش‌فرض است.
.IP

.TP
\fB\-c\fR, \fB\-\-cron\fR
تأیید درخواست لغو کاری که از طریق scrontab ارسال شده است. این گزینه تنها زمانی مؤثر است که گزینه "explicit_scancel" در \fBScronParameters\fR فعال باشد.
.IP

.TP
\fB\-f\fR, \fB\-\-full\fR
به‌طور پیش‌فرض، سیگنال‌هایی غیر از SIGKILL به گام دسته‌ای (اسکریپت شل) ارسال نمی‌شوند. با استفاده از این گزینه، \fBscancel\fR به اسکریپت دسته‌ای و فرآیندهای فرزند آن نیز سیگنال می‌فرستد.
اکثر شل‌ها نمی‌توانند در زمان اجرای یک دستور (یعنی فرآیند فرزندِ گام دسته‌ای) سیگنال‌ها را مدیریت کنند؛ بنابراین شل باید تا پایان آن دستور منتظر بماند تا سیگنال را پردازش کند.
برخلاف \fB\-b\fR و \fB\-\-batch\fR، با این گزینه به فرآیندهای فرزند گام دسته‌ای نیز سیگنال ارسال می‌شود.
\fBنکته\fR: گام‌های srun نیز از فرزندان گام دسته‌ای محسوب می‌شوند، بنابراین با استفاده از این گزینه، به این گام‌ها نیز سیگنال فرستاده می‌شود.
.IP

.TP
\fB\-\-help\fR
چاپ پیام راهنما که تمامی گزینه‌های \fBscancel\fR را شرح می‌دهد.
.IP

.TP
\fB\-H\fR, \fB\-\-hurry\fR
داده‌های میانگیر جهشی (burst buffer) را تخلیه (stage out) نکن.
.IP

.TP
\fB\-i\fR, \fB\-\-interactive\fR
حالت تعاملی. پیش از اجرای عملیات لغو، تأییدیه هر job_id.step_id را دریافت می‌کند.
.IP

.TP
\fB\-n\fR, \fB\-\-jobname\fR=\fIjob_name\fR, \fB\-\-name\fR=\fIjob_name\fR
محدود کردن عملیات scancel به کارهایی با این نام کاربری شغلی.
.IP

.TP
\fB\-\-me\fR
محدود کردن عملیات scancel به کارهای متعلق به کاربر فعلی.

.TP
\fB\-w\fR, \fB\-\-nodelist=\fIhost1,host2,...\fR
لغو هر کاری که از هریک از میزبان‌های داده‌شده استفاده می‌کند. این فهرست می‌تواند به صورت فهرستی از میزبان‌ها با ویرگول جداشده، محدوده‌ای از میزبان‌ها (برای نمونه host[1\-5,7,...]) یا نام یک فایل مشخص شود. فهرست میزبان‌ها تنها زمانی به عنوان نام فایل تلقی خواهد شد که حاوی نویسه "/" باشد.
.IP

.TP
\fB\-p\fR, \fB\-\-partition\fR=\fIpartition_name\fR
محدود کردن عملیات scancel به کارهای موجود در این افراز (partition).
.IP

.TP
\fB\-q\fR, \fB\-\-qos\fR=\fIqos\fR
محدود کردن عملیات scancel به کارهایی با این کیفیت خدمات (QoS).
.IP

.TP
\fB\-Q\fR, \fB\-\-quiet\fR
اگر کار مشخص‌شده پیش‌تر خاتمه یافته باشد، خطایی گزارش نکن. این گزینه با گزینه \fB\-\-verbose\fR ناسازگار است.
.IP

.TP
\fB\-R\fR, \fB\-\-reservation\fR=\fIreservation_name\fR
محدود کردن عملیات scancel به کارهایی با این نام رزرو (reservation).
.IP

.TP
\fB\-\-sibling\fR=\fIcluster_name\fR
حذف یک کار همزاد (sibling job) فعال از یک کار فدراسیونی.
.IP.TP
\fB\-s\fR, \fB\-\-signal\fR=\fIsignal_name\fR
نام یا شماره سیگنالی که باید ارسال شود. اگر از این گزینه استفاده نشود،
کار یا گام مشخص‌شده خاتمه خواهد یافت.
.IP

.TP
\fB\-t\fR, \fB\-\-state\fR=\fIjob_state_name\fR
عملیات \fBscancel\fR را به کارهای موجود در این وضعیت محدود می‌کند.
\fIjob_state_name\fR می‌تواند یکی از مقادیر \(lqPENDING\(rq،
\(lqRUNNING\(rq یا \(lqSUSPENDED\(rq باشد.
.IP

.TP
\fB\-\-usage\fR
چاپ یک پیام راهنمای مختصر شامل فهرست گزینه‌های \fBscancel\fR.
.IP

.TP
\fB\-u\fR, \fB\-\-user\fR=\fIuser_name\fR
عملیات \fBscancel\fR را به کارهای متعلق به کاربر داده‌شده محدود می‌کند.
.IP

.TP
\fB\-v\fR, \fB\-\-verbose\fR
چاپ پیام‌های گزارش‌گیری بیشتر. تکرار v جزئیات گزارش را افزایش می‌دهد.
این گزینه با گزینه \fB\-\-quiet\fR ناسازگار است.
.IP

.TP
\fB\-V\fR, \fB\-\-version\fR
چاپ شماره نسخه دستور \fBscancel\fR.
.IP

.TP
\fB\-\-wckey\fR=\fIwckey\fR
عملیات \fBscancel\fR را به کارهایی که از این کلید مشخصه حجم‌کاری (wckey)
استفاده می‌کنند محدود می‌کند.
.IP

.SH "آرگومان‌ها (ARGUMENTS)"

.TP
\fIjob_id\fP
شناسه کار Slurm برای ارسال سیگنال. همچنین می‌توان به‌جای شناسه عددی کار،
از یک SLUID استفاده کرد.
.IP

.TP
\fIstep_id\fP
شناسه گامِ مربوط به گام کار که باید به آن سیگنال فرستاده شود.
در صورت عدم تعیین، عملیات در سطح کار انجام می‌پذیرد.

اگر نه از \fB\-\-batch\fR و نه از \fB\-\-signal\fR استفاده نشود،
کل کار خاتمه خواهد یافت.

هنگامی که از \fB\-\-batch\fR استفاده شود، به فرایندهای پوسته دسته‌ای سیگنال فرستاده می‌شود.
فرایندهای فرزند پوسته توسط Slurm سیگنال دریافت نخواهند کرد، اما
پوسته ممکن است سیگنال را فوروارد کند.

هنگامی که از \fB\-\-batch\fR استفاده نشود اما از \fB\-\-signal\fR استفاده شود،
به تمام گام‌های کار سیگنال ارسال خواهد شد، اما به خود اسکریپت دسته‌ای
سیگنالی فرستاده نمی‌شود.
.IP

.SH "عملکرد (PERFORMANCE)"
.PP
هنگام اجرای \fBscancel\fR بدون گزینه \fB\-\-ctld\fR؛ یا همراه با گزینه
\fB\-\-ctld\fR و گزینه‌های \fB\-\-interactive\fR، \fB\-\-sibling\fR، یا شناسه‌های گام مشخص؛
یک فراخوانی روال از راه دور (RPC) به \fBslurmctld\fR فرستاده می‌شود تا تمام کارها
دریافت شوند. سپس \fBscancel\fR برای هر کاری که با فیلترهای درخواست‌شده مطابقت دارد،
یک فراخوانی روال از راه دور ارسال سیگنال می‌فرستد.

هنگام اجرای \fBscancel\fR با گزینه \fB\-\-ctld\fR و بدون گزینه‌های
\fB\-\-interactive\fR، \fB\-\-sibling\fR یا شناسه‌های گام مشخص، یک
فراخوانی روال از راه دور واحد به \fBslurmctld\fR فرستاده می‌شود تا به تمام کارهای منطبق
با فیلترهای درخواست‌شده سیگنال ارسال کند. بنابراین توصیه می‌شود از گزینه \fB\-\-ctld\fR
به‌منظور کاهش تعداد فراخوانی‌های روال از راه دور ارسالی به \fBslurmctld\fR استفاده شود.

.PP
اگر تعداد بسیار زیادی فراخوانی به‌طور هم‌زمان از سوی \fBscancel\fR یا سایر دستورهای کلاینت Slurm
که فراخوانی روال از راه دور به دیمن \fBslurmctld\fR می‌فرستند دریافت شود، می‌تواند به افت
عملکرد دیمن \fBslurmctld\fR منجر شده و احتمالاً باعث ایجاد شرایط منع سرویس (denial of service) گردد.

.PP
دستور \fBscancel\fR یا سایر دستورهای کلاینت Slurm را که فراخوانی‌های روال از راه دور به
\fBslurmctld\fR می‌فرستند، درون حلقه‌ها در اسکریپت‌های پوسته یا دیگر برنامه‌ها اجرا نکنید.
اطمینان حاصل کنید که برنامه‌ها، فراخوانی‌های \fBscancel\fR را به حداقل مقدار لازم برای
اطلاعاتی که قصد گردآوری آن را دارید محدود می‌سازند..SH "متغیرهای محیطی (ENVIRONMENT VARIABLES)"
.PP
برخی از گزینه‌های \fBscancel\fR را می‌توان از طریق متغیرهای محیطی تعیین کرد. این
متغیرهای محیطی، به همراه گزینه‌های متناظرشان، در زیر فهرست شده‌اند.
(نکته: گزینه‌های خط فرمان همواره بر این تنظیمات اولویت دارند.)

.TP 20
\fBSCANCEL_ACCOUNT\fR
\fB\-A\fR, \fB\-\-account\fR=\fIaccount\fR
.IP

.TP
\fBSCANCEL_BATCH\fR
\fB\-b, \-\-batch\fR
.IP

.TP
\fBSCANCEL_CTLD\fR
\fB\-\-ctld\fR
.IP

.TP
\fBSCANCEL_CRON\fR
\fB\-c, \-\-cron\fR
.IP

.TP
\fBSCANCEL_FULL\fR
\fB\-f, \-\-full\fR
.IP

.TP
\fBSCANCEL_HURRY\fR
\fB\-H\fR, \fB\-\-hurry\fR
.IP

.TP
\fBSCANCEL_INTERACTIVE\fR
\fB\-i\fR, \fB\-\-interactive\fR
.IP

.TP
\fBSCANCEL_NAME\fR
\fB\-n\fR, \fB\-\-name\fR=\fIjob_name\fR
.IP

.TP
\fBSCANCEL_PARTITION\fR
\fB\-p\fR, \fB\-\-partition\fR=\fIpartition_name\fR
.IP

.TP
\fBSCANCEL_QOS\fR
\fB\-q\fR, \fB\-\-qos\fR=\fIqos\fR
.IP

.TP
\fBSCANCEL_STATE\fR
\fB\-t\fR, \fB\-\-state\fR=\fIjob_state_name\fR
.IP

.TP
\fBSCANCEL_USER\fR
\fB\-u\fR, \fB\-\-user\fR=\fIuser_name\fR
.IP

.TP
\fBSCANCEL_VERBOSE\fR
\fB\-v\fR, \fB\-\-verbose\fR
.IP

.TP
\fBSCANCEL_WCKEY\fR
\fB\-\-wckey\fR=\fIwckey\fR
.IP

.TP
\fBSLURM_CONF\fR
محل قرارگیری فایل پیکربندی Slurm.
.IP

.TP
\fBSLURM_CLUSTERS\fR
\fB\-M\fR, \fB\-\-clusters\fR
.IP

.TP
\fBSLURM_DEBUG_FLAGS\fR
پرچم‌های اشکال‌زدایی را برای استفاده توسط scancel مشخص می‌کند. برای فهرست
کامل پرچم‌ها، DebugFlags را در صفحهٔ راهنمای \fBslurm.conf\fR(5) ببینید. این
متغیر محیطی بر مقدار تنظیم‌شده در slurm.conf اولویت دارد.
.IP.SH "نکات (NOTES)"
.LP
اگر چندین فیلتر مشخص شده باشد (مانند \fB\-\-partition\fR و \fB\-\-name\fR)
تنها به کارهایی که با تمام گزینه‌های فیلترکردن همخوانی داشته باشند سیگنال ارسال خواهد شد.
.LP
لغو یک گام کاری (job step) منجر به پایان یافتن کار نخواهد شد.
برای آزادسازی تخصیص منابع، خود کار باید لغو شود.
.LP
برای لغو یک کار، \fBscancel\fR را بدون گزینهٔ \-\-signal اجرا کنید. این
دستور ابتدا یک سیگنال SIGCONT به تمام گام‌ها ارسال می‌کند تا در نهایت آن‌ها را بیدار کند، سپس
یک SIGTERM می‌فرستد، بعد به مدت بازهٔ زمانی KillWait تعریف‌شده در فایل slurm.conf منتظر می‌ماند
و در نهایت اگر هنوز پایان نیافته باشند یک SIGKILL ارسال می‌کند. این کار به
کار/گام(های) در حال اجرا فرصت پاک‌سازی می‌دهد.
.LP
اگر مقدار سیگنال "KILL" به کل یک کار ارسال شود، این عمل گام‌های
فعال کار را لغو می‌کند اما خود کار را لغو نخواهد کرد.

.SH "مجوزها (AUTHORIZATION)"

هنگام استفاده از SlurmDBD، به کاربرانی که یک AdminLevel برای آن‌ها تعریف شده است (Operator
یا Admin) و کاربرانی که هماهنگ‌کننده حساب (account coordinator) هستند، این
اختیار داده می‌شود که scancel را برای کارهای سایر کاربران اجرا کنند.

.SH "مثال‌ها (EXAMPLES)"
.IP

.TP
ارسال SIGTERM به گام‌های ۱ و ۳ از کار 1234:
.IP
.nf
$ scancel \-\-signal=TERM 1234.1 1234.3
.fi

.TP
لغو کار 1234 به همراه تمام گام‌های آن:
.IP
.nf
$ scancel 1234
.fi

.TP
ارسال SIGKILL به تمام گام‌های کار 1235، بدون لغو خود کار:
.IP
.nf
$ scancel \-\-signal=KILL 1235
.fi

.TP
ارسال SIGUSR1 به فرایندهای شل دسته‌ای (batch shell) کار 1236:
.IP
.nf
$ scancel \-\-signal=USR1 \-\-batch 1236
.fi

.TP
لغو تمام کارهای در انتظار متعلق به کاربر «bob» در پارتیشن «debug»:
.IP
.nf
$ scancel \-\-state=PENDING \-\-user=bob \-\-partition=debug
.fi

.TP
لغو تنها شناسهٔ آرایهٔ ۴ از کار آرایه‌ای 1237:
.IP
.nf
$ scancel 1237_4
.fi

.SH "کپی‌رایت و تکثیر (COPYING)"
کپی‌رایت (C) 2002\-2007 متعلق به The Regents of the University of California.
تولید شده در Lawrence Livermore National Laboratory (همچنین ببینید: DISCLAIMER).
.br
کپی‌رایت (C) 2008\-2011 متعلق به Lawrence Livermore National Security.
.br
کپی‌رایت (C) 2010\-2022 متعلق به SchedMD LLC.
.LP
این فایل بخشی از Slurm است، یک برنامهٔ مدیریت منابع.
برای جزئیات بیشتر، ببینید: <https://slurm.schedmd.com>.
.LP
نرم‌افزار Slurm یک نرم‌افزار آزاد است؛ شما می‌توانید آن را تحت شرایط
مجوز عمومی همگانی گنو (GNU General Public License) همان‌طور که توسط Free
Software Foundation منتشر شده است، بازتوزیع کرده یا تغییر دهید؛ چه نسخهٔ 2 مجوز و چه (به انتخاب خودتان)
هر نسخهٔ بالاتر دیگری.
.LP
نرم‌افزار Slurm با این امید توزیع شده است که مفید واقع شود، اما بدون هرگونه
ضمانت؛ حتی بدون ضمانت ضمنی قابل فروش بودن یا تناسب
برای یک هدف خاص. برای جزئیات بیشتر به GNU General Public License مراجعه
کنید..SH "همچنین ببینید (SEE ALSO)"
\fBslurm_kill_job\fR (3)، \fBslurm_kill_job_step\fR (3)