title: ocf_heartbeat_awseip(7)

text:
# ocf_heartbeat_awseip(7)

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

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

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

It manages AWS Elastic IP Addresses with awscli.

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

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

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

## SUPPORTED PARAMETERS
awscli

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

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

elastic_ip

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

allocation_id

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

private_ip_address

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

region

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

api_delay

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

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

stop

Stops the resource. Suggested minimum timeout: 30s.

monitor

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

migrate_to

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

migrate_from

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

meta-data

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

validate

Suggested minimum timeout: 10s.

validate-all

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

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

```
primitive p_awseip ocf:heartbeat:awseip \

  params \

    elastic_ip=string \

    allocation_id=string \

  meta allow-migrate="true" \

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

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

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

  elastic_ip=string \

  allocation_id=string \

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

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

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


package: resource-agents

title: ocf_heartbeat_awsvip(7)

text:
# ocf_heartbeat_awsvip(7)

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

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

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

It manages AWS Secondary Private IP Addresses with awscli.

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

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

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

## SUPPORTED PARAMETERS
awscli

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

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

secondary_private_ip

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

region

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

api_delay

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

interface

Name of the network interface, i.e. eth0 (optional, string, no default)

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

stop

Stops the resource. Suggested minimum timeout: 30s.

monitor

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

migrate_to

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

migrate_from

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

meta-data

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

validate

Suggested minimum timeout: 10s.

validate-all

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

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

```
primitive p_awsvip ocf:heartbeat:awsvip \

  params \

    secondary_private_ip=string \

  meta allow-migrate="true" \

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

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

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

  secondary_private_ip=string \

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

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

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

branch: sisyphus


title: ocf_heartbeat_azure-events(7)

text:
# ocf_heartbeat_azure-events(7)

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

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

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

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

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

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

Deployment: crm configure primitive rsc_azure-events ocf:heartbeat:azure-events params eventTypes=Reboot,Redeploy verbose=false op monitor interval=10s crm configure clone cln_azure-events rsc_azure-events

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

## SUPPORTED PARAMETERS
eventTypes

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

verbose

Set to true to enable verbose logging (optional, boolean, default false)

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

start

Starts the resource. Suggested minimum timeout: 10s.

stop

Stops the resource. Suggested minimum timeout: 10s.

validate-all

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

monitor

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

meta-data

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

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

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

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

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

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

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

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

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


title: ocf_heartbeat_azure-events-az(7)

text:
# ocf_heartbeat_azure-events-az(7)

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

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

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

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

Deployment:

Set property and location constraint: crm configure property node-health-strategy=custom crm configure location loc_azure_health /'!health-.*'/ rule '#health-azure': defined '#uname'

Set #health-azure attribute to 0 (healthy) for every node in the cluster (example of node1 only): crm_attribute --node node1 --name '#health-azure' --update 0 Configure the RA: crm configure primitive health-azure-events ocf:heartbeat:azure-events-az params eventTypes="Reboot,Redeploy" verbose=false retry_count=3 retry_wait=20 request_timeout=15 op start start-delay=60s op monitor interval=10s meta failure-timeout=120s crm configure clone health-azure-events-cln health-azure-events meta allow-unhealthy-nodes=true

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

## SUPPORTED PARAMETERS
eventTypes

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

verbose

Set to true to enable verbose logging (optional, boolean, default false)

retry_count

Set to any number bigger than zero to enable retry count (optional, integer, default 3)

retry_wait

Set retry wait time in seconds (optional, integer, default 20)

request_timeout

Set request timeout in seconds (optional, integer, default 15)

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

start

Starts the resource. Suggested minimum timeout: 10s.

stop

Stops the resource. Suggested minimum timeout: 10s.

validate-all

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

monitor

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

meta-data

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

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

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

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

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

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

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

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

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


title: ocf_heartbeat_azure-lb(7)

text:
# ocf_heartbeat_azure-lb(7)

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

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

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

## SUPPORTED PARAMETERS
nc

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

port

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

listen

