title: ocf_heartbeat_dnsupdate(7)

summary: IP take\-over via dynamic DNS update

text:
# ocf_heartbeat_dnsupdate(7)

## NAME
ocf_heartbeat_dnsupdate - IP take-over via dynamic DNS update

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

## DESCRIPTION
This resource agent manages IP take-over via dynamic DNS updates.

## SUPPORTED PARAMETERS
hostname

The hostname whose IP address will need to be updated. (unique, required, string, no default)

ip

IP address to set. (required, string, no default)

ttl

Time to live, in seconds, for the DNS record. This affects how soon DNS updates propagate. It should be a reasonable compromise between update speed and DNS server load. If using booth, the ticket timeout is a good start.

(optional, integer, default 300)

keyfile

The file containing the shared secret needed to update the DNS record. Please see the nsupdate man page for the exact syntax. (optional, string, no default)

server

Which DNS server to send these updates for. When no server is provided, this defaults to the master server for the correct zone. (optional, string, no default)

serverport

Port number on the DNS server. Note: due to a limitation in the nsupdate command, this option will only take effect if you also specify the DNS server!

(optional, integer, default 53)

nsupdate_opts

Additional options to be passed to nsupdate. (optional, string, no default)

unregister_on_stop

Whether or not to actively remove records on stop. This is not needed for normal operation, since the site taking over the IP address will delete all previous records. (optional, boolean, default false)

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

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.

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

```
primitive p_dnsupdate ocf:heartbeat:dnsupdate \

  params \

    hostname=string \

    ip=string \

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

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

```
pcs resource create p_dnsupdate ocf:heartbeat:dnsupdate \

  hostname=string \

  ip=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)


package: resource-agents

title: ocf_heartbeat_docker(7)

summary: Docker container resource agent.

text:
# ocf_heartbeat_docker(7)

## NAME
ocf_heartbeat_docker - Docker container resource agent.

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

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

## SUPPORTED PARAMETERS
image

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

name

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

allow_pull

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

run_opts

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

(optional, string, no default)

run_cmd

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

mount_points

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

monitor_cmd

Specify the full path of a command to launch within the container to check the health of the container. This command must return 0 to indicate that the container is healthy. A non-zero return code will indicate that the container has failed and should be recovered. If 'docker exec' is supported, it is used to execute the command. If not, nsenter is used.

Note: Using this method for monitoring processes inside a container is not recommended, as containerd tries to track processes running inside the container and does not deal well with many short-lived processes being spawned. Ensure that your container monitors its own processes and terminates on fatal error rather than invoking a command from the outside.

(optional, string, no default)

force_kill

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

reuse

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

query_docker_health

Query the builtin healthcheck of docker (v1.12+) to determine health of the container. If left empty or set to false it will not be used. The healthcheck itself has to be configured within docker, e.g. via HEALTHCHECK in Dockerfile. This option just queries in what condition docker considers the container to be and lets ocf do its thing accordingly.

Note that the time a container is in "starting" state counts against the monitor timeout.

This is an additional check besides the standard check for the container to be running, and the optional monitor_cmd check. It doesn't disable or override them, so all of them (if used) have to come back healthy for the container to be considered healthy.

(optional, boolean, no default)

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

start

Starts the resource. Suggested minimum timeout: 90s.

stop

Stops the resource. Suggested minimum timeout: 90s.

monitor

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

meta-data

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

validate-all

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

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

```
primitive p_docker ocf:heartbeat:docker \

  params \

    image=string \

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

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

```
pcs resource create p_docker ocf:heartbeat:docker \

  image=string \

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

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

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


title: ocf_heartbeat_docker-compose(7)

summary: This script manages docker services using docker\-compose.

text:
# ocf_heartbeat_docker-compose(7)

## NAME
ocf_heartbeat_docker-compose - This script manages docker services using docker-compose.

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

## DESCRIPTION
Manages docker services using docker-compose as an OCF resource in an High Availability setup. It relies on a well-tested docker compose YAML file which distributed on an identical location on all cluster nodes.

Caveat: 1. A YAML file (docker-compose.yml) and an optional Dockerfile must be provided in a working directory. 2. It is suggested to test run the docker-compose and verify on all cluster nodes before enabling this agent.

## SUPPORTED PARAMETERS
binpath

The docker-composer binary path. For example, "/usr/bin/docker-compose" (optional, string, default "/usr/bin/docker-compose")

dirpath

The directory contains docker compose yaml file. For example, "/data/docker" (required, string, no default)

ymlfile

The docker-compose yaml file. For example, "docker-compose.yml" (optional, string, default "docker-compose.yml")

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

