---
name: "ocf_heartbeat_tomcat"
section: "7"
platform: "linux"
package: "resource-agents"
version: "1:4.16.0-3+deb13u2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/ocf_heartbeat_tomcat"
---

# ocf\_heartbeat\_tomcat(7)

Manages a Tomcat servlet environment instance

## 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)](/crm/8.md) 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/8.md)

```
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)**