title: ocf_heartbeat_sg_persist(7)

summary: Manages SCSI PERSISTENT RESERVATIONS

text:
# ocf_heartbeat_sg_persist(7)

## NAME
ocf_heartbeat_sg_persist - Manages SCSI PERSISTENT RESERVATIONS

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

## DESCRIPTION
This resource agent manages SCSI PERSISTENT RESERVATIONS. "sg_persist" from sg3_utils is used, please see its documentation. Should be used as multistate (Master/Slave) resource Slave registers its node id ("crm_node -i") as reservation key ( --param-rk ) on each device in the "devs" list. Master reserves all devices from "devs" list with reservation "--prout-type" value from "reservation_type" parameter.

## SUPPORTED PARAMETERS
binary

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

devs

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

required_devs_nof

Minimum number of "working" devices from device list 1) existing 2) "sg_persist --read-keys $device" works (Return code 0) resource actions "start","monitor","promote" and "validate-all" return "$OCF_ERR_INSTALLED" if the actual number of "working" devices is less then "required_devs_nof". resource actions "stop" and "demote" tries to remove reservations and registration keys from all working devices, but always return "$OCF_SUCCESS" (optional, string, default "1")

reservation_type

reservation type (optional, string, default "1")

master_score_base

master_score_base value "master_score_base" value is used in "master_score" calculation: master_score = $master_score_base + $master_score_dev_factor * $working_devs if set to bigger value in sg_persist resource configuration on some node, this node will be "preferred" for master role. (optional, string, default "0")

master_score_dev_factor

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

master_score_delay

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

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

start

Starts the resource. Suggested minimum timeout: 30s.

promote

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

demote

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

notify

Suggested minimum timeout: 30s.

stop

Stops the resource. Suggested minimum timeout: 30s.

monitor (Slave role)

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

monitor (Master role)

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

meta-data

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

validate-all

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

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

```
primitive p_sg_persist ocf:heartbeat:sg_persist \

  params \

    devs=string \

  op monitor depth="0" timeout="20s" interval="29s" role="Slave" \

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

```
ms ms_sg_persist p_sg_persist \

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

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

```
pcs resource create p_sg_persist ocf:heartbeat:sg_persist \

  devs=string \

  op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="29s" role="Slave" \

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

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

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


package: resource-agents

title: ocf_heartbeat_slapd(7)

summary: Manages a Stand\-alone LDAP Daemon (slapd) instance

text:
# ocf_heartbeat_slapd(7)

## NAME
ocf_heartbeat_slapd - Manages a Stand-alone LDAP Daemon (slapd) instance

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

## DESCRIPTION
Resource script for Stand-alone LDAP Daemon (slapd). It manages a slapd instance as an OCF resource.

## SUPPORTED PARAMETERS
slapd

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

ldapsearch

Full path to the ldapsearch binary. For example, "/usr/bin/ldapsearch". (optional, string, default "ldapsearch")

config

Full path to a slapd configuration directory or a slapd configuration file. For example, "/etc/ldap/slapd.d" or "/etc/ldap/slapd.conf". (unique, optional, string, no default)

pidfile

File to read the PID from; read from olcPidFile/pidfile in config if not set. (optional, string, no default)

user

User name or id slapd will run with. The group id is also changed to this user's gid, unless the group parameter is used to override. (optional, string, no default)

group

Group name or id slapd will run with. (optional, string, no default)

services

LDAP (and other scheme) URLs slapd will serve. For example, "ldap://127.0.0.1:389 ldaps:/// ldapi:///" (unique, optional, string, default "ldap:///")

watch_suffix

Suffix (database backend) that will be monitored for availability. Multiple suffixes can be specified by providing a space separated list. By providing one or more suffixes here, the ignore_suffix parameter is discarded. All suffixes will be monitored if left blank. (optional, string, no default)

ignore_suffix

Suffix (database backend) that will not be monitored for availability. Multiple suffixes can be specified by providing a space separated list. No suffix will be excluded if left blank. (optional, string, no default)

bind_dn

Distinguished Name used to bind to the LDAP directory for testing. Leave blank to bind to the LDAP directory anonymously. (optional, string, no default)

password

Password used to bind to the LDAP directory for testing. (optional, string, no default)

parameters

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

stop_escalate

Number of seconds to wait for shutdown (using SIGTERM) before resorting to SIGKILL (optional, integer, default 15)

maxfiles

Maximum number of open files (for ulimit -n) (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: 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 slapd resource using the crm(8) shell:

```
primitive p_slapd ocf:heartbeat:slapd \

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

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

```
pcs resource create p_slapd ocf:heartbeat:slapd \

  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_smb-share(7)

summary: Manages samba shares on the fly

text:
# ocf_heartbeat_smb-share(7)

## NAME
ocf_heartbeat_smb-share - Manages samba shares on the fly

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

## DESCRIPTION
This RA is used to control samba shares on the fly. For adding and removing samba shares no restart of the samba daemon is needed. This is the equivalent of the exportfs RA which is used for nfs shares.

For this RA to work as expected you need a cloned samba daemon which have to be startet before. After this RA manages config snippets placed in the filesystem and after a fence of that node these snippets will still located there you will have to use a tmpfs mount for this. Also you need a basic smb.conf file in which all global parameters an permanent shares should be placed. Within this smb.conf also you must put a line in the global section like this:

include = /etc/samba/conf.d/pacemaker-includes.conf

The filename can be changed by setting the parameter includesfile. Every share created by this RA will create a new file located in:

/etc/samba/conf.d/

This directory also can be changed by setting the RA parameter confd.

## SUPPORTED PARAMETERS
share

Set the name of a windows share which should be added to Samba example name "myshare" resulting in [myshare]. (unique, required, string, no default)

path

Set the path to share for cifs clients. example path "/srv/data/myshare". (unique, optional, string, no default)

hosts_allow

This parameter is a comma, space, or tab delimited set of hosts which are permitted to access a service. (optional, string, no default)

browseable

This controls whether this share is seen in the list of available shares in a net view and in the browse list. (optional, string, no default)

writeable

Inverted synonym for read only. (optional, string, no default)

read_only

This option can be used to turn the writing backends tdb, tdb2, and ldap into read only mode. This can be useful e.g. in cases where a pre-filled database exists that should not be extended automatically. (optional, string, no default)

guest_ok

If this parameter is yes for a service, then no password is required to connect to the service. Privileges will be those of the guest account. (optional, string, no default)

directory_mask

This parameter is the octal modes which are used when converting DOS modes to UNIX modes when creating UNIX directories. (optional, string, no default)

create_mask

When a file is created, the necessary permissions are calculated according to the mapping from DOS modes to UNIX permissions, and the resulting UNIX mode is then bit-wise ANDed with this parameter. This parameter may be thought of as a bit-wise MASK for the UNIX modes of a file. (optional, string, no default)

printable

If this parameter is yes, then clients may open, write to and submit spool files on the directory specified for the service. (optional, string, no default)

valid_users

This is a list of users that should be allowed to login to this service. Names starting with @, + and & are interpreted using the same rules as described in the invalid users parameter. (optional, string, no default)

force_user

This specifies a UNIX user name that will be assigned as the default user for all users connecting to this service. This is useful for sharing files. (optional, string, no default)

force_group

This specifies a UNIX group name that will be assigned as the default primary group for all users connecting to this service. This is useful for sharing files by ensuring that all access to files on service will use the named group for their permissions checking. (optional, string, no default)

extraopt

This option can be used to define an additional key = value pair. In this parameter also a semicolon could be placed. Need to set e.g somthinspecial = value (optional, string, no default)

extraopt_list

This option can be used to define multiple additional key = value pairs. Define the list of element semicolon separated. e.g somethingspecial = value;one more = value2 (optional, string, no default)

outfile

Set the path and filename where the snipped should be written. example "/etc/samba/conf.d/myshare.inc". (unique, required, string, no default)

confd

Set the path where the includes will be written. This folder have to be a tmpfs mount This defaults to "/etc/samba/conf.d". (optional, string, default "/etc/samba/conf.d")

includesfile

Set the path and filename in which the include should be placed. example includesfile "/etc/samba/conf.d/pacemaker-includes.conf". This option manages the include= parameter within this file (optional, string, default "/etc/samba/conf.d/pacemaker-includes.conf")

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

start

Starts the resource. Suggested minimum timeout: 20s.

stop

Stops the resource. Suggested minimum timeout: 20s.

status

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

monitor

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

meta-data

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

validate-all

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

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

```
primitive p_smb-share ocf:heartbeat:smb-share \

  params \

    share=string \

    outfile=string \

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

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