start

Starts the resource. Suggested minimum timeout: 240s.

stop

Stops the resource. Suggested minimum timeout: 20s.

monitor

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

```
primitive p_docker-compose ocf:heartbeat:docker-compose \

  params \

    dirpath=string \

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

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

```
pcs resource create p_docker-compose ocf:heartbeat:docker-compose \

  dirpath=string \

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

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

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


title: ocf_heartbeat_dovecot(7)

text:
# ocf_heartbeat_dovecot(7)

## NAME
ocf_heartbeat_dovecot - Manages a highly available Dovecot IMAP/POP3 server instance

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

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

## SUPPORTED PARAMETERS
binary

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

config_file

Full path to a Dovecot configuration file. For example, "/etc/dovecot/dovecot.conf". (unique, optional, string, no default)

pid_file

Full path to a Dovecot PID file. For example, "/var/run/dovecot/master.pid". (unique, optional, string, default "/var/run/dovecot/master.pid")

parameters

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

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

start

Starts the resource. Suggested minimum timeout: 20s.

stop

Stops the resource. Suggested minimum timeout: 20s.

reload

Suggested minimum timeout: 20s.

monitor

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

validate-all

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

meta-data

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

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

```
primitive p_dovecot ocf:heartbeat:dovecot \

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

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

```
pcs resource create p_dovecot ocf:heartbeat:dovecot \

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

summary: Example stateless resource agent

text:
# ocf_heartbeat_dummypy(7)

## NAME
ocf_heartbeat_dummypy - Example stateless resource agent

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

## DESCRIPTION
This is a Dummy Resource Agent. It does absolutely nothing except keep track of whether its running or not. Its purpose in life is for testing and to serve as a template for RA writers.

NB: Please pay attention to the timeouts specified in the actions section below. They should be meaningful for the kind of resource the agent manages. They should be the minimum advised timeouts, but they shouldn't/cannot cover _all_ possible resource instances. So, try to be neither overly generous nor too stingy, but moderate. The minimum timeouts should never be below 10 seconds.

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
state

Location to store the resource state in. (unique, optional, string, no default)

fake

Fake attribute that can be changed to cause a reload (optional, string, no default)

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

start

Starts the resource. Suggested minimum timeout: 20s.

stop

Stops the resource. Suggested minimum timeout: 20s.

monitor

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

reload

Suggested minimum timeout: 20s.

migrate_to

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

migrate_from

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

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

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

```
primitive p_dummypy ocf:heartbeat:dummypy \

  meta allow-migrate="true" \

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

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

```
pcs resource create p_dummypy ocf:heartbeat:dummypy \

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

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

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


title: ocf_heartbeat_eDir88(7)

text:
# ocf_heartbeat_eDir88(7)

## NAME
ocf_heartbeat_eDir88 - Manages a Novell eDirectory directory server

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

## DESCRIPTION
Resource script for managing an eDirectory instance. Manages a single instance of eDirectory as an HA resource. The "multiple instances" feature or eDirectory has been added in version 8.8. This script will not work for any version of eDirectory prior to 8.8. This RA can be used to load multiple eDirectory instances on the same host.

It is very strongly recommended to put eDir configuration files (as per the eDir_config_file parameter) on local storage on each node. This is necessary for this RA to be able to handle situations where the shared storage has become unavailable. If the eDir configuration file is not available, this RA will fail, and heartbeat will be unable to manage the resource. Side effects include STONITH actions, unmanageable resources, etc...

Setting a high action timeout value is _very_ _strongly_ recommended. eDir with IDM can take in excess of 10 minutes to start. If heartbeat times out before eDir has had a chance to start properly, mayhem _WILL ENSUE_.

The LDAP module seems to be one of the very last to start. So this script will take even longer to start on installations with IDM and LDAP if the monitoring of IDM and/or LDAP is enabled, as the start command will wait for IDM and LDAP to be available.

## SUPPORTED PARAMETERS
eDir_config_file

Path to configuration file for eDirectory instance. (unique, optional, string, default "/etc/opt/novell/eDirectory/conf/nds.conf")

eDir_monitor_ldap

Should we monitor if LDAP is running for the eDirectory instance? (optional, boolean, default 0)

eDir_monitor_idm

Should we monitor if IDM is running for the eDirectory instance? (optional, boolean, default 0)

eDir_jvm_initial_heap

Value for the DHOST_INITIAL_HEAP java environment variable. If unset, java defaults will be used. (optional, integer, no default)

eDir_jvm_max_heap

Value for the DHOST_MAX_HEAP java environment variable. If unset, java defaults will be used. (optional, integer, no default)

