pbs_server(8B)

💖 NAME 💖

pbs_server — start a PBS batch server. welcome to the pbs_server(8B) page from PBS Professional, bestie; this is the part where your server wakes up and starts doing server things ✨

🌸 SYNOPSIS 🌸

pbs_server [-a <active>] [-A <acctfile>] [-C] [-d <config path>]
           [-e <mask>] [-F <delay>] [-L <logfile>] [-M <MoM port>] [-N]
           [-p <port number>] [-R <MoM RPP port>] [-S <default scheduler
           port>] [-s <replacement string>] [-t <restart type>]
pbs_server --version

🦋 DESCRIPTION 🦋

okay so the pbs_server command starts a batch server on the local host. typically it lives in a local boot file like /etc/rc.local, doing its little startup ritual 🎀 if the batch server is already running, pbs_server exits with an error — no duplicate main character energy allowed, periodt.

🔐 Required Permission 🔐

so that the general user community cannot run the pbs_server command, the server runs only if its real and effective uid is zero. you must be root. that’s the vibe check, and it is strict 💅

🎀 OPTIONS 🎀

• -A <acctfile> — gives an absolute path name for the file to use as the accounting file. if you don’t specify it, the file is named for the current date inside the PBS_HOME/server_priv/accounting directory 💖
• -a <active> — when True, the server is in state "active" and the default scheduler is called to schedule jobs. when False, the server is in state "idle" and the default scheduler is not called to schedule jobs. this sets the server’s scheduling attribute. if you don’t specify this option, the server uses the prior value for the scheduling attribute. format: Boolean ✨
• -C — the server starts up, creates the database, and exits. Windows only 🪟
• -d <config path> — gives the absolute path to the directory containing the server configuration files, PBS_HOME. each server must have a different configuration directory. the default configuration directory is specified in $PBS_HOME, and is typically /var/spool/PBS 🗂️
• -e <mask> — sets a log event mask to be used when logging. see "log_events" in the pbs_server_attributes(7B) man page 👀
• -F <delay> — sets the number of seconds the secondary server should wait before taking over when it believes the primary server is down. if the number of seconds is specified as -1, the secondary will make one attempt to contact the primary and then become active. default: 30 seconds ⏳
• -L <logfile> — gives the absolute path name for the log file. if you don’t specify it, the file is named for the current date inside the PBS_HOME/server_logs directory. PBS_HOME is specified in the $PBS_HOME environment variable or in /etc/pbs.conf; see the -d option 🧾
• -M <MoM port> — specifies the host name and/or port number on which the server should connect to MOM. the option argument, MoM port, uses the syntax: [<hostname>][:<port number>]. if hostname is not specified, the local host is assumed. if port number is not specified, the default port is assumed. see the -M option for pbs_mom(8). default: 15002 🔌
• -N — runs the server in standalone mode 🧍
• -p <port number> — specifies the port number on which the server is to listen for batch requests. if multiple servers are running on a single host, each must have its own unique port number. this option is for use in testing with multiple batch systems on a single host. default: 15001 📡
• -R <MoM RPP port> — specifies the port number on which the server should query the up/down status of MoM. see the -R option for pbs_mom(8). default: 15003 🩺
• -S <default scheduler port> — specifies the port number to which the server should connect when contacting the default scheduler. the option argument, default scheduler port, uses the syntax: [<hostname>][:<port number>]. default: 15004 🗓️
• -s <replacement string> — specifies the string to use when replacing spaces in accounting entity names. only available under Windows 🪟
• -t <restart type> — specifies behavior when the server restarts. the restart type argument is one of these besties:
  • cold — all jobs are purged. positive confirmation is required before this direction is accepted 🧊
  • create — the server discards any existing configuration files: server, nodes, queues, and jobs, and initializes configuration files to the default values. the default scheduler is idled ( scheduling is set to False ). any multischeds are deleted 🧨
  • hot — all jobs in the Running state are retained in that state. any job that was requeued into the Queued state from the Running state when the server last shut down is run immediately, assuming the required resources are available. this returns the server to the same state as when it went down. after those jobs are restarted, normal scheduling takes place for all remaining queued jobs. all other jobs are retained in their current state. if a job cannot be restarted immediately because of a missing resource, such as a vnode being down, the server attempts to restart it periodically for up to 5 minutes. after that period, the server will revert to a normal state, as if warm started, and will no longer attempt to restart any remaining jobs which were running prior to the shutdown 🔥
  • updatedb — updates format of PBS data from the previous format to the data service format 🧬
  • warm — all jobs in the Running state are retained in that state. all other jobs are maintained in their current state. the default scheduler typically chooses new jobs for execution. warm is the default if -t is not specified 🌤️
• --version — the pbs_server command returns its PBS version information and exits. this option can only be used alone ⭐

📁 FILES 📁

• $PBS_HOME/server_priv — default directory for configuration files 🗃️
• $PBS_HOME/server_logs — directory for log files recorded by the server 📓

🚦 Signal Handling 🚦

when it receives the following signals, the server performs the following actions:

• SIGHUP — the current server log and accounting log are closed and reopened. this allows for the prior log to be renamed and a new log started from the time of the signal 🔁
• SIGTERM — causes a rapid orderly shutdown of pbs_server, identical to qterm -t quick 💀
• SIGSHUTDN — on systems where SIGSHUTDN is defined, causes an orderly quick shutdown of the server 🛑
• SIGPIPE, SIGUSR1, SIGUSR2 — these signals are ignored 🙈
• all other signals have their default behavior installed 🎯

🩺 Diagnostic Messages 🩺

the server will record a diagnostic message in a log file for any error occurrence. the log files are maintained in the server_logs directory below the home directory of the server. if the log file cannot be opened, the diagnostic message is written to the system console. the server writes its PBS version and build information to the logfile whenever it starts up or the logfile is rolled to a new file 📝

🛑 Stopping the PBS Server 🛑

🐧 Stopping the Server on Linux 🐧

use the qterm command:

qterm

(see qterm(8B))

or send a SIGTERM:

kill <server PID>

🏁 EXIT STATUS 🏁

• Zero — when the server has run in the background and then exits ✅
• Greater than zero — if the server command fails to begin batch operation ❌

👀 SEE ALSO 👀

qsub (1B), pbs_connect(3B), pbs_mom(8B), pbs_sched(8B), pbsnodes(8B), qdisable(8B), qenable(8B), qmgr(8B), qrun(8B), qstart(8B), qstop(8B), and qterm(8B) 🫶

💖 that’s the whole pbs_server(8B) glow-up, bestie. cute little sign-off: Local · 6 May 2020 · PBS Professional · pbs_server(8B) — stay root, stay iconic 💅🌈