```
pcs resource create p_smb-share ocf:heartbeat:smb-share \

  share=string \

  outfile=string \

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

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

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


title: ocf_heartbeat_storage-mon(7)

summary: storage I/O health status

text:
# ocf_heartbeat_storage-mon(7)

## NAME
ocf_heartbeat_storage-mon - storage I/O health status

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

## DESCRIPTION
System health agent that checks the storage I/O status of the given drives and updates the #health-storage attribute. Usage is highly recommended in combination with the HealthSMART monitoring agent. The agent currently support a maximum of 25 devices per instance.

## SUPPORTED PARAMETERS
state_file

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

drives

The drive(s) to check as a SPACE separated list. Enter the full path to the device, e.g. "/dev/sda". (unique, required, string, no default)

io_timeout

Specify disk I/O timeout in seconds. Minimum 1, recommeded 10 (default). (optional, integer, default 10)

inject_errors

Used only for testing! Specify % of I/O errors to simulate drives failures. (optional, integer, 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: 120s.

monitor

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

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

```
primitive p_storage-mon ocf:heartbeat:storage-mon \

  params \

    drives=string \

  op monitor timeout="120s" interval="30s" start-delay="0s"
```

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

```
pcs resource create p_storage-mon ocf:heartbeat:storage-mon \

  drives=string \

  op monitor timeout="120s" interval="30s" start-delay="0s"
```

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

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


title: ocf_heartbeat_sybaseASE(7)

summary: Sybase ASE Failover Instance

text:
# ocf_heartbeat_sybaseASE(7)

## NAME
ocf_heartbeat_sybaseASE - Sybase ASE Failover Instance

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

## DESCRIPTION
Sybase ASE Failover Instance

## SUPPORTED PARAMETERS
sybase_home

The home directory of sybase products (optional, string, default "detect")

sybase_ase

The directory name under sybase_home where ASE products are installed (optional, string, default "detect")

sybase_ocs

The directory name under sybase_home where OCS products are installed, i.e. ASE-15_0 (optional, string, default "detect")

server_name

The ASE server name which is configured for the HA service (unique, required, string, no default)

interfaces_file

The full path of interfaces file which is used to start/access the ASE server (optional, string, default "detect/interfaces")

sybase_user

The user who can run ASE server (optional, string, default "sybase")

db_user

The database user required to login to isql. (required, string, no default)

db_passwd

The database user's password required to login to isql. (optional, string, no default)

logfile

Logfile (optional, string, default "detect")

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

start

Starts the resource. Suggested minimum timeout: 300s.

stop

Stops the resource. Suggested minimum timeout: 300s.

status

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

monitor

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

status

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

monitor

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

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

```
primitive p_sybaseASE ocf:heartbeat:sybaseASE \

  params \

    server_name=string \

    db_user=string \

  op monitor interval="30s" timeout="100s" \

  op monitor depth="10" timeout="100s" interval="120s"
```

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

```
pcs resource create p_sybaseASE ocf:heartbeat:sybaseASE \

  server_name=string \

  db_user=string \

  op monitor interval="30s" timeout="100s" \

  op monitor OCF_CHECK_LEVEL="10" timeout="100s" interval="120s"
```

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

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


title: ocf_heartbeat_symlink(7)

summary: Manages a symbolic link

text:
# ocf_heartbeat_symlink(7)

## NAME
ocf_heartbeat_symlink - Manages a symbolic link

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

## DESCRIPTION
This resource agent that manages a symbolic link (symlink).

It is primarily intended to manage configuration files which should be enabled or disabled based on where the resource is running, such as cron job definitions and the like.

## SUPPORTED PARAMETERS
link

Full path of the symbolic link to be managed. This must obviously be in a filesystem that supports symbolic links. (required, string, no default)

target

Full path to the link target (the file or directory which the symlink points to). (required, string, no default)

backup_suffix

A suffix to append to any files that the resource agent moves out of the way because they clash with "link". If this is unset (the default), then the resource agent will simply refuse to create a symlink if it clashes with an existing file.

(optional, string, no default)

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

start

Starts the resource. Suggested minimum timeout: 15s.

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

```
primitive p_symlink ocf:heartbeat:symlink \

  params \

    link=string \

    target=string \

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

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

```
pcs resource create p_symlink ocf:heartbeat:symlink \

  link=string \

  target=string \

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

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

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


title: ocf_heartbeat_syslog-ng(7)

summary: Syslog\-ng resource agent

text:
# ocf_heartbeat_syslog-ng(7)

## NAME
ocf_heartbeat_syslog-ng - Syslog-ng resource agent

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

## DESCRIPTION
This script manages a syslog-ng instance as an HA resource.

For Premium Edition you should set the following parameters (based on default path being "/opt/syslog-ng"): syslog_ng_binary="/opt/syslog-ng/sbin/syslog-ng" syslog_ng_ctl="/opt/syslog-ng/sbin/syslog-ng-ctl" control_file="/opt/syslog-ng/var/run/syslog-ng.ctl" persist_file="/opt/syslog-ng/var/syslog-ng.persist" pidfile="/opt/syslog-ng/var/run/syslog-ng.pid"

Additional parameter for Premium Edition 6 only: qdisk_dir="/opt/syslog-ng/var/"

## SUPPORTED PARAMETERS
configfile

This parameter specifies a configuration file for a syslog-ng instance managed by this RA. (required, string, no default)

syslog_ng_binary

This parameter specifies syslog-ng's executable file. (optional, string, default "/sbin/syslog-ng")

syslog_ng_ctl

This parameter specifies the path of the syslog-ng-ctl executable file. (optional, string, default "/sbin/syslog-ng-ctl")

qdisk_dir

This parameter specifies the directory used for holding disk buffers of syslog-ng (only supported in Premium Edition 6). (optional, string, no default)

control_file

This parameter specifies the path, where syslog-ng would place its control socket, through which it can be controlled. (optional, string, no default)

persist_file

This parameter specifies the path for syslog-ng's persist file, which holds persistent information about the mapping of destinations and disk buffers, the internal state of sources, etc. (optional, string, no default)

pidfile

This parameter specifies the path where the pid file of syslog-ng resides. (optional, string, no default)

start_opts

This parameter specifies startup options for a syslog-ng instance managed by this RA. When no value is given, no startup options is used. Don't use option '-F'. It causes a stuck of a start action. (optional, string, no default)

kill_term_timeout

On a stop action, a normal stop method(pkill -TERM) is firstly used. And then the confirmation of its completion is waited for the specified seconds by this parameter. The default value is 10. (optional, integer, default 10)

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

start

Starts the resource. Suggested minimum timeout: 60s.

stop

Stops the resource. Suggested minimum timeout: 120s.

status

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

monitor

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

meta-data

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

validate-all

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

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

```
primitive p_syslog-ng ocf:heartbeat:syslog-ng \

  params \

    configfile=string \

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

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

