title: ocf_heartbeat_kamailio(7)

summary: Resource agent for Kamailio

text:
# ocf_heartbeat_kamailio(7)

## NAME
ocf_heartbeat_kamailio - Resource agent for Kamailio

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

## DESCRIPTION
Resource agent for the Kamailio SIP proxy/registrar. Multiple instances are possible when using following parameter combinations:

Parameters for Kamailio instance 1: listen_address=192.168.159.128 monitoring_ip=192.168.159.128 proto=udptcp port=5060

Parameters for Kamailio instance 2: listen_address=192.168.159.128 monitoring_ip=192.168.159.128 proto=udp port=5070 conffile=/etc/kamailio/kamailio2.cfg kamctlrc=""

Only one instance can be monitored via the command "kamctl monitor" because the kamctl tool of kamailio 4.x is not designed for multiple instances. Therefore, the provided kamctrlrc file path needs to be empty for instance 2, 3 ...

Parameters for a third Kamailio instance: listen_address=192.168.159.128 monitoring_ip=192.168.159.128 proto=tcp port=5080 conffile=/etc/kamailio/kamailio3.cfg kamctlrc=""

## SUPPORTED PARAMETERS
binary

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

conffile

The kamailio configuration file name with full path. For example, "/etc/kamailio/kamailio.cfg" , which is the default value. Make sure to use unique names in case of having multiple instances. (optional, string, default "/etc/kamailio/kamailio.cfg")

pidfile

The kamailio PID file. The directory used must be writable by kamailio process user. Be sure to use unique name for running more than one instance. Try to use absolute path names. If empty, resource agent create a unique directory from the resource instance name for the PID file and assign it to the process user. (optional, string, default "/var/run/kamailio_RESOURCE_ID/kamailio.pid")

monitoring_ip

SIP IP Address of the kamailio instance used for SIP OPTIONS polling monitoring. Usually the same IP address value as for parameter listen_address should be provided. In order to respond with a 200 OK response to the SIP OOPTION requests, the kamailio.cfg file needs to contain following section: Note: The following "kamailio.cfg" code snippet is part of an XML section. Therefore it contains two & characters, which need to be replaced with two ampersand characters within "kamailio.cfg":

