OCF_HEARTBEAT_JBOSS(7)

📦
version 4.18.0 · 14 versions
, in fedora 43, fedora 44

💖 ocf_heartbeat_jboss — bestie edition 💖

okay so. welcome to the ocf_heartbeat_jboss page, from the OCF resource agents manual crew (that's section 7 of the manual, iykyk). she manages a JBoss application server instance and honestly? she's iconic for it. 🫶

✨ NAME ✨

ocf_heartbeat_jboss — literally just here to manage a JBoss application server instance. that's the whole job. 💅

✨ SYNOPSIS ✨

jboss [start | stop | status | monitor | meta-data | validate-all]

✨ DESCRIPTION ✨

so this is the resource script for Jboss, no cap. she manages a Jboss instance as an HA resource. that's it, that's the vibe. 🌸

✨ SUPPORTED PARAMETERS ✨

the full menu, bestie. every single one. don't skip, they all matter 💖

  • jboss_version — the version of JBoss. default is 5. okay so listen: the way JBoss works got completely rewritten as of JBoss 6, so if you're on JBoss 6 you gotta specify "6". fr fr.

(optional, integer, default 5)

  • resource_name — the name of the resource. defaults to the name of the resource instance, cute right?

(unique, optional, string, default "RESOURCE_ID")

  • console — where the log of the jboss run and shutdown script goes. the receipts, basically. 📝

(unique, optional, string, default "/var/log/RESOURCE_ID.log")

  • shutdown_timeout — timeout for jboss bin/shutdown.sh. we wait for this timeout to expire, then we send the TERM and QUIT signals. and finally, the KILL signal is used to terminate the jboss process. 💀 so you should set the timeout for the stop operation to a value bigger than the sum of the timeout parameters. see also kill_timeout.

(optional, integer, default 5)

  • kill_timeout — if bin/shutdown.sh doesn't stop the jboss process, then we send it TERM and QUIT signals, intermittently and once a second. after this timeout expires, if the process is still live, we use the KILL signal. see also shutdown_timeout.

(optional, integer, default 10)

  • user — a user name to start a JBoss.

(optional, string, default "root")

  • statusurl — the URL to test in the monitor operation.

(optional, string, default "http://127.0.0.1:8080")

  • java_home — home directory of Java. defaults to the environment variable JAVA_HOME. and if that's not set? then bestie you gotta define this parameter yourself. 🙈

(optional, string, no default)

  • java_opts — Java options.

(optional, string, no default)

  • jboss_home — home directory of Jboss. this one is required, no skipping.

(required, string, no default)

  • jboss_base_dir — base directory of JBoss. heads up: this parameter is not used in JBoss5.

(optional, string, no default)

  • pstring — with this string heartbeat matches for the right process to kill. 🎯

(optional, string, default "java -Dprogram.name=run.sh")

  • run_command — JBoss start command.

(optional, string, default "/bin/run.sh")

  • run_opts — start options to start Jboss with, defaults are from the Jboss-Doku.

(optional, string, default "-c default")

  • shutdown_opts — stop options to stop Jboss with.

(optional, string, default "-s 127.0.0.1:1099")

  • rotate_consolelog — rotate console log flag.

(optional, boolean, default false)

  • rotate_value — console log rotation value (default is 86400 seconds).

(optional, integer, default 86400)

  • rotate_logsuffix — rotate console log suffix.

(optional, integer, default .%F)

✨ SUPPORTED ACTIONS ✨

this resource agent supports the following actions (operations), and yes every one of them has a suggested minimum timeout because we're responsible like that 💅

  • start — starts the resource. suggested minimum timeout: 60s.
  • stop — stops the resource. suggested minimum timeout: 120s.
  • status — performs a status check. suggested minimum timeout: 30s.
  • monitor — performs a detailed status check. suggested minimum timeout: 30s. suggested interval: 10s. 👀
  • meta-data — retrieves resource agent metadata (internal use only). suggested minimum timeout: 5s.
  • validate-all — performs a validation of the resource configuration. suggested minimum timeout: 5s.

✨ EXAMPLE CRM SHELL ✨

here's an example config for a jboss resource using the crm(8) shell, copied exactly, character for character, because details matter bestie 🎀

primitive p_jboss ocf:heartbeat:jboss \
  params \
    jboss_home=string \
  op monitor depth="0" timeout="30s" interval="10s"

✨ EXAMPLE PCS ✨

and here's the same energy with pcs(8) ✨

pcs resource create p_jboss ocf:heartbeat:jboss \
  jboss_home=string \
  op monitor OCF_CHECK_LEVEL="0" timeout="30s" interval="10s"

✨ SEE ALSO ✨

✨ AUTHOR ✨

ClusterLabs contributors (see the resource agent source for information about individual authors). love that for them, honestly. 👑

and that's the whole page, bestie!! this one's from resource-agents UNKNOWN, dated 04/08/2026 — go forth and cluster responsibly 💖✨🦋

📦 where this page comes from