```
pcs resource create p_syslog-ng ocf:heartbeat:syslog-ng \

  configfile=string \

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

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

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


title: ocf_heartbeat_varnish(7)

summary: Manage a Varnish instance

text:
# ocf_heartbeat_varnish(7)

## NAME
ocf_heartbeat_varnish - Manage a Varnish instance

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

## DESCRIPTION
The Varnish Resource Agent can manage several varnishd instances throughout the cluster. It does so by creating a unique PID file and requires a unique listen address and name for each instance.

## SUPPORTED PARAMETERS
config

The VCL configuration file that Varnish should manage, for example "/etc/varnish/default.vcl". (unique, required, string, no default)

name

Override the name of the instance that should be given to Varnish (defaults to the resource identifier). (unique, optional, string, default "RESOURCE_ID")

pid

Write the process's PID to the specified file. The default will include the specified name, i.e.: "/var/run/varnish_production.pid". Unlike what this help message shows, it is most likely not necessary to change this parameter. (unique, optional, string, default "/var/run/varnishd_RESOURCE_ID.pid")

listen_address

Listen on this address:port, for example "192.168.1.1:80" (unique, optional, string, default "0.0.0.0:80")

mgmt_address

Provide a management interface, for example "127.0.0.1:2222" (unique, required, string, no default)

ttl

Specify a hard minimum time to live for cached documents. (optional, integer, default 600)

varnish_user

Specify the name of an unprivileged user to which the child process should switch before it starts accepting connections. (optional, string, default "varnish")

varnish_group

Specify the name of an unprivileged group to which the child process should switch before it starts accepting connections. (optional, string, default "varnish")

backend_type

Use the specified storage backend. Valid options are 'malloc' for memory and 'file' for a file backend. (optional, string, default "malloc")

backend_size

Specify the size of the backend. For example "1G". (optional, string, default "1G")

backend_file

Specify the backend filename if you use backend_type file. For example /var/lib/varnish/mybackend.bin (unique, optional, string, default "/var/lib/varnish/RESOURCE_ID.bin")

threads_pools

Number of worker thread pools. Each pool has the minimum, maximum and timeout values configured in the thread_pool_min, thread_pool_max and thread_pool_timeout parameters (optional, string, default "2")

thread_pool_min

Start at least min but no more than max worker threads with the specified idle timeout in each pool. (optional, string, default "100")

thread_pool_max

Start at least min but no more than max worker threads with the specified idle timeout in each pool. (optional, string, default "3000")

thread_pool_timeout

Start at least min but no more than max worker threads with the specified idle timeout in each pool. (optional, string, default "120")

client_binary

This is used to control Varnish via a CLI. It's currently only used to check the status of the running child process. (optional, string, default "varnishadm")

maxfiles

Maximum number of open files (for ulimit -n) (optional, string, default "131072")

max_locked_memory

Locked shared memory limit (for ulimit -l) (optional, string, default "82000")

secret

Path to a file containing a secret used for authorizing access to the management port. (optional, string, default "/etc/varnish/secret")

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

status

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

meta-data

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

validate-all

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

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

```
primitive p_varnish ocf:heartbeat:varnish \

  params \

    config=string \

    mgmt_address=string \

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

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

```
pcs resource create p_varnish ocf:heartbeat:varnish \

  config=string \

  mgmt_address=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_vdo-vol(7)

summary: VDO resource agent

text:
# ocf_heartbeat_vdo-vol(7)

## NAME
ocf_heartbeat_vdo-vol - VDO resource agent

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

## DESCRIPTION
OCF Resource script for VDO (Virtual Data Optimizer) volume(s). It manages VDO volume(s) as a HA resource.

The configuration file needs to be synced to all nodes, and the systemd vdo service must be disabled when using this agent.

## SUPPORTED PARAMETERS
config

Configuration file (optional, string, no default)

volume

VDO Volume (leave empty for all) (optional, string, no default)

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

start

Starts the resource. Suggested minimum timeout: 60s.

stop

Stops the resource. Suggested minimum timeout: 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 vdo-vol resource using the crm(8) shell:

```
primitive p_vdo-vol ocf:heartbeat:vdo-vol \

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

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

```
pcs resource create p_vdo-vol ocf:heartbeat:vdo-vol \

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

text:
# ocf_heartbeat_vmware(7)

## NAME
ocf_heartbeat_vmware - Manages VMWare Server 2.0 virtual machines

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

## DESCRIPTION
OCF compliant script to control vmware server 2.0 virtual machines.

## SUPPORTED PARAMETERS
vmxpath

VMX configuration file path (required, string, no default)

vimshbin

vmware-vim-cmd executable path (optional, string, default "/usr/bin/vmware-vim-cmd")

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

meta-data

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

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

```
primitive p_vmware ocf:heartbeat:vmware \

  params \

    vmxpath=string \

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

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

```
pcs resource create p_vmware ocf:heartbeat:vmware \

  vmxpath=string \

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

summary: Manages an vsftpd

text:
# ocf_heartbeat_vsftpd(7)

## NAME
ocf_heartbeat_vsftpd - Manages an vsftpd

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

## DESCRIPTION
This script manages vsftpd

## SUPPORTED PARAMETERS
binpath

The vsftpd binary path. For example, "/usr/sbin/vsftpd" (optional, string, default "/usr/sbin/vsftpd")

conffile

The vsftpd configuration file name with full path. For example, "/etc/vsftpd/vsftpd.conf" (optional, string, default "/etc/vsftpd/vsftpd.conf")

pidfile

The vsftpd pidfile with full path. For example, "/var/run/vsftpd.pid" (optional, string, default "/var/run/vsftpd.pid")

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

start

Starts the resource. Suggested minimum timeout: 20s.

stop

Stops the resource. Suggested minimum timeout: 20s.

monitor

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

validate-all

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

meta-data

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

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

```
primitive p_vsftpd ocf:heartbeat:vsftpd \

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

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

```
pcs resource create p_vsftpd ocf:heartbeat:vsftpd \

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

summary: Zabbix server resource agent

text:
# ocf_heartbeat_zabbixserver(7)

## NAME
ocf_heartbeat_zabbixserver - Zabbix server resource agent

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

## DESCRIPTION
This is a Zabbix server Resource Agent for zabbix_server monitoring daemon. See: http://www.zabbix.com/

## SUPPORTED PARAMETERS
binary

Location of the zabbix_server binary. (optional, string, default "zabbix_server")

pid

Path to zabbix_server pidfile. As it's created by daemon itself it must be the same as specified in the Zabbix configuration file with parameter 'PidFile='. (unique, optional, string, default "/var/run/zabbix-server/zabbix_server.pid")

config

Path to zabbix_server configuration file. Assumed server default if not specified. (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.

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

```
primitive p_zabbixserver ocf:heartbeat:zabbixserver \

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

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

