pbs_hook_attributes(7B)

💖 NAME 💖

Welcome to pbs_hook_attributes(7B), the PBS Professional manual page for attributes of PBS hooks. It's giving "hook settings cheat sheet," and honestly? Iconic. 💅

✨ DESCRIPTION ✨

Hook attributes can be set, unset, and viewed using the qmgr command. See the qmgr(1B) man page for the full tea. 🫶

An unset hook attribute takes the default value for that attribute. No cap.

privilege check, bestie 🚨 Under UNIX/Linux, root privilege is required in order to operate on hooks. Under Windows, this must be done from the installation account. For domained environments, the installation account must be a local account that is a member of the local Administrators group on the local computer. For standalone environments, the installation account must be a local account that is a member of the local Administrators group on the local computer.

Here are the attributes, all lined up like the main characters they are:

• alarm=<n> — Specifies the number of seconds to allow a hook to run before the hook times out. ⏰
  • Set by administrator.
  • Valid values: >0
  • Format: Integer
  • Default value: 30
• debug — Specifies whether or not the hook produces debugging files under PBS_HOME/server_priv/hooks/tmp or PBS_HOME/mom_priv/hooks/tmp. Files are named hook_<hook event>_<hook name>_<unique ID>.in, .data, and .out. When this is set to true, the hook leaves debugging files. 🐛
  • Set by administrator.
  • Format: Boolean
  • Default value: False
• enabled — Determines whether or not a hook is run when its triggering event occurs. If a hook's enabled attribute is True, the hook is run. ✅
  • Set by administrator.
  • Format: Boolean
  • Default: True
• event — List of events that trigger the hook. Can be operated on with the "=", "+=", and "-=" operators. The provision event cannot be combined with any other events. 🚫
  • Valid events:
    • "exechost_periodic"
    • "exechost_startup"
    • "execjob_attach"
    • "execjob_begin"
    • "execjob_end"
    • "execjob_epilogue"
    • "execjob_launch"
    • "execjob_postsuspend"
    • "execjob_preresume"
    • "execjob_preterm"
    • "execjob_prologue"
    • "modifyjob"
    • "movejob"
    • "periodic"
    • "provision"
    • "queuejob"
    • "resvsub"
    • "runjob"
    • "" (meaning no event)
  • Set by administrator.
  • Format: string array
  • Default value: "" (meaning none, i.e. the hook is not triggered)
• fail_action — Specifies the action to be taken when hook fails due to alarm call or unhandled exception, or to an internal error such as not enough disk space or memory. Can also specify a subsequent action to be taken when hook runs successfully. Value can be either "none" or one or more of "offline_vnodes", "clear_vnodes_upon_recovery", and "scheduler_restart_cycle". If this attribute is set to multiple values, scheduler restart happens last. 😭
  • offline_vnodes — After unsuccessful hook execution, offlines the vnodes managed by the MoM executing the hook. Only available for execjob_prologue, exechost_startup and execjob_begin hooks.
  • clear_vnodes_upon_recovery — After successful hook execution, clears vnodes previously offlined via offline_vnodes fail action. Only available for exechost_startup hooks.
  • scheduler_restart_cycle — After unsuccessful hook execution, restarts scheduling cycle. Only available for execjob_begin and execjob_prologue hooks.
  • Set by administrator.
  • Format: string_array
  • Default value: "none"
• freq — Number of seconds between periodic or exechost_periodic triggers. ⏳
  • Set by administrator.
  • Format: integer
  • Default: 120 seconds
• order — Indicates relative order of hook execution, for hooks of the same type sharing a trigger. Hooks with lower order values execute before those with higher values. Does not apply to periodic or exechost_periodic hooks. 🔢
  • Set by administrator.
  • Valid values:
    • Built-in hooks: [-1000, 2000]
    • Site hooks: [1, 1000]
  • Format: Integer
  • Default value: 1
• Type — The type of the hook. Cannot be set for a built-in hook.
  • Valid values: "pbs", "site"
  • pbs — Hook is built in. 👑
  • site — Hook is custom (site-defined). 🛠️
  • Set by administrator.
  • Format: String
  • Default value: "site"
• user — Specifies who executes the hook.
  • Valid values: "pbsadmin", "pbsuser"
  • pbsadmin — The hook executes as root. 🔥
  • pbsuser — The hook executes as the triggering job's owner. 🫶
  • Set by administrator.
  • Format: String
  • Default value: "pbsadmin"

🦋 SEE ALSO 🦋

qmgr(1B), pbs_module(7B), pbs_stathook(3B) — go read these too, bestie. ✨

🎀 That's the whole glow-up: this is the Local edition, dated 6 May 2020, for pbs_hook_attributes(7B). Periodt. 💖