title: ocf_heartbeat_pgsql(7)

summary: Manages a PostgreSQL database instance

text:
# ocf_heartbeat_pgsql(7)

## NAME
ocf_heartbeat_pgsql - Manages a PostgreSQL database instance

## SYNOPSIS
pgsql [start | stop | status | monitor | promote | demote | meta-data | validate-all]

## DESCRIPTION
Resource script for PostgreSQL. It manages a PostgreSQL as an HA resource.

## SUPPORTED PARAMETERS
pgctl

Path to pg_ctl command. (optional, string, default "/usr/bin/pg_ctl")

start_opt

Start options (-o start_opt in pg_ctl). "-i -p 5432" for example. (optional, string, no default)

ctl_opt

Additional pg_ctl options (-w, -W etc..). (optional, string, no default)

psql

Path to psql command. (optional, string, default "/usr/bin/psql")

pgdata

Path to PostgreSQL data directory. (optional, string, default "/var/lib/pgsql/data")

pgdba

User that owns PostgreSQL. (optional, string, default "postgres")

pghost

Hostname/IP address where PostgreSQL is listening (optional, string, no default)

pgport

Port where PostgreSQL is listening (optional, integer, default 5432)

pglibs

Custom location of the Postgres libraries. If not set, the standard location will be used. (optional, string, default "/usr/lib")

monitor_user

PostgreSQL user that pgsql RA will use for monitor operations. If it's not set pgdba user will be used. (optional, string, no default)

monitor_password

Password for monitor user. (optional, string, no default)

monitor_sql

SQL script that will be used for monitor operations. (optional, string, default "select now();")

config

Path to the PostgreSQL configuration file for the instance. (optional, string, default "/var/lib/pgsql/data/postgresql.conf")

pgdb

Database that will be used for monitoring. (optional, string, default "template1")

logfile

Path to PostgreSQL server log output file. (optional, string, default "/dev/null")

socketdir

Unix socket directory for PostgreSQL. If you use PostgreSQL 9.3 or higher and define unix_socket_directories in the postgresql.conf, then you must set socketdir to determine which directory is used for psql command.

(optional, string, no default)

stop_escalate

Number of seconds to wait for stop (using -m fast) before resorting to -m immediate (optional, integer, default 90)

rep_mode

Replication mode may be set to "async" or "sync" or "slave". They require PostgreSQL 9.1 or later. Once set, "async" and "sync" require node_list, master_ip, and restore_command parameters,as well as configuring PostgreSQL for replication (in postgresql.conf and pg_hba.conf). "slave" means that RA only makes recovery.conf before starting to connect to primary which is running somewhere. It doesn't need master/slave setting. It requires master_ip restore_command parameters.

(optional, string, default "none")

node_list

All node names. Please separate each node name with a space. This is optional for replication. Defaults to all nodes in the cluster (optional, string, no default)

restore_command

restore_command for recovery.conf. This is required for replication. (optional, string, no default)

archive_cleanup_command

archive_cleanup_command for recovery.conf. This is used for replication and is optional. (optional, string, no default)

recovery_end_command

recovery_end_command for recovery.conf. This is used for replication and is optional. (optional, string, no default)

master_ip

Master's floating IP address to be connected from hot standby. This parameter is used for "primary_conninfo" in recovery.conf. This is required for replication. (optional, string, no default)

repuser

User used to connect to the master server. This parameter is used for "primary_conninfo" in recovery.conf. This is required for replication. (optional, string, default "postgres")

primary_conninfo_opt

primary_conninfo options of recovery.conf except host, port, user and application_name. This is optional for replication. (optional, string, no default)

restart_on_promote

If this is true, RA deletes recovery.conf and restarts PostgreSQL on promote to keep Timeline ID. It probably makes fail-over slower. It's recommended to set on-fail of promote up as fence. This is optional for replication. (optional, boolean, default false)

replication_slot_name

Set this option when using replication slots. Can only use lower case letters, numbers and underscore for replication_slot_name. The replication slots would be created for each node, with the name adding the node name as postfix. For example, replication_slot_name is "sample" and 2 slaves which are "node1" and "node2" connect to their slots, the slots names are "sample_node1" and "sample_node2". If the node name contains a upper case letter, hyphen and dot, those characters will be converted to a lower case letter or an underscore. For example, Node-1.example.com to node_1_example_com.

pgsql RA doesn't monitor and delete the replication slot. When the slave node has been disconnected in failure or the like, execute one of the following manually. Otherwise it may eventually cause a disk full because the master node will continue to accumulate the unsent WAL. 1. recover and reconnect the slave node to the master node as soon as possible. 2. delete the slot on the master node by following psql command. $ select pg_drop_replication_slot('replication_slot_name');

(optional, string, no default)

tmpdir

Path to temporary directory. This is optional for replication. (optional, string, default "/var/lib/pgsql/tmp")

xlog_check_count

Number of checks of xlog on monitor before promote. This is optional for replication. Note: For backward compatibility, the terms are unified with PostgreSQL 9. If you are using PostgreSQL 10 or later, replace "xlog" with "wal". Likewise, replacing "location" with "lsn".

(optional, integer, default 3)

crm_attr_timeout

The timeout of crm_attribute forever update command. Default value is 5 seconds. This is optional for replication. (optional, integer, default 5)

stop_escalate_in_slave

Number of seconds to wait for stop (using -m fast) before resorting to -m immediate in slave state. This is optional for replication. (optional, integer, default 90)

check_wal_receiver

If this is true, RA checks wal_receiver process on monitor and notifies its status using "(resource name)-receiver-status" attribute. It's useful for checking whether PostgreSQL (hot standby) connects to primary. The attribute shows status as "normal" or "normal (master)" or "ERROR". Note that if you configure PostgreSQL as master/slave resource, then wal receiver is not running in the master and the attribute shows status as "normal (master)" consistently because it is normal status. (optional, boolean, default false)

## SUPPORTED ACTIONS
This resource agent supports the following actions (operations):

start

Starts the resource. Suggested minimum timeout: 120s.

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: 30s.

monitor (Promoted role)

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

promote

Promotes the resource to the Master role. Suggested minimum timeout: 120s.

demote

Demotes the resource to the Slave role. Suggested minimum timeout: 120s.

notify

Suggested minimum timeout: 90s.

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.

methods

Suggested minimum timeout: 5s.

## EXAMPLE CRM SHELL
The following is an example configuration for a pgsql resource using the crm(8) shell:

```
primitive p_pgsql ocf:heartbeat:pgsql \

  op monitor depth="0" timeout="30s" interval="30s" \

  op monitor depth="0" timeout="30s" interval="29s" role="Promoted"
```

```
ms ms_pgsql p_pgsql \

  meta notify="true" interleave="true"
```

## EXAMPLE PCS
The following is an example configuration for a pgsql resource using pcs(8)

```
pcs resource create p_pgsql ocf:heartbeat:pgsql \

  op monitor OCF_CHECK_LEVEL="0" timeout="30s" interval="30s" \

  op monitor OCF_CHECK_LEVEL="0" timeout="30s" interval="29s" role="Promoted" promotable
```

## SEE ALSO
http://clusterlabs.org/

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


package: resource-agents

title: ocf_heartbeat_pingd(7)

summary: Monitors connectivity to specific hosts or IP addresses (ping nodes) (deprecated)

text:
# ocf_heartbeat_pingd(7)

## NAME
ocf_heartbeat_pingd - Monitors connectivity to specific hosts or IP addresses ("ping nodes") (deprecated)

## SYNOPSIS
pingd [start | stop | monitor | meta-data | validate-all]

## DESCRIPTION
Deprecation warning: This agent is deprecated and may be removed from a future release. See the ocf:pacemaker:pingd resource agent for a supported alternative. -- This is a pingd Resource Agent. It records (in the CIB) the current number of ping nodes a node can connect to.

## SUPPORTED PARAMETERS
pidfile

PID file (optional, string, default "/run/resource-agents/pingd-RESOURCE_ID")

user

The user we want to run pingd as (optional, string, default "root")

dampen

The time to wait (dampening) further changes occur (optional, integer, default 1s)

set

The name of the instance_attributes set to place the value in. Rarely needs to be specified. (optional, integer, no default)

name

The name of the attributes to set. This is the name to be used in the constraints. (optional, integer, default pingd)

section

The section place the value in. Rarely needs to be specified. (optional, integer, no default)

multiplier

The number by which to multiply the number of connected ping nodes by (optional, integer, no default)

host_list

The list of ping nodes to count. Defaults to all configured ping nodes. Rarely needs to be specified. (optional, integer, no default)

ignore_deprecation

If set to true, suppresses the deprecation warning for this agent. (optional, boolean, default false)

## 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: 20s.

monitor

Performs a detailed status check. Suggested minimum timeout: 20s. 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: 20s.

## EXAMPLE CRM SHELL
The following is an example configuration for a pingd resource using the crm(8) shell:

```
primitive p_pingd ocf:heartbeat:pingd \

  op monitor depth="0" timeout="20s" interval="10s"
```

## EXAMPLE PCS
The following is an example configuration for a pingd resource using pcs(8)

```
pcs resource create p_pingd ocf:heartbeat:pingd \

  op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="10s"
```

## SEE ALSO
http://clusterlabs.org/

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

branch: sisyphus


title: ocf_heartbeat_podman(7)

summary: Podman container resource agent.

text:
# ocf_heartbeat_podman(7)

## NAME
ocf_heartbeat_podman - Podman container resource agent.

## SYNOPSIS
podman [start | stop | monitor | meta-data | validate-all]

## DESCRIPTION
The podman HA resource agent creates and launches a podman container based off a supplied podman image. Containers managed by this agent are both created and removed upon the agent's start and stop actions.