```
pcs resource create p_zabbixserver ocf:heartbeat:zabbixserver \

  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)


package: resource-agents-CTDB

title: ocf_heartbeat_CTDB(7)

summary: CTDB Resource Agent

text:
# ocf_heartbeat_CTDB(7)

## NAME
ocf_heartbeat_CTDB - CTDB Resource Agent

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

## DESCRIPTION
This resource agent manages CTDB, allowing one to use Clustered Samba in a Linux-HA/Pacemaker cluster. You need a shared filesystem (e.g. OCFS2 or GFS2) on which the CTDB lock will be stored. Create /etc/ctdb/nodes containing a list of private IP addresses of each node in the cluster, then configure this RA as a clone. This agent expects the samba and windbind resources to be managed outside of CTDB's control as a separate set of resources controlled by the cluster manager. The optional support for enabling CTDB management of these daemons will be depreciated.

For more information see http://linux-ha.org/wiki/CTDB_(resource_agent)

## SUPPORTED PARAMETERS
ctdb_recovery_lock

The location of a shared lock file or helper binary, common across all nodes. See CTDB documentation for details. (unique, required, string, no default)

ctdb_manages_samba

Should CTDB manage starting/stopping the Samba service for you? This will be deprecated in future, in favor of configuring a separate Samba resource. (optional, boolean, default no)

ctdb_manages_winbind

Should CTDB manage starting/stopping the Winbind service for you? This will be deprecated in future, in favor of configuring a separate Winbind resource. (optional, boolean, default no)

ctdb_service_smb

Name of smb init script. Only necessary if CTDB is managing Samba directly. Will usually be auto-detected. (optional, string, no default)

ctdb_service_nmb

Name of nmb init script. Only necessary if CTDB is managing Samba directly. Will usually be auto-detected. (optional, string, no default)

ctdb_service_winbind

Name of winbind init script. Only necessary if CTDB is managing Winbind directly. Will usually be auto-detected. (optional, string, no default)

ctdb_samba_skip_share_check

If there are very many shares it may not be feasible to check that all of them are available during each monitoring interval. In that case this check can be disabled. (optional, boolean, default yes)

ctdb_monitor_free_memory

If the amount of free memory drops below this value the node will become unhealthy and ctdb and all managed services will be shutdown. Once this occurs, the administrator needs to find the reason for the OOM situation, rectify it and restart ctdb with "service ctdb start". With CTDB 4.4.0 and later this parameter is ignored. (optional, integer, default 100)

ctdb_start_as_disabled

When set to yes, the CTDB node will start in DISABLED mode and not host any public ip addresses. (optional, boolean, default no)

ctdb_config_dir

The directory containing various CTDB configuration files. The "nodes" and "notify.sh" scripts are expected to be in this directory. (optional, string, default "/etc/ctdb")

ctdb_binary

Full path to the CTDB binary. (optional, string, default "/usr/bin/ctdb")

ctdbd_binary

Full path to the CTDB cluster daemon binary. (optional, string, default "/usr/sbin/ctdbd")

ctdb_socket

Full path to the domain socket that ctdbd will create, used for local clients to attach and communicate with the ctdb daemon. With CTDB 4.9.0 and later the socket path is hardcoded at build time, so this parameter is ignored. (unique, optional, string, default "/run/ctdb/ctdbd.socket")

ctdb_dbdir

The directory to put the local CTDB database files in. Persistent database files will be put in ctdb_dbdir/persistent. (unique, optional, string, default "/var/run")

ctdb_logfile

Full path to log file. To log to syslog instead, use the value "syslog". (optional, string, default "/var/log/ctdb/log.ctdb")

ctdb_rundir

Full path to ctdb runtime directory, used for storage of socket lock state. (optional, string, default "/run/ctdb")

ctdb_timeout

Indicates that ctdb should wait up to TIMEOUT seconds for a response to most commands sent to the CTDB daemon. (unique, optional, integer, default 10)

ctdb_debuglevel

What debug level to run at (0-10). Higher means more verbose. (optional, integer, default 2)

ctdb_max_open_files

Maximum number of open files (for ulimit -n) (optional, integer, no default)

smb_conf

Path to default samba config file. Only necessary if CTDB is managing Samba. (optional, string, default "/etc/samba/smb.conf")

smb_private_dir

The directory for smbd to use for storing such files as smbpasswd and secrets.tdb. Old versions of CTBD (prior to 1.0.50) required this to be on shared storage. This parameter should not be set for current versions of CTDB, and only remains in the RA for backwards compatibility. (unique, optional, string, no default)

smb_passdb_backend

Which backend to use for storing user and possibly group information. Only necessary if CTDB is managing Samba. (optional, string, default "tdbsam")

smb_idmap_backend

Which backend to use for SID/uid/gid mapping. Only necessary if CTDB is managing Samba. (optional, string, default "tdb2")

smb_fileid_algorithm

Which fileid:algorithm to use with vfs_fileid. The correct value depends on which clustered filesystem is in use, e.g.: for OCFS2, this should be set to "fsid". Only necessary if CTDB is managing Samba. (optional, string, no default)

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

start

Starts the resource. Suggested minimum timeout: 90s.

stop

Stops the resource. Suggested minimum timeout: 100s.

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

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

```
primitive p_CTDB ocf:heartbeat:CTDB \

  params \

    ctdb_recovery_lock=string \

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

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

```
pcs resource create p_CTDB ocf:heartbeat:CTDB \

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


package: resource-agents-WinPopup

title: ocf_heartbeat_WinPopup(7)

text:
# ocf_heartbeat_WinPopup(7)

## NAME
ocf_heartbeat_WinPopup - Sends an SMB notification message to selected hosts

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

## DESCRIPTION
Resource script for WinPopup. It sends WinPopups message to a sysadmin's workstation whenever a takeover occurs.

## SUPPORTED PARAMETERS
hostfile

The file containing the hosts to send WinPopup messages to. (required, string, default "hosts")

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

monitor

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

validate-all

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

meta-data

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

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

```
primitive p_WinPopup ocf:heartbeat:WinPopup \

  params \

    hostfile="hosts" \

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

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

```
pcs resource create p_WinPopup ocf:heartbeat:WinPopup \

  hostfile="hosts" \

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

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

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


package: resource-agents-fio

title: ocf_heartbeat_fio(7)

summary: fio IO load generator

text:
# ocf_heartbeat_fio(7)

## NAME
ocf_heartbeat_fio - fio IO load generator

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

## DESCRIPTION
fio is a generic I/O load generator. This RA allows start/stop of fio instances to simulate load on a cluster without configuring complex services.

## SUPPORTED PARAMETERS
args

Arguments to the fio client. Minimally, this should be a (list of) job descriptions to run. (optional, string, no default)

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

start

Starts the resource. Suggested minimum timeout: 60s.

stop

Stops the resource. Suggested minimum timeout: 60s.

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

```
primitive p_fio ocf:heartbeat:fio \

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

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

