title: ocf_heartbeat_IPaddr2(7)

text:
# ocf_heartbeat_IPaddr2(7)

## NAME
ocf_heartbeat_IPaddr2 - Manages virtual IPv4 and IPv6 addresses (Linux specific version)

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

## DESCRIPTION
This Linux-specific resource manages IP alias IP addresses. It can add an IP alias, or remove one. In addition, it can implement Cluster Alias IP functionality if invoked as a clone resource.

If used as a clone, "shared address with a trivial, stateless (autonomous) load-balancing/mutual exclusion on ingress" mode gets applied (as opposed to "assume resource uniqueness" mode otherwise). For that, Linux firewall (kernel and userspace) is assumed, and since recent distributions are ambivalent in plain "iptables" command to particular back-end resolution, "iptables-legacy" (when present) gets prioritized so as to avoid incompatibilities (note that respective ipt_CLUSTERIP firewall extension in use here is, at the same time, marked deprecated, yet said "legacy" layer can make it workable, literally, to this day) with "netfilter" one (as in "iptables-nft"). In that case, you should explicitly set clone-node-max >= 2, and/or clone-max < number of nodes. In case of node failure, clone instances need to be re-allocated on surviving nodes. This would not be possible if there is already an instance on those nodes, and clone-node-max=1 (which is the default).

When the specified IP address gets assigned to a respective interface, the resource agent sends unsolicited ARP (Address Resolution Protocol, IPv4) or NA (Neighbor Advertisement, IPv6) packets to inform neighboring machines about the change. This functionality is controlled for both IPv4 and IPv6 by shared 'arp_*' parameters.

## SUPPORTED PARAMETERS
ip

The IPv4 (dotted quad notation) or IPv6 address (colon hexadecimal notation) example IPv4 "192.168.1.1". example IPv6 "2001:db8:DC28:0:0:FC57:D4C8:1FFF". (unique, required, string, no default)

nic

The base network interface on which the IP address will be brought online. If left empty, the script will try and determine this from the routing table. Do NOT specify an alias interface in the form eth0:1 or anything here; rather, specify the base interface only. If you want a label, see the iflabel parameter.

Prerequisite:

There must be at least one static IP address, which is not managed by the cluster, assigned to the network interface. If you can not assign any static IP address on the interface, modify this kernel parameter:

sysctl -w net.ipv4.conf.all.promote_secondaries=1 # (or per device)

(optional, string, no default)

cidr_netmask

The netmask for the interface in CIDR format (e.g., 24 and not 255.255.255.0) If unspecified, the script will also try to determine this from the routing table.

(optional, string, no default)

broadcast

Broadcast address associated with the IP. It is possible to use the special symbols '+' and '-' instead of the broadcast address. In this case, the broadcast address is derived by setting/resetting the host bits of the interface prefix. (optional, string, no default)

proto

Proto to match when finding network. E.g. "kernel". (optional, string, no default)

iflabel

You can specify an additional label for your IP address here. This label is appended to your interface name. The kernel allows alphanumeric labels up to a maximum length of 15 characters including the interface name and colon (e.g. eth0:foobar1234)

A label can be specified in nic parameter but it is deprecated. If a label is specified in nic name, this parameter has no effect.

(optional, string, no default)

lvs_support

Enable support for LVS Direct Routing configurations. In case a IP address is stopped, only move it to the loopback device to allow the local node to continue to service requests, but no longer advertise it on the network. Notes for IPv6: It is not necessary to enable this option on IPv6. Instead, enable 'lvs_ipv6_addrlabel' option for LVS-DR usage on IPv6.

(optional, boolean, default false)

lvs_ipv6_addrlabel

Enable adding IPv6 address label so IPv6 traffic originating from the address's interface does not use this address as the source. This is necessary for LVS-DR health checks to realservers to work. Without it, the most recently added IPv6 address (probably the address added by IPaddr2) will be used as the source address for IPv6 traffic from that interface and since that address exists on loopback on the realservers, the realserver response to pings/connections will never leave its loopback. See RFC3484 for the detail of the source address selection. See also 'lvs_ipv6_addrlabel_value' parameter.

(optional, boolean, default true)

lvs_ipv6_addrlabel_value

Specify IPv6 address label value used when 'lvs_ipv6_addrlabel' is enabled. The value should be an unused label in the policy table which is shown by 'ip addrlabel list' command. You would rarely need to change this parameter. (optional, integer, default 99)

