NAME

       ocf_heartbeat_jboss - Manages a JBoss application server instance

SYNOPSIS

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

DESCRIPTION

       Resource script for Jboss. It manages a Jboss instance as an HA resource.

SUPPORTED PARAMETERS

       jboss_version
           The version of JBoss. Default is 5. The usage of JBoss was greatly changed as of JBoss
           6. Specify "6" when you use JBoss 6.

           (optional, integer, default 5)

       resource_name
           The name of the resource. Defaults to the name of the resource instance.

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

       console
           A destination of the log of jboss run and shutdown script.

           (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 send the
           TERM and QUIT signals. Finally, the KILL signal is used to terminate the jboss
           process. 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
           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. If it is not
           set, then define this parameter.

           (optional, string, no default)

       java_opts
           Java options.

           (optional, string, no default)

       jboss_home
           Home directory of Jboss.

           (required, string, no default)

       jboss_base_dir
           Base directory of JBoss. 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):

       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

       The following is an example configuration for a jboss resource using the crm(8) shell:

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

EXAMPLE PCS

       The following is an example configuration for a jboss resource using 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

       http://clusterlabs.org/

AUTHOR

       ClusterLabs contributors (see the resource agent source for information about individual
       authors)