```
pcs resource create p_fio ocf:heartbeat:fio \

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

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

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


package: resource-agents-iSCSI

title: ocf_heartbeat_iSCSILogicalUnit(7)

summary: Manages iSCSI Logical Units (LUs)

text:
# ocf_heartbeat_iSCSILogicalUnit(7)

## NAME
ocf_heartbeat_iSCSILogicalUnit - Manages iSCSI Logical Units (LUs)

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

## DESCRIPTION
Manages iSCSI Logical Unit. An iSCSI Logical unit is a subdivision of an SCSI Target, exported via a daemon that speaks the iSCSI protocol.

## SUPPORTED PARAMETERS
implementation

The iSCSI target daemon implementation. Must be one of "iet", "tgt", "lio", or "lio-t". If unspecified, an implementation is selected based on the availability of management utilities, with "iet" being tried first, then "tgt", then "lio", then "lio-t". (optional, string, no default)

target_iqn

The iSCSI Qualified Name (IQN) that this Logical Unit belongs to. (required, string, no default)

lun

The Logical Unit number (LUN) exposed to initiators. (required, integer, no default)

path

The path to the block device exposed. Some implementations allow this to be a regular file, too. (required, string, no default)

scsi_id

The SCSI ID to be configured for this Logical Unit. The default is the resource name, truncated to 24 bytes. (unique, optional, string, default "RESOURCE_ID")

scsi_sn

The SCSI serial number to be configured for this Logical Unit. The default is a hash of the resource name, truncated to 8 bytes, meaning 26 hex characters. If you are using XenServer with multipath as iSCSI client, you MUST make sure this value is set, or else XenServer multipath will not be able to access the LUN (unique, optional, string, default "b3a49b7f")

emulate_tpu

The SCSI UNMAP command to be configured for this Logical Unit. Setting this integer to 1 will enable TPU IOCTL emulation. (optional, integer, no default)

emulate_3pc

The SCSI EXTENDED COPY command to be configured for this Logical Unit. Setting this integer to 1 will enable 3PC IOCTL emulation. (optional, integer, no default)

emulate_caw

The SCSI Compare and Write command to be configured for this Logical Unit. Setting this integer to 1 will enable CAW IOCTL emulation. (optional, integer, no default)

vendor_id

The SCSI vendor ID to be configured for this Logical Unit. (optional, string, no default)

product_id

The SCSI product ID to be configured for this Logical Unit. (optional, string, no default)

tgt_bstype

TGT specific backing store type. If you want to use aio, make sure your tgtadm is built against libaio. See tgtadm(8). (optional, string, no default)

tgt_bsoflags

TGT specific backing store open flags (direct|sync). See tgtadm(8). (optional, string, no default)

tgt_bsopts

TGT specific backing store options. See tgtadm(8). (optional, string, no default)

tgt_device_type

TGT specific device type. See tgtadm(8). (optional, string, no default)

additional_parameters

Additional LU parameters. A space-separated list of "name=value" pairs which will be passed through to the iSCSI daemon's management interface. The supported parameters are implementation dependent. Neither the name nor the value may contain whitespace. (optional, string, no default)

allowed_initiators

Allowed initiators. A space-separated list of initiators allowed to connect to this lun. Initiators may be listed in any syntax the target implementation allows. If this parameter is empty or not set, access to this lun will not be allowed from any initiator, if target is not in demo mode. This parameter is only necessary when using LIO.

(optional, string, no default)

lio_iblock

LIO iblock device name, a number starting from 0. Using distinct values here avoids a warning in LIO "LEGACY: SHARED HBA"; and it is necessary when using multiple LUNs started at the same time (eg. on node failover) to prevent a race condition in tcm_core on mkdir() in /sys/kernel/config/target/core/.

(optional, integer, default 0)

liot_bstype

LIO-T specific backing store type. If you want to use aio, set this to 'block'. If you want to use async IO, set this to 'fileio'. Async I/O works also with block devices, however - you need to understand the consequences. See targetcli(8). If using file backend, you need to create this file in advance. If you want to use SCSI Passthrough, set this to 'pscsi'. Do not use PSCSI unless you know exactly how it will be used. (optional, string, default "block")

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

start

Starts the resource. Suggested minimum timeout: 10s.

stop

Stops the resource. Suggested minimum timeout: 10s.

status

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

monitor

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

meta-data

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

validate-all

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

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

```
primitive p_iSCSILogicalUnit ocf:heartbeat:iSCSILogicalUnit \

  params \

    target_iqn=string \

    lun=integer \

    path=string \

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

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

```
pcs resource create p_iSCSILogicalUnit ocf:heartbeat:iSCSILogicalUnit \

  target_iqn=string \

  lun=integer \

  path=string \

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

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

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


title: ocf_heartbeat_iSCSITarget(7)

summary: iSCSI target export agent

text:
# ocf_heartbeat_iSCSITarget(7)

## NAME
ocf_heartbeat_iSCSITarget - iSCSI target export agent

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

## DESCRIPTION
Manages iSCSI targets. An iSCSI target is a collection of SCSI Logical Units (LUs) exported via a daemon that speaks the iSCSI protocol.

## SUPPORTED PARAMETERS
implementation

The iSCSI target daemon implementation. Must be one of "iet", "tgt", "lio", or "lio-t". If unspecified, an implementation is selected based on the availability of management utilities, with "iet" being tried first, then "tgt", then "lio", then "lio-t". (optional, string, no default)

iqn

The target iSCSI Qualified Name (IQN). Should follow the conventional "iqn.yyyy-mm.<reversed domain name>[:identifier]" syntax. (unique, required, string, no default)

tid

The iSCSI target ID. Required for tgt. (unique, optional, integer, no default)

portals

iSCSI network portal addresses. Not supported by all implementations. If unset, the default is to create one portal that listens on . (optional, string, default "0.0.0.0:3260")

iser_portals

iSCSI iSER network portal addresses. Not supported by all implementations. (optional, string, no default)

allowed_initiators

Allowed initiators. A space-separated list of initiators allowed to connect to this target. Initiators may be listed in any syntax the target implementation allows. If this parameter is empty or not set, access to this target will be allowed from any initiator. (optional, string, no default)

incoming_username

A username used for incoming initiator authentication. If unspecified, allowed initiators will be able to log in without authentication. This is a unique parameter, as it not allowed to re-use a single username across multiple target instances. (unique, optional, string, no default)

incoming_password

A password used for incoming initiator authentication. (optional, string, no default)

additional_parameters

Additional target parameters. A space-separated list of "name=value" pairs which will be passed through to the iSCSI daemon's management interface. The supported parameters are implementation dependent. Neither the name nor the value may contain whitespace. (optional, string, no default)

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

start

Starts the resource. Suggested minimum timeout: 10s.

stop

Stops the resource. Suggested minimum timeout: 10s.

status

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

monitor

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

meta-data

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

validate-all

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

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

```
primitive p_iSCSITarget ocf:heartbeat:iSCSITarget \

  params \

    iqn=string \

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

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

```
pcs resource create p_iSCSITarget ocf:heartbeat:iSCSITarget \

  iqn=string \

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

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

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


title: ocf_heartbeat_iscsi(7)

text:
# ocf_heartbeat_iscsi(7)

## NAME
ocf_heartbeat_iscsi - Manages a local iSCSI initiator and its connections to iSCSI targets

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

## DESCRIPTION
OCF Resource Agent for iSCSI. Add (start) or remove (stop) iSCSI targets.

## SUPPORTED PARAMETERS
portal

The iSCSI portal address in the form: {ip_address|hostname}[":"port] (required, string, no default)

target

The iSCSI target IQN. (unique, required, string, no default)

discovery_type

Target discovery type. Check the open-iscsi documentation for supported discovery types. (optional, string, default "sendtargets")

iscsiadm

open-iscsi administration utility binary. (optional, string, default "iscsiadm")

udev

If the next resource depends on the udev creating a device then we wait until it is finished. On a normally loaded host this should be done quickly, but you may be unlucky. If you are not using udev set this to "no", otherwise we will spin in a loop until a timeout occurs. (optional, string, default "yes")

try_recovery

If the iSCSI session exists but is currently inactive/broken, which is most probably due to network problems, the iSCSI layer will try to recover. If this parameter is set to true, we'll wait for the recovery to succeed. In that case the monitor operation can only time out so you should set the monitor op timeout attribute appropriately. (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: 30s.

monitor

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

validate-all

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

methods

Suggested minimum timeout: 5s.

meta-data

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

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

```
primitive p_iscsi ocf:heartbeat:iscsi \

  params \

    portal=string \

    target=string \

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

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