mac

Set the interface MAC address explicitly. Currently only used in case of the Cluster IP Alias. Leave empty to chose automatically. (optional, string, no default)

clusterip_hash

Specify the hashing algorithm used for the Cluster IP functionality. (optional, string, default "sourceip-sourceport")

unique_clone_address

If true, add the clone ID to the supplied value of IP to create a unique address to manage (optional, boolean, default false)

arp_interval

Specify the interval between unsolicited ARP (IPv4) or NA (IPv6) packets in milliseconds. This parameter is deprecated and used for the backward compatibility only. It is effective only for the send_arp binary which is built with libnet, and send_ua for IPv6. It has no effect for other arp_sender.

(optional, integer, default 200)

arp_count

Number of unsolicited ARP (IPv4) or NA (IPv6) packets to send at resource initialization. (optional, integer, default 5)

arp_count_refresh

For IPv4, number of unsolicited ARP packets to send during resource monitoring. Doing so helps mitigate issues of stuck ARP caches resulting from split-brain situations. (optional, integer, default 0)

arp_bg

Whether or not to send the ARP (IPv4) or NA (IPv6) packets in the background. The default is true for IPv4 and false for IPv6. (optional, string, no default)

arp_sender

For IPv4, the program to send ARP packets with on start. Available options are: - send_arp: default - ipoibarping: default for infiniband interfaces if ipoibarping is available - iputils_arping: use arping in iputils package - libnet_arping: use another variant of arping based on libnet (optional, string, no default)

send_arp_opts

For IPv4, extra options to pass to the arp_sender program. Available options are vary depending on which arp_sender is used. A typical use case is specifying '-A' for iputils_arping to use ARP REPLY instead of ARP REQUEST as Gratuitous ARPs.

(optional, string, no default)

flush_routes

Flush the routing table on stop. This is for applications which use the cluster IP address and which run on the same physical host that the IP address lives on. The Linux kernel may force that application to take a shortcut to the local loopback interface, instead of the interface the address is really bound to. Under those circumstances, an application may, somewhat unexpectedly, continue to use connections for some time even after the IP address is deconfigured. Set this parameter in order to immediately disable said shortcut when the IP address goes away. (optional, boolean, default false)

run_arping

For IPv4, whether or not to run arping for collision detection check. (optional, string, default "false")

nodad

For IPv6, do not perform Duplicate Address Detection when adding the address. (optional, string, default "false")

noprefixroute

Use noprefixroute flag (see 'man ip-address'). (optional, string, default "false")

preferred_lft

For IPv6, set the preferred lifetime of the IP address. This can be used to ensure that the created IP address will not be used as a source address for routing. Expects a value as specified in section 5.5.4 of RFC 4862. (optional, string, default "forever")

network_namespace

Specifies the network namespace to operate within. The namespace must already exist, and the interface to be used must be within the namespace. (optional, string, no default)

check_link_status

Consider the resource failed if the interface has status DOWN or LOWERLAYERDOWN. (optional, string, 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.

status

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

monitor

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

meta-data

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

validate-all

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

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

```
primitive p_IPaddr2 ocf:heartbeat:IPaddr2 \

  params \

    ip=string \

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

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

```
pcs resource create p_IPaddr2 ocf:heartbeat:IPaddr2 \

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


package: resource-agents

title: ocf_heartbeat_IPsrcaddr(7)

text:
# ocf_heartbeat_IPsrcaddr(7)

## NAME
ocf_heartbeat_IPsrcaddr - Manages the preferred source address for outgoing IP packets

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

## DESCRIPTION
Resource script for IPsrcaddr. It manages the preferred source address modification.

Note: DHCP should not be enabled for the interface serving the preferred source address. Enabling DHCP may result in unexpected behavior, such as the automatic addition of duplicate or conflicting routes. This may cause the IPsrcaddr resource to fail, or it may produce undesired behavior while the resource continues to run.

## SUPPORTED PARAMETERS
ipaddress

The IP address. (required, string, no default)

cidr_netmask

The netmask for the interface in CIDR format. (ie, 24), or in dotted quad notation 255.255.255.0). (optional, string, no default)

destination

The destination IP/subnet for the route (default: 0.0.0.0/0) (optional, string, default "0.0.0.0/0")