eDir_jvm_options

Value for the DHOST_OPTIONS java environment variable. If unset, original values will be used. (optional, string, no default)

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

start

Starts the resource. Suggested minimum timeout: 600s.

stop

Stops the resource. Suggested minimum timeout: 600s.

monitor

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

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

```
primitive p_eDir88 ocf:heartbeat:eDir88 \

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

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

```
pcs resource create p_eDir88 ocf:heartbeat:eDir88 \

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

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

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


title: ocf_heartbeat_ethmonitor(7)

summary: Monitors network interfaces

text:
# ocf_heartbeat_ethmonitor(7)

## NAME
ocf_heartbeat_ethmonitor - Monitors network interfaces

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

## DESCRIPTION
Monitor the vitality of a local network interface.

You may set up this RA as a clone resource to monitor the network interfaces on different nodes, with the same interface name. This is not related to the IP address or the network on which a interface is configured. You may use this RA to move resources away from a node, which has a faulty interface 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 interface.

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: ethmonitor 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 ethmonitor-eth0 ne 1

The ethmonitor works in 3 different modes to test the interface vitality. 1. call ip to see if the link status is up (if link is down -> error) 2. call ip and watch the RX counter (if packages come around in a certain time -> success) 3. call arping to check whether any of the IPs found in the local ARP cache answers an ARP REQUEST (one answer -> success) 4. return error

## SUPPORTED PARAMETERS
interface

The name of the network interface which should be monitored (e.g. eth0). (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 "ethmonitor-'interface_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 interface 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)

arping_count

Number of ARP REQUEST packets to send for every IP. Usually one ARP REQUEST (arping) is send (optional, integer, default 1)

arping_timeout

Time in seconds to wait for ARP REQUESTs (all packets of arping_count). This is to limit the time for arp requests, to be able to send requests to more than one node, without running in the monitor operation timeout. (optional, integer, default 1)

arping_cache_entries

Maximum number of IPs from ARP cache list to check for ARP REQUEST (arping) answers. Newest entries are tried first. (optional, integer, default 5)

infiniband_device

For interfaces that are infiniband devices. (optional, string, no default)

infiniband_port

For infiniband devices, this is the port to monitor. (optional, integer, no default)

link_status_only

Only report success based on link status. Do not perform RX counter or arping 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 ethmonitor resource using the crm(8) shell:

```
primitive p_ethmonitor ocf:heartbeat:ethmonitor \

  params \

    interface=string \

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

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

```
pcs resource create p_ethmonitor ocf:heartbeat:ethmonitor \

  interface=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_galera(7)

summary: Manages a galera instance

text:
# ocf_heartbeat_galera(7)

## NAME
ocf_heartbeat_galera - Manages a galera instance

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

## DESCRIPTION
Resource script for managing galera database.

## SUPPORTED PARAMETERS
binary

Location of the MySQL server binary (optional, string, no default)

client_binary

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

config

Configuration file (optional, string, no default)

datadir

Directory containing databases (optional, string, no default)

user

User running MySQL daemon (optional, string, no default)

group

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

log

The logfile to be used for mysqld. (optional, string, no default)

pid

The pidfile to be used for mysqld. (optional, string, no default)

socket

The socket to be used for mysqld. (optional, string, no default)

enable_creation

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

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)

wsrep_cluster_address

The galera cluster address. This takes the form of: gcomm://node,node,node Only nodes present in this node list will be allowed to start a galera instance. The galera node names listed in this address are expected to match valid pacemaker node names. If both names need to differ, you must provide a mapping in option cluster_host_map.

(required, string, no default)

cluster_host_map

A mapping of pacemaker node names to galera node names. To be used when both pacemaker and galera names need to differ, (e.g. when galera names map to IP from a specific network interface) This takes the form of: pcmk1:node.1.galera;pcmk2:node.2.galera;pcmk3:node.3.galera

where the galera resource started on node pcmk1 would be named node.1.galera in the wsrep_cluster_address

(optional, string, no default)

check_user

Cluster check user. (optional, string, no default)

check_passwd

Cluster check user password. Empty passwords are ignored unless the parameter "check_passwd_use_empty" is set to 1. (optional, string, no default)

check_passwd_use_empty

Use an empty "check_passwd" password. If this parameter is set to 1, "check_passwd" will be ignored and an empty password is used when calling the "mysql" client binary. (optional, boolean, default 0)

two_node_mode

If running in a 2-node pacemaker cluster, rely on pacemaker quorum to allow automatic recovery even when the other node is unreachable. Use it with caution! (and fencing) (optional, boolean, default false)

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

start

Starts the resource. Suggested minimum timeout: 120s.