```
pcs resource create p_iscsi ocf:heartbeat:iscsi \

  portal=string \

  target=string \

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

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

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


package: resource-agents-libvirt

title: ocf_heartbeat_VirtualDomain(7)

text:
# ocf_heartbeat_VirtualDomain(7)

## NAME
ocf_heartbeat_VirtualDomain - Manages virtual domains through the libvirt virtualization framework

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

## DESCRIPTION
Resource agent for a virtual domain (a.k.a. domU, virtual machine, virtual environment etc., depending on context) managed by libvirtd.

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
config

Absolute path to the libvirt configuration file, for this virtual domain. (unique, required, string, no default)

hypervisor

Hypervisor URI to connect to. See the libvirt documentation for details on supported URI formats. The default is system dependent. Determine the system's default uri by running 'virsh --quiet uri'. (optional, string, no default)

force_stop

Always forcefully shut down ("destroy") the domain on stop. The default behavior is to resort to a forceful shutdown only after a graceful shutdown attempt has failed. You should only set this to true if your virtual domain (or your virtualization backend) does not support graceful shutdown. (optional, boolean, default 0)

migration_transport

Transport used to connect to the remote hypervisor while migrating. Please refer to the libvirt documentation for details on transports available. If this parameter is omitted, the resource will use libvirt's default transport to connect to the remote hypervisor. (optional, string, no default)

migration_user

The username will be used in the remote libvirt remoteuri/migrateuri. No user will be given (which means root) in the username if omitted If remoteuri is set, migration_user will be ignored.

(optional, string, no default)

migration_downtime

Define max downtime during live migration in milliseconds (optional, integer, default 0)

migration_speed

Define live migration speed per resource in MiB/s (optional, integer, default 0)

migration_network_suffix

Use a dedicated migration network. The migration URI is composed by adding this parameters value to the end of the node name. If the node name happens to be an FQDN (as opposed to an unqualified host name), insert the suffix immediately prior to the first period (.) in the FQDN. At the moment Qemu/KVM and Xen migration via a dedicated network is supported. Note: Be sure this composed host name is locally resolvable and the associated IP is reachable through the favored network. This suffix will be added to the remoteuri and migrateuri parameters.

See also the migrate_options parameter below.

(optional, string, no default)

migrateuri

You can also specify here if the calculated migrate URI is unsuitable for your environment. If migrateuri is set then migration_network_suffix, migrateport and

--migrateuri in migrate_options are effectively ignored. Use "%n" as the placeholder for the target node name.

Please refer to the libvirt documentation for details on guest migration.

(optional, string, no default)

migrate_options

Extra virsh options for the guest live migration. You can also specify here --migrateuri if the calculated migrate URI is unsuitable for your environment. If --migrateuri is set then migration_network_suffix and migrateport are effectively ignored. Use "%n" as the placeholder for the target node name. Please refer to the libvirt documentation for details on guest migration.

(optional, string, no default)

monitor_scripts

To additionally monitor services within the virtual domain, add this parameter with a list of scripts to monitor. Note: when monitor scripts are used, the start and migrate_from operations will complete only when all monitor scripts have completed successfully. Be sure to set the timeout of these operations to accommodate this delay.

(optional, string, no default)

autoset_utilization_cpu

If set true, the agent will detect the number of domainU's vCPUs from virsh, and put it into the CPU utilization of the resource when the monitor is executed. (optional, boolean, default true)

autoset_utilization_host_memory

If set true, the agent will detect the number of *Max memory* from virsh, and put it into the host_memory utilization of the resource when the monitor is executed. (optional, boolean, default true)

autoset_utilization_hv_memory

If set true, the agent will detect the number of *Max memory* from virsh, and put it into the hv_memory utilization of the resource when the monitor is executed. (optional, boolean, default true)

unset_utilization_cpu

If set true then the agent will remove the cpu utilization resource when the monitor is executed. (optional, boolean, default false)

unset_utilization_host_memory

If set true then the agent will remove the host_memory utilization resource when the monitor is executed. (optional, boolean, default false)

unset_utilization_hv_memory

If set true then the agent will remove the hv_memory utilization resource when the monitor is executed. (optional, boolean, default false)

migrateport

This port will be used in the qemu migrateuri. If unset, the port will be a random highport. (optional, integer, no default)

remoteuri

Use this URI as virsh connection URI to commuicate with a remote hypervisor. If remoteuri is set then migration_user and migration_network_suffix are effectively ignored. Use "%n" as the placeholder for the target node name.

Please refer to the libvirt documentation for details on guest migration.

(optional, string, no default)

save_config_on_stop

Changes to a running VM's config are normally lost on stop. This parameter instructs the RA to save the configuration back to the xml file provided in the "config" parameter. (optional, boolean, no default)

sync_config_on_stop

Setting this automatically enables save_config_on_stop. When enabled this parameter instructs the RA to call csync2 -x to synchronize the file to all nodes. csync2 must be properly set up for this to work. (optional, boolean, no default)

snapshot

Path to the snapshot directory where the virtual machine image will be stored. When this parameter is set, the virtual machine's RAM state will be saved to a file in the snapshot directory when stopped. If on start a state file is present for the domain, the domain will be restored to the same state it was in right before it stopped last. This option is incompatible with the 'force_stop' option. (optional, string, no default)

backingfile

When the VM is used in Copy-On-Write mode, this is the backing file to use (with its full path). The VMs image will be created based on this backing file. This backing file will never be changed during the life of the VM. (optional, string, no default)

stateless

If set to true and backingfile is defined, the start of the VM will systematically create a new qcow2 based on the backing file, therefore the VM will always be stateless. If set to false, the start of the VM will use the COW (<vmname>.qcow2) file if it exists, otherwise the first start will create a new qcow2 based on the backing file given as backingfile. (optional, boolean, default false)

copyindirs

List of directories for the virt-copy-in before booting the VM. Used only in stateless mode. (optional, string, no default)

shutdown_mode

virsh shutdown method to use. Please verify that it is supported by your virsh toolsed with 'virsh help shutdown' When this parameter is set --mode shutdown_mode is passed as an additional argument to the 'virsh shutdown' command. One can use this option in case default acpi method does not work. Verify that this mode is supported by your VM. By default --mode is not passed. (optional, string, no default)

start_resources

Start the virtual storage pools and networks used by the virtual machine before starting it or before live migrating it. (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.

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.

migrate_from

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

migrate_to

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

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

```
primitive p_VirtualDomain ocf:heartbeat:VirtualDomain \

  params \

    config=string \

  meta allow-migrate="true" \

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

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