if (is_method("OPTIONS") && (=~"sip:monitor@.*")) { ## ## If the method is an OPTIONS we are simply going to respond ## with a 200 OK. # xlog("L_INFO", "Method is an OPTIONS, probably just monitoring\n"); sl_send_reply("200", "Kamailio is alive"); exit; }

(optional, string, default "127.0.0.1")

listen_address

SIP IP address the kamailio will listen on. (required, string, no default)

port

SIP port for the kamailio instance. (optional, string, default "5060")

extra_options

Extra options to add to kamailio start. (optional, string, no default)

proto

The protocol used for SIP proto = udp|tcp|udptcp|conf_udp|conf_tcp|conf_udptcp. Using the options "conf_*" does not add any "-l" parameters to the kamailio command, the "listen" parameters from kamailio.conf are used instead. The sipsak checks are performed depending what protocol is defined after the underscore. (optional, string, default "udptcp")

sipsak

The installation path of the sipsak tool, which is used for monitoring Kamailio via SIP OPTIONS polling. (optional, string, default "/usr/bin/sipsak")

kamctl

The installation path of the "kamctl" control tool. (optional, string, default "/usr/bin/kamctl")

kamctlrc

The location of the "kamctlrc" file for the Kamailio instance. The file "kamctlrc" is the Kamailio configuration file for its "kamctl" control tool. This parameter only needs to be provided in case of using multiple Kamailio server instances on a single cluster node:

In case that the parameter "kamctlrc" is not empty, this resource agent monitors the health state of the Kamailio server via the command "kamctl monitor 1". This setting is recommended in case of using a single Kamailio server instance.

In case that the parameter "kamctlrc" is empty, the resource agent does not monitor the health state of the Kamailio server instance via the "kamctl" command.

Please note that the "kamctl" control command of Kamailio 4.x does not support running multiple Kamailio instances on one host. Nevertheless this resource agent does allow multiple Kamailio instances per host. The result of the "kamctl" limitation in terms of number of Kamailio server instances is that the health check via "kamctl monitor 1" can be configured for a single Kamailio instance only.

Please refer to the long description of this resource agent for an example of parameter combinations in case that multiple instances are to be configured per cluster node.

(optional, string, default "/etc/kamailio/kamctlrc")

kamuser

The user account for kamailio process to run with. Uses the current user, if not specified or empty. There is no check, if running kamailio with the specified user account is possible. (optional, string, no default)

kamgroup

The group for kamailio process to run with. Uses the current group, if not specified or empty. (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: 30s.

status

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

monitor

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

meta-data

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

validate-all

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

notify

Suggested minimum timeout: 5s.

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

```
primitive p_kamailio ocf:heartbeat:kamailio \

  params \

    listen_address=string \

  op monitor timeout="30s" interval="10s"
```

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

```
pcs resource create p_kamailio ocf:heartbeat:kamailio \

  listen_address=string \

  op monitor timeout="30s" interval="10s"
```

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

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


package: resource-agents

title: ocf_heartbeat_lvmlockd(7)

summary: This agent manages the lvmlockd daemon

text:
# ocf_heartbeat_lvmlockd(7)

## NAME
ocf_heartbeat_lvmlockd - This agent manages the lvmlockd daemon

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

## DESCRIPTION
This agent manages the lvmlockd daemon. "lvmlockd" is like "clvmd". Both are used by LVM commands to coordinate access to shared storage, but with different design and implementations. "lvmlockd" can use two lock managers: dlm and sanlock. This agent only supports "dlm + lvmlockd". If dlm (or corosync) are already being used by other cluster software, you are advised to select dlm, then configure "controld" resource agent for dlm and this agent for "lvmlockd". Otherwise, consider sanlock for "lvmlockd" if dlm/corosync is not required.

Using lvmlockd requires the settings in LVM configuration file (/etc/lvm/lvm.conf): "locking_type = 1" and "use_lvmlockd = 1". This RA will change the settings respectively if needed.

For more information, refer to manpage lvmlockd.8.

## SUPPORTED PARAMETERS
pidfile

pid file (optional, string, default "/run/lvmlockd.pid")

socket_path

Set the socket path to listen on. (optional, string, default "/run/lvm/lvmlockd.socket")

syslog_priority

Write log messages from this level up to syslog. (optional, string, default "warning")

adopt

Adopt locks from a previous instance of lvmlockd. (optional, integer, default 1)

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

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

```
primitive p_lvmlockd ocf:heartbeat:lvmlockd \

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

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

```
pcs resource create p_lvmlockd ocf:heartbeat:lvmlockd \

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

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

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

branch: sisyphus


title: ocf_heartbeat_lxc(7)

summary: Manages LXC containers

text:
# ocf_heartbeat_lxc(7)

## NAME
ocf_heartbeat_lxc - Manages LXC containers

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

## DESCRIPTION
Allows LXC containers to be managed by the cluster. Notes for lxc Versions before 1.0.0, where the Container is stopped using kill -PWR instead of lxc-stop: It is 'assumed' that the 'init' system will do an orderly shudown if presented with a 'kill -PWR' signal. On a 'sysvinit' this would require the container to have an inittab file containing "p0::powerfail:/sbin/init 0"

## SUPPORTED PARAMETERS
container

The unique name for this 'Container Instance' e.g. 'test1'. (unique, required, string, no default)

config

Absolute path to the file holding the specific configuration for this container e.g. '/etc/lxc/test1/config'. (required, string, no default)

log

Absolute path to the container log file (optional, string, default "/run/resource-agents/RESOURCE_ID.log")

use_screen

Provides the option of capturing the 'root console' from the container and showing it on a separate screen. To see the screen output run 'screen -r {container name}' The default value is set to 'false', change to 'true' to activate this option (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: 30s.

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

```
primitive p_lxc ocf:heartbeat:lxc \

  params \

    container=string \

    config=string \

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

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

```
pcs resource create p_lxc ocf:heartbeat:lxc \

  container=string \

  config=string \

  op monitor timeout="20s" interval="60s" 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_lxd-info(7)

text:
# ocf_heartbeat_lxd-info(7)

## NAME
ocf_heartbeat_lxd-info - Records various node attributes in the CIB

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

## DESCRIPTION
This is a LXD Registration Service Resource Agent. It records (in the CIB) attributes about the number of running LXD containers running on the node. Sample output: lxd_containers: 5

## SUPPORTED PARAMETERS
pidfile

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

delay

Interval to allow values to stabilize (optional, string, default "0s")

## 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.

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

```
primitive p_lxd-info ocf:heartbeat:lxd-info \

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

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

```
pcs resource create p_lxd-info ocf:heartbeat:lxd-info \

  op monitor 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_machine-info(7)

text:
# ocf_heartbeat_machine-info(7)

## NAME
ocf_heartbeat_machine-info - Records various node attributes in the CIB

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

## DESCRIPTION
This is a Virtual Machine and Container Registration Service Resource Agent. It records (in the CIB) attributes about the number of running virtual machines and containers running on the node. It uses systemd machinectl. Sample output: machines: 5

## SUPPORTED PARAMETERS
pidfile

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

delay

Interval to allow values to stabilize (optional, string, default "0s")

## 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.

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

```
primitive p_machine-info ocf:heartbeat:machine-info \

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

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

```
pcs resource create p_machine-info ocf:heartbeat:machine-info \

  op monitor 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_mariadb(7)

summary: Manages a MariaDB promotable instance

text:
# ocf_heartbeat_mariadb(7)

## NAME
ocf_heartbeat_mariadb - Manages a MariaDB promotable instance

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

## DESCRIPTION
Resource script for MariaDB.

Manages a complete promotable replication setup with GTID, for simpler uses look at the mysql resource agent which supports older replication forms which mysql and mariadb have in common.

The resource must be setup to use notifications. Set 'notify=true' in the metadata attributes when defining a MariaDB promotable instance.

The default behavior is to use uname -n values in the change promoted to command. Other IPs can be specified manually by adding a node attribute ${INSTANCE_ATTR_NAME}_mysql_master_IP giving the IP to use for replication. For example, if the mariadb primitive you are using is p_mariadb, the attribute to set will be p_mariadb_mysql_master_IP.

## SUPPORTED PARAMETERS
binary

Location of the MariaDB server binary (optional, string, default "/usr/bin/safe_mysqld")

client_binary

Location of the MariaDB client binary (optional, string, default "mysql")

config

Configuration file (optional, string, default "/etc/my.cnf")

datadir

Directory containing databases (optional, string, default "/var/lib/mysql")

user

User running MariaDB daemon (optional, string, default "mysql")

group

Group running MariaDB daemon (for logfile and directory permissions) (optional, string, default "mysql")

log

The logfile to be used for mysqld. (optional, string, default "/var/log/mysqld.log")

node_list

All node names of nodes that will execute mariadb. Please separate each node name with a space. This is required for the promoted selection to function. (required, string, no default)

pid

The pidfile to be used for mysqld. (optional, string, default "/var/run/mysql/mysqld.pid")

socket

The socket to be used for mysqld. (optional, string, default "/var/lib/mysql/mysql.sock")

test_table

Table to be tested in monitor statement (in database.table notation) (optional, string, default "mysql.user")

test_user

MariaDB test user, must have select privilege on test_table (optional, string, default "root")

test_passwd

MariaDB test user password (optional, string, no default)

enable_creation

If the MariaDB database does not exist, it will be created (optional, boolean, default 0)

additional_parameters

Additional parameters which are passed to the mysqld on startup. (e.g. --skip-external-locking or --skip-grant-tables) (optional, string, no default)

replication_user

MariaDB replication user. This user is used for starting and stopping MariaDB replication, for setting and resetting the promoted host, and for setting and unsetting read-only mode. Because of that, this user must have SUPER, REPLICATION SLAVE, REPLICATION CLIENT, PROCESS and RELOAD privileges on all nodes within the cluster. Mandatory if you define a promotable resource. (optional, string, default "root")

replication_passwd

MariaDB replication password. Used for replication client and unpromoted. Mandatory if you define a promotable resource. (optional, string, no default)

replication_port

The port on which the Promoted MariaDB instance is listening. (optional, string, default "3306")

replication_require_ssl

Enables SSL connection to local MySQL service for replication user. i.e. if REQUIRE SSL for replication user in MySQL set, this should be set to "true". (optional, string, default "false")

replication_master_ssl_ca

The SSL CA certificate to be used for replication over SSL. (optional, string, no default)

replication_master_ssl_cert

The SSL CA certificate to be used for replication over SSL. (optional, string, no default)

replication_master_ssl_key

The SSL certificate key to be used for replication over SSL. (optional, string, no default)

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

monitor (Promoted role)

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

monitor (Unpromoted role)

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

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

```
primitive p_mariadb ocf:heartbeat:mariadb \

  params \

    node_list=string \

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

  op monitor role="Promoted" depth="0" timeout="30s" interval="10s" \

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

```
ms ms_mariadb p_mariadb \

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

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

```
pcs resource create p_mariadb ocf:heartbeat:mariadb \

  node_list=string \

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

  op monitor role="Promoted" OCF_CHECK_LEVEL="0" timeout="30s" interval="10s" \

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

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

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


title: ocf_heartbeat_mdraid(7)

text:
# ocf_heartbeat_mdraid(7)

## NAME
ocf_heartbeat_mdraid - Manages Linux software RAID (MD) devices on shared storage

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

## DESCRIPTION
This resource agent manages Linux software RAID (MD) devices on a shared storage medium ensuring that non-clustered MD arrays are prohibited from starting cloned (which would cause data corruption (e.g., on raid6 arrays) unless forced (see force_clones parameter). Clustered MD RAID layouts (see below) will be discovered and allowed cloning by default; no need to set force_clones.

It uses mdadm(8) to start, stop, and monitor the MD devices.

Supported clustered (i.e., clonable active-active) arrays are linear, raid0, and clustered raid1/raid10 (i.e. mdadm(8) created with

--bitmap=clustered).

Option: OCF_CHECK_LEVEL

When OCF_CHECK_LEVEL is set to any number greater than 0, the standard monitor operation (including probe) will check the array and attempt recovery sequence to re-add devices if any failed device exists. By default, OCF_CHECK_LEVEL is unset, and this is disabled.

## SUPPORTED PARAMETERS
mdadm_conf

The MD RAID configuration file (e.g., /etc/mdadm.conf). (required, string, no default)

md_dev

MD array block device to use (e.g., /dev/md0 or /dev/md/3). With shared access to the array's storage, this should preferably be a clustered raid1 or raid10 array created with --bitmap=clustered, assuming its resource will be cloned (i.e., active-active access). One or more block devices to use, space separated. Alternatively, set to "auto" to manage all devices specified in mdadm_conf. Be sure to disable auto-assembly for the resource-managed arrays!

(required, string, no default)

force_stop

If processes or kernel threads are using the array, it cannot be stopped. We will try to stop processes, first by sending TERM and then, if that doesn't help in seconds, using KILL. The lsof(8) program is required to get the list of array users. Of course, the kernel threads cannot be stopped this way. If the processes are critical for data integrity, then set this parameter to false. Note that in that case the stop operation will fail and the node will be fenced. (optional, boolean, default false)

wait_for_udev

Wait until udevd creates a device in the start operation. On a normally loaded host this should happen quickly, but you may be unlucky. If you are not using udev set this to "no". (optional, boolean, default true)

force_clones

Activating the same, non-clustered MD RAID array (i.e. single-host raid1/4/5/6/10) on multiple nodes at the same time will result in data corruption and thus is forbidden by default. A safe example could be an (exotic) array that is only named identically across all nodes, but is in fact based on distinct (non-shared) storage.

Only set this to "true" if you know what you are doing!

(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.

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

```
primitive p_mdraid ocf:heartbeat:mdraid \

  params \

    mdadm_conf=string \

    md_dev=string \

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

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

```
pcs resource create p_mdraid ocf:heartbeat:mdraid \

  mdadm_conf=string \

  md_dev=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_minio(7)

text:
# ocf_heartbeat_minio(7)

## NAME
ocf_heartbeat_minio - OCF Resource Agent compliant Minio server script.

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

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

## SUPPORTED PARAMETERS
binary

The Minio server binary (optional, string, default "/opt/minio/minio-server")

confdir

The Minio configuration directory path. For example, "/etc/minio" (optional, string, default "/etc/minio")

pidfile

The Minio PID file. The location of the PID file. (optional, string, default "/var/run/minio.pid")

address

Address to bind minio to. (optional, string, default ":9000")

volumepaths

The storage volumes for minio to use. (optional, string, default "/home/shared")

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

meta-data

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

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

```
primitive p_minio ocf:heartbeat:minio \

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

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

```
pcs resource create p_minio ocf:heartbeat:minio \

  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_mpathpersist(7)

text:
# ocf_heartbeat_mpathpersist(7)

## NAME
ocf_heartbeat_mpathpersist - Manages SCSI persistent reservations on multipath devices

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

## DESCRIPTION
This resource agent manages SCSI persistent reservations on multipath devices. "mpathpersist" from multipath-tools is used, please see its documentation. Should be used as multistate (Promotable) resource Unpromoted registers its node id ("crm_node -i") as reservation key ( --param-sark ) on each device in the params "devs" list. Promoted reserves all devices from params "devs" list with reservation "--prout-type" value from "reservation_type" parameter. Please see man sg_persist(8) and mpathpersist(8) for reservation_type details.

## SUPPORTED PARAMETERS
binary

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

devs

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

required_devs_no

Minimum number of "working" devices from device list 1) existing 2) "mpathpersist --in --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 than "required_devs_no". 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 mpathpersist resource configuration on some node, this node will be "preferred" for promoted role. (optional, string, default "0")

master_score_dev_factor

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

master_score_delay

promoted/unpromoted decreases/increases its master_score after delay of "master_score_delay" seconds so if some device gets inaccessible, the unpromoted decreases its promoted first and the resource will no be watched and after this device reappears again the promoted increases its master_score first this can work only if the master_score_delay is bigger then monitor interval on both promoted and unpromoted 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 mpathpersist resource using the crm(8) shell:

```
primitive p_mpathpersist ocf:heartbeat:mpathpersist \

  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_mpathpersist p_mpathpersist \

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

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

```
pcs resource create p_mpathpersist ocf:heartbeat:mpathpersist \

  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_mysql(7)

summary: Manages a MySQL database instance

text:
# ocf_heartbeat_mysql(7)

## NAME
ocf_heartbeat_mysql - Manages a MySQL database instance

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

## DESCRIPTION
Resource script for MySQL. May manage a standalone MySQL database, a clone set with externally managed replication, or a complete master/slave replication setup. Note, when master/slave replication is in use, the resource must be setup to use notifications. Set 'notify=true' in the metadata attributes when defining a MySQL master/slave instance.

While managing replication, the default behavior is to use uname -n values in the change master to command. Other IPs can be specified manually by adding a node attribute ${INSTANCE_ATTR_NAME}_mysql_master_IP giving the IP to use for replication. For example, if the mysql primitive you are using is p_mysql, the attribute to set will be p_mysql_mysql_master_IP.

## SUPPORTED PARAMETERS
binary

Location of the MySQL server binary (optional, string, default "/usr/bin/safe_mysqld")

client_binary

Location of the MySQL client binary (optional, string, default "mysql")

config

Configuration file (optional, string, default "/etc/my.cnf")

datadir

Directory containing databases (optional, string, default "/var/lib/mysql")

user

User running MySQL daemon (optional, string, default "mysql")

group

Group running MySQL daemon (for logfile and directory permissions) (optional, string, default "mysql")

log

The logfile to be used for mysqld. (optional, string, default "/var/log/mysqld.log")

pid

The pidfile to be used for mysqld. (optional, string, default "/var/run/mysql/mysqld.pid")

socket

The socket to be used for mysqld. (optional, string, default "/var/lib/mysql/mysql.sock")

test_table

Table to be tested in monitor statement (in database.table notation) (optional, string, default "mysql.user")

test_user

MySQL test user, must have select privilege on test_table (optional, string, default "root")

test_passwd

MySQL test user password (optional, string, no default)

enable_creation

If the MySQL database does not exist, it will be created (optional, boolean, default 0)

additional_parameters

Additional parameters which are passed to the mysqld on startup. (e.g. --skip-external-locking or --skip-grant-tables) (optional, string, no default)

replication_user

MySQL replication user. This user is used for starting and stopping MySQL replication, for setting and resetting the master host, and for setting and unsetting read-only mode. Because of that, this user must have SUPER, REPLICATION SLAVE, REPLICATION CLIENT, PROCESS and RELOAD privileges on all nodes within the cluster. Mandatory if you define a master-slave resource. (optional, string, default "root")

replication_passwd

MySQL replication password. Used for replication client and slave. Mandatory if you define a master-slave resource. (optional, string, no default)

replication_port

The port on which the Master MySQL instance is listening. (optional, string, default "3306")

replication_require_ssl

Enables SSL connection to local MySQL service for replication user. i.e. if REQUIRE SSL for replication user in MySQL set, this should be set to "true". (optional, string, default "false")

replication_master_ssl_ca

The SSL CA certificate to be used for replication over SSL. (optional, string, no default)

replication_master_ssl_cert

The SSL CA certificate to be used for replication over SSL. (optional, string, no default)

replication_master_ssl_key

The SSL certificate key to be used for replication over SSL. (optional, string, no default)

max_slave_lag

The maximum number of seconds a replication slave is allowed to lag behind its master. Do not set this to zero. What the cluster manager does in case a slave exceeds this maximum lag is determined by the evict_outdated_slaves parameter. (optional, integer, default 3600)

evict_outdated_slaves

If set to true, any slave which is more than max_slave_lag seconds behind the master has its MySQL instance shut down. If this parameter is set to false in a primitive or clone resource, it is simply ignored. If set to false in a master/slave resource, then exceeding the maximum slave lag will merely push down the master preference so the lagging slave is never promoted to the new master. (optional, boolean, default false)

reader_attribute

An attribute that the RA can manage to specify whether a node can be read from. This node attribute will be 1 if it's fine to read from the node, and 0 otherwise (for example, when a slave has lagged too far behind the master). A typical example for the use of this attribute would be to tie a set of IP addresses to MySQL slaves that can be read from.

This parameter is only meaningful in master/slave set configurations.

(unique, optional, string, default "readable")

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

monitor (Promoted role)

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

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

```
primitive p_mysql ocf:heartbeat:mysql \

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

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

```
ms ms_mysql p_mysql \

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

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

```
pcs resource create p_mysql ocf:heartbeat:mysql \

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

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

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

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


title: ocf_heartbeat_mysql-proxy(7)

summary: Manages a MySQL Proxy instance

text:
# ocf_heartbeat_mysql-proxy(7)

## NAME
ocf_heartbeat_mysql-proxy - Manages a MySQL Proxy instance

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

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

The default monitor operation will verify that mysql-proxy is running.

The level 10 monitor operation is left out intentionally for possible future enhancements in conjunction with the admin plugin.

The level 20 monitor operation will perform a SELECT on a given table to verify that the connection to a back-end server is actually working.

Tested with MySQL Proxy 0.8.1 and 0.8.3 on Debian 6.0.

## SUPPORTED PARAMETERS
binary

Full path to the MySQL Proxy binary. For example, "/usr/sbin/mysql-proxy". (optional, string, default "/usr/sbin/mysql-proxy")

client_binary

Location of the MySQL client binary. (optional, string, default "mysql")

defaults_file

Full path to a MySQL Proxy configuration file. For example, "/etc/mysql-proxy.conf". (optional, string, no default)

proxy_backend_addresses

Address:port of the remote back-end servers (default: 127.0.0.1:3306). (optional, string, default "127.0.0.1:3306")

proxy_read_only_backend_addresses

Address:port of the remote (read only) unpromoted-server (default: ). (optional, string, no default)

proxy_address

Listening address:port of the proxy server (default: :4040). You can also specify a socket like "/var/run/mysql-proxy.sock". (optional, string, default ":4040")

log_level

Log all messages of level (error|warning|info|message|debug|) or higher. An empty value disables logging. (optional, string, no default)

keepalive

Try to restart the proxy if it crashed (default: ). Valid values: true or false. An empty value equals "false". (optional, string, no default)

plugins

Whitespace separated list of plugins to load (default: ). Note: The admin plugin will be auto-loaded in case you specify an admin_* parameter. (optional, string, no default)

admin_address

Listening address:port of the admin plugin (default: 127.0.0.1:4041). Note: The admin plugin will be auto-loaded in case you specify an admin_* parameter. (optional, string, default "127.0.0.1:4041")

admin_username

Username for the admin plugin (default: ). Required since MySQL Proxy 0.8.1, if the admin plugin is loaded. Note: The admin plugin will be auto-loaded in case you specify an admin_* parameter. (optional, string, no default)

admin_password

Password for the admin plugin (default: ). Required since MySQL Proxy 0.8.1, if the admin plugin is loaded. Note: The admin plugin will be auto-loaded in case you specify an admin_* parameter. (optional, string, no default)

admin_lua_script

Script to execute by the admin plugin. Required since MySQL Proxy 0.8.1, if the admin plugin is loaded. Note: The admin plugin will be auto-loaded in case you specify an admin_* parameter. (optional, string, no default)

test_table

Table to be tested in monitor statement (in database.table notation) (optional, string, default "mysql.user")

test_user

MySQL test user (optional, string, no default)

test_passwd

MySQL test user password (optional, string, no default)

parameters

The MySQL Proxy daemon may be called with additional parameters. Specify any of them here. (optional, string, no default)

pidfile

PID file (unique, optional, string, default "/run/resource-agents/mysql-proxy-RESOURCE_ID.pid")

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

start

Starts the resource. Suggested minimum timeout: 30s.

stop

Stops the resource. Suggested minimum timeout: 30s.

reload

Suggested minimum timeout: 30s.

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

meta-data

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

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

```
primitive p_mysql-proxy ocf:heartbeat:mysql-proxy \

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

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

```
pcs resource create p_mysql-proxy ocf:heartbeat:mysql-proxy \

  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_nagios(7)

summary: Nagios resource agent

text:
# ocf_heartbeat_nagios(7)

## NAME
ocf_heartbeat_nagios - Nagios resource agent

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

## DESCRIPTION
OCF Resource script for Nagios 3.x or 4.x. It manages a Nagios instance as a HA resource.

## SUPPORTED PARAMETERS
user

User running Nagios daemon (for file permissions) (optional, string, default "nagios")

group

Group running Nagios daemon (for file permissions) (optional, string, default "nagios")

binary

Location of the Nagios binary (optional, string, default "/usr/sbin/nagios")

config

Configuration file (optional, string, default "/etc/nagios/nagios.cfg")

log

Location of the Nagios log (optional, string, default "/var/log/nagios/nagios.log")

retention

Location of the Nagios retention file (optional, string, default "/var/log/nagios/retention.dat")

command

Location of the Nagios external command file (optional, string, default "/var/log/nagios/rw/nagios.cmd")

pid

Location of the Nagios pid/lock (optional, string, default "/var/run/nagios.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.

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

```
primitive p_nagios ocf:heartbeat:nagios \

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

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

```
pcs resource create p_nagios ocf:heartbeat:nagios \

  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_named(7)

summary: Manages a named server

text:
# ocf_heartbeat_named(7)

## NAME
ocf_heartbeat_named - Manages a named server

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

## DESCRIPTION
Resource script for named (Bind) server. It manages named as an HA resource.

## SUPPORTED PARAMETERS
named

Path to the named command. (optional, string, default "/usr/sbin/named")

rndc

Path to the rndc command. (optional, string, default "/usr/sbin/rndc")

host

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

named_user

User that should own named process. (optional, string, default "named")

named_config

Configuration file for named. (unique, optional, string, no default)

named_pidfile

PIDFILE file for named. (unique, optional, string, default "/var/run/named/named.pid")

named_rootdir

Directory that named should use for chroot if any. (unique, optional, string, no default)

named_options

Options for named process if any. (optional, string, no default)

named_keytab_file

named service keytab file (for GSS-TSIG). (optional, string, no default)

rndc_options

Options for rndc process if any. (optional, string, no default)

host_options

Options for host process if any. (optional, string, no default)

monitor_request

Request that shall be sent to named for monitoring. Usually an A record in DNS. (optional, string, default "localhost")

monitor_response

Expected response from named server. (optional, string, default "127.0.0.1")

monitor_ip

IP Address where named listens. (optional, string, default "127.0.0.1")

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

reload

Suggested minimum timeout: 60s.

status

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

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

methods

Suggested minimum timeout: 5s.

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

```
primitive p_named ocf:heartbeat:named \

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

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

```
pcs resource create p_named ocf:heartbeat:named \

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

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

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


title: ocf_heartbeat_nfsnotify(7)

summary: sm\-notify reboot notifications

text:
# ocf_heartbeat_nfsnotify(7)

## NAME
ocf_heartbeat_nfsnotify - sm-notify reboot notifications

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

## DESCRIPTION
This agent sends NFSv3 reboot notifications to clients which informs clients to reclaim locks.

## SUPPORTED PARAMETERS
source_host

Comma separated list of floating IP addresses or host names that clients use to access the nfs service. This will be used to set the source address and mon_name of the SN_NOTIFY reboot notifications. (optional, string, no default)

notify_args

Additional arguments to send to the sm-notify command. By default this agent will always set sm-notify's '-f' option. When the source_host option is set, the '-v' option will be used automatically to set the proper source address. Any additional sm-notify arguments set with this option will be used in addition to the previous default arguments. (optional, string, 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: 90s. Suggested interval: 30s.

reload

Suggested minimum timeout: 90s.

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

```
primitive p_nfsnotify ocf:heartbeat:nfsnotify \

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

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

```
pcs resource create p_nfsnotify ocf:heartbeat:nfsnotify \

  op monitor timeout="90s" 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_nginx(7)

text:
# ocf_heartbeat_nginx(7)

## NAME
ocf_heartbeat_nginx - Manages an Nginx web/proxy server instance

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

## DESCRIPTION
This is the resource agent for the Nginx web/proxy server. This resource agent does not monitor POP or IMAP servers, as we don't know how to determine meaningful status for them.

The start operation ends with a loop in which monitor is repeatedly called to make sure that the server started and that it is operational. Hence, if the monitor operation does not succeed within the start operation timeout, the nginx resource will end with an error status.

The default monitor operation will verify that nginx is running.

The level 10 monitor operation by default will try and fetch the /nginx_status page - which is commented out in sample nginx configurations. Make sure that the /nginx_status page works and that the access is restricted to localhost (address 127.0.0.1) plus whatever places _outside the cluster_ you want to monitor the server from. See the status10url and status10regex attributes for more details.

The level 20 monitor operation will perform a more complex set of tests from a configuration file.

The level 30 monitor operation will run an external command to perform an arbitrary monitoring operation.

## SUPPORTED PARAMETERS
configfile

The full pathname of the Nginx configuration file. This file is parsed to provide defaults for various other resource agent parameters. (unique, optional, string, no default)

httpd

The full pathname of the httpd binary (optional). (optional, string, default "/usr/sbin/httpd")

port

A port number that we can probe for status information using the statusurl. This will default to the port number found in the configuration file, or 80, if none can be found in the configuration file. (optional, integer, no default)

status10url

The URL to monitor (the nginx server status page by default) when given a level 10 monitor operation. If left unspecified, it will be inferred from the nginx configuration file, or defaulted to /nginx_status. If you set this, make sure that it succeeds *only* from the localhost (127.0.0.1) and no other cluster nodes. Otherwise, the cluster software may complain about it being active on multiple nodes.

(optional, string, no default)

status10regex

Regular expression to match in the output of status10url. Case insensitive. (optional, string, default "Reading: [0-9]+ Writing: [0-9]+ Waiting: [0-9]+")

testclient

Client to use to query to Nginx for level 10 and level 20 tests. If not specified, the RA will try to find one on the system. Currently, wget and curl are supported, with curl being preferred. For example, you can set this parameter to "wget" if you prefer that to curl. (optional, string, no default)

test20url

URL to test. If it does not start with "http", then it's considered to be relative to the document root address. (optional, string, no default)

test20regex

Regular expression to match in the output of test20url. Case insensitive. (optional, string, no default)

test20conffile

A file which contains a more complex test configuration. Could be useful if you have to check more than one web application or in case sensitive info should be passed as arguments (passwords). Furthermore, using a config file is the only way to specify certain parameters. Please see README.webapps for examples and file description.

(optional, string, no default)

test20name

Name of the test within the test configuration file. (optional, string, no default)

external_monitor30_cmd

Command string to run which implements level 30 monitoring. (optional, string, no default)

options

Extra options to apply when starting nginx. (optional, string, no default)

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

start

Starts the resource. Suggested minimum timeout: 40s.

stop

Stops the resource. Suggested minimum timeout: 60s.

reload

Suggested minimum timeout: 40s.

status

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

monitor

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

monitor

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

monitor

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

monitor

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

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

```
primitive p_nginx ocf:heartbeat:nginx \

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

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

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

  op monitor timeout="60s" depth="30" interval="61s"
```

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

```
pcs resource create p_nginx ocf:heartbeat:nginx \

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

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

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

  op monitor timeout="60s" OCF_CHECK_LEVEL="30" interval="61s"
```

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

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


title: ocf_heartbeat_nvmet-namespace(7)

summary: NVMe\-oF target export agent

text:
# ocf_heartbeat_nvmet-namespace(7)

## NAME
ocf_heartbeat_nvmet-namespace - NVMe-oF target export agent

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

## DESCRIPTION
Manages NVMe-oF namespaces. An NVMe-oF namespace is part of an NVMe-oF target. A namespace must be created after the subsystem. It is similar in concept to the LUN of an iSCSI target.

## SUPPORTED PARAMETERS
nqn

The NVMe Qualified Name (NQN) is used to identify the remote NVMe storage target. It is similar to an iSCSI Qualified Name (IQN). While it is a free-form string, you should follow the convention: nqn.2014-08.com.vendor:nvme:nvm-subsystem-sn-12345 You need to refer here to the NQN of an NVMe Subsystem your created with the NVMeSubsystem resource agent. (unique, required, string, no default)

namespace_id

The NVMe namespace id (number). (unique, optional, integer, default 1)

backing_path

The full path to the block device or file that should be exposed through this namespace. (required, string, no default)

uuid

The UUID that should be exposed by NVMe. Create it using uuidgen. This is necessary for the initiators to accept the namespace from the new server after failover. (unique, required, string, no default)

nguid

NGUID stands for Namespace Globally Unique Identifier. Seems to be optional, looks like e.g. VMWare ESXi7 uses it to identify namespaces. Use 'uuidgen' to create it. (unique, optional, string, no default)

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

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

```
primitive p_nvmet-namespace ocf:heartbeat:nvmet-namespace \

  params \

    nqn=string \

    backing_path=string \

    uuid=string \

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

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

```
pcs resource create p_nvmet-namespace ocf:heartbeat:nvmet-namespace \

  nqn=string \

  backing_path=string \

  uuid=string \

  op monitor timeout="10s" 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_nvmet-port(7)

summary: NVMe\-oF target export agent

text:
# ocf_heartbeat_nvmet-port(7)

## NAME
ocf_heartbeat_nvmet-port - NVMe-oF target export agent

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

## DESCRIPTION
Manages NVMe-oF ports. An NVMe-oF port is part of an NVMe-oF target. A port must be created after the subsystem. It exposes one or multiple subsystem(s) including the enclosed namespace(s) to the network.

## SUPPORTED PARAMETERS
port_id

The NVMe port number is a 16 bit number. (unique, optional, integer, default 0)

type

The NVMe transport type. Should be one of 'tcp', 'rdma', 'fc' or 'loop'. (optional, string, default "tcp")

addr_fam

The address family of the address. Should be 'ipv4', 'ipv6' or 'fc'. (optional, string, default "ipv4")

svcid

The transport service identifier. The TCP/IP port number this target binds to, or its RDMA protocol equivalent. (optional, integer, default 4420)

addr

The transport address. The TCP/IP address this targets binds to, or its RDMA protocol equivalent. (required, string, no default)

nqns

A space-separated list of NQNs that should be exported through this NVMe-oF-Target port. This list needs to have at least one entry. (required, string, no default)

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

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

```
primitive p_nvmet-port ocf:heartbeat:nvmet-port \

  params \

    addr=string \

    nqns=string \

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

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

```
pcs resource create p_nvmet-port ocf:heartbeat:nvmet-port \

  addr=string \

  nqns=string \

  op monitor timeout="10s" 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_nvmet-subsystem(7)

summary: NVMe\-oF target export agent

text:
# ocf_heartbeat_nvmet-subsystem(7)

## NAME
ocf_heartbeat_nvmet-subsystem - NVMe-oF target export agent

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

## DESCRIPTION
Manages NVMe-oF subsystems. An NVMe-oF subsystem is part of an NVMe-oF target. A subsystem must be created first, before namespace(s) and port(s).

## SUPPORTED PARAMETERS
nqn

The NVMe Qualified Name (NQN) is used to identify the remote NVMe storage target. It is similar to an iSCSI Qualified Name (IQN). While it is a free-form string, you should follow the convention: nqn.2014-08.com.vendor:nvme:nvm-subsystem-sn-12345 (unique, required, string, no default)

allowed_initiators

Allowed initiators. A space-separated list of initiators allowed to connect to this target. Initiators are identified by their NQN. If the list is empty, any initiator will be allowed to connect. (optional, string, no default)

serial

The serial of the subsystem. Set it to a random 16 character hex value. Use hexdump -n 8 -e '4/4 "%08x" 1 "\n"' /dev/urandom (optional, string, no default)

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

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

```
primitive p_nvmet-subsystem ocf:heartbeat:nvmet-subsystem \

  params \

    nqn=string \

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

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

```
pcs resource create p_nvmet-subsystem ocf:heartbeat:nvmet-subsystem \

  nqn=string \

  op monitor timeout="10s" 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_ocivip(7)

text:
# ocf_heartbeat_ocivip(7)

## NAME
ocf_heartbeat_ocivip - OCI Secondary Private IP Address for Compute instances Resource Agent

## SYNOPSIS
ocivip [start | stop | monitor | migrate_to | migrate_from | meta-data | validate-all]

## DESCRIPTION
Resource Agent for OCI Compute instance Secondary Private IP Addresses.

It manages OCI Secondary Private IP Addresses for Compute instances with oci cli.

See https://docs.oracle.com/en-us/iaas/Content/API/Concepts/cliconcepts.htm for more information about oci cli.

Prerequisites:

- OCI CLI installed (https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/climanualinst.htm)

- jq installed

- dynamic group with a policy attacched

- the policy must have this statement: allow dynamic-group GROUP_NAME to use virtual-network-family in compartment id COMPARTMENT_ID

- a reserved secondary private IP address for Compute Instances high availability

This resource agent may be configured for native migration if available in the cluster manager. For Pacemaker, the allow-migrate="true" meta attribute enables native migration.

## SUPPORTED PARAMETERS
ocicli

OCI Command line interface (CLI) tools (optional, string, default "/usr/local/bin/oci")

secondary_private_ip

reserved secondary private ip for compute instance (unique, required, string, no default)

cidr_netmask

netmask for the secondary_private_ip (optional, integer, default 24)

interface_alias

numeric alias for the interface (optional, integer, default 0)

api_delay

a short delay between API calls, to avoid sending API too quick (optional, integer, default 3)

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

start

Starts the resource. Suggested minimum timeout: 30s.

stop

Stops the resource. Suggested minimum timeout: 30s.

monitor

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

migrate_to

Executes steps necessary for migrating the resource to the node. Suggested minimum timeout: 30s.

migrate_from

Executes steps necessary for migrating the resource away from the node. Suggested minimum timeout: 30s.

meta-data

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

validate

Suggested minimum timeout: 10s.

validate-all

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

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

```
primitive p_ocivip ocf:heartbeat:ocivip \

  params \

    secondary_private_ip=string \

  meta allow-migrate="true" \

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

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

```
pcs resource create p_ocivip ocf:heartbeat:ocivip \

  secondary_private_ip=string \

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

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

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


summary: Attach a cinder volume

text:
# ocf_heartbeat_openstack-cinder-volume(7)

## NAME
ocf_heartbeat_openstack-cinder-volume - Attach a cinder volume

## SYNOPSIS
openstack-cinder-volume [start | stop | monitor | meta-data | validate-all]

## DESCRIPTION
Resource Agent to attach a cinder volume to an instance. It relies on attributes given by openstack-info resource agent (openstack_id attribute).

## SUPPORTED PARAMETERS
cloud

Openstack cloud (from ~/.config/openstack/clouds.yaml or /etc/openstack/clouds.yaml). (optional, string, no default)

openrc

Openstack credentials as openrc file from api_access/openrc. (optional, string, no default)

auth_url

Keystone Auth URL (optional, string, no default)

username

Username. (optional, string, no default)

password

Password. (optional, string, no default)

project_name

Keystone Project. (optional, string, no default)

user_domain_name

Keystone User Domain Name. (optional, string, default "Default")

project_domain_name

Keystone Project Domain Name. (optional, string, default "Default")

openstackcli

Path to command line tools for openstack. (optional, string, default "/usr/bin/openstack")

insecure

Allow insecure connections (optional, boolean, default false)

volume_local_check

This option allows the cluster to monitor the cinder volume presence without calling the API. (optional, boolean, default true)

volume_id

Cinder volume identifier to use to attach the block storage. (required, string, no default)

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

start

Starts the resource. Suggested minimum timeout: 180s.

stop

Stops the resource. Suggested minimum timeout: 180s.

monitor

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

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

```
primitive p_openstack-cinder-volume ocf:heartbeat:openstack-cinder-volume \

  params \

    volume_id=string \

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

## EXAMPLE PCS
The following is an example configuration for a openstack-cinder-volume resource using pcs(8)

```
pcs resource create p_openstack-cinder-volume ocf:heartbeat:openstack-cinder-volume \

  volume_id=string \

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

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

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


title: ocf_heartbeat_openstack-floating-ip(7)

summary: Move a floating IP

text:
# ocf_heartbeat_openstack-floating-ip(7)

## NAME
ocf_heartbeat_openstack-floating-ip - Move a floating IP

## SYNOPSIS
openstack-floating-ip [start | stop | monitor | meta-data | validate-all]

## DESCRIPTION
Resource Agent to move a floating IP address from an instance to another one. It relies on attributes given by openstack-info resource agent (openstack_ports, openstack_id attributes). The attribute called "openstack_floating_ip" is updated.

## SUPPORTED PARAMETERS
cloud

Openstack cloud (from ~/.config/openstack/clouds.yaml or /etc/openstack/clouds.yaml). (optional, string, no default)

openrc

Openstack credentials as openrc file from api_access/openrc. (optional, string, no default)

auth_url

Keystone Auth URL (optional, string, no default)

username

Username. (optional, string, no default)

password

Password. (optional, string, no default)

project_name

Keystone Project. (optional, string, no default)

user_domain_name

Keystone User Domain Name. (optional, string, default "Default")

project_domain_name

Keystone Project Domain Name. (optional, string, default "Default")

openstackcli

Path to command line tools for openstack. (optional, string, default "/usr/bin/openstack")

insecure

Allow insecure connections (optional, boolean, default false)

ip_id

Floating IP Identifier. (required, string, no default)

subnet_id

Subnet Identifier to use to attach the address. (required, string, no default)

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

start

Starts the resource. Suggested minimum timeout: 180s.

stop

Stops the resource. Suggested minimum timeout: 180s.

monitor

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

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

```
primitive p_openstack-floating-ip ocf:heartbeat:openstack-floating-ip \

  params \

    ip_id=string \

    subnet_id=string \

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

## EXAMPLE PCS
The following is an example configuration for a openstack-floating-ip resource using pcs(8)

```
pcs resource create p_openstack-floating-ip ocf:heartbeat:openstack-floating-ip \

  ip_id=string \

  subnet_id=string \

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

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

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


title: ocf_heartbeat_openstack-info(7)

text:
# ocf_heartbeat_openstack-info(7)

## NAME
ocf_heartbeat_openstack-info - Records various node attributes in the CIB

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

## DESCRIPTION
OCF resource agent to set attributes from Openstack instance details. It records (in the CIB) various attributes of a node. Sample output: openstack_az : nova openstack_flavor : c1.small openstack_id : 60ac4343-5828-49b1-8aac-7c69b1417f31 openstack_ports : 7960d889-9750-4160-bf41-c69a41ad72d9:96530d18-57a3-4718-af32-30f2a74c22a2,b0e55a06-bd75-468d-8baa-22cfeb65799f:a55ae917-8016-4b1e-8ffa-04311b9dc7d6

The layout of openstack_ports is a comma-separated list of tuples "subnet_id:port_id".

## SUPPORTED PARAMETERS
cloud

Openstack cloud (from ~/.config/openstack/clouds.yaml or /etc/openstack/clouds.yaml). (optional, string, no default)

openrc

Openstack credentials as openrc file from api_access/openrc. (optional, string, no default)

auth_url

Keystone Auth URL (optional, string, no default)

username

Username. (optional, string, no default)

password

Password. (optional, string, no default)

project_name

Keystone Project. (optional, string, no default)

user_domain_name

Keystone User Domain Name. (optional, string, default "Default")

project_domain_name

Keystone Project Domain Name. (optional, string, default "Default")

openstackcli

Path to command line tools for openstack. (optional, string, default "/usr/bin/openstack")

insecure

Allow insecure connections (optional, boolean, default false)

pidfile

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

delay

Interval to allow values to stabilize (optional, string, default "0")

curlcli

Path to command line cURL binary. (optional, string, default "/usr/bin/curl")

pythoncli

Path to command line Python interpreter. (optional, string, default "/usr/bin/python3")

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

start

Starts the resource. Suggested minimum timeout: 180s.

stop

Stops the resource. Suggested minimum timeout: 180s.

monitor

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

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

```
primitive p_openstack-info ocf:heartbeat:openstack-info \

  op monitor timeout="180s" interval="60s"
```

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

```
pcs resource create p_openstack-info ocf:heartbeat:openstack-info \

  op monitor timeout="180s" interval="60s"
```

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

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


title: ocf_heartbeat_openstack-virtual-ip(7)

summary: Move a virtual IP

text:
# ocf_heartbeat_openstack-virtual-ip(7)

## NAME
ocf_heartbeat_openstack-virtual-ip - Move a virtual IP

## SYNOPSIS
openstack-virtual-ip [start | stop | monitor | meta-data | validate-all]

## DESCRIPTION
Resource Agent to move a virtual IP address from an instance to another one by adding an allowed-address pair associated with an instance port. It relies on attributes given by openstack-info resource agent (openstack_ports, openstack_id attributes). The attribute called "openstack_virtual_ip" is updated.

## SUPPORTED PARAMETERS
cloud

Openstack cloud (from ~/.config/openstack/clouds.yaml or /etc/openstack/clouds.yaml). (optional, string, no default)

openrc

Openstack credentials as openrc file from api_access/openrc. (optional, string, no default)

auth_url

Keystone Auth URL (optional, string, no default)

username

Username. (optional, string, no default)

password

Password. (optional, string, no default)

project_name

Keystone Project. (optional, string, no default)

user_domain_name

Keystone User Domain Name. (optional, string, default "Default")

project_domain_name

Keystone Project Domain Name. (optional, string, default "Default")

openstackcli

Path to command line tools for openstack. (optional, string, default "/usr/bin/openstack")

insecure

Allow insecure connections (optional, boolean, default false)

ip

Virtual IP Address. (required, string, no default)

subnet_id

Subnet Identifier to use to attach the address. (required, string, no default)

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

start

Starts the resource. Suggested minimum timeout: 180s.

stop

Stops the resource. Suggested minimum timeout: 180s.

monitor

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

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

```
primitive p_openstack-virtual-ip ocf:heartbeat:openstack-virtual-ip \

  params \

    ip=string \

    subnet_id=string \

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

## EXAMPLE PCS
The following is an example configuration for a openstack-virtual-ip resource using pcs(8)

```
pcs resource create p_openstack-virtual-ip ocf:heartbeat:openstack-virtual-ip \

  ip=string \

  subnet_id=string \

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

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

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


title: ocf_heartbeat_oraasm(7)

summary: Oracle ASM resource agent

text:
# ocf_heartbeat_oraasm(7)

## NAME
ocf_heartbeat_oraasm - Oracle ASM resource agent

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

## DESCRIPTION
OCF Resource script for Oracle ASM. It uses the ohasd init-script to manage a Oracle ASM Disk Group as a HA resource.

## SUPPORTED PARAMETERS
user

Oracle Grid user (optional, string, default "grid")

diskgroup

The name of the Oracle Disk Group. If not specified, then the Disk Group along with its home should be listed in /etc/oratab. (required, string, no default)

home

The Oracle Grid home directory (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: 60s.

status

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

monitor

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

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

```
primitive p_oraasm ocf:heartbeat:oraasm \

  params \

    diskgroup=string \

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

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

```
pcs resource create p_oraasm ocf:heartbeat:oraasm \

  diskgroup=string \

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

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

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


title: ocf_heartbeat_oracle(7)

summary: Manages an Oracle Database instance

text:
# ocf_heartbeat_oracle(7)

## NAME
ocf_heartbeat_oracle - Manages an Oracle Database instance

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

## DESCRIPTION
Resource script for oracle. Manages an Oracle Database instance as an HA resource.

## SUPPORTED PARAMETERS
sid

The Oracle SID (aka ORACLE_SID). (unique, required, string, no default)

home

The Oracle home directory (aka ORACLE_HOME). If not specified, then the SID along with its home should be listed in /etc/oratab. (optional, string, no default)

user

The Oracle owner (aka ORACLE_OWNER). If not specified, then it is set to the owner of file $ORACLE_HOME/dbs/*${ORACLE_SID}.ora. If this does not work for you, just set it explicitely. (optional, string, no default)

monuser

Monitoring user name. Every connection as sysdba is logged in an audit log. This can result in a large number of new files created. A new user is created (if it doesn't exist) in the start action and subsequently used in monitor. It should have very limited rights. Make sure that the password for this user does not expire. (optional, string, default "OCFMON")

monpassword

Password for the monitoring user. Make sure that the password for this user does not expire. Set to avoid using the agents default password for "monuser". (optional, string, default "OCFMON")

monprofile

Profile used by the monitoring user. If the profile does not exist, it will be created with a non-expiring password. (optional, string, default "OCFMONPROFILE")

ipcrm

Sometimes IPC objects (shared memory segments and semaphores) belonging to an Oracle instance might be left behind which prevents the instance from starting. It is not easy to figure out which shared segments belong to which instance, in particular when more instances are running as same user. What we use here is the "oradebug" feature and its "ipc" trace utility. It is not optimal to parse the debugging information, but I am not aware of any other way to find out about the IPC information. In case the format or wording of the trace report changes, parsing might fail. There are some precautions, however, to prevent stepping on other peoples toes. There is also a dumpinstipc option which will make us print the IPC objects which belong to the instance. Use it to see if we parse the trace file correctly.

Three settings are possible:

- none: don't mess with IPC and hope for the best (beware: you'll probably be out of luck, sooner or later)

- instance: try to figure out the IPC stuff which belongs to the instance and remove only those (default; should be safe)

- orauser: remove all IPC belonging to the user which runs the instance (don't use this if you run more than one instance as same user or if other apps running as this user use IPC)

The default setting "instance" should be safe to use, but in that case we cannot guarantee that the instance will start. In case IPC objects were already left around, because, for instance, someone mercilessly killing Oracle processes, there is no way any more to find out which IPC objects should be removed. In that case, human intervention is necessary, and probably _all_ instances running as same user will have to be stopped. The third setting, "orauser", guarantees IPC objects removal, but it does that based only on IPC objects ownership, so you should use that only if every instance runs as separate user.

Please report any problems. Suggestions/fixes welcome.

(optional, string, default "instance")

clear_backupmode

The clear of the backup mode of ORACLE. (optional, boolean, default false)

shutdown_method

How to stop Oracle is a matter of taste it seems. The default method ("checkpoint/abort") is: alter system checkpoint; shutdown abort;

This should be the fastest safe way bring the instance down. If you find "shutdown abort" distasteful, set this attribute to "immediate" in which case we will

shutdown immediate;

If you still think that there's even better way to shutdown an Oracle instance we are willing to listen.

(optional, string, default "checkpoint/abort")

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

monitor

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

validate-all

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

methods

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

```
primitive p_oracle ocf:heartbeat:oracle \

  params \

    sid=string \

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

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

```
pcs resource create p_oracle ocf:heartbeat:oracle \

  sid=string \

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

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

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


title: ocf_heartbeat_oralsnr(7)

summary: Manages an Oracle TNS listener

text:
# ocf_heartbeat_oralsnr(7)

## NAME
ocf_heartbeat_oralsnr - Manages an Oracle TNS listener

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

## DESCRIPTION
Resource script for Oracle Listener. It manages an Oracle Listener instance as an HA resource.

## SUPPORTED PARAMETERS
sid

The Oracle SID (aka ORACLE_SID). Necessary for the monitor op, i.e. to do tnsping SID. (unique, required, string, no default)

home

The Oracle home directory (aka ORACLE_HOME). If not specified, then the SID should be listed in /etc/oratab. (optional, string, no default)

user

Run the listener as this user. (optional, string, no default)

listener

Listener instance to be started (as defined in listener.ora). Defaults to LISTENER. (unique, optional, string, default "LISTENER")

tns_admin

Full path to the directory that contains the Oracle listener tnsnames.ora configuration file. The shell variable TNS_ADMIN is set to the value provided. (optional, string, no default)

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

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.

methods

Suggested minimum timeout: 5s.

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

```
primitive p_oralsnr ocf:heartbeat:oralsnr \

  params \

    sid=string \

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

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

```
pcs resource create p_oralsnr ocf:heartbeat:oralsnr \

  sid=string \

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

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

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


title: ocf_heartbeat_osceip(7)

text:
# ocf_heartbeat_osceip(7)

## NAME
ocf_heartbeat_osceip - Outscale Elastic IP Address Resource Agent

## SYNOPSIS
osceip [start | stop | monitor | migrate_to | migrate_from | meta-data | validate-all]

## DESCRIPTION
Resource Agent for Outscale Elastic IP Addresses.

It manages Outscale Elastic IP Addresses with osc-cli.

Credentials needs to be setup.

See https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html for more information about osccli.

This resource agent may be configured for native migration if available in the cluster manager. For Pacemaker, the allow-migrate="true" meta attribute enables native migration.

## SUPPORTED PARAMETERS
osccli

command line tools for outscale services (optional, string, default "/usr/local/bin/osc-cli")

profile

Valid OSC-CLI profile name (see ~/.osc/config and 'osc configure') (optional, string, default "default")

elastic_ip

reserved elastic ip for vm instance (unique, required, string, no default)

region

Region for osc resource (required for role-based authentication) (optional, string, no default)

curl_retries

curl retries before failing (optional, integer, default 3)

curl_sleep

curl sleep between tries (optional, integer, default 1)

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

start

Starts the resource. Suggested minimum timeout: 30s.

stop

Stops the resource. Suggested minimum timeout: 30s.

monitor

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

migrate_to

Executes steps necessary for migrating the resource to the node. Suggested minimum timeout: 30s.

migrate_from

Executes steps necessary for migrating the resource away from the node. Suggested minimum timeout: 30s.

meta-data

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

validate

Suggested minimum timeout: 10s.

validate-all

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

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

```
primitive p_osceip ocf:heartbeat:osceip \

  params \

    elastic_ip=string \

  meta allow-migrate="true" \

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

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

```
pcs resource create p_osceip ocf:heartbeat:osceip \

  elastic_ip=string \

  op monitor timeout="30s" interval="20s" 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_ovsmonitor(7)

summary: Monitors ovs bonding bonds

text:
# ocf_heartbeat_ovsmonitor(7)

## NAME
ocf_heartbeat_ovsmonitor - Monitors ovs bonding bonds

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

## DESCRIPTION
Monitor the vitality of a local ovs bond.

You may set up this RA as a clone resource to monitor the network bonds on different nodes, with the same bond name. This is not related to the IP address or the network on which a bond is configured. You may use this RA to move resources away from a node, which has a faulty bond or prevent moving resources to such a node. This gives you independent control of the resources, without involving cluster intercommunication. But it requires your nodes to have more than one network bond.

The resource configuration requires a monitor operation, because the monitor does the main part of the work. In addition to the resource configuration, you need to configure some location constraints, based on a CIB attribute value. The name of the attribute value is configured in the 'name' option of this RA.

Example constraint configuration using crmsh location loc_connected_node my_resource_grp rule ="rule_loc_connected_node" -INF: ovsmonitor-bond-public eq 0

Example constraint configuration using pcs. Only allow 'my_resource' to run on nodes where eth0 ethernet device is available. pcs constraint location my_resource rule score=-INFINITY ovsmonitor-bond-public ne 1

The ethmonitor works in 3 different modes to test the bond vitality. 1. call ovs-appctl to see if at least one of the bonding's link status is up (if link is down -> error) 2. call ovs-ofctl and watch the RX counter (if packages come around in a certain time -> success) 3. return error

## SUPPORTED PARAMETERS
bond

The name of the network bond which should be monitored (e.g. bond-public). (unique, required, string, no default)

bridge

The name of the ovs bridge that contains the bridge. (unique, required, string, no default)

name

The name of the CIB attribute to set. This is the name to be used in the constraints. Defaults to "ovsmonitor-'bond_name'". (unique, optional, string, no default)

multiplier

Multiplier for the value of the CIB attriobute specified in parameter name. (optional, integer, default 1)

repeat_count

Specify how often the bond will be monitored, before the status is set to failed. You need to set the timeout of the monitoring operation to at least repeat_count * repeat_interval (optional, integer, default 5)

repeat_interval

Specify how long to wait in seconds between the repeat_counts. (optional, integer, default 10)

pktcnt_timeout

Timeout for the RX packet counter. Stop listening for packet counter changes after the given number of seconds. (optional, integer, default 5)

link_status_only

Only report success based on link status. Do not perform RX counter related connectivity tests. (optional, boolean, default false)

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

monitor

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

```
primitive p_ovsmonitor ocf:heartbeat:ovsmonitor \

  params \

    bond=string \

    bridge=string \

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

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

```
pcs resource create p_ovsmonitor ocf:heartbeat:ovsmonitor \

  bond=string \

  bridge=string \

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

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

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


title: ocf_heartbeat_pgagent(7)

summary: Controls pgagent

text:
# ocf_heartbeat_pgagent(7)

## NAME
ocf_heartbeat_pgagent - Controls pgagent

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

## DESCRIPTION
This is a pgagent Resource Agent.

## SUPPORTED PARAMETERS
connection_string

Connection string for pgagent. (optional, string, default "user=postgres host=/var/run/postgresql")

user

User to run pgagent as. (optional, string, default "postgres")

options

Options for pgagent. (optional, string, default "-r 1 -t 1")

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

start

Starts the resource. Suggested minimum timeout: 5s.

stop

Stops the resource. Suggested minimum timeout: 5s.

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

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

```
primitive p_pgagent ocf:heartbeat:pgagent \

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

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

```
pcs resource create p_pgagent ocf:heartbeat:pgagent \

  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)