stop

Stops the resource. Suggested minimum timeout: 120s.

status

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

monitor

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

monitor (Master role)

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

monitor (Slave role)

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

promote

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

demote

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

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

```
primitive p_galera ocf:heartbeat:galera \

  params \

    wsrep_cluster_address=string \

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

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

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

```
ms ms_galera p_galera \

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

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

```
pcs resource create p_galera ocf:heartbeat:galera \

  wsrep_cluster_address=string \

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

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

  op monitor role="Slave" 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_garbd(7)

summary: Manages a galera arbitrator instance

text:
# ocf_heartbeat_garbd(7)

## NAME
ocf_heartbeat_garbd - Manages a galera arbitrator instance

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

## DESCRIPTION
Resource script for managing Galera arbitrator.

## SUPPORTED PARAMETERS
binary

Location of the Galera arbitrator binary (optional, string, default "/usr/sbin/garbd")

user

User running the garbd process (optional, string, default "mysql")

group

Group running garbd (for logfile permissions) (optional, string, default "mysql")

log

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

pid

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

options

Additional parameters which are passed to garbd on startup. (optional, string, no default)

wsrep_cluster_address

The galera cluster address. This takes the form of: gcomm://node:port,node:port,node:port Unlike Galera servers, port is mandatory for garbd.

(required, string, no default)

wsrep_cluster_name

The group name of the Galera cluster to connect to. (required, string, no default)

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

start

Starts the resource. Suggested minimum timeout: 20s.

stop

Stops the resource. Suggested minimum timeout: 20s.

monitor

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

validate-all

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

meta-data

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

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

```
primitive p_garbd ocf:heartbeat:garbd \

  params \

    wsrep_cluster_address=string \

    wsrep_cluster_name=string \

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

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

```
pcs resource create p_garbd ocf:heartbeat:garbd \

  wsrep_cluster_address=string \

  wsrep_cluster_name=string \

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

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

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


title: ocf_heartbeat_gcp-ilb(7)

text:
# ocf_heartbeat_gcp-ilb(7)

## NAME
ocf_heartbeat_gcp-ilb - Replies to health checks from Google Cloud

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

## DESCRIPTION
Resource Agent that wraps /usr/bin/nc or /usr/bin/socat to reply to health checks in Google Cloud. See https://cloud.google.com/load-balancing/docs/health-checks for more information.

## SUPPORTED PARAMETERS
port

Listening port for health-check probes. Default: 60000 (optional, string, default "60000")

cat

Location of netcat (default: /usr/bin/nc ) or socat (default: /usr/bin/socat ). If present, is used /usr/bin/socat. The recommended binary is socat, present in the following minimum versions if the package resource-agents: - SLES 12 SP4/SP5: resource-agents-4.3.018.a7fb5035-3.30.1. - SLES 15/15 SP1: resource-agents-4.3.0184.6ee15eb2-4.13.1. (optional, string, default "nc")

log_enable

Logging with an external application is enabled (accepts "true" or "false"). The defaults are configured to call "gcloud logging" (see: https://cloud.google.com/sdk/gcloud/reference/logging). (optional, string, default "false")

log_cmd

External logging command. The defaults are configured to call "gcloud logging" (see: https://cloud.google.com/sdk/gcloud/reference/logging). This parameter should only have the binary that can be validated (e.g., gcloud). The rest of the command is formed with the additional parameters and the message being logged as follows: - log_cmd + log_params + "The message being logged" + log_end_params Using the gcloud command for Stackdriver logging, the parameters would be: - log_cmd = gcloud - log_params = logging write GCPILB - "This is a message being sent by the app" - log_end_params = (nothing in this case, this is reserved for use with other tools) Which would result in this valid command (where GCPILB is the name of the log): gcloud logging write GCPILB "This is a message being sent by the app" NOTE: Only the binary is validated for existence and no further checks are performed. The assumption is that only administrators with root access can configure this tool.

(optional, string, default "gcloud")

log_params

Additional input for the logging application. See explanation for log_cmd (optional, string, default "logging write GCPILB")

log_end_params

Additional input for the logging application. Placed after the message being logged. (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: 30s.

monitor

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

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

```
primitive p_gcp-ilb ocf:heartbeat:gcp-ilb \

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

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