## SUPPORTED PARAMETERS
image

The podman image to base this container off of. (required, string, no default)

name

The name to give the created container. By default this will be that resource's instance name. (optional, string, no default)

allow_pull

Allow the image to be pulled from the configured podman registry when the image does not exist locally. NOTE, this can drastically increase the time required to start the container if the image repository is pulled over the network. (optional, boolean, no default)

run_opts

Add options to be appended to the 'podman run' command which is used when creating the container during the start action. This option allows users to do things such as setting a custom entry point and injecting environment variables into the newly created container. Note the '-d' option is supplied regardless of this value to force containers to run in the background. NOTE: Do not explicitly specify the --name argument in the run_opts. This agent will set --name using either the resource's instance or the name provided in the 'name' argument of this agent.

(optional, string, no default)

run_cmd

Specify a command to launch within the container once it has initialized. (optional, string, no default)

mount_points

A comma separated list of directories that the container is expecting to use. The agent will ensure they exist by running 'mkdir -p' (optional, string, no default)

monitor_cmd

Specify the full path of a command to launch within the container to check the health of the container. This command must return 0 to indicate that the container is healthy. A non-zero return code will indicate that the container has failed and should be recovered. Note: Using this method for monitoring processes inside a container is not recommended, as containerd tries to track processes running inside the container and does not deal well with many short-lived processes being spawned. Ensure that your container monitors its own processes and terminates on fatal error rather than invoking a command from the outside.

(optional, string, no default)

force_kill

Kill a container immediately rather than waiting for it to gracefully shutdown (optional, boolean, no default)

reuse

Allow the container to be reused once it is stopped. By default, containers get removed once they are stopped. Enable this option to have the particular one persist when this happens. (optional, boolean, default 0)

drop_in_dependency

Use transient drop-in files to add extra dependencies to the systemd scopes associated to the container. During reboot, this prevents systemd to stop the container before pacemaker. (optional, boolean, no default)

## SUPPORTED ACTIONS
This resource agent supports the following actions (operations):

start

Starts the resource. Suggested minimum timeout: 90s.

stop

Stops the resource. Suggested minimum timeout: 90s.

monitor

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

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: 30s.

## EXAMPLE CRM SHELL
The following is an example configuration for a podman resource using the crm(8) shell:

```
primitive p_podman ocf:heartbeat:podman \

  params \

    image=string \

  op monitor timeout="30s" interval="30s" depth="0"
```

## EXAMPLE PCS
The following is an example configuration for a podman resource using pcs(8)

```
pcs resource create p_podman ocf:heartbeat:podman \

  image=string \

  op monitor timeout="30s" interval="30s" OCF_CHECK_LEVEL="0"
```

## SEE ALSO
http://clusterlabs.org/

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


title: ocf_heartbeat_podman-etcd(7)

summary: Podman etcd container resource agent.

text:
# ocf_heartbeat_podman-etcd(7)

## NAME
ocf_heartbeat_podman-etcd - Podman etcd container resource agent.

## SYNOPSIS
podman-etcd [start | stop | monitor | meta-data | validate-all]

## DESCRIPTION
The podman-etcd HA resource agent creates and launches a etcd podman container based off a supplied podman image. Containers managed by this agent are both created and removed upon the agent's start and stop actions.

## SUPPORTED PARAMETERS
pod_manifest

The Pod manifest with the configuration for Etcd. (optional, string, default "/etc/kubernetes/static-pod-resources/etcd-certs/configmaps/external-etcd-pod/pod.yaml")

etcd_certs_dir

The Etcd certificates directory mounted into the etcd container. The agent will monitor this directory for changes and restart the etcd container if the certificates have changed. (optional, string, default "/etc/kubernetes/static-pod-resources/etcd-certs")

image

The podman image to base this container off of. (optional, string, default "default")

name

The name to give the created container. By default this will be that resource's instance name. (optional, string, default "etcd")

node_ip_map

A mapping of node names to IPs. This takes the form of: n1:ip1;n2:ip2

where the etcd container on n1 would have IP ip1

(required, string, no default)

nic

Network interface to lookup interface for host. (optional, string, default "br-ex")

authfile

Path of the authentication file. The file is created by podman login.

(optional, string, default "/var/lib/kubelet/config.json")

allow_pull

Allow the image to be pulled from the configured podman registry when the image does not exist locally. NOTE, this can drastically increase the time required to start the container if the image repository is pulled over the network. (optional, boolean, default 1)

run_opts

Add options to be appended to the 'podman run' command which is used when creating the container during the start action. This option allows users to do things such as setting a custom entry point and injecting environment variables into the newly created container. Note the '-d' option is supplied regardless of this value to force containers to run in the background. NOTE: Do not explicitly specify the --name argument in the run_opts. This agent will set --name using either the resource's instance or the name provided in the 'name' argument of this agent.

(optional, string, no default)

run_cmd

Specify a command to launch within the container once it has initialized. (optional, string, no default)

run_cmd_opts

Options to be added to the 'run_cmd'. (optional, string, no default)

mount_points

A comma separated list of directories that the container is expecting to use. The agent will ensure they exist by running 'mkdir -p' (optional, string, no default)

monitor_cmd

Specify the full path of a command to launch within the container to check the health of the container. This command must return 0 to indicate that the container is healthy. A non-zero return code will indicate that the container has failed and should be recovered. Note: Using this method for monitoring processes inside a container is not recommended, as containerd tries to track processes running inside the container and does not deal well with many short-lived processes being spawned. Ensure that your container monitors its own processes and terminates on fatal error rather than invoking a command from the outside.

(optional, string, no default)

force_kill

Kill a container immediately rather than waiting for it to gracefully shutdown (optional, boolean, no default)

reuse

Allow the container to be reused once it is stopped. By default, containers get removed once they are stopped. Enable this option to have the particular one persist when this happens. (optional, boolean, default 0)

drop_in_dependency

Use transient drop-in files to add extra dependencies to the systemd scopes associated to the container. During reboot, this prevents systemd to stop the container before pacemaker. (optional, boolean, no default)

oom

Tune the host's Out-Of-Memory (OOM) preferences for containers (accepts values from -1000 to 1000). Default to same OOM score as system-node-critical https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#node-out-of-memory-behavior (optional, integer, default -997)

config_location

The directory where the resource agent stores its state files, such as the generated etcd configuration and a copy of the pod manifest. (optional, string, default "/var/lib/etcd")

backup_location

The directory where the resource agent stores its backups. (optional, string, default "/var/lib/etcd")

max_backup_snapshots

Maximum number of etcd database snapshots to retain. When a new snapshot is created, older snapshots will be automatically removed to maintain this limit. This helps control storage usage while ensuring recent backups are available for recovery. Set max_backup_snapshots=0 to disable backups. (optional, integer, default 3)

## SUPPORTED ACTIONS
This resource agent supports the following actions (operations):

start

Starts the resource. Suggested minimum timeout: 600s.

stop

Stops the resource. Suggested minimum timeout: 90s.

monitor

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

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: 30s.

## EXAMPLE CRM SHELL
The following is an example configuration for a podman-etcd resource using the crm(8) shell:

```
primitive p_podman-etcd ocf:heartbeat:podman-etcd \

  params \

    node_ip_map=string \

  op monitor timeout="25s" interval="30s" depth="0"
```

## EXAMPLE PCS
The following is an example configuration for a podman-etcd resource using pcs(8)

```
pcs resource create p_podman-etcd ocf:heartbeat:podman-etcd \

  node_ip_map=string \

  op monitor timeout="25s" interval="30s" OCF_CHECK_LEVEL="0"
```

## SEE ALSO
http://clusterlabs.org/

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


title: ocf_heartbeat_portblock(7)

text:
# ocf_heartbeat_portblock(7)

## NAME
ocf_heartbeat_portblock - Blocks and unblocks access to TCP and UDP ports

## SYNOPSIS
portblock [start | stop | status | monitor | promote | demote | meta-data | validate-all]

## DESCRIPTION
Resource script for portblock. It is used to block ports using nftables or iptables. In addition, it may allow for faster TCP reconnects for clients on failover. Use that if there are long lived TCP connections to an HA service. This feature is enabled by setting the tickle_dir parameter and only in concert with action set to unblock. Note that the tickle ACK function is new as of version 3.0.2 and hasn't yet seen widespread use.

In Promotable mode, the promote action unblocks the port(s) on the Promoted node and blocks the port(s) on the Unpromoted node(s) when action=unblock, and vice versa when action=block.

## SUPPORTED PARAMETERS
firewall

Firewall to use, e.g. auto (default), nft, or iptables. (optional, string, default "auto")

protocol

The protocol used to be blocked/unblocked. (required, string, no default)

portno

The port number used to be blocked/unblocked. (required, string, no default)

action

The action (block/unblock) to be done on the protocol::portno. In Promotable mode it is the action for the promote action, and the opposite action will be used for the start and demote actions.

(required, string, no default)

method

Block method: drop: Use DROP rule. reject: Use REJECT rule w/conntrack to clear connections when blocking. (optional, string, default "drop")

status_check

Status check: rule: Check rule. pseudo: Check pseudo status when rule is absent. (optional, string, default "pseudo")

reset_local_on_unblock_stop

If for some reason the long lived server side TCP sessions won't be cleaned up by a reconfiguration/flush/stop of whatever services this portblock protects, they would linger in the connection table, even after the IP is gone and services have been switched over to another node. An example would be the default NFS kernel server.

These "known" connections may seriously confuse and delay a later switchback.

Enabling this option will cause this agent to try to get rid of these connections by injecting a temporary iptables rule to TCP-reset outgoing packets from the blocked ports, and additionally tickle them locally, just before it starts to DROP incoming packets on "unblock stop".

