title: ocf_heartbeat_ManageVE(7)

text:
# ocf_heartbeat_ManageVE(7)

## NAME
ocf_heartbeat_ManageVE - Manages an OpenVZ Virtual Environment (VE)

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

## DESCRIPTION
This OCF compliant resource agent manages OpenVZ VEs and thus requires a proper OpenVZ installation including a recent vzctl util.

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
veid

OpenVZ ID of virtual environment (see output of vzlist -a for all assigned IDs) (required, integer, no default)

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

start

Starts the resource. Suggested minimum timeout: 75s.

stop

Stops the resource. Suggested minimum timeout: 75s.

status

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

monitor

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

migrate_to

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

migrate_from

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

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

```
primitive p_ManageVE ocf:heartbeat:ManageVE \

  params \

    veid=integer \

  meta allow-migrate="true" \

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

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

```
pcs resource create p_ManageVE ocf:heartbeat:ManageVE \

  veid=integer \

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

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

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


package: resource-agents

title: ocf_heartbeat_NodeUtilization(7)

summary: Node Utilization

text:
# ocf_heartbeat_NodeUtilization(7)

## NAME
ocf_heartbeat_NodeUtilization - Node Utilization

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

## DESCRIPTION
The Node Utilization agent detects system parameters like available CPU, host memory and hypervisor memory availability, and adds them into the CIB for each node using crm_attribute. Run the agent as a clone resource to have it populate these parameters on each node. Note: Setting hv_memory only works with Xen at the moment, using the xl or xm command line tools.

## SUPPORTED PARAMETERS
dynamic

If set, parameters will be updated if there are differences between the HA parameters and the system values when running the monitor action. If not set, the parameters will be set once when the resource instance starts. (optional, boolean, default true)

utilization_cpu

Enable setting node CPU utilization limit. (optional, boolean, default true)

utilization_cpu_reservation

Subtract this value when setting the CPU utilization parameter. (optional, integer, default 1)

utilization_host_memory

Enable setting available host memory. (optional, boolean, default true)

utilization_host_memory_reservation

Subtract this value when setting host memory utilization, in MB. (optional, integer, default 512)

utilization_hv_memory

Enable setting available hypervisor memory. (optional, boolean, default true)

utilization_hv_memory_reservation

Subtract this value when setting hypervisor memory utilization, in MB. (optional, integer, default 512)

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

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

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

```
primitive p_NodeUtilization ocf:heartbeat:NodeUtilization \

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

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

```
pcs resource create p_NodeUtilization ocf:heartbeat:NodeUtilization \

  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_Pure-FTPd(7)

summary: Manages a Pure\-FTPd FTP server instance

text:
# ocf_heartbeat_Pure-FTPd(7)

## NAME
ocf_heartbeat_Pure-FTPd - Manages a Pure-FTPd FTP server instance

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

## DESCRIPTION
This script manages Pure-FTPd in an Active-Passive setup

## SUPPORTED PARAMETERS
script

The full path to the Pure-FTPd startup script. For example, "/sbin/pure-config.pl" (unique, optional, string, default "/sbin/pure-config.pl")

conffile

The Pure-FTPd configuration file name with full path. For example, "/etc/pure-ftpd/pure-ftpd.conf" (unique, optional, string, default "/etc/pure-ftpd/pure-ftpd.conf")

daemon_type

The Pure-FTPd daemon to be called by pure-ftpd-wrapper. Valid options are "" for pure-ftpd, "mysql" for pure-ftpd-mysql, "postgresql" for pure-ftpd-postgresql and "ldap" for pure-ftpd-ldap (unique, optional, string, no default)

pidfile

PID file (optional, string, default "/var/run/resource-agents/pure-ftpd-RESOURCE_ID.pid")

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

start

Starts the resource. Suggested minimum timeout: 20s.

stop

Stops the resource. Suggested minimum timeout: 20s.

monitor

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

validate-all

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

meta-data

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

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

```
primitive p_Pure-FTPd ocf:heartbeat:Pure-FTPd \

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

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

```
pcs resource create p_Pure-FTPd ocf:heartbeat:Pure-FTPd \

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

text:
# ocf_heartbeat_Raid1(7)

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

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

## DESCRIPTION
This resource agent manages Linux software RAID (MD) devices on a shared storage medium. It uses mdadm(8) to start, stop, and monitor the MD devices. Raidtools are supported, but deprecated. See https://raid.wiki.kernel.org/index.php/Linux_Raid for more information.

## SUPPORTED PARAMETERS
raidconf

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

raiddev

One or more block devices to use, space separated. Alternatively, set to "auto" to manage all devices specified in raidconf. (required, string, no default)

homehost

The value for the homehost directive; this is an mdadm feature to protect RAIDs against being activated by accident. It is recommended to create RAIDs managed by the cluster with "homehost" set to a special value, so they are not accidentally auto-assembled by nodes not supposed to own them. (optional, 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 3 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 true)

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 md RAID array on multiple nodes at the same time will result in data corruption and thus is forbidden by default. A safe example could be an array that is only named identically across all nodes, but is in fact distinct.

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.

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.

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

```
primitive p_Raid1 ocf:heartbeat:Raid1 \

  params \

    raidconf=string \

    raiddev=string \

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

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

```
pcs resource create p_Raid1 ocf:heartbeat:Raid1 \

  raidconf=string \

  raiddev=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_Route(7)

summary: Manages network routes

text:
# ocf_heartbeat_Route(7)

## NAME
ocf_heartbeat_Route - Manages network routes

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

## DESCRIPTION
Enables and disables network routes.

Supports host and net routes, routes via a gateway address, and routes using specific source addresses.

This resource agent is useful if a node's routing table needs to be manipulated based on node role assignment.

Consider the following example use case:

- One cluster node serves as an IPsec tunnel endpoint.

- All other nodes use the IPsec tunnel to reach hosts in a specific remote network.

Then, here is how you would implement this scheme making use of the Route resource agent:

- Configure an ipsec LSB resource.

- Configure a cloned Route OCF resource.

- Create an order constraint to ensure that ipsec is started before Route.

- Create a colocation constraint between the ipsec and Route resources, to make sure no instance of your cloned Route resource is started on the tunnel endpoint itself.

## SUPPORTED PARAMETERS
destination

The destination network (or host) to be configured for the route. Specify the netmask suffix in CIDR notation (e.g. "/24"). If no suffix is given, a host route will be created. Specify "0.0.0.0/0" or "default" if you want this resource to set the system default route. (unique, required, string, no default)

device

The outgoing network device to use for this route. (optional, string, no default)

gateway

The gateway IP address to use for this route. (optional, string, no default)

source

The source IP address to be configured for the route. (optional, string, no default)

table

The routing table to be configured for the route. (optional, string, no default)

family

The address family to be used for the route ip4 IP version 4 ip6 IP version 6 detect Detect from 'destination' address. (optional, string, default "detect")

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

validate-all

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

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

```
primitive p_Route ocf:heartbeat:Route \

  params \

    destination=string \

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

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

```
pcs resource create p_Route ocf:heartbeat:Route \

  destination=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_SAPDatabase(7)

text:
# ocf_heartbeat_SAPDatabase(7)

## NAME
ocf_heartbeat_SAPDatabase - Manages a SAP database instance as an HA resource.

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

## DESCRIPTION
Resource script for SAP databases. It manages a SAP database of any type as an HA resource.