```
pcs resource create p_gcp-ilb ocf:heartbeat:gcp-ilb \

  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_gcp-pd-move(7)

text:
# ocf_heartbeat_gcp-pd-move(7)

## NAME
ocf_heartbeat_gcp-pd-move - Attach/Detach a persistent disk on current GCP instance

## SYNOPSIS
gcp-pd-move [start | stop | monitor | meta-data]

## DESCRIPTION
Resource Agent that can attach or detach a regional/zonal disk on current GCP instance. Requirements :

- Disk has to be properly created as regional/zonal in order to be used correctly.

## SUPPORTED PARAMETERS
disk_name

The name of the GCP disk. (unique, required, string, no default)

disk_scope

Disk scope (optional, string, default "detect")

disk_csek_file

Path to a Customer-Supplied Encryption Key (CSEK) key file (optional, string, no default)

mode

Attachment mode (READ_WRITE, READ_ONLY) (optional, string, default "READ_WRITE")

device_name

An optional name that indicates the disk name the guest operating system will see. (optional, boolean, default false)

stackdriver_logging

Use stackdriver_logging output to global resource (yes, true, enabled) (optional, string, default "no")

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

start

Starts the resource. Suggested minimum timeout: 300s.

stop

Stops the resource. Suggested minimum timeout: 15s.

monitor

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

meta-data

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

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

```
primitive p_gcp-pd-move ocf:heartbeat:gcp-pd-move \

  params \

    disk_name=string \

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

## EXAMPLE PCS
The following is an example configuration for a gcp-pd-move resource using pcs(8)

```
pcs resource create p_gcp-pd-move ocf:heartbeat:gcp-pd-move \

  disk_name=string \

  op monitor timeout="15s" 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_gcp-vpc-move-ip(7)

summary: Move IP within a GCP VPC

text:
# ocf_heartbeat_gcp-vpc-move-ip(7)

## NAME
ocf_heartbeat_gcp-vpc-move-ip - Move IP within a GCP VPC

## SYNOPSIS
gcp-vpc-move-ip [start | stop | monitor | meta-data | validate-all]

## DESCRIPTION
Resource Agent that can move a floating IP addresse within a GCP VPC by changing an entry in the routing table. This agent also configures the floating IP locally on the instance OS. Requirements :

- IP forwarding must be enabled on all instances in order to be able to terminate the route

- The floating IP address must be chosen so that it is outside all existing subnets in the VPC network

- IAM permissions (see https://cloud.google.com/compute/docs/access/iam-permissions) : 1) compute.routes.delete, compute.routes.get and compute.routes.update on the route 2) compute.networks.updatePolicy on the network (to add a new route) 3) compute.networks.get on the network (to check the VPC network existence) 4) compute.routes.list on the project (to check conflicting routes)

## SUPPORTED PARAMETERS
gcloud

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

configuration

Named configuration for gcloud (optional, string, default "default")

ip

Floating IP address. Note that this IP must be chosen outside of all existing subnet ranges (unique, required, string, no default)

vpc_network

Name of the VPC network (required, string, default "default")

interface

Name of the network interface (optional, string, default "eth0")

route_name

Route name (unique, optional, string, default "ra-gcp-vpc-move-ip")

## 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: 30s. 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 gcp-vpc-move-ip resource using the crm(8) shell:

```
primitive p_gcp-vpc-move-ip ocf:heartbeat:gcp-vpc-move-ip \

  params \

    ip=string \

    vpc_network="default" \

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

## EXAMPLE PCS
The following is an example configuration for a gcp-vpc-move-ip resource using pcs(8)

```
pcs resource create p_gcp-vpc-move-ip ocf:heartbeat:gcp-vpc-move-ip \

  ip=string \

  vpc_network="default" \

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

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

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


title: ocf_heartbeat_gcp-vpc-move-vip(7)

text:
# ocf_heartbeat_gcp-vpc-move-vip(7)

## NAME
ocf_heartbeat_gcp-vpc-move-vip - Floating IP Address or Range on Google Cloud Platform

## SYNOPSIS
gcp-vpc-move-vip [start | stop | monitor | meta-data | validate-all]

## DESCRIPTION
Floating IP Address or Range on Google Cloud Platform - Using Alias IP address functionality to attach a secondary IP range to a running instance

## SUPPORTED PARAMETERS
alias_ip

IP range to be added including CIDR netmask (e.g., 192.168.0.1/32) (unique, required, string, no default)

alias_range_name

Subnet name for the Alias IP (optional, string, no default)

hostlist

List of hosts in the cluster, separated by spaces (optional, string, no default)

project

Project ID of the instance. It can be useful to set this attribute if the instance is in a shared service project. Otherwise, the agent should be able to determine the project ID automatically. (optional, string, default "default")

serviceaccount

Path to Service account JSON file (optional, string, no default)

stackdriver_logging

If enabled (set to true), IP failover logs will be posted to stackdriver logging (optional, boolean, default false)

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

start

Starts the resource. Suggested minimum timeout: 300s.

stop

Stops the resource. Suggested minimum timeout: 15s.

monitor

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

meta-data

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

validate-all

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

## EXAMPLE CRM SHELL
The following is an example configuration for a gcp-vpc-move-vip resource using the crm(8) shell:

```
primitive p_gcp-vpc-move-vip ocf:heartbeat:gcp-vpc-move-vip \

  params \

    alias_ip=string \

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