```
pcs resource create p_VirtualDomain ocf:heartbeat:VirtualDomain \

  config=string \

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

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

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


package: resource-agents-lvm

title: ocf_heartbeat_LVM(7)

text:
# ocf_heartbeat_LVM(7)

## NAME
ocf_heartbeat_LVM - Controls the availability of an LVM Volume Group

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

## DESCRIPTION
Resource script for LVM. It manages an Linux Volume Manager volume (LVM) as an HA resource.

## SUPPORTED PARAMETERS
volgrpname

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

exclusive

If set, the volume group will be activated exclusively. This option works one of two ways. If the volume group has the cluster attribute set, then the volume group will be activated exclusively using clvmd across the cluster. If the cluster attribute is not set, the volume group will be activated exclusively using a tag and the volume_list filter. When the tag option is in use, the volume_list in lvm.con must be initialized. This can be as simple as setting 'volume_list = []' depending on your setup. (optional, boolean, default false)

tag

If "exclusive" is set on a non clustered volume group, this overrides the tag to be used. (optional, string, default "pacemaker")

partial_activation

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

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

monitor

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

methods

Suggested minimum timeout: 5s.

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

```
primitive p_LVM ocf:heartbeat:LVM \

  params \

    volgrpname=string \

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

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

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

  volgrpname=string \

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

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

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


package: resource-agents-nfs

title: ocf_heartbeat_exportfs(7)

summary: Manages NFS exports

text:
# ocf_heartbeat_exportfs(7)

## NAME
ocf_heartbeat_exportfs - Manages NFS exports

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

## DESCRIPTION
Exportfs uses the exportfs command to add/remove nfs exports. It does NOT manage the nfs server daemon. It depends on Linux specific NFS implementation details, so is considered not portable to other platforms yet.

## SUPPORTED PARAMETERS
clientspec

The client specification allowing remote machines to mount the directory (or directories) over NFS. Note: it follows the format defined in "man exportfs". For example, in the use case to export the directory(-ies) for multiple subnets, please do config a dedicated primitive for each subnet CIDR ip address, and do not attempt to use multiple CIDR ip addresses in a space separated list, like in /etc/exports.

(required, string, no default)

options

The options to pass to exportfs for the exported directory or directories. (optional, string, no default)

directory

The directory or directories to be exported using NFS. Multiple directories are separated by white space. (required, string, no default)

fsid

The fsid option to pass to exportfs. This can be a unique positive integer, a UUID (assuredly sans comma characters), or the special string "root" which is functionally identical to numeric fsid of 0. If multiple directories are being exported, then they are assigned ids sequentially starting with this fsid (fsid, fsid+1, fsid+2, ...). Obviously, in that case the fsid must be an integer. 0 (root) identifies the export as the root of an NFSv4 pseudofilesystem -- avoid this setting unless you understand its special status. This value will override any fsid provided via the options parameter. (required, string, no default)

unlock_on_stop

Relinquish NFS locks associated with this filesystem when the resource stops. Enabling this parameter is highly recommended unless the path exported by this exportfs resource is also exported by a different resource. Note: Unlocking is only possible on Linux systems where /proc/fs/nfsd/unlock_filesystem exists and is writable. If your system does not fulfill this requirement (on account of having an nonrecent kernel, for example), you may set this parameter to 0 to silence the associated warning.

(optional, boolean, default 1)

wait_for_leasetime_on_stop

When stopping (unexporting), wait out the NFSv4 lease time. Only after all leases have expired does the NFS kernel server relinquish all server-side handles on the exported filesystem. If this exportfs resource manages an export that resides on a mount point designed to fail over along with the NFS export itself, then enabling this parameter will ensure such failover is working properly. Note that when this parameter is set, your stop timeout MUST accommodate for the wait period. This parameter is safe to disable if none of your NFS clients are using NFS version 4 or later. (optional, boolean, default 0)

rmtab_backup

Back up those entries from the NFS rmtab that apply to the exported directory, to the specified backup file. The filename is interpreted as relative to the exported directory. This backup is required if clients are connecting to the export via NFSv3 over TCP. Note that a configured monitor operation is required for this functionality. To disable rmtab backups, set this parameter to the special string "none".

(optional, string, default ".rmtab")

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

start

Starts the resource. Suggested minimum timeout: 40s.

stop

Stops the resource. Suggested minimum timeout: 120s.

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

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

```
primitive p_exportfs ocf:heartbeat:exportfs \

  params \

    clientspec=string \

    directory=string \

    fsid=string \

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

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

```
pcs resource create p_exportfs ocf:heartbeat:exportfs \

  clientspec=string \

  directory=string \

  fsid=string \

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

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

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


title: ocf_heartbeat_nfsserver(7)

summary: Manages an NFS server

text:
# ocf_heartbeat_nfsserver(7)

## NAME
ocf_heartbeat_nfsserver - Manages an NFS server

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

## DESCRIPTION
Nfsserver helps one to manage the Linux nfs server as a failover-able resource in Linux-HA. It depends on Linux specific NFS implementation details, so is considered not portable to other platforms yet.

## SUPPORTED PARAMETERS
nfs_init_script

The default init script shipped with the Linux distro. The nfsserver resource agent offloads the start/stop/monitor work to the init script because the procedure to start/stop/monitor nfsserver varies on different Linux distro. In the event that this option is not set, this agent will attempt to use an init script at this location, /etc/init.d/nfsserver, or detect a systemd unit-file to use in the event that no init script is detected. (optional, string, default "auto detected")

nfs_no_notify

Do not send reboot notifications to NFSv3 clients during server startup. (optional, boolean, default false)

nfs_notify_foreground

Keeps the sm-notify attached to its controlling terminal and running in the foreground. (optional, boolean, default false)

nfs_smnotify_retry_time

Specifies the length of sm-notify retry time, in minutes, to continue retrying notifications to unresponsive hosts. If this option is not specified, sm-notify attempts to send notifications for 15 minutes. Specifying a value of 0 causes sm-notify to continue sending notifications to unresponsive peers until it is manually killed. (optional, integer, no default)

nfs_server_scope

RFC8881, 8.4.2.1 State Reclaim: If the server scope is different, the client should not attempt to reclaim locks. In this situation, no lock reclaim is possible. Any attempt to re-obtain the locks with non-reclaim operations is problematic since there is no guarantee that the existing filehandles will be recognized by the new server, or that if recognized, they denote the same objects. It is best to treat the locks as having been revoked by the reconfiguration event.

For lock reclaim to even be attempted, we have to define and set the same server scope for NFSD on all cluster nodes in the NFS failover cluster.

This agent won't "guess" a suitable server scope name for you, you need to explicitly specify this. But without it, NFSv4 lock reclaim after failover won't work properly. Suggested value: the failover "service IP".

(optional, string, no default)

nfs_ip

Comma separated list of floating IP addresses used to access the nfs service (optional, string, no default)

nfs_shared_infodir

The nfsserver resource agent will save nfs related information in this specific directory. And this directory must be able to fail-over before nfsserver itself. (optional, string, no default)

rpcpipefs_dir

The mount point for the sunrpc file system. Default is /var/lib/nfs/rpc_pipefs. This script will mount (bind) nfs_shared_infodir on /var/lib/nfs/ (cannot be changed), and this script will mount the sunrpc file system on /var/lib/nfs/rpc_pipefs (default, can be changed by this parameter). If you want to move only rpc_pipefs/ (e.g. to keep rpc_pipefs/ local) from default, please set this value. (optional, string, default "/var/lib/nfs/rpc_pipefs")

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

start

Starts the resource. Suggested minimum timeout: 40s.

stop

Stops the resource. Suggested minimum timeout: 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: 30s.

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

```
primitive p_nfsserver ocf:heartbeat:nfsserver \

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

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

```
pcs resource create p_nfsserver ocf:heartbeat:nfsserver \

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

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

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


package: resource-agents-tomcat

title: ocf_heartbeat_tomcat(7)

text:
# ocf_heartbeat_tomcat(7)