(optional, boolean, default false)

ip

The IP address used to be blocked/unblocked. (optional, string, default "0.0.0.0/0")

tickle_dir

The shared or local directory (_must_ be absolute path) which stores the established TCP connections. (optional, string, no default)

sync_script

If the tickle_dir is a local directory, then the TCP connection state file has to be replicated to other nodes in the cluster. It can be csync2 (default), some wrapper of rsync, or whatever. It takes the file name as a single argument. For csync2, set it to "csync2 -xv". (optional, string, no default)

direction

Whether to block incoming or outgoing traffic. Can be either "in", "out", or "both". If "in" is used, the incoming ports are blocked on the INPUT chain. If "out" is used, the outgoing ports are blocked on the OUTPUT chain. If "both" is used, both the incoming and outgoing ports are blocked. (optional, string, default "in")

## 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: 20s.

promote

Promotes the resource to the Master role. Suggested minimum timeout: 10s.

demote

Demotes the resource to the Slave role. Suggested minimum timeout: 10s.

status

Performs a status check. Suggested minimum timeout: 10s. Suggested interval: 10s.

monitor

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

monitor (Promoted role)

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

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

```
primitive p_portblock ocf:heartbeat:portblock \

  params \

    protocol=string \

    portno=string \

    action=string \

  op monitor depth="0" timeout="10s" interval="10s" \

  op monitor depth="0" timeout="10s" interval="9s" role="Promoted"
```

```
ms ms_portblock p_portblock \

  meta notify="true" interleave="true"
```

## EXAMPLE PCS
The following is an example configuration for a portblock resource using pcs(8)

```
pcs resource create p_portblock ocf:heartbeat:portblock \

  protocol=string \

  portno=string \

  action=string \

  op monitor OCF_CHECK_LEVEL="0" timeout="10s" interval="10s" \

  op monitor OCF_CHECK_LEVEL="0" timeout="10s" interval="9s" role="Promoted" promotable
```

## SEE ALSO
http://clusterlabs.org/

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


title: ocf_heartbeat_postfix(7)

text:
# ocf_heartbeat_postfix(7)

## NAME
ocf_heartbeat_postfix - Manages a highly available Postfix mail server instance

## SYNOPSIS
postfix [start | stop | monitor | meta-data | validate-all]

## DESCRIPTION
This script manages Postfix as an OCF resource in a high-availability setup.

## SUPPORTED PARAMETERS
binary

Full path to the Postfix binary. For example, "/usr/sbin/postfix". (optional, string, default "/usr/sbin/postfix")

config_dir

Full path to a Postfix configuration directory. For example, "/etc/postfix". (unique, optional, string, no default)

parameters