proto

Proto to match when finding network. E.g. "kernel". (optional, string, no default)

metric

Metric. Only needed if incorrect metric value is used. (optional, string, no default)

pref

IPv6 route preference (low, medium or high). Only needed if incorrect pref value is used. (optional, string, no default)

table

Table to modify and use for interface lookup. E.g. "local". The table has to have a route matching the "destination" parameter.

This can be used for policy based routing. See man ip-rule(8).

(optional, string, no default)

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

start

Starts the resource. Suggested minimum timeout: 20s.

stop

Stops the resource. Suggested minimum timeout: 20s.

monitor

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

validate-all

Performs a validation of the resource configuration. Suggested minimum timeout: 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 IPsrcaddr resource using the crm(8) shell:

```
primitive p_IPsrcaddr ocf:heartbeat:IPsrcaddr \

  params \

    ipaddress=string \

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

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

```
pcs resource create p_IPsrcaddr ocf:heartbeat:IPsrcaddr \

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

branch: sisyphus


title: ocf_heartbeat_LVM-activate(7)

text:
# ocf_heartbeat_LVM-activate(7)

## NAME
ocf_heartbeat_LVM-activate - This agent activates/deactivates logical volumes.

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

## DESCRIPTION
This agent manages LVM activation/deactivation work for a given volume group.

It supports the following modes, controlled by the vg_access_mode parameter:

* lvmlockd * system_id * clvmd * tagging

Notes:

1. There are two possible configuration combinations: lvmlockd+LVM-activate and clvm+LVM-activate. However, it is not possible to use both at the same time!

2. Put all "lvmlockd"/"clvmd" volume groups into auto management by the agent if using the cluster to manage at least one of them. If you manage some manually, the stop action of the lvmlockd agent may fail and the node may get fenced, because some DLM lockspaces might be in use and cannot be closed automatically.

3. The autoactivation property of volume group will be disabled when vg_access_mode is set to system_id.

Option: OCF_CHECK_LEVEL

The standard monitor operation of depth 0 checks if the VG or LV is valid. If you want deeper tests, set OCF_CHECK_LEVEL to 10:

10: read first 1 byte of the underlying device (raw read)

If there are many underlying devs in VG, it will only read one of the devs. This is not perfect solution for detecting underlying devices livable. e.g. iscsi SAN IO timeout will return EIO, and it makes monitor failed.

## SUPPORTED PARAMETERS
vgname

The volume group name. (required, string, no default)

lvname

If set, only the specified LV will be activated. (optional, string, no default)

vg_access_mode

This option decides which solution will be used to protect the volume group in cluster environment. Optional solutions are: lvmlockd, clvmd, system_id and tagging. (required, string, no default)

activation_mode

The activation mode decides the visibility of logical volumes in the cluster. There are two different modes: "shared" for cluster filesystem and "exclusive" for local filesystem. With "shared", an LV can be activated concurrently from multiple nodes. With "exclusive", an LV can be activated by one node at a time. This option only has effect on "lvmlockd"/"clvmd" vg_access_mode. For "system_id" and "tagging", they always mean exclusive activation.

(optional, string, default "exclusive")

tag

The tag used for tagging activation mode. (optional, string, default "pacemaker")

partial_activation

If set, the volume group will be activated partially even with some physical volumes missing. It helps to set to true when using mirrored logical volumes. (optional, string, default "false")

degraded_activation

Activate RAID LVs using the "degraded" activation mode. This allows RAID LVs to be activated with missing PVs if all data can be provided with RAID redundancy. The RAID level determines the number of PVs that are required for degraded activation to succeed. If fewer PVs are available, then degraded activation will fail. Also enable majority_pvs. (optional, string, default "false")

majority_pvs