The purpose of the resource agent is to start, stop and monitor the database instance of a SAP system. Together with the RDBMS system it will also control the related network service for the database. Like the Oracle Listener and the xserver of MaxDB. The resource agent expects a standard SAP installation of the database and therefore needs less parameters to configure. The resource agent supports the following databases:

- Oracle 10.2, 11.2 and 12

- DB/2 UDB for Windows and Unix 9.x

- SAP-DB / MaxDB 7.x

- Sybase ASE 15.7

- SAP HANA Database since 1.00 - with SAP note 1625203 (http://sdn.sap.com)

In fact this resource agent does not run any database commands directly. It uses the SAP standard process SAPHostAgent to control the database. The SAPHostAgent must be installed on each cluster node locally. It will not work, if you try to run the SAPHostAgent also as a HA resource. Please follow SAP note 1031096 for the installation of SAPHostAgent. The required minimum version of SAPHostAgent is: Release: 7.20 Patch Number: 90 or compile time after: Dec 17 2011

To exemplify the usage, for a HANA database with SID "TST" and instance number "10", the resource configuration using crmsh syntax looks like:

primitive rsc_SAPDatabase_TST_HDB10 ocf:heartbeat:SAPDatabase \ params DBTYPE="HDB" SID="TST" \ op start interval="0" timeout="3600" \ op monitor interval="120" timeout="700" \ op stop interval="0" timeout="600"

Make sure to tune the operations timeout values accordingly with your chosen Database and available infrastructure.

Note that the same configuration can be achieved using any other CLI tool for cluster configuration available, like pcs or cibadmin.

## SUPPORTED PARAMETERS
SID

The unique database system identifier. e.g. P01 (unique, required, string, no default)

DIR_EXECUTABLE

The full qualified path where to find saphostexec and saphostctrl. Usually you can leave this empty. Then the default: /usr/sap/hostctrl/exe is used. (optional, string, default "/usr/sap/hostctrl/exe")

DBTYPE

The name of the database vendor you use. Set either: ADA, DB6, ORA, SYB, HDB (required, string, no default)

DBINSTANCE

Must be used for special database implementations, when database instance name is not equal to the SID (e.g. Oracle DataGuard) (unique, optional, string, no default)

DBOSUSER

The parameter can be set, if the database processes on operating system level are not executed with the default user of the used database type. Defaults: ADA=taken from /etc/opt/sdb, DB6=db2SID, ORA=oraSID and oracle, SYB=sybSID, HDB=SIDadm (unique, optional, string, no default)

NETSERVICENAME

Deprecated - do not use anymore. This parameter will be deleted in one of the next releases. (optional, string, no default)

DBJ2EE_ONLY

Deprecated - do not use anymore. This parameter will be deleted in one of the next releases. (optional, boolean, default false)

JAVA_HOME

Deprecated - do not use anymore. This parameter will be deleted in one of the next releases. (optional, string, no default)

STRICT_MONITORING

This controls how the resource agent monitors the database. If set to true, it will use 'saphostctrl -function GetDatabaseStatus' to test the database state. If set to false, only operating system processes are monitored. (optional, boolean, default false)

AUTOMATIC_RECOVER

If you set this to true, 'saphostctrl -function StartDatabase' will always be called with the '-force' option. (optional, boolean, default false)

MONITOR_SERVICES

Defines which services are monitored by the SAPDatabase resource agent. Service names must correspond with the output of the 'saphostctrl -function GetDatabaseStatus' command. The default MONITOR_SERVICES value is derived from the database type DBTYPE. For reference: - DBTYPE "ORA" sets MONITOR_SERVICES="Instance|Database|Listener";

- DBTYPE "HDB" sets MONITOR_SERVICES="hdbindexserver|hdbnameserver";

- DBTYPE "ADA" sets MONITOR_SERVICES="Database";

- DBTYPE "DB6" sets MONITOR_SERVICES="{SID}|{db2sid}";

- DBTYPE "SYB" sets MONITOR_SERVICES="Server".

This parameter should be set ONLY if is needed to monitor different services than the ones listed above.

(optional, string, no default)

DIR_BOOTSTRAP

Deprecated - do not use anymore. This parameter will be deleted in one of the next releases. (optional, string, no default)

DIR_SECSTORE

Deprecated - do not use anymore. This parameter will be deleted in one of the next releases. (optional, string, no default)

DB_JARS

Deprecated - do not use anymore. This parameter will be deleted in one of the next releases. (optional, string, no default)

PRE_START_USEREXIT

The full qualified path where to find a script or program which should be executed before this resource gets started. (optional, string, no default)

POST_START_USEREXIT

The full qualified path where to find a script or program which should be executed after this resource got started. (optional, string, no default)

PRE_STOP_USEREXIT

The full qualified path where to find a script or program which should be executed before this resource gets stopped. (optional, string, no default)

POST_STOP_USEREXIT

The full qualified path where to find a script or program which should be executed after this resource got stopped. (optional, string, no default)

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

start

Starts the resource. Suggested minimum timeout: 1800s.

stop

Stops the resource. Suggested minimum timeout: 1800s.

status

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

monitor

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

methods

Suggested minimum timeout: 5s.

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

```
primitive p_SAPDatabase ocf:heartbeat:SAPDatabase \

  params \

    SID=string \

    DBTYPE=string \

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

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

```
pcs resource create p_SAPDatabase ocf:heartbeat:SAPDatabase \

  SID=string \

  DBTYPE=string \

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

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

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


title: ocf_heartbeat_SAPInstance(7)

text:
# ocf_heartbeat_SAPInstance(7)

## NAME
ocf_heartbeat_SAPInstance - Manages a SAP instance as an HA resource.

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

## DESCRIPTION
Usually a SAP system consists of one database and at least one or more SAP instances (sometimes called application servers). One SAP Instance is defined by having exactly one instance profile. The instance profiles can usually be found in the directory /sapmnt/SID/profile. Each instance must be configured as it's own resource in the cluster configuration. The resource agent supports the following SAP versions:

- SAP WebAS ABAP Release 6.20 - 7.40

- SAP WebAS Java Release 6.40 - 7.40

- SAP WebAS ABAP + Java Add-In Release 6.20 - 7.40 (Java is not monitored by the cluster in that case) When using a SAP Kernel 6.40 please check and implement the actions from the section "Manual postprocessing" from SAP note 995116 (http://sdn.sap.com). Other versions may also work with this agent, but have not been verified.

All operations of the SAPInstance resource agent are done by using the startup framework called SAP Management Console or sapstartsrv that was introduced with SAP kernel release 6.40. Find more information about the SAP Management Console in SAP note 1014480. Using this framework defines a clear interface for the Heartbeat cluster, how it sees the SAP system. The options for monitoring the SAP system are also much better than other methods like just watching the ps command for running processes or doing some pings to the application. sapstartsrv uses SOAP messages to request the status of running SAP processes. Therefore it can actually ask a process itself what it's status is, independent from other problems that might exist at the same time.

sapstartsrv knows 4 status colours:

- GREEN = everything is fine

- YELLOW = something is wrong, but the service is still working

- RED = the service does not work

- GRAY = the service has not been started

The SAPInstance resource agent will interpret GREEN and YELLOW as OK. That means that minor problems will not be reported to the Heartbeat cluster. This prevents the cluster from doing an unwanted failover. The statuses RED and GRAY are reported as NOT_RUNNING to the cluster. Depending on the status the cluster expects from the resource, it will do a restart, failover or just nothing.

## SUPPORTED PARAMETERS
InstanceName

The full qualified SAP instance name. e.g. P01_DVEBMGS00_sapp01ci. Usually this is the name of the SAP instance profile. (unique, required, string, no default)

DIR_EXECUTABLE

The full qualified path where to find sapstartsrv and sapcontrol. Specify this parameter, if you have changed the SAP kernel directory location after the default SAP installation. (optional, string, no default)

DIR_PROFILE

The full qualified path where to find the SAP START profile. Specify this parameter, if you have changed the SAP profile directory location after the default SAP installation. (optional, string, no default)

START_PROFILE

The name of the SAP START profile. Specify this parameter, if you have changed the name of the SAP START profile after the default SAP installation. As SAP release 7.10 does not have a START profile anymore, you need to specify the Instance Profile than. (unique, optional, string, no default)

START_WAITTIME

After that time in seconds a monitor operation is executed by the resource agent. Does the monitor return SUCCESS, the start ishandled as SUCCESS. This is useful to resolve timing problems with e.g. the J2EE-Addin instance.Usually the resource agent waits until all services are started and the SAP Management Console reports a GREEN status. A double stack installation (ABAP + Java AddIn) consists of an ABAP dispatcher and a JAVA instance. Normally the start of the JAVA instance takes much longer than the start of the ABAP instance. For a JAVA Instance you may need to configure a much higher timeout for the start operation of the resource in Heartbeat. The disadvantage here is, that the discovery of a failed start by the cluster takes longer. Somebody might say: For me it is important, that the ABAP instance is up and running. A failure of the JAVA instance shall not cause a failover of the SAP instance. Actually the SAP MC reports a YELLOW status, if the JAVA instance of a double stack system fails. From the resource agent point of view YELLOW means:everything is OK. Setting START_WAITTIME to a lower value determines the resource agent to check the status of the instance during a start operation after that time. As it would wait normally for a GREEN status, now it reports SUCCESS to the cluster in case of a YELLOW status already after the specified time. That is only useful for double stack systems.

(optional, string, default "3600")

AUTOMATIC_RECOVER

The SAPInstance resource agent tries to recover a failed start attempt automatically one time. This is done by killing running instance processes, removing the kill.sap file and executing cleanipc. Sometimes a crashed SAP instance leaves some processes and/or shared memory segments behind. Setting this option to true will try to remove those leftovers during a start operation. That is to reduce manual work for the administrator. (optional, boolean, default false)

MONITOR_SERVICES

Within a SAP instance there can be several services. Usually you will find the defined services in the START profile of the related instance (Attention: with SAP Release 7.10 the START profile content was moved to the instance profile). Not all of those services are worth to monitor by the cluster. For example you properly do not like to failover your SAP instance, if the central syslog collector daemon fails. Those services are monitored within the SAPInstance resource agent: - disp+work

- msg_server

- enserver (ENSA1)

- enq_server (ENSA2)

- enrepserver (ENSA1)

- enq_replicator (ENSA2)

- jcontrol

- jstart

Some other services could be monitored as well. They have to be given with the parameter MONITOR_SERVICES, e.g.:

- sapwebdisp - TREXDaemon.x

That names match the strings used in the output of the command 'sapcontrol -nr [Instance-Nr] -function GetProcessList'. The default should fit most cases where you want to manage a SAP Instance from the cluster. You may change this with this parameter, if you like to monitor more/less or other services that sapstartsrv supports. You may specify multiple services separated by a | (pipe) sign in this parameter: disp+work|msg_server|enserver

(optional, string, default "disp+work|msg_server|enserver|enrepserver|jcontrol|jstart|enq_server|enq_replicator")

SHUTDOWN_METHOD

Usually a SAP Instance is stopped by the command 'sapcontrol -nr InstanceNr -function Stop'. SHUTDOWN_METHOD=KILL means to kill the SAP Instance using OS commands. SAP processes of the instance are terminated with 'kill -9', shared memory is deleted with 'cleanipc' and the 'kill.sap' file will be deleted. That method is much faster than the graceful stop, but the instance does not have the chance to say goodbye to other SAPinstances in the same system. USE AT YOUR OWN RISK !! (optional, string, default "normal")

ERS_InstanceName

Only used in a Master/Slave resource configuration: The full qualified SAP enqueue replication instance name. e.g. P01_ERS02_sapp01ers. Usually this is the name of the SAP instance profile. The enqueue replication instance must be installed, before you want to configure a master-slave cluster resource. The master-slave configuration in the cluster must use this properties: clone_max = 2 clone_node_max = 1 master_node_max = 1 master_max = 1

(unique, optional, string, no default)

ERS_START_PROFILE

Only used in a Master/Slave resource configuration: The parameter ERS_InstanceName must also be set in this configuration. The name of the SAP START profile. Specify this parameter, if you have changed the name of the SAP START profile after the default SAP installation. As SAP release 7.10 does not have a START profile anymore, you need to specify the Instance Profile than. (unique, optional, string, no default)

PRE_START_USEREXIT

The full qualified path where to find a script or program which should be executed before this resource gets started. (optional, string, no default)

POST_START_USEREXIT

The full qualified path where to find a script or program which should be executed after this resource got started. (optional, string, no default)

PRE_STOP_USEREXIT

The full qualified path where to find a script or program which should be executed before this resource gets stopped. (optional, string, no default)

POST_STOP_USEREXIT

The full qualified path where to find a script or program which should be executed after this resource got stopped. (optional, string, no default)

IS_ERS

Only used for ASCS/ERS SAP Netweaver installations without implementing a master/slave resource to allow the ASCS to 'find' the ERS running on another cluster node after a resource failure. This parameter should be set to true 'only' for the ERS instance for implementations following the SAP NetWeaver 7.40 HA certification (NW-HA-CLU-740). This includes also systems for NetWeaver less than 7.40, if you like to implement the NW-HA-CLU-740 scenario. (optional, boolean, default false)

MINIMAL_PROBE

Setting MINIMAL_PROBE=true forces the resource agent to do only minimal check during a probe. This is needed for special file system setups. The MINIMAL_PROBE=true is only supported, if requested either by your vendor's support or if described in an architecture document from your HA vendor. (optional, boolean, default false)

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

status

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

monitor

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

monitor (Slave role)

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

monitor (Master role)

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

promote

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

demote

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

reload

Suggested minimum timeout: 320s.

validate-all

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

meta-data

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

methods

Suggested minimum timeout: 5s.

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

```
primitive p_SAPInstance ocf:heartbeat:SAPInstance \

  params \

    InstanceName=string \

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

  op monitor depth="0" timeout="60s" interval="121s" role="Slave" \

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

```
ms ms_SAPInstance p_SAPInstance \

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

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

```
pcs resource create p_SAPInstance ocf:heartbeat:SAPInstance \

  InstanceName=string \

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

  op monitor OCF_CHECK_LEVEL="0" timeout="60s" interval="121s" role="Slave" \

  op monitor OCF_CHECK_LEVEL="0" timeout="60s" interval="119s" role="Master" promotable
```

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

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


title: ocf_heartbeat_SendArp(7)

text:
# ocf_heartbeat_SendArp(7)

## NAME
ocf_heartbeat_SendArp - Broadcasts unsolicited ARP announcements

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

## DESCRIPTION
This RA can be used _instead_ of the IPaddr2 or IPaddr RA to send gratuitous ARP for an IP address on a given interface, without adding the address to that interface. For example, if for some reason you wanted to send gratuitous ARP for addresses managed by IPaddr2 or IPaddr on an additional interface.

## SUPPORTED PARAMETERS
ip

The IP address for sending ARP packet. (required, string, no default)

nic

The NIC for sending ARP packet. (required, string, no default)

background

Send ARPs in background. Set to false if you want to test if sending ARPs succeeded. (optional, boolean, default true)

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

start

Starts the resource. Suggested minimum timeout: 20s.

stop

Stops the resource. Suggested minimum timeout: 20s.

monitor

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

meta-data

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

validate-all

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

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

```
primitive p_SendArp ocf:heartbeat:SendArp \

  params \

    ip=string \

    nic=string \

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

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

```
pcs resource create p_SendArp ocf:heartbeat:SendArp \

  ip=string \

  nic=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_ServeRAID(7)

text:
# ocf_heartbeat_ServeRAID(7)

## NAME
ocf_heartbeat_ServeRAID - Enables and disables shared ServeRAID merge groups

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

## DESCRIPTION
Resource script for ServeRAID. It enables/disables shared ServeRAID merge groups.

## SUPPORTED PARAMETERS
serveraid

The adapter number of the ServeRAID adapter. (required, integer, no default)

mergegroup

The logical drive under consideration. (required, integer, no default)

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

start

Starts the resource. Suggested minimum timeout: 40s.

stop

Stops the resource. Suggested minimum timeout: 40s.

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.

validate-all

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

meta-data

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

methods

Suggested minimum timeout: 5s.

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

```
primitive p_ServeRAID ocf:heartbeat:ServeRAID \

  params \

    serveraid=integer \

    mergegroup=integer \

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

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

```
pcs resource create p_ServeRAID ocf:heartbeat:ServeRAID \

  serveraid=integer \

  mergegroup=integer \

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

summary: Manages the Sphinx search daemon.

text:
# ocf_heartbeat_SphinxSearchDaemon(7)

## NAME
ocf_heartbeat_SphinxSearchDaemon - Manages the Sphinx search daemon.

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

## DESCRIPTION
This is a searchd Resource Agent. It manages the Sphinx Search Daemon.

## SUPPORTED PARAMETERS
config

searchd configuration file (unique, optional, string, default "/etc/sphinx/sphinx.conf")

searchd

searchd binary (optional, string, default "/usr/local/bin/searchd")

search

Search binary for functional testing in the monitor action. (optional, string, default "/usr/local/bin/search")

testQuery

Test query for functional testing in the monitor action. The query does not need to match any documents in the index. The purpose is merely to test whether the search daemon is is able to query its indices and respond properly. (optional, string, default "Heartbeat_Monitor_Query_Match_string")

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

start

Starts the resource. Suggested minimum timeout: 20s.

stop

Stops the resource. Suggested minimum timeout: 20s.

monitor

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

meta-data

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

validate-all

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

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

```
primitive p_SphinxSearchDaemon ocf:heartbeat:SphinxSearchDaemon \

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

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

```
pcs resource create p_SphinxSearchDaemon ocf:heartbeat:SphinxSearchDaemon \

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

summary: Manages a Squid proxy server instance

text:
# ocf_heartbeat_Squid(7)

## NAME
ocf_heartbeat_Squid - Manages a Squid proxy server instance

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

## DESCRIPTION
The resource agent of Squid. This manages a Squid instance as an HA resource.

## SUPPORTED PARAMETERS
squid_exe

This is a required parameter. This parameter specifies squid's executable file. (required, string, no default)

squid_conf

This is a required parameter. This parameter specifies a configuration file for a squid instance managed by this RA. (unique, required, string, no default)

squid_opts

This is a optional parameter. This parameter specifies the start options. (optional, string, no default)

squid_pidfile

Deprecated - do not use anymore (unique, optional, string, no default)

squid_port

This is a required parameter. This parameter specifies a port number for a squid instance managed by this RA. If multiple ports are used, you must specify only one of them. (unique, required, integer, no default)

squid_stop_timeout

On stop, a squid shutdown is invoked first. If the resource doesn't stop within this timeout, we resort to stopping processes by sending signals and finally KILLing them. (optional, integer, default 10)

debug_mode

This is an optional parameter. This RA runs in debug mode when this parameter includes 'x' or 'v'. If 'x' is included, both of STDOUT and STDERR redirect to the logfile specified by "debug_log", and then the builtin shell option 'x' is turned on. It is similar about 'v'. (optional, string, no default)

debug_log

This is an optional parameter. This parameter specifies a destination file for debug logs and works only if this RA run in debug mode. Refer to "debug_mode" about debug mode. If no value is given but is required, it's constructed according to the following rules: "/var/log/" as a directory part, the basename of the configuration file given by "syslog_ng_conf" as a basename part, ".log" as a suffix. (optional, string, no default)

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

start

Starts the resource. Suggested minimum timeout: 60s.

stop

Stops the resource. Suggested minimum timeout: 120s.

status

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

monitor

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

meta-data

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

validate-all

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

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

```
primitive p_Squid ocf:heartbeat:Squid \

  params \

    squid_exe=string \

    squid_conf=string \

    squid_port=integer \

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

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

```
pcs resource create p_Squid ocf:heartbeat:Squid \

  squid_exe=string \

  squid_conf=string \

  squid_port=integer \

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

summary: Example stateful resource agent

text:
# ocf_heartbeat_Stateful(7)

## NAME
ocf_heartbeat_Stateful - Example stateful resource agent

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

## DESCRIPTION
This is an example resource agent that implements two states

## SUPPORTED PARAMETERS
state

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

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

start

Starts the resource. Suggested minimum timeout: 20s.

stop

Stops the resource. Suggested minimum timeout: 20s.

promote

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

demote

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

monitor

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

meta-data

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

validate-all

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

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

```
primitive p_Stateful ocf:heartbeat:Stateful \

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

```
ms ms_Stateful p_Stateful \

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

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

```
pcs resource create p_Stateful ocf:heartbeat:Stateful \

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

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

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


title: ocf_heartbeat_SysInfo(7)

text:
# ocf_heartbeat_SysInfo(7)

## NAME
ocf_heartbeat_SysInfo - Records various node attributes in the CIB

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

## DESCRIPTION
This is a SysInfo Resource Agent. It records (in the CIB) various attributes of a node Sample Linux output: arch: i686 os: Linux-2.4.26-gentoo-r14 free_swap: 1999 cpu_info: Intel(R) Celeron(R) CPU 2.40GHz cpu_speed: 4771.02 cpu_cores: 1 cpu_load: 0.00 ram_total: 513 ram_free: 117 root_free: 2.4

Sample Darwin output: arch: i386 os: Darwin-8.6.2 cpu_info: Intel Core Duo cpu_speed: 2.16 cpu_cores: 2 cpu_load: 0.18 ram_total: 2016 ram_free: 787 root_free: 13

Units: free_swap: Mb ram_*: Mb root_free: Gb cpu_speed (Linux): bogomips cpu_speed (Darwin): Ghz

## SUPPORTED PARAMETERS
pidfile

PID file (optional, string, default "/var/run/resource-agents/SysInfo-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 SysInfo resource using the crm(8) shell:

```
primitive p_SysInfo ocf:heartbeat:SysInfo \

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

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

```
pcs resource create p_SysInfo ocf:heartbeat:SysInfo \

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

text:
# ocf_heartbeat_VIPArip(7)

## NAME
ocf_heartbeat_VIPArip - Manages a virtual IP address through RIP2

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

## DESCRIPTION
Virtual IP Address by RIP2 protocol. This script manages IP alias in different subnet with quagga/ripd. It can add an IP alias, or remove one.

## SUPPORTED PARAMETERS
ip

The IPv4 address in different subnet, for example "192.168.1.1". (unique, required, string, no default)

nic

The nic for broadcast the route information. The ripd uses this nic to broadcast the route information to others (optional, string, default "eth0")

zebra_binary

Absolute path to the zebra binary. (optional, string, default "/usr/sbin/zebra")

ripd_binary

Absolute path to the ripd binary. (optional, string, default "/usr/sbin/ripd")

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

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

```
primitive p_VIPArip ocf:heartbeat:VIPArip \

  params \

    ip=string \

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

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

```
pcs resource create p_VIPArip ocf:heartbeat:VIPArip \

  ip=string \

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

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

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


title: ocf_heartbeat_WAS(7)

text:
# ocf_heartbeat_WAS(7)

## NAME
ocf_heartbeat_WAS - Manages a WebSphere Application Server instance

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

## DESCRIPTION
Resource script for WAS. It manages a Websphere Application Server (WAS) as an HA resource.

## SUPPORTED PARAMETERS
config

The WAS-configuration file. (optional, string, default "/usr/WebSphere/AppServer/config/server-cfg.xml")

port

The WAS-(snoop)-port-number. (optional, integer, default 9080)

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

start

Starts the resource. Suggested minimum timeout: 300s.

stop

Stops the resource. Suggested minimum timeout: 300s.

status

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

monitor

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

validate-all

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

meta-data

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

methods

Suggested minimum timeout: 5s.

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

```
primitive p_WAS ocf:heartbeat:WAS \

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

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

```
pcs resource create p_WAS ocf:heartbeat:WAS \

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

text:
# ocf_heartbeat_WAS6(7)

## NAME
ocf_heartbeat_WAS6 - Manages a WebSphere Application Server 6 instance

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

## DESCRIPTION
Resource script for WAS6. It manages a Websphere Application Server (WAS6) as an HA resource.

## SUPPORTED PARAMETERS
profile

The WAS profile name. (optional, string, default "default")

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

start

Starts the resource. Suggested minimum timeout: 300s.

stop

Stops the resource. Suggested minimum timeout: 300s.

status

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

monitor

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

validate-all

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

meta-data

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

methods

Suggested minimum timeout: 5s.

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

```
primitive p_WAS6 ocf:heartbeat:WAS6 \

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

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

```
pcs resource create p_WAS6 ocf:heartbeat:WAS6 \

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

summary: Manages a service of Xinetd

text:
# ocf_heartbeat_Xinetd(7)

## NAME
ocf_heartbeat_Xinetd - Manages a service of Xinetd

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

## DESCRIPTION
Resource script for Xinetd. It starts/stops services managed by xinetd by enabling or disabling them in the configuration file.

The xinetd daemon itself must be running: we are not going to start or stop it ourselves.

All services should have a line saying either "disable=yes" or "disable=no". The script just changes those settings before reloading xinetd.

Important: in case the services managed by the cluster are the only ones enabled, you should specify the -stayalive option for xinetd or it will exit on Heartbeat stop. Alternatively, you may enable some internal service such as echo.

## SUPPORTED PARAMETERS
service

The name of the service managed by xinetd. (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.

restart

Suggested minimum timeout: 20s.

status

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

monitor

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

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

```
primitive p_Xinetd ocf:heartbeat:Xinetd \

  params \

    service=string \

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

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

```
pcs resource create p_Xinetd ocf:heartbeat:Xinetd \

  service=string \

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

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

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


title: ocf_heartbeat_ZFS(7)

summary: Manages ZFS pools

text:
# ocf_heartbeat_ZFS(7)

## NAME
ocf_heartbeat_ZFS - Manages ZFS pools

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

## DESCRIPTION
This script manages ZFS pools It can import a ZFS pool or export it

## SUPPORTED PARAMETERS
pool

The name of the ZFS pool to manage, e.g. "tank". (unique, required, string, no default)

importargs

Arguments to zpool import, e.g. "-d /dev/disk/by-id". (optional, string, no default)

importforce

zpool import is given the -f option. (optional, boolean, default true)

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

start

Starts the resource. Suggested minimum timeout: 60s.

stop

Stops the resource. Suggested minimum timeout: 60s.

monitor

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

validate-all

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

meta-data

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

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

```
primitive p_ZFS ocf:heartbeat:ZFS \

  params \

    pool=string \

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

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

```
pcs resource create p_ZFS ocf:heartbeat:ZFS \

  pool=string \

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

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

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


title: ocf_heartbeat_aliyun-vpc-move-ip(7)

summary: Move IP within a VPC of the Aliyun ECS

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

## NAME
ocf_heartbeat_aliyun-vpc-move-ip - Move IP within a VPC of the Aliyun ECS

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

## DESCRIPTION
Resource Agent to move IP addresses within a VPC of the Aliyun Webservices ECS by changing an entry in an specific routing table

## SUPPORTED PARAMETERS
aliyuncli

Path to command line tools for Aliyun (optional, string, default "detect")

address

VPC private IP address (required, string, no default)

routing_table

Name of the routing table, where the route for the IP address should be changed, i.e. vtb-... (required, string, no default)

interface

Name of the network interface, i.e. eth0 (required, string, default "eth0")

endpoint

An endpoint is the service entry of an Alibaba Cloud service, i.e. vpc.cn-beijing.aliyuncs.com (optional, string, default "vpc.aliyuncs.com")

profile

Valid Aliyun CLI profile name (see 'aliyun cli configure'). See https://www.alibabacloud.com/help/zh/product/29991.htm for more information about aliyun cli. (optional, string, default "default")

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

start

Starts the resource. Suggested minimum timeout: 180s.

stop

Stops the resource. Suggested minimum timeout: 180s.

monitor

Performs a detailed status check. Suggested minimum timeout: 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 aliyun-vpc-move-ip resource using the crm(8) shell:

```
primitive p_aliyun-vpc-move-ip ocf:heartbeat:aliyun-vpc-move-ip \

  params \

    address=string \

    routing_table=string \

    interface="eth0" \

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

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

```
pcs resource create p_aliyun-vpc-move-ip ocf:heartbeat:aliyun-vpc-move-ip \

  address=string \

  routing_table=string \

  interface="eth0" \

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

summary: Manages an arbitrary service

text:
# ocf_heartbeat_anything(7)

## NAME
ocf_heartbeat_anything - Manages an arbitrary service

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

## DESCRIPTION
This is a generic OCF RA to manage almost anything.

## SUPPORTED PARAMETERS
binfile

The full name of the binary to be executed. This is expected to keep running with the same pid and not just do something and exit. (required, string, no default)

cmdline_options

Command line options to pass to the binary (optional, string, no default)

workdir

The path from where the binfile will be executed. (optional, string, no default)

pidfile

File to read/write the PID from/to. (optional, string, default "/var/run/anything_RESOURCE_ID.pid")

logfile

File to write STDOUT to (optional, string, default "/dev/null")

errlogfile

File to write STDERR to (optional, string, no default)

user

User to run the command as (optional, string, default "root")

monitor_hook

Command to run in monitor operation (optional, string, no default)

stop_timeout

In the stop operation: Seconds to wait for kill -TERM to succeed before sending kill -SIGKILL. Defaults to 2/3 of the stop operation timeout. (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.

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

```
primitive p_anything ocf:heartbeat:anything \

  params \

    binfile=string \

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

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

```
pcs resource create p_anything ocf:heartbeat:anything \

  binfile=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_apache(7)

summary: Manages an Apache Web server instance

text:
# ocf_heartbeat_apache(7)

## NAME
ocf_heartbeat_apache - Manages an Apache Web server instance

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

## DESCRIPTION
This is the resource agent for the Apache Web server. This resource agent operates both version 1.x and version 2.x Apache servers.

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

The monitor operation by default loads the server status page which depends on the mod_status module and the corresponding configuration file (usually /etc/apache2/mod_status.conf). Make sure that the server status page works and that the access is allowed *only* from localhost (address 127.0.0.1). See the statusurl and testregex attributes for more details.

See also http://httpd.apache.org/

## SUPPORTED PARAMETERS
configfile

The full pathname of the Apache configuration file. This file is parsed to provide defaults for various other resource agent parameters. (unique, optional, string, default "/etc/httpd/conf/httpd.conf")

httpd

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

port

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

statusurl

The URL to monitor (the apache server status page by default). If left unspecified, it will be inferred from the apache configuration file. If you set this, make sure that it succeeds *only* from the localhost (127.0.0.1). Otherwise, it may happen that the cluster complains about the resource being active on multiple nodes.

(optional, string, no default)

testregex

Regular expression to match in the output of statusurl. Case insensitive. (optional, string, default "exists, but impossible to show in a human readable format (try grep testregex)")

client

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

testurl

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

testregex10

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

testconffile

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

(optional, string, no default)

testname

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

options

Extra options to apply when starting apache. See man httpd(8). (optional, string, no default)

envfiles

Files (one or more) which contain extra environment variables. If you want to prevent script from reading the default file, set this parameter to empty string. (optional, string, default "/etc/apache2/envvars")

use_ipv6

We will try to detect if the URL (for monitor) is IPv6, but if that doesn't work set this to true to enforce IPv6. (optional, boolean, default false)

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

start

Starts the resource. Suggested minimum timeout: 40s.

stop

Stops the resource. Suggested minimum timeout: 60s.

status

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

monitor

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

meta-data

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

validate-all

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

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

```
primitive p_apache ocf:heartbeat:apache \

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

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

```
pcs resource create p_apache ocf:heartbeat:apache \

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

summary: Manages an Asterisk PBX

text:
# ocf_heartbeat_asterisk(7)

## NAME
ocf_heartbeat_asterisk - Manages an Asterisk PBX

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

## DESCRIPTION
Resource agent for the Asterisk PBX. May manage an Asterisk PBX telephony system or a clone set that forms an Asterisk distributed device setup.

## SUPPORTED PARAMETERS
binary

Location of the Asterisk PBX server binary (optional, string, default "asterisk")

canary_binary

Location of the Asterisk PBX Canary server binary (optional, string, default "astcanary")

config

The Asterisk PBX configuration file (optional, string, default "/etc/asterisk/asterisk.conf")

user

User running Asterisk PBX daemon (optional, string, default "asterisk")

group

Group running Asterisk PBX daemon (for logfile and directory permissions) (optional, string, default "asterisk")

additional_parameters

Additional parameters which are passed to the Asterisk PBX on startup (e.g. -L <load> or -M <value>). (optional, string, default "-g -vvv")

realtime

Determines whether the Asterisk PBX daemon will be run with realtime priority or not. (optional, boolean, default false)

maxfiles

Determines how many files the Asterisk PBX is allowed to open at a time. Helps to fix the 'Too many open files' error message. (optional, integer, default 8192)

monitor_sipuri

A SIP URI to check when monitoring. During monitor, the agent will attempt to do a SIP OPTIONS request against this URI. Requires the sipsak utility to be present and executable. If unset, the agent does no SIP URI monitoring. (optional, string, no default)

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

start

Starts the resource. Suggested minimum timeout: 20s.

stop

Stops the resource. Suggested minimum timeout: 20s.

status

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

monitor

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

```
primitive p_asterisk ocf:heartbeat:asterisk \

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

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

```
pcs resource create p_asterisk ocf:heartbeat:asterisk \

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

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

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


title: ocf_heartbeat_aws-vpc-move-ip(7)

summary: Move IP within a VPC of the AWS EC2

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

## NAME
ocf_heartbeat_aws-vpc-move-ip - Move IP within a VPC of the AWS EC2

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

## DESCRIPTION
Resource Agent to move IP addresses within a VPC of the Amazon Webservices EC2 by changing an entry in an specific routing table

## SUPPORTED PARAMETERS
awscli

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

profile

Valid AWS CLI profile name (see ~/.aws/config and 'aws configure') (optional, string, default "default")

region

Valid AWS region name (e.g., 'us-west-2') (optional, string, no default)

ip

VPC private IP address (required, string, no default)

address

Deprecated IP address param. Use the ip param instead. (optional, string, no default)

routing_table

Name of the routing table(s), where the route for the IP address should be changed. If declaring multiple routing tables they should be separated by comma. Example: rtb-XXXXXXXX,rtb-YYYYYYYYY (required, string, no default)

routing_table_role

Role to use to query/update the route table (optional, string, no default)

interface

Name of the network interface, i.e. eth0 (required, string, default "eth0")

monapi

Enable enhanced monitoring using AWS API calls to check route table entry (optional, boolean, default false)

lookup_type

Name of resource type to lookup in route table. "InstanceId" : EC2 instance ID. (default) "NetworkInterfaceId" : ENI ID. (useful in shared VPC setups). (optional, string, default "InstanceId")

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

```
primitive p_aws-vpc-move-ip ocf:heartbeat:aws-vpc-move-ip \

  params \

    ip=string \

    routing_table=string \

    interface="eth0" \

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

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

```
pcs resource create p_aws-vpc-move-ip ocf:heartbeat:aws-vpc-move-ip \

  ip=string \

  routing_table=string \

  interface="eth0" \

  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_aws-vpc-route53(7)

summary: Update Route53 VPC record for AWS EC2

text:
# ocf_heartbeat_aws-vpc-route53(7)

## NAME
ocf_heartbeat_aws-vpc-route53 - Update Route53 VPC record for AWS EC2

## SYNOPSIS
aws-vpc-route53 [start | stop | monitor | meta-data | validate-all]

## DESCRIPTION
Update Route53 record of Amazon Webservices EC2 by updating an entry in a hosted zone ID table.

AWS instances will require policies which allow them to update Route53 ARecords: { "Version": "2012-10-17", "Statement": [ { "Sid": "Stmt1471878724000", "Effect": "Allow", "Action": [ "route53:ChangeResourceRecordSets", "route53:GetChange", "route53:ListResourceRecordSets", ], "Resource": [ "*" ] } ] }

Example Cluster Configuration:

Use a configuration in "crm configure edit" which looks as follows. Replace hostedzoneid, fullname and profile with the appropriate values:

primitive res_route53 ocf:heartbeat:aws-vpc-route53 params hostedzoneid=EX4MPL3EX4MPL3 fullname=service.cloud.example.corp. profile=cluster op start interval=0 timeout=180 op stop interval=0 timeout=180 op monitor interval=300 timeout=180 meta target-role=Started

## SUPPORTED PARAMETERS
awscli

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

profile

The name of the AWS CLI profile of the root account. This profile will have to use the "text" format for CLI output. The file /root/.aws/config should have an entry which looks like: [profile cluster] region = us-east-1 output = text

"cluster" is the name which has to be used in the cluster configuration. The region has to be the current one. The output has to be "text".

(optional, string, default "default")

hostedzoneid

Hosted zone ID of Route 53. This is the table of the Route 53 record. (required, string, no default)

fullname

The full name of the service which will host the IP address. Example: service.cloud.example.corp. Note: The trailing dot is important to Route53! (required, string, no default)

ip

IP (local (default), public or secondary private IP address (e.g. 10.0.0.1). A secondary private IP can be setup with the awsvip agent.

(optional, string, default "local")

ttl

Time to live for Route53 ARECORD (optional, string, default "10")

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

start

Starts the resource. Suggested minimum timeout: 180s.

stop

Stops the resource. Suggested minimum timeout: 180s.

monitor

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

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

```
primitive p_aws-vpc-route53 ocf:heartbeat:aws-vpc-route53 \

  params \

    hostedzoneid=string \

    fullname=string \

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

## EXAMPLE PCS
The following is an example configuration for a aws-vpc-route53 resource using pcs(8)

```
pcs resource create p_aws-vpc-route53 ocf:heartbeat:aws-vpc-route53 \

  hostedzoneid=string \

  fullname=string \

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

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

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


title: ocf_heartbeat_awseip(7)

text:
# ocf_heartbeat_awseip(7)

## NAME
ocf_heartbeat_awseip - Amazon AWS Elastic IP Address Resource Agent

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

## DESCRIPTION
Resource Agent for Amazon AWS Elastic IP Addresses.

It manages AWS Elastic IP Addresses with awscli.

Credentials needs to be setup by running "aws configure".

See https://aws.amazon.com/cli/ for more information about awscli.

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
awscli

command line tools for aws services (optional, string, default "/usr/bin/aws")

profile

Valid AWS CLI profile name (see ~/.aws/config and 'aws configure') (optional, string, default "default")

elastic_ip

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

allocation_id

reserved allocation id for ec2 instance (unique, required, string, no default)

private_ip_address

predefined private ip address for ec2 instance (unique, optional, string, no default)

api_delay

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

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

start

Starts the resource. Suggested minimum timeout: 30s.

stop

Stops the resource. Suggested minimum timeout: 30s.

monitor

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

migrate_to

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

migrate_from

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

meta-data

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

validate

Suggested minimum timeout: 10s.

validate-all

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

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

```
primitive p_awseip ocf:heartbeat:awseip \

  params \

    elastic_ip=string \

    allocation_id=string \

  meta allow-migrate="true" \

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

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

```
pcs resource create p_awseip ocf:heartbeat:awseip \

  elastic_ip=string \

  allocation_id=string \

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

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

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


title: ocf_heartbeat_awsvip(7)

text:
# ocf_heartbeat_awsvip(7)

## NAME
ocf_heartbeat_awsvip - Amazon AWS Secondary Private IP Address Resource Agent

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

## DESCRIPTION
Resource Agent for Amazon AWS Secondary Private IP Addresses.

It manages AWS Secondary Private IP Addresses with awscli.

Credentials needs to be setup by running "aws configure".

See https://aws.amazon.com/cli/ for more information about awscli.

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
awscli

command line tools for aws services (optional, string, default "/usr/bin/aws")

profile

Valid AWS CLI profile name (see ~/.aws/config and 'aws configure') (optional, string, default "default")

secondary_private_ip

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

api_delay

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

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

start

Starts the resource. Suggested minimum timeout: 30s.

stop

Stops the resource. Suggested minimum timeout: 30s.

monitor

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

migrate_to

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

migrate_from

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

meta-data

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

validate

Suggested minimum timeout: 10s.

validate-all

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

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

```
primitive p_awsvip ocf:heartbeat:awsvip \

  params \

    secondary_private_ip=string \

  meta allow-migrate="true" \

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

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

```
pcs resource create p_awsvip ocf:heartbeat:awsvip \

  secondary_private_ip=string \

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

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

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


title: ocf_heartbeat_azure-events(7)

text:
# ocf_heartbeat_azure-events(7)

## NAME
ocf_heartbeat_azure-events - Microsoft Azure Scheduled Events monitoring agent

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

## DESCRIPTION
This resource agent implements a monitor for scheduled (maintenance) events for a Microsoft Azure VM.

If any relevant events are found, it moves all Pacemaker resources away from the affected node to allow for a graceful shutdown.

Usage: [OCF_RESKEY_eventTypes=VAL] [OCF_RESKEY_verbose=VAL] azure-events ACTION

action (required): Supported values: monitor, help, meta-data eventTypes (optional): List of event types to be considered relevant by the resource agent (comma-separated). Supported values: Freeze,Reboot,Redeploy Default = Reboot,Redeploy / verbose (optional): If set to true, displays debug info. Default = false

Deployment: crm configure primitive rsc_azure-events ocf:heartbeat:azure-events op monitor interval=10s crm configure clone cln_azure-events rsc_azure-events

For further information on Microsoft Azure Scheduled Events, please refer to the following documentation: https://docs.microsoft.com/en-us/azure/virtual-machines/linux/scheduled-events

## SUPPORTED PARAMETERS
eventTypes

A comma-separated list of event types that will be handled by this resource agent. (Possible values: Freeze,Reboot,Redeploy) (optional, string, default "Reboot,Redeploy")

verbose

Set to true to enable verbose logging (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: 10s.

validate-all

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

monitor

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

meta-data

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

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

```
primitive p_azure-events ocf:heartbeat:azure-events \

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

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

```
pcs resource create p_azure-events ocf:heartbeat:azure-events \

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

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

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


title: ocf_heartbeat_azure-lb(7)

text:
# ocf_heartbeat_azure-lb(7)

## NAME
ocf_heartbeat_azure-lb - Answers Azure Load Balancer health probe requests

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

## DESCRIPTION
Resource agent to answer Azure Load Balancer health probe requests

## SUPPORTED PARAMETERS
nc

The full path of the used binary. This can be nc or socat path. The default is /usr/bin/nc and /usr/bin/socat for SUSE distributions. (optional, string, default "/usr/bin/nc")

port

Port to listen to. (optional, string, default "61000")

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

start

Starts the resource. Suggested minimum timeout: 20s.

stop

Stops the resource. Suggested minimum timeout: 20s.

monitor

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

meta-data

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

validate-all

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

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

```
primitive p_azure-lb ocf:heartbeat:azure-lb \

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

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

```
pcs resource create p_azure-lb ocf:heartbeat:azure-lb \

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

summary: clvmd

text:
# ocf_heartbeat_clvm(7)

## NAME
ocf_heartbeat_clvm - clvmd

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

## DESCRIPTION
This agent manages the clvmd daemon.

## SUPPORTED PARAMETERS
with_cmirrord

Start with cmirrord (cluster mirror log daemon). (optional, boolean, default false)

daemon_options

Options to clvmd. Refer to clvmd.8 for detailed descriptions. (optional, string, default "-d0")

activate_vgs

Whether or not to activate all cluster volume groups after starting the clvmd or not. Note that clustered volume groups will always be deactivated before the clvmd stops regardless of what this option is set to. (optional, boolean, default true)

exclusive

If set, only exclusive volume groups will be monitored. (optional, boolean, default false)

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

```
primitive p_clvm ocf:heartbeat:clvm \

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

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

```
pcs resource create p_clvm ocf:heartbeat:clvm \

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

summary: This resource agent manages conntrackd

text:
# ocf_heartbeat_conntrackd(7)

## NAME
ocf_heartbeat_conntrackd - This resource agent manages conntrackd

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

## DESCRIPTION
Master/Slave OCF Resource Agent for conntrackd

## SUPPORTED PARAMETERS
binary

Name of the conntrackd executable. If conntrackd is installed and available in the default PATH, it is sufficient to configure the name of the binary For example "my-conntrackd-binary-version-0.9.14" If conntrackd is installed somewhere else, you may also give a full path For example "/packages/conntrackd-0.9.14/sbin/conntrackd" (optional, string, default "conntrackd")

config

Full path to the conntrackd.conf file. For example "/packages/conntrackd-0.9.14/etc/conntrackd/conntrackd.conf" (optional, string, default "/etc/conntrackd/conntrackd.conf")

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

monitor (Master role)

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

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

```
primitive p_conntrackd ocf:heartbeat:conntrackd \

  op monitor timeout="20s" interval="20s" role="Slave" \

  op monitor timeout="20s" interval="10s" role="Master"
```

```
ms ms_conntrackd p_conntrackd \

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

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

```
pcs resource create p_conntrackd ocf:heartbeat:conntrackd \

  op monitor timeout="20s" interval="20s" role="Slave" \

  op monitor timeout="20s" interval="10s" role="Master" promotable
```

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

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


title: ocf_heartbeat_crypt(7)

summary: LUKS/crypt resource agent

text:
# ocf_heartbeat_crypt(7)

## NAME
ocf_heartbeat_crypt - LUKS/crypt resource agent

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

## DESCRIPTION
This is a LUKS/crypt Resource Agent managing encrypted devices via cryptsetup(8). The agent imposes limitations on device types supported: luks, luks[1..N].

## SUPPORTED PARAMETERS
encrypted_dev

Encrypted backing device, which should be defined by UUID, 36 characters including '-'s as reported by blkid(8). Although it can be defined as a block device path (e.g. /dev/sdh), the UUID should be preferred over the block device path to allow for the unique discovery of the crypt backing device given the volatile nature of /dev entries (e.g. /dev/sdh on one node may be /dev/sdg on another).

Only define as block device path if you know what you are doing.

(unique, required, string, no default)

crypt_dev

Encrypted device name, no path. I.e. the one given in "cryptsetup open name ...". The resulting block device path is /dev/mapper/name. (unique, required, string, no default)

key_file

Key file path containing the encryption passphrase (aka key; see cryptsetup(8)). For LUKS, the passphrase as of the key_file parameter is used to decrypt a randomly selected key when the device was created. (required, string, no default)

crypt_type

Encryption (device) type (e.g. "luks" or "luks2"). This parameter affirms the encryption format as of the crypt metadata thus allowing for safety measures when starting the encrypted resource.

(required, string, no default)

force_stop

If processes or kernel threads are using the crypt device, 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)

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

start

Starts the resource. Suggested minimum timeout: 20s.

stop

Stops the resource. Suggested minimum timeout: 20s.

monitor

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

meta-data

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

validate-all

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

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

```
primitive p_crypt ocf:heartbeat:crypt \

  params \

    encrypted_dev=string \

    crypt_dev=string \

    key_file=string \

    crypt_type=string \

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

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

```
pcs resource create p_crypt ocf:heartbeat:crypt \

  encrypted_dev=string \

  crypt_dev=string \

  key_file=string \

  crypt_type=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_db2(7)

text:
# ocf_heartbeat_db2(7)

## NAME
ocf_heartbeat_db2 - Resource Agent that manages an IBM DB2 LUW databases in Standard role as primitive or in HADR roles as master/slave configuration. Multiple partitions are supported.

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

## DESCRIPTION
Resource Agent that manages an IBM DB2 LUW databases in Standard role as primitive or in HADR roles in master/slave configuration. Multiple partitions are supported.

Standard mode:

An instance including all or selected databases is made highly available. Configure each partition as a separate primitive resource.

HADR mode:

A single database in HADR configuration is made highly available by automating takeover operations. Configure a master / slave resource with notifications enabled and an additional monitoring operation with role "Master".

In case of HADR be very deliberate in specifying intervals/timeouts. The detection of a failure including promote must complete within HADR_PEER_WINDOW.

In addition to honoring requirements for crash recovery etc. for your specific database use the following relations as guidance:

"monitor interval" < HADR_PEER_WINDOW - (appr 30 sec)

"promote timeout" < HADR_PEER_WINDOW + (appr 20 sec)

For further information and examples consult http://www.linux-ha.org/wiki/db2_(resource_agent)

## SUPPORTED PARAMETERS
instance

The instance of the database(s). (unique, required, string, no default)

dblist

List of databases to be managed, e.g "db1 db2". Defaults to all databases in the instance. Specify one db for HADR mode. (optional, string, no default)

admin

DEPRECATED: The admin user of the instance. (optional, string, no default)

dbpartitionnum

The number of the partition (DBPARTITIONNUM) to be managed. (optional, string, default "0")

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

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

monitor

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

monitor (Master role)

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

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

```
primitive p_db2 ocf:heartbeat:db2 \

  params \

    instance=string \

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

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

```
ms ms_db2 p_db2 \

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

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

```
pcs resource create p_db2 ocf:heartbeat:db2 \

  instance=string \

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

  op monitor OCF_CHECK_LEVEL="0" timeout="60s" role="Master" interval="22s" promotable
```

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

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


title: ocf_heartbeat_dhcpd(7)

text:
# ocf_heartbeat_dhcpd(7)

## NAME
ocf_heartbeat_dhcpd - Chrooted ISC DHCP server resource agent.

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

## DESCRIPTION
Manage an ISC DHCP server service in a chroot environment.

## SUPPORTED PARAMETERS
config

The absolute path to the DHCP server configuration file. (unique, required, string, no default)

chrooted

Configure the dhcpd service to run in a chrooted or non-chrooted mode. (unique, optional, boolean, default true)

chrooted_path

The absolute path of the chrooted DHCP environment. (unique, optional, string, default "/var/lib/dhcp")

binary

The binary for the DHCP server process. An absolute path definition is not required, but can be used to override environment path. (optional, string, default "dhcpd")

user

The system user the DHCP server process will run as when it is chrooted. (optional, string, default "dhcpd")

group

The system group the DHCP server process will run as when it is chrooted. (optional, string, default "nogroup")

interface

The network interface(s) the DHCP server process will bind to. A blank value will bind the process to all interfaces. (optional, string, no default)

includes

This parameter provides a means to copy include files into the chrooted environment. If a dhcpd.conf file contains a line similar to this: include "/etc/named.keys";

Then an admin also has to tell the dhcpd RA that this file should be pulled into the chrooted environment. This is a space delimited list.

(optional, string, no default)

leases

The leases database file, relative to chrooted_path. (optional, string, default "/db/dhcpd.leases")

pid

The path and filename of the PID file. It is relative to chrooted_path. (optional, string, default "/var/run/dhcpd.pid")

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

start

Starts the resource. Suggested minimum timeout: 20s.

stop

Stops the resource. Suggested minimum timeout: 20s.

restart

Suggested minimum timeout: 20s.

monitor

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

meta-data

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

validate-all

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

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

```
primitive p_dhcpd ocf:heartbeat:dhcpd \

  params \

    config=string \

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

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

```
pcs resource create p_dhcpd ocf:heartbeat:dhcpd \

  config=string \

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

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

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