This parameter can have following walues: default: Neither -4 nor -6 will be used. The default behavior of socat and nc will be used. socat: Listen only on IPv4 addresses nc: If net.ipv6.bindv6only = 0 => Listen on both IPv4 and IP6 addresses If net.ipv6.bindv6only = 1 => Listen only on IPv4 addresses ipv4only: Listen only on IPv4 addresses. ipv6enable: Enable TCP6 support. nc: Listen only on IPv6 addresses independent of net.ipv6.bindv6only socat: If net.ipv6.bindv6only = 0 => Listen on both IPv4 and IP6 addresses. If net.ipv6.bindv6only = 1 => Listen only on IPv6 addresses. (optional, string, default "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 azure-lb resource using the crm(8) shell:

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

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

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

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

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

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

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


title: ocf_heartbeat_clvm(7)

summary: clvmd

text:
# ocf_heartbeat_clvm(7)

## NAME
ocf_heartbeat_clvm - clvmd

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

## DESCRIPTION
This agent manages the clvmd daemon.

## SUPPORTED PARAMETERS
with_cmirrord

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

daemon_options

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

activate_vgs

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

exclusive

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

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

start

Starts the resource. Suggested minimum timeout: 90s.

stop

Stops the resource. Suggested minimum timeout: 90s.

monitor

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

meta-data

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

validate-all

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

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

```
primitive p_clvm ocf:heartbeat:clvm \

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

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

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

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

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

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


title: ocf_heartbeat_conntrackd(7)

summary: This resource agent manages conntrackd

text:
# ocf_heartbeat_conntrackd(7)

## NAME
ocf_heartbeat_conntrackd - This resource agent manages conntrackd

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

## DESCRIPTION
Promotable OCF Resource Agent for conntrackd

## SUPPORTED PARAMETERS
binary

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

config

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

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

start

Starts the resource. Suggested minimum timeout: 30s.

promote

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

demote

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

notify

Suggested minimum timeout: 30s.

stop

Stops the resource. Suggested minimum timeout: 30s.

monitor (Unpromoted role)

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

monitor (Promoted role)

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

meta-data

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

validate-all

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

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

```
primitive p_conntrackd ocf:heartbeat:conntrackd \

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

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

```
ms ms_conntrackd p_conntrackd \

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

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

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

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

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

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

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


title: ocf_heartbeat_corosync-qnetd(7)

summary: Corosync QNet daemon resource agent

text:
# ocf_heartbeat_corosync-qnetd(7)

## NAME
ocf_heartbeat_corosync-qnetd - Corosync QNet daemon resource agent

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

## DESCRIPTION
OCF Resource script for corosync-qnetd. It manages a corosync-qnetd instance as a HA resource. It is required to copy nss db directory (usually /etc/corosync/qnetd/nssdb) across all nodes (only once - after database is initialized).

## SUPPORTED PARAMETERS
binary

Location of the corosync-qnetd binary (optional, string, default "/usr/bin/corosync-qnetd")

qnetd_opts

Additional options for corosync-qnetd binary. "-4" for example. (optional, string, no default)

qnetd_tool_binary

The absolute path to the corosync-qnetd-tool for monitoring with OCF_CHECK_LEVEL greater zero. (optional, string, default "/usr/bin/corosync-qnetd-tool")

ip

IP address to listen on. By default the daemon listens on all addresses (wildcard). (optional, string, no default)

port

TCP port to listen on. Default port is 5403. (optional, string, no default)

nss_db_dir

Location of the corosync-qnetd nss db directory (empty for default - usually /etc/corosync/qnetd/nssdb) (optional, string, no default)

pid

Location of the corosync-qnetd pid/lock (optional, string, default "/var/run/corosync-qnetd/corosync-qnetd-RESOURCE_ID.pid")

ipc_sock

Location of the corosync-qnetd ipc socket (optional, string, default "/var/run/corosync-qnetd/corosync-qnetd-RESOURCE_ID.sock")

user

User running corosync-qnetd (optional, string, default "coroqnetd")

group

Group running corosync-qnetd (optional, string, default "coroqnetd")

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

start

Starts the resource. Suggested minimum timeout: 20s.

stop

Stops the resource. Suggested minimum timeout: 20s.

status

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

monitor

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

validate-all

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

meta-data

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

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

```
primitive p_corosync-qnetd ocf:heartbeat:corosync-qnetd \

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

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

```
pcs resource create p_corosync-qnetd ocf:heartbeat:corosync-qnetd \

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

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

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


title: ocf_heartbeat_crypt(7)

summary: LUKS/crypt resource agent

text:
# ocf_heartbeat_crypt(7)

## NAME
ocf_heartbeat_crypt - LUKS/crypt resource agent

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

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

## SUPPORTED PARAMETERS
encrypted_dev

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

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

(unique, required, string, no default)

crypt_dev

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

key_file

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

crypt_type

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

(optional, string, no default)

force_stop

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

use_clevis

If LUKS volume is set up to unlock automatically using Tang/Clevis, then set this parameter to "true". This has the side-effect of ignoring the "key_file" and "crypt_type" parameters. (optional, boolean, default false)

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

start

Starts the resource. Suggested minimum timeout: 20s.

stop

Stops the resource. Suggested minimum timeout: 20s.

monitor

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

meta-data

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

validate-all

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

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

```
primitive p_crypt ocf:heartbeat:crypt \

  params \

    encrypted_dev=string \

    crypt_dev=string \

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

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

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

  encrypted_dev=string \

  crypt_dev=string \

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

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

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


title: ocf_heartbeat_db2(7)

text:
# ocf_heartbeat_db2(7)

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

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

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

Standard mode:

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

HADR mode:

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

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

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

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

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

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

## SUPPORTED PARAMETERS
instance

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

dblist

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

skip_basic_sql_health_check

Skip basic health check SQL query. Only set to "true" when the "monitor_retries" and "monitor_retry_all_errors" parameters arent enough to avoid issues under high load.

(optional, boolean, default false)

monitor_retries

Monitor retries before failing. (optional, string, default "1")

monitor_retries_sleep

Monitor sleep between tries. (optional, string, default "1")

monitor_retry_all_errors

Set to true to retry monitor-action for all errors instead of the default "db2pd" race conditions. (optional, string, default "false")

admin

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

dbpartitionnum

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

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

start

Starts the resource. Suggested minimum timeout: 120s.

stop

Stops the resource. Suggested minimum timeout: 120s.

promote

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

demote

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

monitor

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

monitor (Promoted role)

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

validate-all

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

meta-data

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

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

```
primitive p_db2 ocf:heartbeat:db2 \

  params \

    instance=string \

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

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

```
ms ms_db2 p_db2 \

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

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

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

  instance=string \

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

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

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

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


title: ocf_heartbeat_dhcpd(7)

text:
# ocf_heartbeat_dhcpd(7)

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

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

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

## SUPPORTED PARAMETERS
config

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

chrooted

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

chrooted_path

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

binary

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

user

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

group

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

interface

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

includes

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

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

(optional, string, no default)

leases

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

pid

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

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

start

Starts the resource. Suggested minimum timeout: 20s.

stop

Stops the resource. Suggested minimum timeout: 20s.

restart

Suggested minimum timeout: 20s.

monitor

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

meta-data

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

validate-all

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

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

```
primitive p_dhcpd ocf:heartbeat:dhcpd \

  params \

    config=string \

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

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

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

  config=string \

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

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

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


title: ocf_heartbeat_dnsupdate(7)

summary: IP take\-over via dynamic DNS update

text:
# ocf_heartbeat_dnsupdate(7)

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

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

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

## SUPPORTED PARAMETERS
hostname

Either the hostname whose IP address will need to be updated (in case of type=A) or alias whose hostname will need to be updated (in case of type=CNAME). (unique, required, string, no default)

type

The type of DNS record that need to be updated (A or CNAME). (optional, string, default "A")

ip

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

cname

The CNAME whose hostname address will need to be updated. (optional, string, no default)

ttl

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

(optional, integer, default 300)

keyfile

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

server

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

serverport

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

(optional, integer, default 53)

nsupdate_opts

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

unregister_on_stop

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

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

start

Starts the resource. Suggested minimum timeout: 30s.

stop

Stops the resource. Suggested minimum timeout: 30s.

status

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

monitor

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

meta-data

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

validate-all

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

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

```
primitive p_dnsupdate ocf:heartbeat:dnsupdate \

  params \

    hostname=string \

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

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

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

  hostname=string \

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

summary: Docker container resource agent.

text:
# ocf_heartbeat_docker(7)

## NAME
ocf_heartbeat_docker - Docker container resource agent.

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

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

## SUPPORTED PARAMETERS
image

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

name

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

allow_pull

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

run_opts

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

(optional, string, no default)

run_cmd

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

mount_points

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

monitor_cmd

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

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

(optional, string, no default)

force_kill

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

reuse

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

query_docker_health

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

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

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

(optional, boolean, no default)

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

start

Starts the resource. Suggested minimum timeout: 90s.

stop

Stops the resource. Suggested minimum timeout: 90s.

monitor

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

meta-data

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

validate-all

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

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

```
primitive p_docker ocf:heartbeat:docker \

  params \

    image=string \

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

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

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

  image=string \

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

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

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


title: ocf_heartbeat_docker-compose(7)

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

text:
# ocf_heartbeat_docker-compose(7)

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

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

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

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

## SUPPORTED PARAMETERS
binpath

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

dirpath

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

ymlfile

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

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

start

Starts the resource. Suggested minimum timeout: 240s.

stop

Stops the resource. Suggested minimum timeout: 20s.

monitor

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

validate-all

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

meta-data

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

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

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

  params \

    dirpath=string \

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

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

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

  dirpath=string \

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

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

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


title: ocf_heartbeat_dovecot(7)

text:
# ocf_heartbeat_dovecot(7)

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

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

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

## SUPPORTED PARAMETERS
binary

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

config_file

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

pid_file

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

parameters

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

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

start

Starts the resource. Suggested minimum timeout: 20s.

stop

Stops the resource. Suggested minimum timeout: 20s.

reload

Suggested minimum timeout: 20s.

monitor

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

validate-all

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

meta-data

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

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

```
primitive p_dovecot ocf:heartbeat:dovecot \

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

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

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

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

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

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


title: ocf_heartbeat_dummypy(7)

summary: Example stateless resource agent

text:
# ocf_heartbeat_dummypy(7)

## NAME
ocf_heartbeat_dummypy - Example stateless resource agent

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

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

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

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

## SUPPORTED PARAMETERS
state

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

fake

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

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

start

Starts the resource. Suggested minimum timeout: 20s.

stop

Stops the resource. Suggested minimum timeout: 20s.

monitor

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

reload

Suggested minimum timeout: 20s.

migrate_to

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

migrate_from

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

validate-all

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

meta-data

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

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

```
primitive p_dummypy ocf:heartbeat:dummypy \

  meta allow-migrate="true" \

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

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

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

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

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

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


title: ocf_heartbeat_eDir88(7)

text:
# ocf_heartbeat_eDir88(7)

## NAME
ocf_heartbeat_eDir88 - Manages a Novell eDirectory directory server

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

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

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

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

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

## SUPPORTED PARAMETERS
eDir_config_file

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

eDir_monitor_ldap

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

eDir_monitor_idm

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

eDir_jvm_initial_heap

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

eDir_jvm_max_heap

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

eDir_jvm_options

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

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

start

Starts the resource. Suggested minimum timeout: 600s.

stop

Stops the resource. Suggested minimum timeout: 600s.

monitor

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

meta-data

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

validate-all

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

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

```
primitive p_eDir88 ocf:heartbeat:eDir88 \

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

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

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

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

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

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


title: ocf_heartbeat_ethmonitor(7)

summary: Monitors network interfaces

text:
# ocf_heartbeat_ethmonitor(7)

## NAME
ocf_heartbeat_ethmonitor - Monitors network interfaces

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

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

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

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

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

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

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

## SUPPORTED PARAMETERS
interface

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

name

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

multiplier

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

repeat_count

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

repeat_interval

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

pktcnt_timeout

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

arping_count

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

arping_timeout

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

arping_cache_entries

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

infiniband_device

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

infiniband_port

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

link_status_only

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

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

start

Starts the resource. Suggested minimum timeout: 60s.

stop

Stops the resource. Suggested minimum timeout: 20s.

status

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

monitor

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

meta-data

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

validate-all

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

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

```
primitive p_ethmonitor ocf:heartbeat:ethmonitor \

  params \

    interface=string \

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

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

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

  interface=string \

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

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

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


title: ocf_heartbeat_galera(7)

summary: Manages a galera instance

text:
# ocf_heartbeat_galera(7)

## NAME
ocf_heartbeat_galera - Manages a galera instance

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

## DESCRIPTION
Resource script for managing galera database.

## SUPPORTED PARAMETERS
binary

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

client_binary

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

config

Configuration file (optional, string, no default)

datadir

Directory containing databases (optional, string, no default)

user

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

group

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

log

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

pid

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

socket

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

enable_creation

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

additional_parameters

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

wsrep_cluster_address

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

(required, string, no default)

cluster_host_map

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

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

(optional, string, no default)

check_user

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

check_passwd

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

check_passwd_use_empty

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

two_node_mode

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

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

start

Starts the resource. Suggested minimum timeout: 120s.

stop

Stops the resource. Suggested minimum timeout: 120s.

status

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

monitor

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

monitor (Promoted role)

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

promote

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

demote

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

validate-all

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

meta-data

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

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

```
primitive p_galera ocf:heartbeat:galera \

  params \

    wsrep_cluster_address=string \

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

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

```
ms ms_galera p_galera \

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

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

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

  wsrep_cluster_address=string \

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

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

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

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


title: ocf_heartbeat_garbd(7)

summary: Manages a galera arbitrator instance

text:
# ocf_heartbeat_garbd(7)

## NAME
ocf_heartbeat_garbd - Manages a galera arbitrator instance

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

## DESCRIPTION
Resource script for managing Galera arbitrator.

## SUPPORTED PARAMETERS
binary

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

user

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

group

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

log

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

pid

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

options

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

wsrep_cluster_address

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

(required, string, no default)

wsrep_cluster_name

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

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

start

Starts the resource. Suggested minimum timeout: 20s.

stop

Stops the resource. Suggested minimum timeout: 20s.

monitor

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

validate-all

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

meta-data

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

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

```
primitive p_garbd ocf:heartbeat:garbd \

  params \

    wsrep_cluster_address=string \

    wsrep_cluster_name=string \

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

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

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

  wsrep_cluster_address=string \

  wsrep_cluster_name=string \

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

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

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


title: ocf_heartbeat_gcp-ilb(7)

text:
# ocf_heartbeat_gcp-ilb(7)

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

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

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

## SUPPORTED PARAMETERS
port

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

cat

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

log_enable

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

log_cmd

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

(optional, string, default "gcloud")

log_params

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

log_end_params

Additional input for the logging application. Placed after the message being logged. (optional, string, no default)

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

start

Starts the resource. Suggested minimum timeout: 10s.

stop

Stops the resource. Suggested minimum timeout: 30s.

monitor

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

validate-all

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

meta-data

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

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

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

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

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

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

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

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

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


title: ocf_heartbeat_gcp-pd-move(7)

text:
# ocf_heartbeat_gcp-pd-move(7)

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

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

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

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

## SUPPORTED PARAMETERS
disk_name

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

disk_scope

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

disk_csek_file

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

mode

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

device_name

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

stackdriver_logging

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

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

start

Starts the resource. Suggested minimum timeout: 300s.

stop

Stops the resource. Suggested minimum timeout: 15s.

monitor

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

meta-data

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

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

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

  params \

    disk_name=string \

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

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

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

  disk_name=string \

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

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

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


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

summary: Move IP within a GCP VPC

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

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

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

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

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

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

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

## SUPPORTED PARAMETERS
gcloud

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

configuration

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

ip

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

vpc_network

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

interface

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

route_name

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

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

start

Starts the resource. Suggested minimum timeout: 180s.

stop

Stops the resource. Suggested minimum timeout: 180s.

monitor

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

validate-all

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

meta-data

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

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

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

  params \

    ip=string \

    vpc_network="default" \

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

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

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

  ip=string \

  vpc_network="default" \

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

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

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


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

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

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

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

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

## SUPPORTED PARAMETERS
alias_ip

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

alias_range_name

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

hostlist

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

project

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

serviceaccount

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

stackdriver_logging

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

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

start

Starts the resource. Suggested minimum timeout: 300s.

stop

Stops the resource. Suggested minimum timeout: 15s.

monitor

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

meta-data

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

validate-all

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

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

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

  params \

    alias_ip=string \

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

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

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

  alias_ip=string \

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

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

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


title: ocf_heartbeat_ids(7)

text:
# ocf_heartbeat_ids(7)

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

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

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

## SUPPORTED PARAMETERS
informixdir

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

informixserver

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

onconfig

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

dbname

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

sqltestquery

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

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

start

Starts the resource. Suggested minimum timeout: 120s.

stop

Stops the resource. Suggested minimum timeout: 120s.

status

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

monitor

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

validate-all

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

meta-data

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

methods

Suggested minimum timeout: 5s.

usage

Suggested minimum timeout: 5s.

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

```
primitive p_ids ocf:heartbeat:ids \

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

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

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

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

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

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


title: ocf_heartbeat_iface-bridge(7)

summary: Manages Bridge network interfaces.

text:
# ocf_heartbeat_iface-bridge(7)

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

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

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

## SUPPORTED PARAMETERS
bridge_name

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

bridge_slaves

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

bridge_ageing

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

port_hairpin

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

stp

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

stp_bridgeprio

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

stp_fd

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

stp_maxage

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

stp_hello

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

stp_pathcost

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

stp_portprio

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

multicast_router

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

multicast_snooping

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

multicast_port_router

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

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

start

Starts the resource. Suggested minimum timeout: 30s.

stop

Stops the resource. Suggested minimum timeout: 20s.

status

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

monitor

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

meta-data

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

validate-all

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

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

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

  params \

    bridge_name=string \

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

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

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

  bridge_name=string \

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

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

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


title: ocf_heartbeat_iface-macvlan(7)

summary: Manages MACVLAN network interfaces.

text:
# ocf_heartbeat_iface-macvlan(7)

## NAME
ocf_heartbeat_iface-macvlan - Manages MACVLAN network interfaces.

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

## DESCRIPTION
This resource manages MACVLAN network interfaces. It can add, remove, configure MACVLANs.

## SUPPORTED PARAMETERS
device

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

name

Define the MACVLAN NAME. It has to be a valid interface name (max 15 characters). (unique, required, string, no default)

mode

Define the name of the MACVLAN mode (currently only bridge is supported). (optional, string, default "bridge")

mac

Set the interface MAC address explicitly. (unique, optional, string, no default)

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

start

Starts the resource. Suggested minimum timeout: 30s.

stop

Stops the resource. Suggested minimum timeout: 20s.

status

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

monitor

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

meta-data

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

validate-all

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

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

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

  params \

    device=string \

    name=string \

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

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

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

  device=string \

  name=string \

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

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

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


title: ocf_heartbeat_iface-vlan(7)

summary: Manages VLAN network interfaces.

text:
# ocf_heartbeat_iface-vlan(7)

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

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

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

## SUPPORTED PARAMETERS
vlan_interface

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

vlan_id

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

vlan_name

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

vlan_reorder_hdr

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

vlan_gvrp

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

vlan_mvrp

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

vlan_loose_binding

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

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

start

Starts the resource. Suggested minimum timeout: 30s.

stop

Stops the resource. Suggested minimum timeout: 20s.

status

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

monitor

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

meta-data

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

validate-all

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

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

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

  params \

    vlan_interface=string \

    vlan_id=integer \

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

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

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

  vlan_interface=string \

  vlan_id=integer \

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

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

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


title: ocf_heartbeat_ipsec(7)

summary: Handles IPSEC tunnels for VIPs

text:
# ocf_heartbeat_ipsec(7)

## NAME
ocf_heartbeat_ipsec - Handles IPSEC tunnels for VIPs

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

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

## SUPPORTED PARAMETERS
tunnel

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

vip

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

confdir

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

fallbacktunnel

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

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

start

Starts the resource. Suggested minimum timeout: 20s.

stop

Stops the resource. Suggested minimum timeout: 20s.

monitor

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

reload

Suggested minimum timeout: 20s.

meta-data

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

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

```
primitive p_ipsec ocf:heartbeat:ipsec \

  params \

    tunnel=string \

    vip=string \

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

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

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

  tunnel=string \

  vip=string \

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

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

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


title: ocf_heartbeat_jboss(7)

text:
# ocf_heartbeat_jboss(7)

## NAME
ocf_heartbeat_jboss - Manages a JBoss application server instance

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

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

## SUPPORTED PARAMETERS
jboss_version

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

resource_name

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

console

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

shutdown_timeout

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

kill_timeout

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

user

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

statusurl

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

java_home

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

java_opts

Java options. (optional, string, no default)

jboss_home

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

jboss_base_dir

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

pstring

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

run_command

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

run_opts

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

shutdown_opts

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

rotate_consolelog

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

rotate_value

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

rotate_logsuffix

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

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

start

Starts the resource. Suggested minimum timeout: 60s.

stop

Stops the resource. Suggested minimum timeout: 120s.

status

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

monitor

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

meta-data

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

validate-all

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

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

```
primitive p_jboss ocf:heartbeat:jboss \

  params \

    jboss_home=string \

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

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

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

  jboss_home=string \

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

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

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


title: ocf_heartbeat_jira(7)

summary: JIRA OCF RA

text:
# ocf_heartbeat_jira(7)

## NAME
ocf_heartbeat_jira - JIRA OCF RA

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

## DESCRIPTION
OCF Resource Agent to manage JIRA software

## SUPPORTED PARAMETERS
statusurl

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

java_home

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

jira_installation

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

jira_user

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

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

start

Starts the resource. Suggested minimum timeout: 300s.

stop

Stops the resource. Suggested minimum timeout: 300s.

monitor

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

meta-data

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

validate-all

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

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

```
primitive p_jira ocf:heartbeat:jira \

  params \

    jira_installation=string \

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

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

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

  jira_installation=string \

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

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

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