If set, the VG system ID can be reassigned to a new host if a majority of PVs in the VG are present. Otherwise, VG failover with system ID will fail when the VG is missing PVs. Also enable degraded_activation when RAID LVs are used. (optional, string, 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 LVM-activate resource using the crm(8) shell:

```
primitive p_LVM-activate ocf:heartbeat:LVM-activate \

  params \

    vgname=string \

    vg_access_mode=string \

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

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

```
pcs resource create p_LVM-activate ocf:heartbeat:LVM-activate \

  vgname=string \

  vg_access_mode=string \

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

summary: Enables and disables SCSI devices through the kernel SCSI hot\-plug subsystem (deprecated)

text:
# ocf_heartbeat_LinuxSCSI(7)

## NAME
ocf_heartbeat_LinuxSCSI - Enables and disables SCSI devices through the kernel SCSI hot-plug subsystem (deprecated)

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

## DESCRIPTION
Deprecation warning: This agent makes use of Linux SCSI hot-plug functionality which has been superseded by SCSI reservations. It is deprecated and may be removed from a future release. See the scsi2reservation and sfex agents for alternatives. -- This is a resource agent for LinuxSCSI. It manages the availability of a SCSI device from the point of view of the linux kernel. It make Linux believe the device has gone away, and it can make it come back again.

## SUPPORTED PARAMETERS
scsi

The SCSI instance to be managed. (required, string, no default)

ignore_deprecation

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

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

start

Starts the resource. Suggested minimum timeout: 20s.

stop

Stops the resource. Suggested minimum timeout: 20s.

methods

Suggested minimum timeout: 5s.

status

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

monitor

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

meta-data

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

validate-all

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

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

```
primitive p_LinuxSCSI ocf:heartbeat:LinuxSCSI \

  params \

    scsi=string \

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

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

```
pcs resource create p_LinuxSCSI ocf:heartbeat:LinuxSCSI \

  scsi=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_MailTo(7)

text:
# ocf_heartbeat_MailTo(7)

## NAME
ocf_heartbeat_MailTo - Notifies recipients by email in the event of resource takeover

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

## DESCRIPTION
This is a resource agent for MailTo. It sends email to a sysadmin whenever a takeover occurs.

## SUPPORTED PARAMETERS
email

The email address of sysadmin. (required, string, no default)

subject

The subject of the email. (optional, string, default "Resource Group")

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

start

Starts the resource. Suggested minimum timeout: 10s.

stop

Stops the resource. Suggested minimum timeout: 10s.

status

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

monitor

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

meta-data

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

validate-all

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

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

```
primitive p_MailTo ocf:heartbeat:MailTo \

  params \

    email=string \

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

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

```
pcs resource create p_MailTo ocf:heartbeat:MailTo \

  email=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_ManageRAID(7)

summary: Manages RAID devices

text:
# ocf_heartbeat_ManageRAID(7)

## NAME
ocf_heartbeat_ManageRAID - Manages RAID devices

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

## DESCRIPTION
Manages starting, stopping and monitoring of RAID devices which are preconfigured in /etc/conf.d/HB-ManageRAID.

## SUPPORTED PARAMETERS
raidname

Name (case sensitive) of RAID to manage. (preconfigured in /etc/conf.d/HB-ManageRAID) (required, string, 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.

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

```
primitive p_ManageRAID ocf:heartbeat:ManageRAID \

  params \

    raidname=string \

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

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

```
pcs resource create p_ManageRAID ocf:heartbeat:ManageRAID \

  raidname=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_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)


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 "/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 Promotable 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 promotable cluster resource. The promotable 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 Promotable 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 promotable 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 (Unpromoted role)

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

monitor (Promoted 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="Unpromoted" \

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

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

  op monitor OCF_CHECK_LEVEL="0" timeout="60s" interval="119s" role="Promoted" 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 "/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 "/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

Credentials needs to be setup by running "aws configure", or by using AWS Policies.

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

## SUPPORTED PARAMETERS
awscli

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

auth_type

Authentication type "key" for AccessKey and SecretAccessKey set via "aws configure", or "role" to use AWS Policies. (optional, string, default "key")

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 (optional, string, default "eth0")

iflabel

You can specify an additional label for your IP address here. This label is appended to your interface name. The kernel allows alphanumeric labels up to a maximum length of 15 characters including the interface name and colon (e.g. eth0:foobar1234)

(optional, string, no default)

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")

curl_retries

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

curl_sleep

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

awscli_timeout

awscli cli-connect-timeout value (optional, integer, no default)

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

start

Starts the resource. Suggested minimum timeout: 180s.

stop

Stops the resource. Suggested minimum timeout: 180s.

monitor

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

  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 \

  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")

auth_type

Authentication type "key" for AccessKey and SecretAccessKey set via "aws configure", or "role" to use AWS Policies. (optional, string, default "key")

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")

curl_retries

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

curl_sleep

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

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