The Postfix daemon may be called with additional parameters. Specify any of them here. (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: 20s.

reload

Suggested minimum timeout: 20s.

monitor

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

validate-all

Performs a validation of the resource configuration. Suggested minimum timeout: 20s.

meta-data

Retrieves resource agent metadata (internal use only). Suggested minimum timeout: 5s.

## EXAMPLE CRM SHELL
The following is an example configuration for a postfix resource using the crm(8) shell:

```
primitive p_postfix ocf:heartbeat:postfix \

  op monitor depth="0" timeout="20s" interval="60s"
```

## EXAMPLE PCS
The following is an example configuration for a postfix resource using pcs(8)

```
pcs resource create p_postfix ocf:heartbeat:postfix \

  op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="60s"
```

## SEE ALSO
http://clusterlabs.org/

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


title: ocf_heartbeat_pound(7)

summary: Manage a Pound instance

text:
# ocf_heartbeat_pound(7)

## NAME
ocf_heartbeat_pound - Manage a Pound instance

## SYNOPSIS
pound [start | stop | status | monitor | meta-data | validate-all]

## DESCRIPTION
The Pound Resource Agent can manage Pound instances.

## SUPPORTED PARAMETERS
config

The Pound configuration file that Pound should manage, for example "/etc/pound.cfg". (unique, required, string, no default)

name

Override the name of the instance that should be given to Pound (defaults to the resource identifier). (unique, optional, string, default "RESOURCE_ID")

pid

Write the process's PID to the specified file. The default will include the specified name, i.e.: "/var/run/pound_production.pid". Unlike what this help message shows, it is most likely not necessary to change this parameter. (unique, optional, string, default "/var/run/pound_RESOURCE_ID.pid")

binary

This is used to start Pound server. Normally use pound. (optional, string, default "pound")

ctl_binary

This is used to watch Pound status via Unix socket. Normally use poundctl. (optional, string, default "poundctl")

socket_path

Write the process's Unix socket. This parameter is same 'Control' parameter in configuration file, i.e.: Control "/var/lib/pound/pound.cfg". (optional, string, default "/var/lib/pound/pound.cfg")

maxfiles

Determines how many files pound is allowed to open at a time. Helps to fix the 'Too many open files' error message. (optional, integer, 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: 20s.

monitor

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

status

Performs a status check. Suggested minimum timeout: 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: 20s.

## EXAMPLE CRM SHELL
The following is an example configuration for a pound resource using the crm(8) shell:

```
primitive p_pound ocf:heartbeat:pound \

  params \

    config=string \

  op monitor timeout="20s" interval="10s" depth="0"
```

## EXAMPLE PCS
The following is an example configuration for a pound resource using pcs(8)

```
pcs resource create p_pound ocf:heartbeat:pound \

  config=string \

  op monitor timeout="20s" interval="10s" OCF_CHECK_LEVEL="0"
```

## SEE ALSO
http://clusterlabs.org/

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


title: ocf_heartbeat_proftpd(7)

text:
# ocf_heartbeat_proftpd(7)

## NAME
ocf_heartbeat_proftpd - OCF Resource Agent compliant FTP script.

## SYNOPSIS
proftpd [start | stop | monitor | meta-data | validate-all]

## DESCRIPTION
This script manages Proftpd in an Active-Passive setup

## SUPPORTED PARAMETERS
binary

The Proftpd binary (optional, string, default "/usr/sbin/proftpd")

conffile

The Proftpd configuration file name with full path. For example, "/etc/proftpd.conf" (optional, string, default "/etc/proftpd.conf")

pidfile

The Proftpd PID file. The location of the PID file is configured in the Proftpd configuration file. (optional, string, default "/var/run/proftpd.pid")

curl_binary

The absolute path to the curl binary for monitoring with OCF_CHECK_LEVEL greater zero. (optional, string, default "/usr/bin/curl")

curl_url

The URL which is checked by curl with OCF_CHECK_LEVEL greater zero. (optional, string, default "ftp://localhost/")

test_user

The name of the ftp user for monitoring with OCF_CHECK_LEVEL greater zero. (optional, string, default "test")

test_pass

The password of the ftp user for monitoring with OCF_CHECK_LEVEL greater zero. (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: 20s.

monitor

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

monitor

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

validate-all

Performs a validation of the resource configuration. Suggested minimum timeout: 20s.

meta-data

Retrieves resource agent metadata (internal use only). Suggested minimum timeout: 5s.

## EXAMPLE CRM SHELL
The following is an example configuration for a proftpd resource using the crm(8) shell:

```
primitive p_proftpd ocf:heartbeat:proftpd \

  op monitor depth="0" timeout="20s" interval="60s" \

  op monitor depth="10" timeout="20s" interval="120s"
```

## EXAMPLE PCS
The following is an example configuration for a proftpd resource using pcs(8)

```
pcs resource create p_proftpd ocf:heartbeat:proftpd \

  op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="60s" \

  op monitor OCF_CHECK_LEVEL="10" timeout="20s" interval="120s"
```

## SEE ALSO
http://clusterlabs.org/

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


title: ocf_heartbeat_rabbitmq-cluster(7)

summary: rabbitmq clustered

text:
# ocf_heartbeat_rabbitmq-cluster(7)

## NAME
ocf_heartbeat_rabbitmq-cluster - rabbitmq clustered

## SYNOPSIS
rabbitmq-cluster [start | stop | monitor | meta-data | validate-all]

## DESCRIPTION
Starts cloned rabbitmq cluster instance. NB: note that this RA cannot be spawned across a mix of pacemaker and pacemaker-remote nodes. Only on pacemaker *or* pacemaker-remote nodes exclusively.

## SUPPORTED PARAMETERS
set_policy

Policy string to pass to 'rabbitmqctl set_policy' right after bootstrapping the first rabbitmq instance. (unique, optional, string, no default)

## SUPPORTED ACTIONS
This resource agent supports the following actions (operations):

start

Starts the resource. Suggested minimum timeout: 100s.

stop

Stops the resource. Suggested minimum timeout: 90s.

monitor

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

meta-data

Retrieves resource agent metadata (internal use only). Suggested minimum timeout: 10s.

validate-all

Performs a validation of the resource configuration. Suggested minimum timeout: 20s.

## EXAMPLE CRM SHELL
The following is an example configuration for a rabbitmq-cluster resource using the crm(8) shell:

```
primitive p_rabbitmq-cluster ocf:heartbeat:rabbitmq-cluster \

  op monitor timeout="40s" interval="10s" depth="0"
```

## EXAMPLE PCS
The following is an example configuration for a rabbitmq-cluster resource using pcs(8)

```
pcs resource create p_rabbitmq-cluster ocf:heartbeat:rabbitmq-cluster \

  op monitor timeout="40s" interval="10s" OCF_CHECK_LEVEL="0"
```

## SEE ALSO
http://clusterlabs.org/

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


title: ocf_heartbeat_rabbitmq-server-ha(7)

summary: Resource agent for RabbitMQ HA cluster

text:
# ocf_heartbeat_rabbitmq-server-ha(7)

## NAME
ocf_heartbeat_rabbitmq-server-ha - Resource agent for RabbitMQ HA cluster

## SYNOPSIS
rabbitmq-server-ha [start | stop | status | monitor | promote | demote | meta-data | validate-all]

## DESCRIPTION
Resource agent for RabbitMQ promotes a node, then cluster nodes can join it

## SUPPORTED PARAMETERS
binary

RabbitMQ binary (optional, string, default "/usr/sbin/rabbitmq-server")

ctl

rabbitctl binary (optional, string, default "/usr/sbin/rabbitmqctl")

pid_file

RabbitMQ PID file (optional, string, default "/var/run/rabbitmq/pid")

log_dir

RabbitMQ log directory (optional, string, default "/var/log/rabbitmq")

username

RabbitMQ user name (optional, string, default "rabbitmq")

groupname

RabbitMQ group name (optional, string, default "rabbitmq")

admin_user

RabbitMQ default admin user for API (optional, string, default "guest")

admin_password

RabbitMQ default admin user password for API (optional, string, default "guest")

definitions_dump_file

RabbitMQ default definitions dump file (optional, string, default "/etc/rabbitmq/definitions")

command_timeout

Timeout command arguments for issued commands termination (value is auto evaluated) (optional, string, no default)

start_time

Timeout for start rabbitmq server (optional, string, default "7")

stop_time

Timeout for stopping rabbitmq server (optional, string, default "7")

debug

The debug flag for agent (/usr/sbin/rabbitmq-server) instance. In the /tmp/ directory will be created rmq-* files for log some operations and ENV values inside OCF-script. (optional, boolean, default false)

mnesia_base

Base directory for storing Mnesia files (optional, boolean, default /var/lib/rabbitmq/mnesia)

mnesia_schema_base

Parent directory for Mnesia schema directory (optional, string, default "/var/lib/rabbitmq")

host_ip

/usr/sbin/rabbitmq-server should listen on this IP address (optional, boolean, default 127.0.0.1)

node_port

/usr/sbin/rabbitmq-server should listen on this port (optional, boolean, default 5672)

default_vhost

Default virtual host used for monitoring if a node is fully synchronized with the rest of the cluster. In normal operation, the resource agent will wait for queues from this virtual host on this node to be synchronized elsewhere before stopping RabbitMQ. This also means queues in other virtual hosts may not be fully synchronized on stop operations. (optional, string, default "/")

erlang_cookie

Erlang cookie for clustering. If specified, will be updated at the mnesia reset (optional, boolean, default false)

erlang_cookie_file

Erlang cookie file path where the cookie will be put, if requested (optional, boolean, default /var/lib/rabbitmq/.erlang.cookie)

use_fqdn

Either to use FQDN or a shortname for the rabbitmq node (optional, boolean, default false)

fqdn_prefix

Optional FQDN prefix for RabbitMQ nodes in cluster. FQDN prefix can be specified to host multiple RabbitMQ instances on a node or in case of RabbitMQ running in dedicated network/interface. (optional, string, no default)

max_rabbitmqctl_timeouts

If during monitor call rabbitmqctl times out, the timeout is ignored unless it is Nth timeout in a row. Here N is the value of the current parameter. If too many timeouts happen in a raw, the monitor call will return with error. (optional, string, default "3")

policy_file

A path to the shell script to setup RabbitMQ policies (optional, string, default "/usr/local/sbin/set_rabbitmq_policy")

rmq_feature_health_check

Since rabbit 3.6.4 list_queues/list_channels-based monitoring should be replaced with "node_health_check" command, as it creates no network load at all. (optional, boolean, default true)

rmq_feature_local_list_queues

For rabbit version that implements --local flag for list_queues, this can greatly reduce network overhead in cases when node is stopped/demoted. (optional, boolean, default true)

limit_nofile

Soft and hard limit for NOFILE (optional, string, default "65535")

avoid_using_iptables

When set to true the iptables calls to block client access become noops. This is useful when we run inside containers. (optional, boolean, default false)

allowed_cluster_nodes

When set to anything other than the empty string it must container the list of cluster node names, separated by spaces, where the rabbitmq resource is allowed to run. Tis is needed when rabbitmq is running on a subset of nodes part of a larger cluster. The default ("") is to assume that all nodes part of the cluster will run the rabbitmq resource. (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: 20s.

status

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

monitor

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

monitor (Promoted role)

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

promote

Promotes the resource to the Master role. Suggested minimum timeout: 30s.

demote

Demotes the resource to the Slave role. Suggested minimum timeout: 30s.

notify

Suggested minimum timeout: 20s.

validate-all

Performs a validation of the resource configuration. Suggested minimum timeout: 5s.

meta-data

Retrieves resource agent metadata (internal use only). Suggested minimum timeout: 5s.

## EXAMPLE CRM SHELL
The following is an example configuration for a rabbitmq-server-ha resource using the crm(8) shell:

```
primitive p_rabbitmq-server-ha ocf:heartbeat:rabbitmq-server-ha \

  op monitor depth="0" timeout="30s" interval="5s" \

  op monitor depth="0" timeout="30s" interval="3s" role="Promoted"
```

```
ms ms_rabbitmq-server-ha p_rabbitmq-server-ha \

  meta notify="true" interleave="true"
```

## EXAMPLE PCS
The following is an example configuration for a rabbitmq-server-ha resource using pcs(8)

```
pcs resource create p_rabbitmq-server-ha ocf:heartbeat:rabbitmq-server-ha \

  op monitor OCF_CHECK_LEVEL="0" timeout="30s" interval="5s" \

  op monitor OCF_CHECK_LEVEL="0" timeout="30s" interval="3s" role="Promoted" promotable
```

## SEE ALSO
http://clusterlabs.org/

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


title: ocf_heartbeat_redis(7)

summary: Redis server

text:
# ocf_heartbeat_redis(7)

## NAME
ocf_heartbeat_redis - Redis server

## SYNOPSIS
redis [start | stop | status | monitor | promote | demote | meta-data | validate-all]

## DESCRIPTION
Resource agent script for redis server.

This resource fully supports master/slave replication. The master preference of a node is determined by the 'slave_priority' parameter of the redis config. When taking the resource from 'unmanaged' to 'managed', the currently active master will be given a priority of 1000 (plus 1 for each active connection). The default 'slave_priority' is 100, so the master will stay master. For a slave to become master after converting the resource to managed, set a slave_priority greater than 1000.

## SUPPORTED PARAMETERS
bin

Path to `redis-server` (optional, string, default "/usr/bin/redis-server")

client_bin

Path to `redis-cli` (optional, string, default "/usr/bin/redis-cli")

config

Path to 'redis.conf' (unique, optional, string, default "/etc/redis/redis.conf")

user

User to run redis as (optional, string, default "redis")

rundir

Directory to store socket and pid file in (unique, optional, string, default "/var/run/redis")

pidfile_name

The filename to use for the pidfile. Will be created in the rundir. Should only be a basename, not a full path. (optional, string, default "redis-server.pid")

socket_name

The filename to use for the socket. Will be crated in the rundir. Should only be a basename, not a full path. (optional, string, default "redis.sock")

port

Port for replication client to connect to on remote server (optional, string, default "6379")

tunnel_host

When replication traffic is tunnelled, this is the host to target to forward outgoing traffic to the redis master. The resource agent configures the redis slave to target the master via tunnel_host:tunnel_port. Note that in order to enable replication traffic tunneling, parameter {tunnel_port_map} must be populated.

(optional, string, default "127.0.0.1")

tunnel_port_map

A mapping of pacemaker node names to redis port number. To be used when redis servers need to tunnel replication traffic. On every node where the redis resource is running, the redis server listens to a different port. Each redis server can access its peers for replication traffic via a tunnel accessible at {tunnel_host}:port.

The mapping the form of: pcmk1-name:port-for-redis1;pcmk2-name:port-for-redis2;pcmk3-name:port-for-redis3

where the redis resource started on node pcmk1-name would listen on port port-for-redis1

(optional, string, no default)

wait_last_known_master

During redis cluster bootstrap, wait for the last known master to be promoted before allowing any other instances in the cluster to be promoted. This lessens the risk of data loss when persistent data is in use. (optional, boolean, default false)

## SUPPORTED ACTIONS
This resource agent supports the following actions (operations):

start

Starts the resource. Suggested minimum timeout: 120s.

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: 60s. Suggested interval: 45s.

monitor (Promoted role)

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

promote

Promotes the resource to the Master role. Suggested minimum timeout: 120s.

demote

Demotes the resource to the Slave role. Suggested minimum timeout: 120s.

notify

Suggested minimum timeout: 90s.

validate-all

Performs a validation of the resource configuration. Suggested minimum timeout: 5s.

meta-data

Retrieves resource agent metadata (internal use only). Suggested minimum timeout: 5s.

## EXAMPLE CRM SHELL
The following is an example configuration for a redis resource using the crm(8) shell:

```
primitive p_redis ocf:heartbeat:redis \

  op monitor depth="0" timeout="60s" interval="45s" \

  op monitor role="Promoted" depth="0" timeout="60s" interval="20s"
```

```
ms ms_redis p_redis \

  meta notify="true" interleave="true"
```

## EXAMPLE PCS
The following is an example configuration for a redis resource using pcs(8)

```
pcs resource create p_redis ocf:heartbeat:redis \

  op monitor OCF_CHECK_LEVEL="0" timeout="60s" interval="45s" \

  op monitor role="Promoted" OCF_CHECK_LEVEL="0" timeout="60s" interval="20s" promotable
```

## SEE ALSO
http://clusterlabs.org/

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


title: ocf_heartbeat_rkt(7)

summary: rkt container resource agent.

text:
# ocf_heartbeat_rkt(7)

## NAME
ocf_heartbeat_rkt - rkt container resource agent.

## SYNOPSIS
rkt [start | stop | monitor | meta-data | validate-all]

## DESCRIPTION
The rkt HA resource agent creates and launches a container based off a supplied image. Containers managed by this agent are both created and removed upon the agent's start and stop actions.

## SUPPORTED PARAMETERS
image

The image to base this container off of. (required, string, no default)

name

The name to give the created container. By default this will be that resource's instance name. (optional, string, no default)

allow_pull

Allow the image to be pulled from the configured registry when the image does not exist locally. NOTE, this can drastically increase the time required to start the container if the image repository is pulled over the network. (optional, boolean, no default)

run_opts

Add options to be appended to the 'rkt run' command which is used when creating the container during the start action. This option allows users to do things such as setting a custom entry point and injecting environment variables into the newly created container. NOTE: Do not explicitly specify the --name argument in the run_opts. This agent will set --name using either the resource's instance or the name provided in the 'name' argument of this agent.

(optional, string, no default)

run_cmd

Specify a command to launch within the container once it has initialized. (optional, string, no default)

mount_points

A comma separated list of directories that the container is expecting to use. The agent will ensure they exist by running 'mkdir -p' (optional, string, no default)

monitor_cmd

Specify the full path of a command to launch within the container to check the health of the container. This command must return 0 to indicate that the container is healthy. A non-zero return code will indicate that the container has failed and should be recovered. Note: Using this method for monitoring processes inside a container is not recommended, as rkt tries to track processes running inside the container and does not deal well with many short-lived processes being spawned. Ensure that your container monitors its own processes and terminates on fatal error rather than invoking a command from the outside.

(optional, string, no default)

force_kill

Kill a container immediately rather than waiting for it to gracefully shutdown (optional, boolean, no default)

## SUPPORTED ACTIONS
This resource agent supports the following actions (operations):

start

Starts the resource. Suggested minimum timeout: 90s.

stop

Stops the resource. Suggested minimum timeout: 90s.

monitor

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

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: 30s.

## EXAMPLE CRM SHELL
The following is an example configuration for a rkt resource using the crm(8) shell:

```
primitive p_rkt ocf:heartbeat:rkt \

  params \

    image=string \

  op monitor timeout="30s" interval="30s" depth="0"
```

## EXAMPLE PCS
The following is an example configuration for a rkt resource using pcs(8)

```
pcs resource create p_rkt ocf:heartbeat:rkt \

  image=string \

  op monitor timeout="30s" interval="30s" OCF_CHECK_LEVEL="0"
```

## SEE ALSO
http://clusterlabs.org/

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


title: ocf_heartbeat_rsyncd(7)

summary: Manages an rsync daemon

text:
# ocf_heartbeat_rsyncd(7)

## NAME
ocf_heartbeat_rsyncd - Manages an rsync daemon

## SYNOPSIS
rsyncd [start | stop | monitor | meta-data | validate-all]

## DESCRIPTION
This script manages rsync daemon

## SUPPORTED PARAMETERS
binpath

The rsync binary path. For example, "/usr/bin/rsync" (optional, string, default "rsync")

conffile

The rsync daemon configuration file name with full path. For example, "/etc/rsyncd.conf" (optional, string, default "/etc/rsyncd.conf")

bwlimit

This option allows you to specify a maximum transfer rate in kilobytes per second. This option is most effective when using rsync with large files (several megabytes and up). Due to the nature of rsync transfers, blocks of data are sent, then if rsync determines the transfer was too fast, it will wait before sending the next data block. The result is an average transfer rate equaling the specified limit. A value of zero specifies no limit. (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: 20s.

monitor

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

validate-all

Performs a validation of the resource configuration. Suggested minimum timeout: 20s.

meta-data

Retrieves resource agent metadata (internal use only). Suggested minimum timeout: 5s.

## EXAMPLE CRM SHELL
The following is an example configuration for a rsyncd resource using the crm(8) shell:

```
primitive p_rsyncd ocf:heartbeat:rsyncd \

  op monitor depth="0" timeout="20s" interval="60s"
```

## EXAMPLE PCS
The following is an example configuration for a rsyncd resource using pcs(8)

```
pcs resource create p_rsyncd ocf:heartbeat:rsyncd \

  op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="60s"
```

## SEE ALSO
http://clusterlabs.org/

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


title: ocf_heartbeat_rsyslog(7)

summary: rsyslog resource agent

text:
# ocf_heartbeat_rsyslog(7)

## NAME
ocf_heartbeat_rsyslog - rsyslog resource agent

## SYNOPSIS
rsyslog [start | stop | status | monitor | meta-data | validate-all]

## DESCRIPTION
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"
```

## SEE ALSO
http://clusterlabs.org/

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


title: ocf_heartbeat_scsi2reservation(7)

summary: scsi\-2 reservation

text:
# ocf_heartbeat_scsi2reservation(7)

## NAME
ocf_heartbeat_scsi2reservation - scsi-2 reservation

## SYNOPSIS
scsi2reservation [start | stop | monitor | meta-data | validate-all]

## DESCRIPTION
The scsi-2-reserve resource agent is a place holder for SCSI-2 reservation. A healthy instance of scsi-2-reserve resource, indicates the own of the specified SCSI device. This resource agent depends on the scsi_reserve from scsires package, which is Linux specific.

## SUPPORTED PARAMETERS
scsi_reserve

The scsi_reserve is a command from scsires package. It helps one to issue SCSI-2 reservation on SCSI devices. (optional, string, default "/usr/sbin/scsi_reserve")

sharedisk

The shared disk that can be reserved. (optional, string, default "/dev/sdb")

start_loop

We are going to try several times before giving up. Start_loop indicates how many times we are going to re-try. (optional, string, default "10")

## SUPPORTED ACTIONS
This resource agent supports the following actions (operations):

start

Starts the resource. Suggested minimum timeout: 300s.

stop

Stops the resource. Suggested minimum timeout: 100s.

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: 30s.

## EXAMPLE CRM SHELL
The following is an example configuration for a scsi2reservation resource using the crm(8) shell:

```
primitive p_scsi2reservation ocf:heartbeat:scsi2reservation \

  op monitor depth="0" timeout="20s" interval="20s"
```

## EXAMPLE PCS
The following is an example configuration for a scsi2reservation resource using pcs(8)

```
pcs resource create p_scsi2reservation ocf:heartbeat:scsi2reservation \

  op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="20s"
```

## SEE ALSO
http://clusterlabs.org/

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


title: ocf_heartbeat_sfex(7)

summary: Manages exclusive access to shared storage using Shared Disk File EXclusiveness (SF\-EX)

text:
# ocf_heartbeat_sfex(7)

## NAME
ocf_heartbeat_sfex - Manages exclusive access to shared storage using Shared Disk File EXclusiveness (SF-EX)

## SYNOPSIS
sfex [start | stop | monitor | meta-data | validate-all]

## DESCRIPTION
Resource script for SF-EX. It manages a shared storage medium exclusively .

## SUPPORTED PARAMETERS
device

Block device path that stores exclusive control data. (required, string, no default)

index

Location in block device where exclusive control data is stored. 1 or more is specified. Default is 1. (optional, integer, default 1)

collision_timeout

Waiting time when a collision of lock acquisition is detected. Default is 1 second. (optional, integer, default 1)

monitor_interval

Monitor interval(sec). Default is 10 seconds (optional, integer, default 10)

lock_timeout

Valid term of lock(sec). Default is 100 seconds. The lock_timeout is calculated by the following formula. lock_timeout = monitor_interval + "The expiration time of the lock"

We suggest 90 seconds as a default value of the "The expiration time of the lock", but you should change it in consideration of access delay to the shared disk and the switch time of the multipath driver.

The lock timeout have an impact on start action timeout because start action timeout value is calculated by the following formula.

start timeout = collision_timeout + lock_timeout + "safety margin"

The "safety margin" is decided within the range of about 10-20 seconds(It depends on your system requirement).

(optional, integer, default 100)

## SUPPORTED ACTIONS
This resource agent supports the following actions (operations):

start

Starts the resource. Suggested minimum timeout: 120s.

stop

Stops the resource. Suggested minimum timeout: 20s.

monitor

Performs a detailed status check. Suggested minimum timeout: 10s. 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 sfex resource using the crm(8) shell:

```
primitive p_sfex ocf:heartbeat:sfex \

  params \

    device=string \

  op monitor depth="0" timeout="10s" interval="10s"
```

## EXAMPLE PCS
The following is an example configuration for a sfex resource using pcs(8)

```
pcs resource create p_sfex ocf:heartbeat:sfex \

  device=string \

  op monitor OCF_CHECK_LEVEL="0" timeout="10s" interval="10s"
```

## SEE ALSO
http://clusterlabs.org/

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


title: ocf_heartbeat_sg_persist(7)

summary: Manages SCSI PERSISTENT RESERVATIONS

text:
# ocf_heartbeat_sg_persist(7)

## NAME
ocf_heartbeat_sg_persist - Manages SCSI PERSISTENT RESERVATIONS

## SYNOPSIS
sg_persist [start | stop | monitor | promote | demote | meta-data | validate-all]

## DESCRIPTION
This resource agent manages SCSI PERSISTENT RESERVATIONS. "sg_persist" from sg3_utils is used, please see its documentation. Should be used as multistate (Master/Slave) resource Slave registers its node id ("crm_node -i") as reservation key ( --param-rk ) on each device in the "devs" list. Master reserves all devices from "devs" list with reservation "--prout-type" value from "reservation_type" parameter.

## SUPPORTED PARAMETERS
binary

The name of the binary that manages the resource. (optional, string, default "sg_persist")

devs

Device list. Multiple devices can be listed with blank space as separator. Shell wildcards are allowed. (required, string, no default)

required_devs_nof

Minimum number of "working" devices from device list 1) existing 2) "sg_persist --read-keys $device" works (Return code 0) resource actions "start","monitor","promote" and "validate-all" return "$OCF_ERR_INSTALLED" if the actual number of "working" devices is less then "required_devs_nof". resource actions "stop" and "demote" tries to remove reservations and registration keys from all working devices, but always return "$OCF_SUCCESS" (optional, string, default "1")

reservation_type

reservation type (optional, string, default "1")

master_score_base

master_score_base value "master_score_base" value is used in "master_score" calculation: master_score = $master_score_base + $master_score_dev_factor * $working_devs if set to bigger value in sg_persist resource configuration on some node, this node will be "preferred" for master role. (optional, string, default "0")

master_score_dev_factor

Working device factor in master_score calculation each "working" device provides additional value to "master_score", so the node that sees more devices will be preferred for the "Master"-role Setting it to 0 will disable this behavior. (optional, string, default "100")

master_score_delay

master/slave decreases/increases its master_score after delay of $master_score_delay seconds so if some device gets inaccessible, the slave decreases its master_score first and the resource will no be watched and after this device reappears again the master increases its master_score first this can work only if the master_score_delay is bigger then monitor interval on both master and slave Setting it to 0 will disable this behavior. (optional, string, default "30")

## SUPPORTED ACTIONS
This resource agent supports the following actions (operations):

start

Starts the resource. Suggested minimum timeout: 30s.

promote

Promotes the resource to the Master role. Suggested minimum timeout: 30s.

demote

Demotes the resource to the Slave role. Suggested minimum timeout: 30s.

notify

Suggested minimum timeout: 30s.

stop

Stops the resource. Suggested minimum timeout: 30s.

monitor (Unpromoted role)

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

monitor (Promoted role)

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

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: 30s.

## EXAMPLE CRM SHELL
The following is an example configuration for a sg_persist resource using the crm(8) shell:

```
primitive p_sg_persist ocf:heartbeat:sg_persist \

  params \

    devs=string \

  op monitor depth="0" timeout="20s" interval="29s" role="Unpromoted" \

  op monitor depth="0" timeout="20s" interval="60s" role="Promoted"
```

```
ms ms_sg_persist p_sg_persist \

  meta notify="true" interleave="true"
```

## EXAMPLE PCS
The following is an example configuration for a sg_persist resource using pcs(8)

```
pcs resource create p_sg_persist ocf:heartbeat:sg_persist \

  devs=string \

  op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="29s" role="Unpromoted" \

  op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="60s" role="Promoted" promotable
```

## SEE ALSO
http://clusterlabs.org/

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


title: ocf_heartbeat_slapd(7)

summary: Manages a Stand\-alone LDAP Daemon (slapd) instance

text:
# ocf_heartbeat_slapd(7)

## NAME
ocf_heartbeat_slapd - Manages a Stand-alone LDAP Daemon (slapd) instance

## SYNOPSIS
slapd [start | stop | monitor | meta-data | validate-all]

## DESCRIPTION
Resource script for Stand-alone LDAP Daemon (slapd). It manages a slapd instance as an OCF resource.

## SUPPORTED PARAMETERS
slapd

Full path to the slapd binary. For example, "/usr/sbin/slapd". (optional, string, default "/usr/sbin/slapd")

ldapsearch

Full path to the ldapsearch binary. For example, "/usr/bin/ldapsearch". (optional, string, default "ldapsearch")

config

Full path to a slapd configuration directory or a slapd configuration file. For example, "/etc/ldap/slapd.d" or "/etc/ldap/slapd.conf". (unique, optional, string, no default)

pidfile

File to read the PID from; read from olcPidFile/pidfile in config if not set. (optional, string, no default)

user

User name or id slapd will run with. The group id is also changed to this user's gid, unless the group parameter is used to override. (optional, string, no default)

group

Group name or id slapd will run with. (optional, string, no default)

services

LDAP (and other scheme) URLs slapd will serve. For example, "ldap://127.0.0.1:389 ldaps:/// ldapi:///" (unique, optional, string, default "ldap:///")

watch_suffix

Suffix (database backend) that will be monitored for availability. Multiple suffixes can be specified by providing a space separated list. By providing one or more suffixes here, the ignore_suffix parameter is discarded. All suffixes will be monitored if left blank. (optional, string, no default)

ignore_suffix

Suffix (database backend) that will not be monitored for availability. Multiple suffixes can be specified by providing a space separated list. No suffix will be excluded if left blank. (optional, string, no default)

bind_dn

Distinguished Name used to bind to the LDAP directory for testing. Leave blank to bind to the LDAP directory anonymously. (optional, string, no default)

password

Password used to bind to the LDAP directory for testing. (optional, string, no default)

parameters

slapd may be called with additional parameters. Specify any of them here. (optional, string, no default)

stop_escalate

Number of seconds to wait for shutdown (using SIGTERM) before resorting to SIGKILL (optional, integer, default 15)

maxfiles

Maximum number of open files (for ulimit -n) (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: 20s.

monitor

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

validate-all

Performs a validation of the resource configuration. Suggested minimum timeout: 20s.

meta-data

Retrieves resource agent metadata (internal use only). Suggested minimum timeout: 5s.

## EXAMPLE CRM SHELL
The following is an example configuration for a slapd resource using the crm(8) shell:

```
primitive p_slapd ocf:heartbeat:slapd \

  op monitor depth="0" timeout="20s" interval="60s"
```

## EXAMPLE PCS
The following is an example configuration for a slapd resource using pcs(8)

```
pcs resource create p_slapd ocf:heartbeat:slapd \

  op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="60s"
```

## SEE ALSO
http://clusterlabs.org/

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


title: ocf_heartbeat_smb-share(7)

summary: Manages samba shares on the fly

text:
# ocf_heartbeat_smb-share(7)

## NAME
ocf_heartbeat_smb-share - Manages samba shares on the fly

## SYNOPSIS
smb-share [start | stop | status | monitor | meta-data | validate-all]

## DESCRIPTION
This RA is used to control samba shares on the fly. For adding and removing samba shares no restart of the samba daemon is needed. This is the equivalent of the exportfs RA which is used for nfs shares.

For this RA to work as expected you need a cloned samba daemon which have to be startet before. After this RA manages config snippets placed in the filesystem and after a fence of that node these snippets will still located there you will have to use a tmpfs mount for this. Also you need a basic smb.conf file in which all global parameters an permanent shares should be placed. Within this smb.conf also you must put a line in the global section like this:

include = /etc/samba/conf.d/pacemaker-includes.conf

The filename can be changed by setting the parameter includesfile. Every share created by this RA will create a new file located in:

/etc/samba/conf.d/

This directory also can be changed by setting the RA parameter confd.

## SUPPORTED PARAMETERS
share

Set the name of a windows share which should be added to Samba example name "myshare" resulting in [myshare]. (unique, required, string, no default)

path

Set the path to share for cifs clients. example path "/srv/data/myshare". (unique, optional, string, no default)

hosts_allow

This parameter is a comma, space, or tab delimited set of hosts which are permitted to access a service. (optional, string, no default)

browseable

This controls whether this share is seen in the list of available shares in a net view and in the browse list. (optional, string, no default)

writeable

Inverted synonym for read only. (optional, string, no default)

read_only

This option can be used to turn the writing backends tdb, tdb2, and ldap into read only mode. This can be useful e.g. in cases where a pre-filled database exists that should not be extended automatically. (optional, string, no default)

guest_ok

If this parameter is yes for a service, then no password is required to connect to the service. Privileges will be those of the guest account. (optional, string, no default)

directory_mask

This parameter is the octal modes which are used when converting DOS modes to UNIX modes when creating UNIX directories. (optional, string, no default)

create_mask

When a file is created, the necessary permissions are calculated according to the mapping from DOS modes to UNIX permissions, and the resulting UNIX mode is then bit-wise ANDed with this parameter. This parameter may be thought of as a bit-wise MASK for the UNIX modes of a file. (optional, string, no default)

printable

If this parameter is yes, then clients may open, write to and submit spool files on the directory specified for the service. (optional, string, no default)

valid_users

This is a list of users that should be allowed to login to this service. Names starting with @, + and & are interpreted using the same rules as described in the invalid users parameter. (optional, string, no default)

force_user

This specifies a UNIX user name that will be assigned as the default user for all users connecting to this service. This is useful for sharing files. (optional, string, no default)

force_group

This specifies a UNIX group name that will be assigned as the default primary group for all users connecting to this service. This is useful for sharing files by ensuring that all access to files on service will use the named group for their permissions checking. (optional, string, no default)

extraopt

This option can be used to define an additional key = value pair. In this parameter also a semicolon could be placed. Need to set e.g somthinspecial = value (optional, string, no default)

extraopt_list

This option can be used to define multiple additional key = value pairs. Define the list of element semicolon separated. e.g somethingspecial = value;one more = value2 (optional, string, no default)

outfile

Set the path and filename where the snipped should be written. example "/etc/samba/conf.d/myshare.inc". (unique, required, string, no default)

confd

Set the path where the includes will be written. This folder have to be a tmpfs mount This defaults to "/etc/samba/conf.d". (optional, string, default "/etc/samba/conf.d")

includesfile

Set the path and filename in which the include should be placed. example includesfile "/etc/samba/conf.d/pacemaker-includes.conf". This option manages the include= parameter within this file (optional, string, default "/etc/samba/conf.d/pacemaker-includes.conf")

## 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: 20s.

status

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

monitor

Performs a detailed status check. Suggested minimum timeout: 20s. 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: 20s.

## EXAMPLE CRM SHELL
The following is an example configuration for a smb-share resource using the crm(8) shell:

```
primitive p_smb-share ocf:heartbeat:smb-share \

  params \

    share=string \

    outfile=string \

  op monitor depth="0" timeout="20s" interval="10s"
```

## EXAMPLE PCS
The following is an example configuration for a smb-share resource using pcs(8)

```
pcs resource create p_smb-share ocf:heartbeat:smb-share \

  share=string \

  outfile=string \

  op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="10s"
```

## SEE ALSO
http://clusterlabs.org/

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


title: ocf_heartbeat_storage-mon(7)

summary: storage I/O health status

text:
# ocf_heartbeat_storage-mon(7)

## NAME
ocf_heartbeat_storage-mon - storage I/O health status

## SYNOPSIS
storage-mon [start | stop | monitor | meta-data | validate-all]

## DESCRIPTION
System health agent that checks the storage I/O status of the given drives and updates the #health-storage attribute. Usage is highly recommended in combination with the HealthSMART monitoring agent. The agent currently support a maximum of 25 devices per instance.

## SUPPORTED PARAMETERS
state_file

Location to store the resource state in. (unique, optional, string, default "/run/resource-agents/storage-mon-RESOURCE_ID.state")

drives

The drive(s) to check as a SPACE separated list. Enter the full path to the device, e.g. "/dev/sda". (unique, required, string, no default)

io_timeout

Specify disk I/O timeout in seconds. Minimum 1, recommended 10 (default). (optional, integer, default 10)

check_interval

Specify interval between I/O checks in seconds.(Only supported with the damonize option.) (optional, integer, default 30)

inject_errors

Used only for testing! Specify % of I/O errors to simulate drives failures. (optional, integer, no default)

daemonize

Specifies to start storage-mon as a daemon and check for devices. (optional, boolean, default false)

## SUPPORTED ACTIONS
This resource agent supports the following actions (operations):

start

Starts the resource. Suggested minimum timeout: 10s.

stop

Stops the resource. Suggested minimum timeout: 120s.

monitor

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

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: 10s.

## EXAMPLE CRM SHELL
The following is an example configuration for a storage-mon resource using the crm(8) shell:

```
primitive p_storage-mon ocf:heartbeat:storage-mon \

  params \

    drives=string \

  op monitor timeout="120s" interval="30s" start-delay="0s"
```

## EXAMPLE PCS
The following is an example configuration for a storage-mon resource using pcs(8)

```
pcs resource create p_storage-mon ocf:heartbeat:storage-mon \

  drives=string \

  op monitor timeout="120s" interval="30s" start-delay="0s"
```

## SEE ALSO
http://clusterlabs.org/

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


title: ocf_heartbeat_sybaseASE(7)

summary: Sybase ASE Failover Instance

text:
# ocf_heartbeat_sybaseASE(7)

## NAME
ocf_heartbeat_sybaseASE - Sybase ASE Failover Instance

## SYNOPSIS
sybaseASE [start | stop | status | monitor | meta-data | validate-all]

## DESCRIPTION
Sybase ASE Failover Instance

## SUPPORTED PARAMETERS
sybase_home

The home directory of sybase products (optional, string, default "detect")

sybase_ase

The directory name under sybase_home where ASE products are installed (optional, string, default "detect")

sybase_ocs

The directory name under sybase_home where OCS products are installed, i.e. ASE-15_0 (optional, string, default "detect")

server_name

The ASE server name which is configured for the HA service (unique, required, string, no default)

interfaces_file

The full path of interfaces file which is used to start/access the ASE server (optional, string, default "detect/interfaces")

sybase_user

The user who can run ASE server (optional, string, default "sybase")

db_user

The database user required to login to isql. (required, string, no default)

db_passwd

The database user's password required to login to isql. (optional, string, no default)

logfile

Logfile (optional, string, default "detect")

## SUPPORTED ACTIONS
This resource agent supports the following actions (operations):

start

Starts the resource. Suggested minimum timeout: 300s.

stop

Stops the resource. Suggested minimum timeout: 300s.

status

Performs a status check. Suggested minimum timeout: 100s. Suggested interval: 30s.

monitor

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

status

Performs a status check. Suggested minimum timeout: 100s. Suggested interval: 120s.

monitor

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

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

```
primitive p_sybaseASE ocf:heartbeat:sybaseASE \

  params \

    server_name=string \

    db_user=string \

  op monitor interval="30s" timeout="100s" \

  op monitor depth="10" timeout="100s" interval="120s"
```

## EXAMPLE PCS
The following is an example configuration for a sybaseASE resource using pcs(8)

```
pcs resource create p_sybaseASE ocf:heartbeat:sybaseASE \

  server_name=string \

  db_user=string \

  op monitor interval="30s" timeout="100s" \

  op monitor OCF_CHECK_LEVEL="10" timeout="100s" interval="120s"
```

## SEE ALSO
http://clusterlabs.org/

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


title: ocf_heartbeat_symlink(7)

summary: Manages a symbolic link

text:
# ocf_heartbeat_symlink(7)

## NAME
ocf_heartbeat_symlink - Manages a symbolic link

## SYNOPSIS
symlink [start | stop | monitor | meta-data | validate-all]

## DESCRIPTION
This resource agent that manages a symbolic link (symlink).

It is primarily intended to manage configuration files which should be enabled or disabled based on where the resource is running, such as cron job definitions and the like.

## SUPPORTED PARAMETERS
link

Full path of the symbolic link to be managed. This must obviously be in a filesystem that supports symbolic links. (required, string, no default)

target

Full path to the link target (the file or directory which the symlink points to). (required, string, no default)

backup_suffix

A suffix to append to any files that the resource agent moves out of the way because they clash with "link". If this is unset (the default), then the resource agent will simply refuse to create a symlink if it clashes with an existing file.

(optional, string, no default)

## SUPPORTED ACTIONS
This resource agent supports the following actions (operations):

start

Starts the resource. Suggested minimum timeout: 15s.

stop

Stops the resource. Suggested minimum timeout: 15s.

monitor

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

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: 10s.

## EXAMPLE CRM SHELL
The following is an example configuration for a symlink resource using the crm(8) shell:

```
primitive p_symlink ocf:heartbeat:symlink \

  params \

    link=string \

    target=string \

  op monitor depth="0" timeout="15s" interval="60s"
```

## EXAMPLE PCS
The following is an example configuration for a symlink resource using pcs(8)

```
pcs resource create p_symlink ocf:heartbeat:symlink \

  link=string \

  target=string \

  op monitor OCF_CHECK_LEVEL="0" timeout="15s" interval="60s"
```

## SEE ALSO
http://clusterlabs.org/

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


title: ocf_heartbeat_syslog-ng(7)

summary: Syslog\-ng resource agent

text:
# ocf_heartbeat_syslog-ng(7)

## NAME
ocf_heartbeat_syslog-ng - Syslog-ng resource agent

## SYNOPSIS
syslog-ng [start | stop | status | monitor | meta-data | validate-all]

## DESCRIPTION
This script manages a syslog-ng instance as an HA resource.

For Premium Edition you should set the following parameters (based on default path being "/opt/syslog-ng"): syslog_ng_binary="/opt/syslog-ng/sbin/syslog-ng" syslog_ng_ctl="/opt/syslog-ng/sbin/syslog-ng-ctl" control_file="/opt/syslog-ng/var/run/syslog-ng.ctl" persist_file="/opt/syslog-ng/var/syslog-ng.persist" pidfile="/opt/syslog-ng/var/run/syslog-ng.pid"

Additional parameter for Premium Edition 6 only: qdisk_dir="/opt/syslog-ng/var/"

## SUPPORTED PARAMETERS
configfile

This parameter specifies a configuration file for a syslog-ng instance managed by this RA. (required, string, no default)

syslog_ng_binary

This parameter specifies syslog-ng's executable file. (optional, string, default "/sbin/syslog-ng")

syslog_ng_ctl

This parameter specifies the path of the syslog-ng-ctl executable file. (optional, string, default "/sbin/syslog-ng-ctl")

qdisk_dir

This parameter specifies the directory used for holding disk buffers of syslog-ng (only supported in Premium Edition 6). (optional, string, no default)

control_file

This parameter specifies the path, where syslog-ng would place its control socket, through which it can be controlled. (optional, string, no default)

persist_file

This parameter specifies the path for syslog-ng's persist file, which holds persistent information about the mapping of destinations and disk buffers, the internal state of sources, etc. (optional, string, no default)

pidfile

This parameter specifies the path where the pid file of syslog-ng resides. (optional, string, no default)

start_opts

This parameter specifies startup options for a syslog-ng 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)

kill_term_timeout

On a stop action, a normal stop method(pkill -TERM) is firstly used. And then the confirmation of its completion is waited for the specified seconds by this parameter. The default value is 10. (optional, integer, default 10)

## 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: 60s. Suggested interval: 60s.

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

```
primitive p_syslog-ng ocf:heartbeat:syslog-ng \

  params \

    configfile=string \

  op monitor depth="0" timeout="60s" interval="60s"
```

## EXAMPLE PCS
The following is an example configuration for a syslog-ng resource using pcs(8)

```
pcs resource create p_syslog-ng ocf:heartbeat:syslog-ng \

  configfile=string \

  op monitor OCF_CHECK_LEVEL="0" timeout="60s" interval="60s"
```

## SEE ALSO
http://clusterlabs.org/

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


title: ocf_heartbeat_varnish(7)

summary: Manage a Varnish instance

text:
# ocf_heartbeat_varnish(7)

## NAME
ocf_heartbeat_varnish - Manage a Varnish instance

## SYNOPSIS
varnish [start | stop | status | monitor | meta-data | validate-all]

## DESCRIPTION
The Varnish Resource Agent can manage several varnishd instances throughout the cluster. It does so by creating a unique PID file and requires a unique listen address and name for each instance.

## SUPPORTED PARAMETERS
config

The VCL configuration file that Varnish should manage, for example "/etc/varnish/default.vcl". (unique, required, string, no default)

name

Override the name of the instance that should be given to Varnish (defaults to the resource identifier). (unique, optional, string, default "RESOURCE_ID")

pid

Write the process's PID to the specified file. The default will include the specified name, i.e.: "/var/run/varnish_production.pid". Unlike what this help message shows, it is most likely not necessary to change this parameter. (unique, optional, string, default "/var/run/varnishd_RESOURCE_ID.pid")

listen_address

Listen on this address:port, for example "192.168.1.1:80" (unique, optional, string, default "0.0.0.0:80")

mgmt_address

Provide a management interface, for example "127.0.0.1:2222" (unique, required, string, no default)

ttl

Specify a hard minimum time to live for cached documents. (optional, integer, default 600)

varnish_user

Specify the name of an unprivileged user to which the child process should switch before it starts accepting connections. (optional, string, default "varnish")

varnish_group

Specify the name of an unprivileged group to which the child process should switch before it starts accepting connections. (optional, string, default "varnish")

backend_type

Use the specified storage backend. Valid options are 'malloc' for memory and 'file' for a file backend. (optional, string, default "malloc")

backend_size

Specify the size of the backend. For example "1G". (optional, string, default "1G")

backend_file

Specify the backend filename if you use backend_type file. For example /var/lib/varnish/mybackend.bin (unique, optional, string, default "/var/lib/varnish/RESOURCE_ID.bin")

threads_pools

Number of worker thread pools. Each pool has the minimum, maximum and timeout values configured in the thread_pool_min, thread_pool_max and thread_pool_timeout parameters (optional, string, default "2")

thread_pool_min

Start at least min but no more than max worker threads with the specified idle timeout in each pool. (optional, string, default "100")

thread_pool_max

Start at least min but no more than max worker threads with the specified idle timeout in each pool. (optional, string, default "3000")

thread_pool_timeout

Start at least min but no more than max worker threads with the specified idle timeout in each pool. (optional, string, default "120")

client_binary

This is used to control Varnish via a CLI. It's currently only used to check the status of the running child process. (optional, string, default "varnishadm")

maxfiles

Maximum number of open files (for ulimit -n) (optional, string, default "131072")

max_locked_memory

Locked shared memory limit (for ulimit -l) (optional, string, default "82000")

secret

Path to a file containing a secret used for authorizing access to the management port. (optional, string, default "/etc/varnish/secret")

## 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: 20s.

monitor

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

status

Performs a status check. Suggested minimum timeout: 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: 20s.

## EXAMPLE CRM SHELL
The following is an example configuration for a varnish resource using the crm(8) shell:

```
primitive p_varnish ocf:heartbeat:varnish \

  params \

    config=string \

    mgmt_address=string \

  op monitor timeout="20s" interval="10s" depth="0"
```

## EXAMPLE PCS
The following is an example configuration for a varnish resource using pcs(8)

```
pcs resource create p_varnish ocf:heartbeat:varnish \

  config=string \

  mgmt_address=string \

  op monitor timeout="20s" interval="10s" OCF_CHECK_LEVEL="0"
```

## SEE ALSO
http://clusterlabs.org/

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


title: ocf_heartbeat_vdo-vol(7)

summary: VDO resource agent

text:
# ocf_heartbeat_vdo-vol(7)

## NAME
ocf_heartbeat_vdo-vol - VDO resource agent

## SYNOPSIS
vdo-vol [start | stop | status | monitor | meta-data | validate-all]

## DESCRIPTION
OCF Resource script for VDO (Virtual Data Optimizer) volume(s). It manages VDO volume(s) as a HA resource.

The configuration file needs to be synced to all nodes, and the systemd vdo service must be disabled when using this agent.

## SUPPORTED PARAMETERS
config

Configuration file (optional, string, no default)

volume

VDO Volume (leave empty for all) (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: 20s.

status

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

monitor

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

validate-all

Performs a validation of the resource configuration. Suggested minimum timeout: 20s.

meta-data

Retrieves resource agent metadata (internal use only). Suggested minimum timeout: 20s.

## EXAMPLE CRM SHELL
The following is an example configuration for a vdo-vol resource using the crm(8) shell:

```
primitive p_vdo-vol ocf:heartbeat:vdo-vol \

  op monitor depth="0" timeout="20s" interval="10s" start-delay="10s"
```

## EXAMPLE PCS
The following is an example configuration for a vdo-vol resource using pcs(8)

```
pcs resource create p_vdo-vol ocf:heartbeat:vdo-vol \

  op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="10s" start-delay="10s"
```

## SEE ALSO
http://clusterlabs.org/

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


title: ocf_heartbeat_vmware(7)

text:
# ocf_heartbeat_vmware(7)

## NAME
ocf_heartbeat_vmware - Manages VMWare Server 2.0 virtual machines

## SYNOPSIS
vmware [start | stop | monitor | meta-data]

## DESCRIPTION
OCF compliant script to control vmware server 2.0 virtual machines.

## SUPPORTED PARAMETERS
vmxpath

VMX configuration file path (required, string, no default)

vimshbin

vmware-vim-cmd executable path (optional, string, default "/usr/bin/vmware-vim-cmd")

## SUPPORTED ACTIONS
This resource agent supports the following actions (operations):

start

Starts the resource. Suggested minimum timeout: 600s.

stop

Stops the resource. Suggested minimum timeout: 600s.

monitor

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

meta-data

Retrieves resource agent metadata (internal use only). Suggested minimum timeout: 5s.

## EXAMPLE CRM SHELL
The following is an example configuration for a vmware resource using the crm(8) shell:

```
primitive p_vmware ocf:heartbeat:vmware \

  params \

    vmxpath=string \

  op monitor timeout="30s" interval="300s" depth="0"
```

## EXAMPLE PCS
The following is an example configuration for a vmware resource using pcs(8)

```
pcs resource create p_vmware ocf:heartbeat:vmware \

  vmxpath=string \

  op monitor timeout="30s" interval="300s" OCF_CHECK_LEVEL="0"
```

## SEE ALSO
http://clusterlabs.org/

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


title: ocf_heartbeat_vsftpd(7)

summary: Manages an vsftpd

text:
# ocf_heartbeat_vsftpd(7)

## NAME
ocf_heartbeat_vsftpd - Manages an vsftpd

## SYNOPSIS
vsftpd [start | stop | monitor | meta-data | validate-all]

## DESCRIPTION
This script manages vsftpd. The parameter background in the vsftpd.conf must be set to yes and setproctitle_enable must be disabled. Otherwise the RA can not work.

## SUPPORTED PARAMETERS
binpath

The vsftpd binary path. For example, "/usr/sbin/vsftpd" (optional, string, default "/usr/sbin/vsftpd")

conffile

The vsftpd configuration file name with full path. For example, "/etc/vsftpd/vsftpd.conf" (optional, string, default "/etc/vsftpd/vsftpd.conf")

pidfile

The vsftpd pidfile with full path. For example, "/var/run/vsftpd.pid" (optional, string, default "/var/run/vsftpd.pid")

## 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: 20s.

monitor

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

validate-all

Performs a validation of the resource configuration. Suggested minimum timeout: 20s.

meta-data

Retrieves resource agent metadata (internal use only). Suggested minimum timeout: 5s.

## EXAMPLE CRM SHELL
The following is an example configuration for a vsftpd resource using the crm(8) shell:

```
primitive p_vsftpd ocf:heartbeat:vsftpd \

  op monitor depth="0" timeout="20s" interval="60s"
```

## EXAMPLE PCS
The following is an example configuration for a vsftpd resource using pcs(8)

```
pcs resource create p_vsftpd ocf:heartbeat:vsftpd \

  op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="60s"
```

## SEE ALSO
http://clusterlabs.org/

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


title: ocf_heartbeat_zabbixserver(7)

summary: Zabbix server resource agent

text:
# ocf_heartbeat_zabbixserver(7)

## NAME
ocf_heartbeat_zabbixserver - Zabbix server resource agent

## SYNOPSIS
zabbixserver [start | stop | monitor | meta-data | validate-all]

## DESCRIPTION
This is a Zabbix server Resource Agent for zabbix_server monitoring daemon. See: http://www.zabbix.com/

## SUPPORTED PARAMETERS
binary

Location of the zabbix_server binary. (optional, string, default "zabbix_server")

pid

Path to zabbix_server pidfile. As it's created by daemon itself it must be the same as specified in the Zabbix configuration file with parameter 'PidFile='. (unique, optional, string, default "/var/run/zabbix-server/zabbix_server.pid")

config

Path to zabbix_server configuration file. Assumed server default if not specified. (unique, 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: 20s.

monitor

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

validate-all

Performs a validation of the resource configuration. Suggested minimum timeout: 20s.

meta-data

Retrieves resource agent metadata (internal use only). Suggested minimum timeout: 5s.

## EXAMPLE CRM SHELL
The following is an example configuration for a zabbixserver resource using the crm(8) shell:

```
primitive p_zabbixserver ocf:heartbeat:zabbixserver \

  op monitor timeout="20s" interval="10s" depth="0"
```

## EXAMPLE PCS
The following is an example configuration for a zabbixserver resource using pcs(8)

```
pcs resource create p_zabbixserver ocf:heartbeat:zabbixserver \

  op monitor timeout="20s" interval="10s" OCF_CHECK_LEVEL="0"
```

## SEE ALSO
http://clusterlabs.org/

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