## EXAMPLE PCS
The following is an example configuration for a gcp-vpc-move-vip resource using pcs(8)

```
pcs resource create p_gcp-vpc-move-vip ocf:heartbeat:gcp-vpc-move-vip \

  alias_ip=string \

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

text:
# ocf_heartbeat_ids(7)

## NAME
ocf_heartbeat_ids - Manages an Informix Dynamic Server (IDS) instance

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

## DESCRIPTION
OCF resource agent to manage an IBM Informix Dynamic Server (IDS) instance as an High-Availability resource.

## SUPPORTED PARAMETERS
informixdir

The value the environment variable INFORMIXDIR has after a typical installation of IDS. Or in other words: the path (without trailing '/') where IDS was installed to. If this parameter is unspecified the script will try to get the value from the shell environment. (optional, string, no default)

informixserver

The value the environment variable INFORMIXSERVER has after a typical installation of IDS. Or in other words: the name of the IDS server instance to manage. If this parameter is unspecified the script will try to get the value from the shell environment. (optional, string, no default)

onconfig

The value the environment variable ONCONFIG has after a typical installation of IDS. Or in other words: the name of the configuration file for the IDS instance specified in INFORMIXSERVER. The specified configuration file will be searched at '/etc/'. If this parameter is unspecified the script will try to get the value from the shell environment. (optional, string, no default)

dbname

This parameter defines which database to use in order to monitor the IDS instance. If this parameter is unspecified the script will use the 'sysmaster' database as a default. (optional, string, default "sysmaster")

sqltestquery

SQL test query to run on the database specified by the parameter 'dbname' in order to monitor the IDS instance and determine if it's functional or not. If this parameter is unspecified the script will use 'SELECT COUNT(*) FROM systables;' as a default. (optional, string, default "SELECT COUNT(*) FROM systables;")

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

usage

Suggested minimum timeout: 5s.

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

```
primitive p_ids ocf:heartbeat:ids \

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

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

```
pcs resource create p_ids ocf:heartbeat:ids \

  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_iface-bridge(7)

summary: Manages Bridge network interfaces.

text:
# ocf_heartbeat_iface-bridge(7)

## NAME
ocf_heartbeat_iface-bridge - Manages Bridge network interfaces.

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

## DESCRIPTION
This resource manages Bridge network interfaces. It can add, remove, configure bridges and spanning-tree.

## SUPPORTED PARAMETERS
bridge_name

Define the name of the bridge (max 15 charaters). (unique, required, string, no default)

bridge_slaves

Define the list of interfaces, space separated, to add to the bridge. The list can be empty. (unique, optional, string, no default)

bridge_ageing

Set the ethernet (MAC) address ageing time in seconds. (optional, integer, no default)

port_hairpin

Set hairpin forwarding mode. A list of ports that should have hairpin enabled can be specified using the following Example: eth0 eth1 (optional, string, no default)

stp

Enable or disable Spanning Tree Protocol on the bridge. (optional, boolean, default false)

stp_bridgeprio

Set the bridge's priority to defined value. The priority value is a number between 0 and 65535), and has no dimension. Lower priority values are preferred. The bridge with the lowest priority will be elected as root bridge. (optional, integer, no default)

stp_fd

Set the bridge forward delay (in seconds). (optional, integer, default 0)

stp_maxage

Set the bridge maximum message age (in seconds). (optional, integer, no default)

stp_hello

Set the bridge hello time (in seconds). (optional, integer, no default)

stp_pathcost

Set the port cost. This is a dimensionless metric. A list of port/cost can be specified using the following format: slave cost slave cost. Example: eth0 100 eth1 1000 (optional, string, no default)

stp_portprio

Set the port priority. This is a number between 0 and 63. brctl man page reports a value between 0 and 255, but tests show a limit of 63 on a live system. This metric is used in the designated port and root port selection algorithms. A list of port/priority can be specified using the following format: slave cost slave cost. Example: eth0 10 eth1 60 (optional, string, no default)

multicast_router

Enable or disable multicast routing on the bridge. (optional, boolean, default 1)

multicast_snooping

Enable or disable multicast snooping on the bridge. (optional, boolean, default 1)

multicast_port_router

Enable or disable a port from the multicast router. Kernel enables all port by default. A list of port can be specified using the following format: slave 0|1 slave 0|1. Example: eth0 1 eth1 0 (optional, string, no default)

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

status

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

monitor

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

meta-data

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

validate-all

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

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

```
primitive p_iface-bridge ocf:heartbeat:iface-bridge \

  params \

    bridge_name=string \

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

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

