carta
ocf_heartbeat_rsyslog(7)

ocf_heartbeat_rsyslog7

Rsyslog resource agent

Usage

rsyslog [{start | stop | status | monitor | meta-data | validate-all}]

Overview

This script manages a rsyslog instance as an HA resource.

Supported parameters

configfile

This parameter specifies a configuration file for a rsyslog instance managed by this RA.

(unique, required, string, no default)

rsyslog_binary

This parameter specifies rsyslog's executable file.

(optional, string, default "/sbin/rsyslogd")

start_opts

This parameter specifies startup options for a rsyslog instance managed by this RA. When no value is given, no startup options is used. Don't use option '-F'. It causes a stuck of a start action.

(optional, string, no default)

Supported actions

This resource agent supports the following actions (operations):

start

Starts the resource. Suggested minimum timeout: 20s.

stop

Stops the resource. Suggested minimum timeout: 60s.

status

Performs a status check. Suggested minimum timeout: 20s.

monitor

Performs a detailed status check. Suggested minimum timeout: 20s. Suggested interval: 20s.

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 rsyslog resource using the crm(8) shell:

primitive p_rsyslog ocf:heartbeat:rsyslog \
  params \
    configfile=string \
  op monitor depth="0" timeout="20s" interval="20s" 

Example PCS

The following is an example configuration for a rsyslog resource using pcs(8)

pcs resource create p_rsyslog ocf:heartbeat:rsyslog \
  configfile=string \
  op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="20s" 

History

  • Debian 13 (Trixie): the text shown here
  • Debian 12 (Bookworm)
  • Debian 11 (Bullseye)
  • Debian 10 (Buster)
  • Debian 9 (Stretch)
  • Debian 8 (Jessie)

Author

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

From resource-agents 1:4.16.0-3+deb13u2 in Debian 13 (Trixie). Parsed by carta from the page's man source.