## NAME
ocf_heartbeat_tomcat - Manages a Tomcat servlet environment instance

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

## DESCRIPTION
Resource script for Tomcat. It manages a Tomcat instance as a cluster resource.

## SUPPORTED PARAMETERS
tomcat_name

The name of the resource, added as a Java parameter in JAVA_OPTS: -Dname=<tomcat_name> to Tomcat process on start. Used to ensure process is still running and must be unique.

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

script_log

Log file, used during start and stop operations. (unique, optional, string, default "/var/log/tomcat.log")

tomcat_stop_timeout

Time-out for stop operation. DEPRECATED (optional, integer, no default)

tomcat_suspend_trialcount

Maximum number of times to retry stop operation before suspending and killing Tomcat. DEPRECATED. Does not retry. (optional, integer, no default)

tomcat_user

The user who starts Tomcat. (optional, string, default "root")

statusurl

URL for state confirmation. (optional, string, default "http://127.0.0.1:8080")

max_stop_time

Number of seconds to wait during a stop before drastic measures (force kill) are used on the tomcat process. This number MUST be less than your cluster stop timeout for the resource. The default value is five seconds before the timeout value of stop operation. When it is over this value, it stops a process in kill commands. This parameter is only effective on Tomcat 6 or later. (optional, integer, no default)

java_home

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

java_opts

Java JVM options used on start and stop. (optional, string, no default)

catalina_home

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

catalina_base

Instance directory of Tomcat (unique, optional, string, no default)

catalina_out

Log file name of Tomcat (unique, optional, string, default "/logs/catalina.out")

catalina_pid

A PID file name for Tomcat. (unique, optional, string, no default)

force_systemd

Force use of systemd when available. (optional, string, default "0")

tomcat_start_script

Absolute path to the custom tomcat start script to use. (optional, string, no default)

tomcat_start_opts

Tomcat start options. (optional, string, no default)

catalina_opts

Catalina options, for the start operation only. (optional, string, no default)

catalina_tmpdir

Temporary directory of Tomcat (unique, optional, string, no default)

catalina_rotate_log

Rotate catalina.out flag. (optional, boolean, default NO)

catalina_rotatetime

catalina.out rotation interval (seconds). (optional, integer, default 86400)

java_endorsed_dirs

Java_endorsed_dirs of tomcat (unique, optional, string, no default)

logging_config

Logging_config of tomcat (unique, optional, string, no default)

logging_manager

Logging_manager of tomcat (unique, optional, string, no default)

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

start

Starts the resource. Suggested minimum timeout: 60s.

stop

Stops the resource. Suggested minimum timeout: 120s.

status

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

monitor

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

meta-data

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

validate-all

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

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

```
primitive p_tomcat ocf:heartbeat:tomcat \

  params \

    java_home=string \

    catalina_home=string \

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

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

```
pcs resource create p_tomcat ocf:heartbeat:tomcat \

  java_home=string \

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


package: resource-agents-xen

title: ocf_heartbeat_Xen(7)

text:
# ocf_heartbeat_Xen(7)

## NAME
ocf_heartbeat_Xen - Manages Xen unprivileged domains (DomUs)

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

## DESCRIPTION
Resource Agent for the Xen Hypervisor. Manages Xen virtual machine instances by mapping cluster resource start and stop, to Xen create and shutdown, respectively.

A note on names

We will try to extract the name from the config file (the xmfile attribute). If you use a simple assignment statement, then you should be fine. Otherwise, if there's some python acrobacy involved such as dynamically assigning names depending on other variables, and we will try to detect this, then please set the name attribute. You should also do that if there is any chance of a pathological situation where a config file might be missing, for example if it resides on a shared storage. If all fails, we finally fall back to the instance id to preserve backward compatibility.

Para-virtualized guests can also be migrated by enabling the meta_attribute allow-migrate.

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
xmfile

Absolute path to the Xen control file, for this virtual machine. (required, string, default "/etc/xen/vm/MyDomU")

name

Name of the virtual machine. (optional, string, no default)

shutdown_timeout

The Xen agent will first try an orderly shutdown using xl shutdown. Should this not succeed within this timeout, the agent will escalate to xl destroy, forcibly killing the node. If this is not set, it will default to two-third of the stop action timeout.

Setting this value to 0 forces an immediate destroy.

(optional, string, no default)

shutdown_acpi

Handle shutdown by simulating an ACPI power button event. Enable this to allow graceful shutdown for HVM domains without installed PV drivers. (optional, boolean, default 0)

allow_mem_management

This parameter enables dynamic adjustment of memory for start and stop actions used for Dom0 and the DomUs. The default is to not adjust memory dynamically. (optional, boolean, default 0)

node_ip_attribute

In case of a live migration, the system will default to using the IP address associated with the hostname via DNS or /etc/hosts. This parameter allows you to specify a node attribute that will be queried instead for the target node, overriding the IP address. This allows you to use a dedicated network for live migration traffic to a specific node.

Warning: make very sure the IP address does point to the right node. Or else the live migration will end up somewhere else, greatly confusing the cluster and causing havoc.

(optional, string, no default)

reserved_Dom0_memory

In case memory management is used, this parameter defines the minimum amount of memory to be reserved for the dom0. The default minimum memory is 512MB. (optional, string, default "512")

autoset_utilization_cpu

If set true, the agent will detect the number of domain's vCPUs from Xen, and put it into the CPU utilization of the resource when the monitor is executed. Before enabling make sure node utilization is also set (using NodeUtilization agent or manually) or the resource might not be able to start anywhere. (optional, boolean, default false)

autoset_utilization_hv_memory

If set true, the agent will detect the number of memory from Xen, and put it into the hv_memory utilization of the resource when the monitor is executed. Before enabling make sure node utilization is also set (using NodeUtilization agent or manually) or the resource might not be able to start anywhere. (optional, boolean, default false)

monitor_scripts

To additionally monitor services within the unprivileged domain, add this parameter with a list of scripts to monitor. (optional, string, no default)

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

start

Starts the resource. Suggested minimum timeout: 60s.

stop

Stops the resource. Suggested minimum timeout: 40s.

migrate_from

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

migrate_to

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

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

```
primitive p_Xen ocf:heartbeat:Xen \

  params \

    xmfile="/etc/xen/vm/MyDomU" \

  meta allow-migrate="true" \

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

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

```
pcs resource create p_Xen ocf:heartbeat:Xen \

  xmfile="/etc/xen/vm/MyDomU" \

  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)


rz-esil

package: rizin

title: rz-esil(7)

summary: Evaluable Strings Intermediate Language

text:
# rz-esil(7)

## NAME
ESIL - Evaluable Strings Intermediate Language

## DESCRIPTION
ESIL aims to describe a Forth-like representation for every target CPU opcode semantics. ESIL representations can be evaluated (interpreted) in order to emulate individual instructions.

## SYNTAX
Each command of an ESIL expression is separated by a comma

<source0>,<source1>,<operation>

<source>,<destination>,<operation>

<source_destination>,<operation>

## BASIC OPERATIONS
These operations should be enough to emulate most instructions of any architecture

=

Set the value of the destination to the value of the source

+

Add the values of source0 and source1 and push the result on the esil stack

-

Subtract the value of source0 from the value of source1 and push the result on the esil stack

*

Multiply the values of source0 and source1 and push the result on the esil stack

/

Divide the value of source1 by the value of source0

## BASIC OPERATIONS EXAMPLES (x86)
jmp eax -> eax,eip,=

## SEE ALSO
rizin(1)