QRSUB(1)

💖 QRSUB(1) 💖

okay bestie, welcome to qrsub from the Grid Engine User Commands section of the manual (that's section 1, iykyk). this is the one that books your future resources in advance, and honestly? she's iconic for it. ✨

---

🌸 NAME 🌸

qrsub — Submit an Advance Reservation (AR) to Grid Engine.

---

🎀 SYNTAX 🎀

qrsub [-a date_time] [-A account_string] [-ckpt ckpt_name] [-d time] [-e date_time] [-he yes|no] [-help] [-l resource_list] [-now] [-M user[@host],...] [-N ar_name] [-w e|v] [-pe pe_name slot_range] [-q wc_queue_list] [-u wc_user_list]

---

✨ DESCRIPTION ✨

so Qrsub is your girl for creating an Advance Reservation, aka an AR, in the Grid Engine queuing system. who's allowed to do this? operators, managers, or users referenced in the ACL called "arusers" (peep access_list(5) for that). 💅

and what even is an AR? it's reserving particular consumable resources for future use. these reserved resources are only available for jobs requesting the AR, and the scheduler makes sure those resources are actually available when the start time hits. jobs requesting the AR can only use the reserved consumable resources — no wandering off, no cap. 🫶

when you submit an AR, the Grid Engine queuing system picks the best suited queues for your AR request and then reserves the amount of resources you asked for. for a reservation, all queues that are not in orphaned state count as suited. and the AR only gets granted if the request can actually be fulfilled. only then. periodt.

ARs get deleted either automatically when the end time is reached, or manually with qrdel(1). either way, first all jobs requesting the AR get removed, and then the AR itself. already granted ARs can be shown with qrstat(1). 🦋

Note: to make AR behavior predictable, it's necessary to have reserved resources available at the time of AR start. this is done by keeping jobs with a unlimited runtime limit separated from ARs, and not considering resources used by such jobs for reservation.

Note: Resource Quotas are not considered for AR queue selection, nor for jobs requesting an AR. not even a little bit.

when an AR was successfully added to the Grid Engine queuing system, qrsub returns a unique integer ID referring to the the newly created AR. the highest AR ID is 9999999. if the highest ID is reached, a wraparound happens and the next unused ID, starting with 1, will be used. recycling era. 😌

for qrsub, the administrator and the user may define default request files (analogous to Grid Engine_request for qsub), which can contain any of the possible command line options.

a cluster wide default request file is optional. if such a default request file is used, it must be placed under $SGE_ROOT/$SGE_CELL/common/sge_ar_request (global defaults file).

a user private default request file is optional. if it is used, it must be placed under $HOME/.sge_ar_request (user private defaults file).

---

👑 OPTIONS 👑

• -a date_time — defines the activation (start) date and time of an AR. this option is not mandatory. if you omit it, the current date_time is assumed. either a duration or end date_time must also be specified. for details of the date_time definition please see sge_types(5).
• -A account_string — identifies the account to which the resource reservation of the AR should be charged. for "account_string" value details please see the "name" definition in sge_types(5). if this parameter is absent, Grid Engine will place the default account string "sge" in the accounting record of the AR.
• -ckpt ckpt_name — selects the checkpointing environment (see checkpoint(5)) the AR jobs may request. using this option guarantees that only queues providing this checkpoint environment will be reserved. no substitutes. 💯
• -d date_time — defines the duration of the AR. using -d is optional if -e date_time is requested. for details of the date_time definition please see sge_types(5).
• -e date_time — defines the end date and time of an AR. using -e date_time is optional if -d time is requested. for details about date_time definition please see sge_types(5).
• -he y[es]|n[o] — specifies the behavior when the AR goes into an error state. the AR goes into error state when a reserved host goes into unknown state, a queue error happens, or when a queue is disabled or suspended.

a hard error, -he yes, means as long as the AR is in error state no jobs using the AR will be scheduled. if soft error, -he no, is specified the AR stays usable with the remaining resources. by default soft error handling is used.

• -help — prints a list of all options. bless. 🙏
• -l resource=value,... — creates an AR in a Grid Engine queue, providing the given resource request list. complex(5) describes how a list of available resources and their associated valid value specifiers can be obtained. there may be multiple -l switches in a single command. stack 'em.
• -m b|e|a|n — defines or redefines under which circumstances mail is to be sent to the AR owner or to the users defined with the -M option described below. the option arguments have the following meaning:
  • b — Mail is sent at the beginning of the AR
  • e — Mail is sent at the end of the AR
  • a — Mail is sent when the AR goes into error state
  • n — No mail is sent, default for qrsub
• -M user[@host],... — defines or redefines the list of users to which the qmaster sends mail. 📬
• -masterq wc_queue_list — only meaningful for a parallel AR request together with the -pe option.

this option is used to reserve the proper queues to match this request if it would be requested by a qsub. a more detailed description of wc_queue_list can be found in sge_types(5).

• -now y[es]|n[o] — this option affects the queue selection for reservation. with the -now y option, only queues with the qtype "INTERACTIVE" assigned will be considered for reservation. -now n is the default for qrsub.
• -N name — the name of the AR. the name, if requested, must conform to "name" as defined in sge_types(5). invalid names will be denied at submit time. 🚫
• -w e|v — specifies the validation level applied to the AR request.

the specifiers e and v define the following validation modes:

• v — verify - does not submit the AR but prints an extensive validation report
• e — error - rejects request if requirements cannot be fulfilled, default for qrsub

• -pe parallel_env n[-[m]]|[-]m,... — parallel programming environment (PE) to select for the AR queue reservation. please see the details of a PE in sge_pe(5).
• -q wc_queue_list — defines or redefines a list of cluster queues, queue domains or queue instances that may be reserved by the AR. please find a description of wc_queue_list in sge_types(5). this parameter has all the properties of a resource request and will be merged with requirements derived from the -l option described above.
• -u [username|@access_list],... — defines the users allowed to submit jobs requesting the AR. the access is specified by a comma-separated list containing UNIX users or ACLs (see access_list(5)). an ACL is differentiated from a UNIX user name by prefixing the ACL name with an '@' sign. by default only the AR owner is allowed to submit jobs requesting the AR.

Note: Only queues where all users specified in the list have access are considered for reservation (see queue_conf(5)).

---

🌈 ENVIRONMENT VARIABLES 🌈

• SGE_ROOT — Specifies the location of the Grid Engine standard configuration files.
• SGE_CELL — If set, specifies the default Grid Engine cell. To address a Grid Engine cell, qsub, qsh, qlogin or qalter use (in the order of precedence):
  • The name of the cell specified in the environment variable SGE_CELL, if it is set.
  • The name of the default cell, i.e. default.
• SGE_DEBUG_LEVEL — If set, specifies that debug information should be written to stderr. In addition the level of detail in which debug information is generated is defined.
• SGE_QMASTER_PORT — If set, specifies the TCP port on which sge_qmaster(8) is expected to listen for communication requests. Most installations will use a services map entry for the service "sge_qmaster" instead of defining the port.

---

🍓 FILES 🍓

• $SGE_ROOT/$SGE_CELL/common/sge_ar_request — global defaults file
• $HOME/.sge_ar_request — user private defaults file

---

🧚 SEE ALSO 🧚

qrdel(1), qrstat(1), qsub(1), sge_types(5), checkpoint(5), complex(5), queue_conf(5), sge_pe(5), sge_resource_quota(5).

---

💜 COPYRIGHT 💜

See sge_intro(1) for a full statement of rights and permissions.

---

and that's the whole page, bestie!! this one's from SGE 8.1.3pre, dated 2011-05-20 — vintage but still serving. go reserve something cute 💅✨🎀