```
pcs resource create p_iface-bridge ocf:heartbeat:iface-bridge \

  bridge_name=string \

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

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

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


title: ocf_heartbeat_iface-vlan(7)

summary: Manages VLAN network interfaces.

text:
# ocf_heartbeat_iface-vlan(7)

## NAME
ocf_heartbeat_iface-vlan - Manages VLAN network interfaces.

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

## DESCRIPTION
This resource manages VLAN network interfaces. It can add, remove, configure VLANs.

## SUPPORTED PARAMETERS
vlan_interface

Define the interface where VLAN should be attached. (required, string, no default)

vlan_id

Define the VLAN ID. It has to be a value between 0 and 4094. (required, integer, no default)

vlan_name

Define the name of the VLAN interface (max 15 charaters). (unique, optional, string, default ".")

vlan_reorder_hdr

Enable or disable header reordering. (optional, boolean, default 1)

vlan_gvrp

Enable or disable GARP VLAN registration protocol. (optional, boolean, default 0)

vlan_mvrp

Enable or disable Multiple VLAN Registration Protocol. Please note that most distributions do not ship a version of iproute2 that supports mvrp yet, even if the kernel has support for it. Check output of link add type vlan --help in the FLAG section to verify if mvrp support is available. (optional, boolean, default 0)

vlan_loose_binding

Enable or disable VLAN loose bind. By default the VLAN interface admin status (UP/DOWN) follows the underneath interface status. Enabling loose bind allows the VLAN to disconnect from the interface status. Be very careful that enabling loose binding could invalidate this agent monitor operations. Please note that most distributions do not ship a version of iproute2 that supports loose_binding yet, even if the kernel has support for it. Check output of link add type vlan --help in the FLAG section to verify if loose_binding support is available. (optional, boolean, default 0)

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

status

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

monitor

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

meta-data

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

validate-all

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

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

```
primitive p_iface-vlan ocf:heartbeat:iface-vlan \

  params \

    vlan_interface=string \

    vlan_id=integer \

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

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

```
pcs resource create p_iface-vlan ocf:heartbeat:iface-vlan \

  vlan_interface=string \

  vlan_id=integer \

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

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

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


title: ocf_heartbeat_ipsec(7)

summary: Handles IPSEC tunnels for VIPs

text:
# ocf_heartbeat_ipsec(7)

## NAME
ocf_heartbeat_ipsec - Handles IPSEC tunnels for VIPs

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

## DESCRIPTION
This is a Resource Agent to manage IPSEC tunnels associated with a Virtual IP Address. It's meant to be collocated with a specific VIP, and will manage setting up or down a specific tunnel.

## SUPPORTED PARAMETERS
tunnel

The name of the tunnel to be monitored. (unique, required, string, no default)

vip

Virtual IP address that the tunnel is using. (unique, required, string, no default)

confdir

The directory where the IPSEC tunnel configurations can be found. (optional, string, default "/etc/ipsec.d/")

fallbacktunnel

The name of the tunnel to fall back to when the main tunnel is put down. (unique, optional, string, no default)

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

start

Starts the resource. Suggested minimum timeout: 20s.

stop

Stops the resource. Suggested minimum timeout: 20s.

monitor

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

reload

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

```
primitive p_ipsec ocf:heartbeat:ipsec \

  params \

    tunnel=string \

    vip=string \

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

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

