qterm(8B)

✨ qterm(8B) — the "bye bye server" manual ✨

Okay bestie, so this is the manpage for qterm(8B) from PBS Professional, and it's literally the command you use when you need to say peace out to your PBS servers. Let me break it down for you 💅

🌸 NAME 🌸

qterm — terminate one or both PBS servers, and optionally terminate scheduler(s) and/or MoMs

🎀 SYNOPSIS 🎀

qterm [-f | -F | -i] [-m] [-s] [-t <type>] [<server>[ <server> ...]]
qterm --version

💖 DESCRIPTION 💖

So the qterm command terminates a PBS batch server. That's the main character energy right there.

Once the server is terminating, no new jobs are accepted by the server, and no jobs are allowed to begin execution. The impact on running jobs depends on the way the server is shut down — like, it's giving "different vibes for different shutdown types".

The qterm command does not exit until the server has completed its shutdown procedure. So it's not ghosting you — it waits for the whole thing to finish.

If the complex is configured for failover, and the primary server is shut down, the normal behavior for the secondary server is to become active. The qterm command provides options to manage the behavior of the secondary server; it can be shut down, forced to remain idle, or shut down in place of the primary server.

Required Privilege In order to run the qterm command, you must have PBS Operator or Manager privilege. So like, you need the right access, no cap.

🌈 OPTIONS 🌈

• (no options) — The qterm command defaults to qterm -t quick. So if you just run it with no flags, it's doing the quick thing by default.
• -f — If the complex is configured for failover, shuts down both the primary and secondary servers. Without the -f option, qterm shuts down the primary server and makes the secondary server active. The -f option cannot be used with the -i or -F options. So like, don't try to combine them, bestie.
• -F — If the complex is configured for failover, shuts down only the secondary server, leaving the primary server active. The -F option cannot be used with the -f or -i options. Periodt.
• -i — If the complex is configured for failover, leaves the secondary server idle when the primary server is shut down. The -i option cannot be used with the -f or -F options. Slay.
• -m — Shuts down the primary server and all MoMs (pbs_mom). This option does not cause jobs or subjobs to be killed. Jobs are left running subject to other options to the qterm command. So it's giving "I'm leaving but not taking you with me".
• -s — Shuts down the primary server and the scheduler (pbs_sched). Bye scheduler!
• -t <type> — The type specifies how the server is shut down. The types are the following:

🔥 immediate 🔥

Shuts down the primary server. Immediately stops all running jobs. Any running jobs that can be checkpointed are checkpointed, terminated, and requeued. Jobs that cannot be checkpointed are terminated and requeued if they are rerunnable, otherwise they are killed.

If any job cannot be terminated, for example the server cannot contact the MoM of a running job, the server continues to execute and the job is listed as running. The server can be terminated by a second qterm -t immediate command.

While terminating, the server is in the Terminating state. So like, it's actively terminating, not just chilling.

🦋 delay 🦋

Shuts down the primary server. The server waits to terminate until all non-checkpointable, non-rerunnable jobs are finished executing. Any running jobs that can be checkpointed are checkpointed, terminated, and requeued. Jobs that cannot be checkpointed are terminated and requeued if they are rerunnable, otherwise they are allowed to continue to run.

While terminating, the server is in the Terminating-Delayed state. So it's giving "I'll go when I'm ready".

🍓 quick 🍓

Shuts down the primary server. Running jobs and subjobs are left running.

This is the default behavior when no options are given to the qterm command.

While terminating, the server is in the Terminating state. So it's the quickest vibe.

Okay so like, <pink>-f</pink>, <pink>-F</pink>, and <pink>-i</pink> are mutually exclusive bestie — pick one, not all three. The manpage is very clear about that.

• --version — The qterm command returns its PBS version information and exits. This option can only be used alone. So don't try to pair it with anything else, bestie.

🫶 OPERANDS 🫶

You optionally specify the list of servers to shut down using [<server>[ <server> ...].

If you do not specify any servers, the qterm command shuts down the default server. So if you're like "shut down whatever the default is", just don't list any servers.

🍓 STANDARD ERROR 🍓

The qterm command writes a diagnostic message to standard error for each error occurrence. So like, if something goes wrong, it's gonna tell you.

🧚 EXIT STATUS 🧚

• Zero — Upon successful processing of all operands presented to the qterm command. Like, everything worked, slay.
• Greater than zero — If the qterm command fails to process any operand. So like, something didn't work, and it's not happy about it.

💜 SEE ALSO 💜

pbs_server(8B), pbs_mom(8B), pbs_sched(8B)

This iconic page is from the Local version, dated 6 May 2020, for qterm(8B). 💅✨