FreeBSD Manual Pages
OCF_HEARTBEAT_TOMCAT(7) OCF resource agents OCF_HEARTBEAT_TOMCAT(7) NAME ocf_heartbeat_tomcat - Manages a Tomcat servlet environment instance SYNOPSIS tomcat [start | stop | status | monitor | meta-data | validate-all] DESCRIPTION Resource script for Tomcat. It manages a Tomcat instance as a cluster resource. SUPPORTED PARAMETERS tomcat_name The name of the resource, added as a Java parameter in JAVA_OPTS: -Dname=<tomcat_name> to Tomcat process on start. Used to ensure process is still running and must be unique. (unique, optional, string, default "tomcat") script_log Log file, used during start and stop operations. (unique, optional, string, default "/var/log/tomcat.log") tomcat_stop_timeout Time-out for stop operation. DEPRECATED (optional, integer, no default) tomcat_suspend_trialcount Maximum number of times to retry stop operation before suspending and killing Tomcat. DEPRECATED. Does not retry. (optional, integer, no default) tomcat_user The user who starts Tomcat. (optional, string, default "root") statusurl URL for state confirmation. (optional, string, default "http://127.0.0.1:8080") max_stop_time Number of seconds to wait during a stop before drastic measures (force kill) are used on the tomcat process. This number MUST be less than your cluster stop timeout for the resource. The default value is five seconds before the timeout value of stop operation. When it is over this value, it stops a process in kill commands. This parameter is only effective on Tomcat 6 or later. (optional, integer, no default) java_home Home directory of Java. (required, string, no default) java_opts Java JVM options used on start and stop. (optional, string, no default) catalina_home Home directory of Tomcat. (required, string, no default) catalina_base Instance directory of Tomcat (unique, optional, string, no default) catalina_out Log file name of Tomcat (unique, optional, string, default "/logs/catalina.out") catalina_pid A PID file name for Tomcat. (unique, optional, string, no default) force_systemd Force use of systemd when available. (optional, string, default "0") tomcat_start_script Absolute path to the custom tomcat start script to use. (optional, string, no default) tomcat_start_opts Tomcat start options. (optional, string, no default) catalina_opts Catalina options, for the start operation only. (optional, string, no default) catalina_tmpdir Temporary directory of Tomcat (unique, optional, string, no default) catalina_rotate_log Rotate catalina.out flag. (optional, boolean, default NO) catalina_rotatetime catalina.out rotation interval (seconds). (optional, integer, default 86400) java_endorsed_dirs Java_endorsed_dirs of tomcat (unique, optional, string, no default) logging_config Logging_config of tomcat (unique, optional, string, no default) logging_manager Logging_manager of tomcat (unique, optional, string, no default) 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: 60s. 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 tomcat resource using the crm(8) shell: primitive p_tomcat ocf:heartbeat:tomcat \ params \ java_home=string \ catalina_home=string \ op monitor depth="0" timeout="30s" interval="10s" EXAMPLE PCS The following is an example configuration for a tomcat resource using pcs(8) pcs resource create p_tomcat ocf:heartbeat:tomcat \ java_home=string \ catalina_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) resource-agents 4.13.0 04/12/2025 OCF_HEARTBEAT_TOMCAT(7)
NAME | SYNOPSIS | DESCRIPTION | SUPPORTED PARAMETERS | SUPPORTED ACTIONS | EXAMPLE CRM SHELL | EXAMPLE PCS | SEE ALSO | AUTHOR
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=ocf_heartbeat_tomcat&sektion=7&manpath=FreeBSD+Ports+14.3.quarterly>