```
pcs resource create p_ipsec ocf:heartbeat:ipsec \

  tunnel=string \

  vip=string \

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

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

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


title: ocf_heartbeat_jboss(7)

text:
# ocf_heartbeat_jboss(7)

## NAME
ocf_heartbeat_jboss - Manages a JBoss application server instance

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

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

## SUPPORTED PARAMETERS
jboss_version

The version of JBoss. Default is 5. The usage of JBoss was greatly changed as of JBoss 6. Specify "6" when you use JBoss 6. (optional, integer, default 5)

resource_name

The name of the resource. Defaults to the name of the resource instance. (unique, optional, string, default "RESOURCE_ID")

console

A destination of the log of jboss run and shutdown script. (unique, optional, string, default "/var/log/RESOURCE_ID.log")

shutdown_timeout

Timeout for jboss bin/shutdown.sh. We wait for this timeout to expire, then send the TERM and QUIT signals. Finally, the KILL signal is used to terminate the jboss process. You should set the timeout for the stop operation to a value bigger than the sum of the timeout parameters. See also kill_timeout. (optional, integer, default 5)

kill_timeout

If bin/shutdown.sh doesn't stop the jboss process, then we send it TERM and QUIT signals, intermittently and once a second. After this timeout expires, if the process is still live, we use the KILL signal. See also shutdown_timeout. (optional, integer, default 10)

user

A user name to start a JBoss. (optional, string, default "root")

statusurl

URL to test in the monitor operation. (optional, string, default "http://127.0.0.1:8080")

java_home

Home directory of Java. Defaults to the environment variable JAVA_HOME. If it is not set, then define this parameter. (optional, string, no default)

java_opts

Java options. (optional, string, no default)

jboss_home

Home directory of Jboss. (required, string, no default)

jboss_base_dir

Base directory of JBoss. This parameter is not used in JBoss5. (optional, string, no default)

pstring

With this string heartbeat matches for the right process to kill. (optional, string, default "java -Dprogram.name=run.sh")

run_command

JBoss start command. (optional, string, default "/bin/run.sh")

run_opts

Start options to start Jboss with, defaults are from the Jboss-Doku. (optional, string, default "-c default")

shutdown_opts

Stop options to stop Jboss with. (optional, string, default "-s 127.0.0.1:1099")

rotate_consolelog

Rotate console log flag. (optional, boolean, default false)

rotate_value

Console log rotation value (default is 86400 seconds). (optional, integer, default 86400)

rotate_logsuffix

Rotate console log suffix. (optional, integer, default .%F)

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

start

Starts the resource. Suggested minimum timeout: 60s.

stop

Stops the resource. Suggested minimum timeout: 120s.

status

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

monitor

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

meta-data

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

validate-all

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

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

```
primitive p_jboss ocf:heartbeat:jboss \

  params \

    jboss_home=string \

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

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

```
pcs resource create p_jboss ocf:heartbeat:jboss \

  jboss_home=string \

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

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

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


title: ocf_heartbeat_jira(7)

summary: JIRA OCF RA

text:
# ocf_heartbeat_jira(7)

## NAME
ocf_heartbeat_jira - JIRA OCF RA

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

## DESCRIPTION
OCF Resource Agent to manage JIRA software

## SUPPORTED PARAMETERS
statusurl

Status URL for JIRA monitoring (optional, string, default "http://localhost:8080/status")

java_home

Java Home in the Linux instance (optional, string, default "/usr/lib/jvm/jre")

jira_installation

JIRA installation directory (binaries, ... etc) (required, string, no default)

jira_user

User to run Jira software with (optional, string, default "jira")

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

start

Starts the resource. Suggested minimum timeout: 300s.

stop

Stops the resource. Suggested minimum timeout: 300s.

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

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

```
primitive p_jira ocf:heartbeat:jira \

  params \

    jira_installation=string \

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

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

```
pcs resource create p_jira ocf:heartbeat:jira \

  jira_installation=string \

  op monitor timeout="30s" 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_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)


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)


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 "/var/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 "/var/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 "/var/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 master/slave instance

text:
# ocf_heartbeat_mariadb(7)

## NAME
ocf_heartbeat_mariadb - Manages a MariaDB master/slave instance

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

## DESCRIPTION
Resource script for MariaDB.

Manages a complete master/slave 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 master/slave instance.

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 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 master 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 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

MariaDB 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 MariaDB instance is listening. (optional, string, default "3306")

## 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 (Master role)

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

monitor (Slave 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="Master" depth="0" timeout="30s" interval="10s" \

  op monitor role="Slave" 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="Master" OCF_CHECK_LEVEL="0" timeout="30s" interval="10s" \

  op monitor role="Slave" 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). 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 (Master/Slave) resource Slave registers its node id ("crm_node -i") as reservation key ( --param-sark ) on each device in the params "devs" list. Master 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 master role. (optional, string, default "0")

master_score_dev_factor

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

master_score_delay

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

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

start

Starts the resource. Suggested minimum timeout: 30s.

promote

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

demote

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

notify

Suggested minimum timeout: 30s.

stop

Stops the resource. Suggested minimum timeout: 30s.

monitor (Slave role)

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

monitor (Master 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="Slave" \

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

```
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="Slave" \

  op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="60s" role="Master" 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 (Master role)

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

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

```
primitive p_mysql ocf:heartbeat:mysql \

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

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

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

```
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="Master" OCF_CHECK_LEVEL="0" timeout="30s" interval="10s" \

  op monitor role="Slave" 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)