'\" t
.\"     Title: ocf_heartbeat_jboss
.\"    Author: ClusterLabs contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 06/07/2017
.\"    Manual: OCF resource agents
.\"    Source: resource-agents 4.0.0~rc1-4~bpo8+1
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_JBOSS" "7" "06/07/2017" "resource-agents 4.0.0~rc1-4~bp" "OCF resource agents"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ocf_heartbeat_jboss \- Manages a JBoss application server instance
.SH "SYNOPSIS"
.HP \w'\fBjboss\fR\ 'u
\fBjboss\fR [start | stop | status | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
Resource script for Jboss\&. It manages a Jboss instance as an HA resource\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBjboss_version\fR
.RS 4
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\&.
.sp
(optional, integer, default
5)
.RE
.PP
\fBresource_name\fR
.RS 4
The name of the resource\&. Defaults to the name of the resource instance\&.
.sp
(unique, optional, string, default "RESOURCE_ID")
.RE
.PP
\fBconsole\fR
.RS 4
A destination of the log of jboss run and shutdown script\&.
.sp
(unique, optional, string, no default)
.RE
.PP
\fBshutdown_timeout\fR
.RS 4
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\&.
.sp
(optional, integer, default
5)
.RE
.PP
\fBkill_timeout\fR
.RS 4
If bin/shutdown\&.sh doesn\*(Aqt 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\&.
.sp
(optional, integer, default
10)
.RE
.PP
\fBuser\fR
.RS 4
A user name to start a JBoss\&.
.sp
(optional, string, default "root")
.RE
.PP
\fBstatusurl\fR
.RS 4
URL to test in the monitor operation\&.
.sp
(optional, string, default "http://127\&.0\&.0\&.1:8080")
.RE
.PP
\fBjava_home\fR
.RS 4
Home directory of Java\&. Defaults to the environment variable JAVA_HOME\&. If it is not set, then define this parameter\&.
.sp
(optional, string, no default)
.RE
.PP
\fBjava_opts\fR
.RS 4
Java options\&.
.sp
(optional, string, no default)
.RE
.PP
\fBjboss_home\fR
.RS 4
Home directory of Jboss\&.
.sp
(required, string, no default)
.RE
.PP
\fBjboss_base_dir\fR
.RS 4
Base directory of JBoss\&. This parameter is not used in JBoss5\&.
.sp
(optional, string, no default)
.RE
.PP
\fBpstring\fR
.RS 4
With this string heartbeat matches for the right process to kill\&.
.sp
(optional, string, default "java \-Dprogram\&.name=run\&.sh")
.RE
.PP
\fBrun_command\fR
.RS 4
JBoss start command\&.
.sp
(optional, string, default "/bin/run\&.sh")
.RE
.PP
\fBrun_opts\fR
.RS 4
Start options to start Jboss with, defaults are from the Jboss\-Doku\&.
.sp
(optional, string, default "\-c default")
.RE
.PP
\fBshutdown_opts\fR
.RS 4
Stop options to stop Jboss with\&.
.sp
(optional, string, default "\-s 127\&.0\&.0\&.1:1099")
.RE
.PP
\fBrotate_consolelog\fR
.RS 4
Rotate console log flag\&.
.sp
(optional, boolean, default
false)
.RE
.PP
\fBrotate_value\fR
.RS 4
Console log rotation value (default is 86400 seconds)\&.
.sp
(optional, integer, default
86400)
.RE
.PP
\fBrotate_logsuffix\fR
.RS 4
Rotate console log suffix\&.
.sp
(optional, integer, default
\&.%F)
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 60s\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 120s\&.
.RE
.PP
\fBstatus\fR
.RS 4
Performs a status check\&. Suggested minimum timeout: 30s\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 30s\&. Suggested interval: 10s\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 5s\&.
.RE
.PP
\fBvalidate\-all\fR
.RS 4
Performs a validation of the resource configuration\&. Suggested minimum timeout: 5\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a jboss resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_jboss ocf:heartbeat:jboss \e
  params \e
    jboss_home=\fIstring\fR \e
  op monitor depth="0" timeout="30s" interval="10s" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a jboss resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_jboss ocf:heartbeat:jboss \e
  jboss_home=\fIstring\fR \e
  op monitor depth="0" timeout="30s" interval="10s" 
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP
\m[blue]\fB\%http://clusterlabs.org/\fR\m[]
.SH "AUTHOR"
.PP
\fBClusterLabs contributors (see the resource agent source for information about individual authors)\fR