package: pacemaker

title: ocf_pacemaker_ClusterMon(7)

text:
# ocf_pacemaker_ClusterMon(7)

## NAME
ocf_pacemaker_ClusterMon - Runs crm_mon in the background, recording the cluster status to an HTML file

## SYNOPSIS
[OCF_RESKEY_user=string] [OCF_RESKEY_update=integer] [OCF_RESKEY_extra_options=string] [OCF_RESKEY_pidfile=string] [OCF_RESKEY_htmlfile=string]

ClusterMon [start | stop | monitor | meta-data | validate-all]

## DESCRIPTION
This is a ClusterMon Resource Agent. It outputs current cluster status to the html.

## SUPPORTED PARAMETERS
OCF_RESKEY_user = string [root]

The user we want to run crm_mon as The user we want to run crm_mon as

OCF_RESKEY_update = integer [15000]

Update interval in milliseconds How frequently should we update the cluster status (in milliseconds). For compatibility with old documentation, values less than 1000 will be treated as seconds.

OCF_RESKEY_extra_options = string []

Extra options Additional options to pass to crm_mon. Eg. -n -r

OCF_RESKEY_pidfile = string [/tmp/ClusterMon_.pid]

PID file PID file location to ensure only one instance is running

OCF_RESKEY_htmlfile = string [/tmp/ClusterMon_.html]

HTML output Location to write HTML output to.

## AUTHOR
Andrew Beekhof <andrew@beekhof.net>

Author.

branch: sisyphus


title: ocf_pacemaker_Dummy(7)

summary: Example stateless resource agent

text:
# ocf_pacemaker_Dummy(7)

## NAME
ocf_pacemaker_Dummy - Example stateless resource agent

## SYNOPSIS
[OCF_RESKEY_state=string] [OCF_RESKEY_passwd=string] [OCF_RESKEY_fake=string] [OCF_RESKEY_op_sleep=string] [OCF_RESKEY_fail_start_on=string] [OCF_RESKEY_envfile=string]

Dummy [start | stop | monitor | reload | reload-agent | migrate_to | migrate_from | validate-all | meta-data]

## DESCRIPTION
This is a dummy OCF resource agent. It does absolutely nothing except keep track of whether it is running or not, and can be configured so that actions fail or take a long time. Its purpose is primarily for testing, and to serve as a template for resource agent writers.

## SUPPORTED PARAMETERS
OCF_RESKEY_state = string [/Dummy-.state]

State file Location to store the resource state in.

OCF_RESKEY_passwd = string []

Password Fake password field

OCF_RESKEY_fake = string [dummy]

Fake attribute that can be changed to cause an agent reload Fake attribute that can be changed to cause an agent reload

OCF_RESKEY_op_sleep = string [0]

Operation sleep duration in seconds. Number of seconds to sleep during operations. This can be used to test how the cluster reacts to operation timeouts.

OCF_RESKEY_fail_start_on = string []

Report bogus start failure on specified host Start, migrate_from, and reload-agent actions will return failure if running on the host specified here, but the resource will run successfully anyway (future monitor calls will find it running). This can be used to test on-fail=ignore.

OCF_RESKEY_envfile = string []

Environment dump file If this is set, the environment will be dumped to this file for every call.

## AUTHOR
Andrew Beekhof <andrew@beekhof.net>

Author.


title: ocf_pacemaker_HealthCPU(7)

summary: System health CPU usage

text:
# ocf_pacemaker_HealthCPU(7)

## NAME
ocf_pacemaker_HealthCPU - System health CPU usage

## SYNOPSIS
[OCF_RESKEY_state=string] [OCF_RESKEY_yellow_limit=string] [OCF_RESKEY_red_limit=string] [OCF_RESKEY_dampening=string]

HealthCPU [start | stop | monitor | reload-agent | meta-data | validate-all]

## DESCRIPTION
System health agent that measures the CPU idling and updates the #health-cpu attribute.

## SUPPORTED PARAMETERS
OCF_RESKEY_state = string [/health-cpu-.state]

State file Location to store the resource state in.

OCF_RESKEY_yellow_limit = string [50]

Lower limit for yellow health attribute Lower (!) limit of idle percentage to switch the health attribute to yellow. I.e. the #health-cpu will go yellow if the %idle of the CPU falls below 50%.

OCF_RESKEY_red_limit = string [10]

Lower limit for red health attribute Lower (!) limit of idle percentage to switch the health attribute to red. I.e. the #health-cpu will go red if the %idle of the CPU falls below 10%.

OCF_RESKEY_dampening = string [30s]

The time to wait (dampening) in seconds for further changes before writing The time to wait (dampening) in seconds for further changes before writing

## AUTHOR
Andrew Beekhof <andrew@beekhof.net>

Author.


title: ocf_pacemaker_HealthIOWait(7)

text:
# ocf_pacemaker_HealthIOWait(7)

## NAME
ocf_pacemaker_HealthIOWait - System health based on CPU iowait measurement

## SYNOPSIS
[OCF_RESKEY_state=string] [OCF_RESKEY_yellow_limit=integer] [OCF_RESKEY_red_limit=integer] [OCF_RESKEY_dampening=string]

HealthIOWait [start | stop | monitor | reload-agent | meta-data | validate-all]

## DESCRIPTION
System health agent that measures the CPU iowait via top and updates the #health-iowait attribute.

## SUPPORTED PARAMETERS
OCF_RESKEY_state = string [/health-iowait-.state]

State file Location to store the resource state in.

OCF_RESKEY_yellow_limit = integer [10]

Upper limit for yellow health attribute Upper limit of iowait percentage to switch the health attribute to yellow. I.e. the #health-iowait will go yellow if the %iowait of the CPU gets higher than 10%.

OCF_RESKEY_red_limit = integer [15]

Upper limit for red health attribute Upper limit of iowait percentage to switch the health attribute to red. I.e. the #health-iowait will go red if the %iowait of the CPU get higher than 15%.

OCF_RESKEY_dampening = string [5s]

The time to wait (dampening) in seconds for further changes before writing The time to wait (dampening) in seconds for further changes before writing

## AUTHOR
Andrew Beekhof <andrew@beekhof.net>

Author.


title: ocf_pacemaker_HealthSMART(7)

summary: SMART health status

text:
# ocf_pacemaker_HealthSMART(7)

## NAME
ocf_pacemaker_HealthSMART - SMART health status

## SYNOPSIS
[OCF_RESKEY_state=string] [OCF_RESKEY_drives=string] [OCF_RESKEY_devices=string] [OCF_RESKEY_temp_lower_limit=string] [OCF_RESKEY_temp_upper_limit=string] [OCF_RESKEY_temp_warning=string] [OCF_RESKEY_smartctl=string] [OCF_RESKEY_dampen=string]

HealthSMART [start | stop | monitor | meta-data | validate-all | reload-agent]

## DESCRIPTION
System health agent that checks the S.M.A.R.T. status of the given drives and updates the #health-smart attribute.

## SUPPORTED PARAMETERS
OCF_RESKEY_state = string [/HealthSMART-.state]

State file Location to store the resource state in.

OCF_RESKEY_drives = string [/dev/sda]

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

OCF_RESKEY_devices = string

Device types The device type(s) to assume for the drive(s) being tested as a SPACE separated list.

OCF_RESKEY_temp_lower_limit = string [0]

Lower limit for the red smart attribute Lower limit of the temperature in deg C of the drive(s). Below this limit the status of #health-smart will be red.

OCF_RESKEY_temp_upper_limit = string [60]

Upper limit for red smart attribute Upper limit of the temperature if deg C of the drives(s). If the drive reports a temperature higher than this value the status of #health-smart will be red.

OCF_RESKEY_temp_warning = string [5]

Deg C below/above the upper limits for yellow smart attribute Number of deg C below/above the upper/lower temp limits at which point the status of #health-smart will change to yellow.

OCF_RESKEY_smartctl = string [/usr/sbin/smartctl]

The path to the smartctl program The path to the smartctl program, used for querying device health.

OCF_RESKEY_dampen = string [5s]

Dampening interval The time to wait (dampening) for further changes to occur

## AUTHOR
Andrew Beekhof <andrew@beekhof.net>

Author.


title: ocf_pacemaker_Stateful(7)

summary: Example stateful resource agent

text:
# ocf_pacemaker_Stateful(7)

## NAME
ocf_pacemaker_Stateful - Example stateful resource agent

## SYNOPSIS
[OCF_RESKEY_state=string] [OCF_RESKEY_envfile=string] [OCF_RESKEY_notify_delay=string]

Stateful [start | stop | monitor | monitor | promote | demote | notify | meta-data | reload-agent | validate-all]

## DESCRIPTION
This is an example resource agent that implements Promoted and Unpromoted roles

## SUPPORTED PARAMETERS
OCF_RESKEY_state = string [/Stateful-.state]

State file Location to store the resource state in

OCF_RESKEY_envfile = string []

Environment dump file If this is set, the environment will be dumped to this file for every call.

OCF_RESKEY_notify_delay = string []

Notify delay in seconds The notify action will sleep for this many seconds before returning, to simulate a long-running notify.

## AUTHOR
Andrew Beekhof <andrew@beekhof.net>

Author.


title: ocf_pacemaker_SysInfo(7)

summary: SysInfo resource agent

text:
# ocf_pacemaker_SysInfo(7)

## NAME
ocf_pacemaker_SysInfo - SysInfo resource agent

## SYNOPSIS
[OCF_RESKEY_pidfile=string] [OCF_RESKEY_delay=string] [OCF_RESKEY_disks=string] [OCF_RESKEY_disk_unit=select] [OCF_RESKEY_min_disk_free=string]

SysInfo [start | stop | monitor | reload-agent | meta-data | validate-all]

## DESCRIPTION
This is a SysInfo Resource Agent. It records (in the CIB) various attributes of a node Sample Linux output: arch: i686 os: Linux-2.4.26-gentoo-r14 free_swap: 1999 cpu_info: Intel(R) Celeron(R) CPU 2.40GHz cpu_speed: 4771.02 cpu_cores: 1 cpu_load: 0.00 ram_total: 513 ram_free: 117 root_free: 2.4 #health_disk: red Sample Darwin output: arch: i386 os: Darwin-8.6.2 cpu_info: Intel Core Duo cpu_speed: 2.16 cpu_cores: 2 cpu_load: 0.18 ram_total: 2016 ram_free: 787 root_free: 13 #health_disk: green Units: free_swap: MB ram_*: MB cpu_speed (Linux): bogomips cpu_speed (Darwin): GHz *_free: GB (or user-defined: disk_unit)

## SUPPORTED PARAMETERS
OCF_RESKEY_pidfile = string [/SysInfo-]

PID file

OCF_RESKEY_delay = string [0s]

Dampening Delay Interval to allow values to stabilize

OCF_RESKEY_disks = string

List of Filesytems/Paths to query for free disk space Filesystems or Paths to be queried for free disk space as a SPACE separated list - e.g "/dev/sda1 /tmp". Results will be written to an attribute with leading slashes removed, and other slashes replaced with underscore, and the word 'free' appended - e.g for /dev/sda1 it would be 'dev_sda1_free'. Note: The root filesystem '/' is always queried to an attribute named 'root_free'

OCF_RESKEY_disk_unit = select [G]

Unit to report disk free space in Unit to report disk free space in. Can be one of: B, K, M, G, T, P (case-insensitive)

OCF_RESKEY_min_disk_free = string []

minimum disk free space required The amount of free space required in monitored disks. If any of the monitored disks has less than this amount of free space, , with the node attribute "#health_disk" changing to "red", all resources will move away from the node. Set the node-health-strategy property appropriately for this to take effect. If the unit is not specified, it defaults to disk_unit.

## AUTHOR
Andrew Beekhof <andrew@beekhof.net>

Author.


title: ocf_pacemaker_attribute(7)

summary: Manages a node attribute

text:
# ocf_pacemaker_attribute(7)

## NAME
ocf_pacemaker_attribute - Manages a node attribute

## SYNOPSIS
[OCF_RESKEY_state=string] [OCF_RESKEY_name=string] [OCF_RESKEY_active_value=string] [OCF_RESKEY_inactive_value=string]

attribute [start | stop | monitor | reload | migrate_to | migrate_from | validate-all | meta-data]

## DESCRIPTION
This resource agent controls a node attribute for the node it's running on. It sets the attribute one way when started, and another way when stopped, according to the configuration parameters.

## SUPPORTED PARAMETERS
OCF_RESKEY_state = string [/var/run/opa-RESOURCENAME.state]

State file Full path of a temporary file to store the resource state in

OCF_RESKEY_name = string [opa-RESOURCENAME]

Attribute name Name of node attribute to manage

OCF_RESKEY_active_value = string [1]

Attribute value when active Value to use for node attribute when resource becomes active (empty string is discouraged, because monitor cannot distinguish it from a query error)

OCF_RESKEY_inactive_value = string [0]

Attribute value when inactive Value to use for node attribute when resource becomes inactive

## AUTHOR
Andrew Beekhof <andrew@beekhof.net>

Author.


title: ocf_pacemaker_controld(7)

summary: DLM Agent for cluster file systems

text:
# ocf_pacemaker_controld(7)

## NAME
ocf_pacemaker_controld - DLM Agent for cluster file systems

## SYNOPSIS
[OCF_RESKEY_args=string] [OCF_RESKEY_daemon=string] [OCF_RESKEY_allow_fencing_disabled=string] [OCF_RESKEY_allow_stonith_disabled=string]

controld [start | stop | monitor | meta-data | validate-all]

## DESCRIPTION
This Resource Agent can control the dlm_controld services needed by cluster-aware file systems. It assumes that dlm_controld is in your default PATH. In most cases, it should be run as an anonymous clone.

## SUPPORTED PARAMETERS
OCF_RESKEY_args = string [-s 0]

DLM Options Any additional options to start the dlm_controld service with

OCF_RESKEY_daemon = string [dlm_controld]

The daemon to start The daemon to start - supports dlm_controld

OCF_RESKEY_allow_fencing_disabled = string [false]

Allow start-up even without fencing Allow DLM start-up even if fencing is disabled in the cluster. Setting this option to true will cause cluster malfunction and hangs on fail-over for DLM clients that require fencing (such as GFS2, OCFS2, and cLVM2). This option is advanced use only.

OCF_RESKEY_allow_stonith_disabled = string [false]

Deprecated

## AUTHOR
Andrew Beekhof <andrew@beekhof.net>

Author.


title: ocf_pacemaker_ifspeed(7)

summary: Network interface speed monitor

text:
# ocf_pacemaker_ifspeed(7)

## NAME
ocf_pacemaker_ifspeed - Network interface speed monitor

## SYNOPSIS
[OCF_RESKEY_name=string] [OCF_RESKEY_iface=string] [OCF_RESKEY_ip=string] [OCF_RESKEY_bridge_ports=string] [OCF_RESKEY_weight_base=integer] [OCF_RESKEY_dampen=integer] [OCF_RESKEY_debug=string]

ifspeed [start | stop | monitor | meta-data | validate-all | reload-agent]

## DESCRIPTION
This agent's monitor action records the speed of a specified network interface as a node attribute. The attribute can be used in rules to prefer nodes based on network speeds. This agent can monitor physical interfaces, bonded interfaces, bridges, VLANs, or any combination thereof. For example: *) Bridge on top of one 10Gbps interface (eth2) and 802.3ad bonding (bond0) built on two 1Gbps interfaces (eth0 and eth1). *) Active-backup bonding built on top of one physical interface and one VLAN on another interface. For STP-enabled bridges, this agent tries to determine the network topology, and by default looks only on ports which are connected to an upstream switch. This can be overridden by 'bridge_ports' parameter. Active interfaces in this case are those in "forwarding" state. For balancing bonded interfaces, this agent uses 80% of the sum of the speeds of underlying "up" ports. For non-balancing bonded interfaces ("active-backup" and probably "broadcast"), only the speed of the currently active port is considered.

## SUPPORTED PARAMETERS
OCF_RESKEY_name = string [ifspeed]

Attribute name Name of the node attribute to set

OCF_RESKEY_iface = string []

Network interface If this is set, monitor this network interface. One of iface or ip must be set.

OCF_RESKEY_ip = string []

IPv4 or IPv6 address If this is set instead of iface, monitor the interface that holds this IP address. The address may be specified in dotted-quad notation for IPv4 (for example, 192.168.1.1) or hexadecimal notation for IPv6 (for example, 2001:db8:DC28:0:0:FC57:D4C8:1FFF). One of iface or ip must be set.

OCF_RESKEY_bridge_ports = string [detect]

Bridge ports If set and iface is a bridge, consider these bridge ports (by default, all ports which have designated_bridge=root_id)

OCF_RESKEY_weight_base = integer [1000]

Weight of 1Gbps Relative weight of 1Gbps in interface speed. Can be used to tune how big attribute value will be.

OCF_RESKEY_dampen = integer [5]

Dampening interval The time to wait (dampening) for further changes to occur.

OCF_RESKEY_debug = string [false]

Verbose logging Log more verbosely.

## AUTHOR
Andrew Beekhof <andrew@beekhof.net>

Author.


title: ocf_pacemaker_ping(7)

summary: node connectivity

text:
# ocf_pacemaker_ping(7)

## NAME
ocf_pacemaker_ping - node connectivity

## SYNOPSIS
[OCF_RESKEY_pidfile=string] [OCF_RESKEY_dampen=integer] [OCF_RESKEY_name=string] [OCF_RESKEY_multiplier=integer] [OCF_RESKEY_host_list=string] [OCF_RESKEY_attempts=integer] [OCF_RESKEY_timeout=integer] [OCF_RESKEY_options=string] [OCF_RESKEY_failure_score=integer] [OCF_RESKEY_use_fping=boolean] [OCF_RESKEY_debug=string]

ping [start | stop | monitor | meta-data | validate-all | reload-agent]

## DESCRIPTION
Every time the monitor action is run, this resource agent records (in the CIB) the current number of nodes the host can connect to using the system fping (preferred) or ping tool.

## SUPPORTED PARAMETERS
OCF_RESKEY_pidfile = string [/ping-]

PID file

OCF_RESKEY_dampen = integer [5s]

Dampening interval The time to wait (dampening) further changes occur

OCF_RESKEY_name = string [pingd]

Attribute name The name of the attributes to set. This is the name to be used in the constraints.

OCF_RESKEY_multiplier = integer [1]

Value multiplier The number by which to multiply the number of connected ping nodes by

OCF_RESKEY_host_list = string []

Host list A space separated list of ping nodes to count.

OCF_RESKEY_attempts = integer [3]

no. of ping attempts Number of ping attempts, per host, before declaring it dead

OCF_RESKEY_timeout = integer [2]

ping timeout in seconds How long, in seconds, to wait before declaring a ping lost

OCF_RESKEY_options = string []

Extra Options A catch all for any other options that need to be passed to ping.

OCF_RESKEY_failure_score = integer []

failure_score Resource is failed if the score is less than failure_score. Default never fails.

OCF_RESKEY_use_fping = boolean [1]

Use fping if available Use fping rather than ping, if found. If set to 0, fping will not be used even if present.

OCF_RESKEY_debug = string [false]

Verbose logging Enables to use default attrd_updater verbose logging on every call.

## AUTHOR
Andrew Beekhof <andrew@beekhof.net>

Author.


title: ocf_pacemaker_remote(7)

summary: Pacemaker Remote connection

text:
# ocf_pacemaker_remote(7)

## NAME
ocf_pacemaker_remote - Pacemaker Remote connection

## SYNOPSIS
[OCF_RESKEY_server=string] [OCF_RESKEY_port=integer] [OCF_RESKEY_reconnect_interval=string]

remote [start | stop | monitor | migrate_to | migrate_from | reload | reload-agent | meta-data]

## SUPPORTED PARAMETERS
OCF_RESKEY_server = string

Remote hostname Server location to connect to (IP address or resolvable host name)

OCF_RESKEY_port = integer [3121]

Remote port TCP port at which to contact Pacemaker Remote executor

OCF_RESKEY_reconnect_interval = string [0]

reconnect interval If this is a positive time interval, the cluster will attempt to reconnect to a remote node after an active connection has been lost at this interval. Otherwise, the cluster will attempt to reconnect immediately (after any fencing needed).

## AUTHOR
Andrew Beekhof <andrew@beekhof.net>

Author.


pacemaker-based

title: pacemaker-based(7)

text:
# pacemaker-based(7)

## NAME
pacemaker-based - Cluster Information Base manager options

## SYNOPSIS
[enable-acl=boolean] [cluster-ipc-limit=integer]

## DESCRIPTION
Cluster options used by Pacemaker's Cluster Information Base manager

## SUPPORTED PARAMETERS
enable-acl = boolean [false]

Enable Access Control Lists (ACLs) for the CIB

cluster-ipc-limit = integer

*** Deprecated *** Ignored

## AUTHOR
Andrew Beekhof <andrew@beekhof.net>

Author.


pacemaker-controld

title: pacemaker-controld(7)

summary: Pacemaker controller options

text:
# pacemaker-controld(7)

## NAME
pacemaker-controld - Pacemaker controller options

## SYNOPSIS
[dc-version=string] [cluster-infrastructure=string] [cluster-name=string] [dc-deadtime=time] [cluster-recheck-interval=time] [election-timeout=time] [shutdown-escalation=time] [join-integration-timeout=time] [join-finalization-timeout=time] [transition-delay=time] [fencing-reaction=select] [fence-reaction=select] [fencing-watchdog-timeout=time] [stonith-watchdog-timeout=time] [fencing-max-attempts=integer] [stonith-max-attempts=integer] [load-threshold=percentage] [node-action-limit=integer]

## DESCRIPTION
Cluster options used by Pacemaker's controller

## SUPPORTED PARAMETERS
dc-version = string

Pacemaker version on cluster node elected Designated Controller (DC) Includes a hash which identifies the exact revision the code was built from. Used for diagnostic purposes.

cluster-infrastructure = string

The messaging layer on which Pacemaker is currently running Used for informational and diagnostic purposes.

cluster-name = string

An arbitrary name for the cluster This optional value is mostly for users' convenience as desired in administration, but may also be used in Pacemaker configuration rules via the #cluster-name node attribute, and by higher-level tools and resource agents.

dc-deadtime = time [20s]

How long to wait for a response from other nodes during start-up The optimal value will depend on the speed and load of your network and the type of switches used.

cluster-recheck-interval = time [15min]

Polling interval to recheck cluster state and evaluate rules with date specifications Pacemaker is primarily event-driven, and looks ahead to know when to recheck cluster state for failure-timeout settings and most time-based rules. However, it will also recheck the cluster after this amount of inactivity, to evaluate rules with date specifications and serve as a fail-safe for certain types of scheduler bugs. A value of 0 disables polling. A positive value sets an interval in seconds, unless other units are specified (for example, "5min").

election-timeout = time [2min]

*** Advanced Use Only *** Declare an election failed if it is not decided within this much time. If you need to adjust this value, it probably indicates the presence of a bug.

shutdown-escalation = time [20min]

*** Advanced Use Only *** Exit immediately if shutdown does not complete within this much time. If you need to adjust this value, it probably indicates the presence of a bug.

join-integration-timeout = time [3min]

*** Advanced Use Only *** If you need to adjust this value, it probably indicates the presence of a bug.

join-finalization-timeout = time [30min]

*** Advanced Use Only *** If you need to adjust this value, it probably indicates the presence of a bug.

transition-delay = time [0s]

*** Advanced Use Only *** Enabling this option will slow down cluster recovery under all conditions Delay cluster recovery for this much time to allow for additional events to occur. Useful if your configuration is sensitive to the order in which ping updates arrive.

fencing-reaction = select [stop]

How a cluster node should react if notified of its own fencing A cluster node may receive notification of a "succeeded" fencing that targeted it if fencing is misconfigured, or if fabric fencing is in use that doesn't cut cluster communication. Use "stop" to attempt to immediately stop Pacemaker and stay stopped, or "panic" to attempt to immediately reboot the local node, falling back to stop on failure. Allowed values: stop, panic

fence-reaction = select [stop]

*** Deprecated *** *** Replaced with fencing-reaction *** Deprecated alias for fencing-reaction Allowed values: stop, panic

fencing-watchdog-timeout = time [0]

How long before nodes can be assumed to be safely down when watchdog-based self-fencing via SBD is in use If this is set to a positive value, lost nodes are assumed to achieve self-fencing using watchdog-based SBD within this much time. This does not require a fencing resource to be explicitly configured, though a fence_watchdog resource can be configured, to limit use to specific nodes. If this is set to 0 (the default), the cluster will never assume watchdog-based self-fencing. If this is set to a negative value, the cluster will use twice the local value of the `SBD_WATCHDOG_TIMEOUT` environment variable if that is positive, or otherwise treat this as 0. WARNING: When used, this timeout must be larger than `SBD_WATCHDOG_TIMEOUT` on all nodes that use watchdog-based SBD, and Pacemaker will refuse to start on any of those nodes where this is not true for the local value or SBD is not active. When this is set to a negative value, `SBD_WATCHDOG_TIMEOUT` must be set to the same value on all nodes that use SBD, otherwise data corruption or loss could occur.

stonith-watchdog-timeout = time [0]

*** Deprecated *** *** Replaced with fencing-watchdog-timeout *** Deprecated alias for fencing-watchdog-timeout

fencing-max-attempts = integer [10]

How many times fencing can fail before it will no longer be immediately re-attempted on a target

stonith-max-attempts = integer [10]

*** Deprecated *** *** Replaced with fencing-max-attempts *** Deprecated alias for fencing-max-attempts

load-threshold = percentage [80%]

Maximum amount of system load that should be used by cluster nodes The cluster will slow down its recovery process when the amount of system resources used (currently CPU) approaches this limit

node-action-limit = integer [0]

Maximum number of jobs that can be scheduled per node (defaults to 2x cores)

## AUTHOR
Andrew Beekhof <andrew@beekhof.net>

Author.


pacemaker-fenced

title: pacemaker-fenced(7)

summary: Instance attributes available for all stonith\-class resources

text:
# pacemaker-fenced(7)

## NAME
pacemaker-fenced - Instance attributes available for all "stonith"-class resources

## SYNOPSIS
[pcmk_host_argument=string] [pcmk_host_map=string] [pcmk_host_list=string] [pcmk_host_check=select] [pcmk_delay_max=time] [pcmk_delay_base=string] [pcmk_action_limit=integer] [pcmk_reboot_action=string] [pcmk_reboot_timeout=time] [pcmk_reboot_retries=integer] [pcmk_off_action=string] [pcmk_off_timeout=time] [pcmk_off_retries=integer] [pcmk_on_action=string] [pcmk_on_timeout=time] [pcmk_on_retries=integer] [pcmk_list_action=string] [pcmk_list_timeout=time] [pcmk_list_retries=integer] [pcmk_monitor_action=string] [pcmk_monitor_timeout=time] [pcmk_monitor_retries=integer] [pcmk_status_action=string] [pcmk_status_timeout=time] [pcmk_status_retries=integer]

## DESCRIPTION
Instance attributes available for all "stonith"-class resources and used by Pacemaker's fence daemon

## SUPPORTED PARAMETERS
pcmk_host_argument = string

*** Advanced Use Only *** Name of agent parameter that should be set to the fencing target If the fencing agent metadata advertises support for the "port" or "plug" parameter, that will be used as the default, otherwise "none" will be used, which tells the cluster not to supply any additional parameters.

pcmk_host_map = string

A mapping of node names to port numbers for devices that do not support node names. For example, "node1:1;node2:2,3" would tell the cluster to use port 1 for node1 and ports 2 and 3 for node2.

pcmk_host_list = string

Nodes targeted by this device Comma-separated list of nodes that can be targeted by this device (for example, "node1,node2,node3"). If pcmk_host_check is "static-list", either this or pcmk_host_map must be set.

pcmk_host_check = select

How to determine which nodes can be targeted by the device Use "dynamic-list" to query the device via the 'list' command; "static-list" to check the pcmk_host_list attribute; "status" to query the device via the 'status' command; or "none" to assume every device can fence every node. The default value is "static-list" if pcmk_host_map or pcmk_host_list is set; otherwise "dynamic-list" if the device supports the list operation; otherwise "status" if the device supports the status operation; otherwise "none" Allowed values: dynamic-list, static-list, status, none

pcmk_delay_max = time [0s]

Enable a delay of no more than the time specified before executing fencing actions. Enable a delay of no more than the time specified before executing fencing actions. Pacemaker derives the overall delay by taking the value of pcmk_delay_base and adding a random delay value such that the sum is kept below this maximum.

pcmk_delay_base = string [0s]

Enable a base delay for fencing actions and specify base delay value. This enables a static delay for fencing actions, which can help avoid "death matches" where two nodes try to fence each other at the same time. If pcmk_delay_max is also used, a random delay will be added such that the total delay is kept below that value. This can be set to a single time value to apply to any node targeted by this device (useful if a separate device is configured for each target), or to a node map (for example, "node1:1s;node2:5") to set a different value for each target.

pcmk_action_limit = integer [1]

The maximum number of actions can be performed in parallel on this device If the concurrent-fencing cluster property is "true", this specifies the maximum number of actions that can be performed in parallel on this device. A value of -1 means unlimited.

pcmk_reboot_action = string [reboot]

*** Advanced Use Only *** An alternate command to run instead of 'reboot' Some devices do not support the standard commands or may provide additional ones. Use this to specify an alternate, device-specific, command that implements the 'reboot' action.

pcmk_reboot_timeout = time [60s]

*** Advanced Use Only *** Specify an alternate timeout to use for 'reboot' actions instead of fencing-timeout Some devices need much more/less time to complete than normal. Use this to specify an alternate, device-specific, timeout for 'reboot' actions.

pcmk_reboot_retries = integer [2]

*** Advanced Use Only *** The maximum number of times to try the 'reboot' command within the timeout period Some devices do not support multiple connections. Operations may "fail" if the device is busy with another task. In that case, Pacemaker will automatically retry the operation if there is time remaining. Use this option to alter the number of times Pacemaker tries a 'reboot' action before giving up.

pcmk_off_action = string [off]

*** Advanced Use Only *** An alternate command to run instead of 'off' Some devices do not support the standard commands or may provide additional ones. Use this to specify an alternate, device-specific, command that implements the 'off' action.

pcmk_off_timeout = time [60s]

*** Advanced Use Only *** Specify an alternate timeout to use for 'off' actions instead of fencing-timeout Some devices need much more/less time to complete than normal. Use this to specify an alternate, device-specific, timeout for 'off' actions.

pcmk_off_retries = integer [2]

*** Advanced Use Only *** The maximum number of times to try the 'off' command within the timeout period Some devices do not support multiple connections. Operations may "fail" if the device is busy with another task. In that case, Pacemaker will automatically retry the operation if there is time remaining. Use this option to alter the number of times Pacemaker tries a 'off' action before giving up.

pcmk_on_action = string [on]

*** Advanced Use Only *** An alternate command to run instead of 'on' Some devices do not support the standard commands or may provide additional ones. Use this to specify an alternate, device-specific, command that implements the 'on' action.

pcmk_on_timeout = time [60s]

*** Advanced Use Only *** Specify an alternate timeout to use for 'on' actions instead of fencing-timeout Some devices need much more/less time to complete than normal. Use this to specify an alternate, device-specific, timeout for 'on' actions.

pcmk_on_retries = integer [2]

*** Advanced Use Only *** The maximum number of times to try the 'on' command within the timeout period Some devices do not support multiple connections. Operations may "fail" if the device is busy with another task. In that case, Pacemaker will automatically retry the operation if there is time remaining. Use this option to alter the number of times Pacemaker tries a 'on' action before giving up.

pcmk_list_action = string [list]

*** Advanced Use Only *** An alternate command to run instead of 'list' Some devices do not support the standard commands or may provide additional ones. Use this to specify an alternate, device-specific, command that implements the 'list' action.

pcmk_list_timeout = time [60s]

*** Advanced Use Only *** Specify an alternate timeout to use for 'list' actions instead of fencing-timeout Some devices need much more/less time to complete than normal. Use this to specify an alternate, device-specific, timeout for 'list' actions.

pcmk_list_retries = integer [2]

*** Advanced Use Only *** The maximum number of times to try the 'list' command within the timeout period Some devices do not support multiple connections. Operations may "fail" if the device is busy with another task. In that case, Pacemaker will automatically retry the operation if there is time remaining. Use this option to alter the number of times Pacemaker tries a 'list' action before giving up.

pcmk_monitor_action = string [monitor]

*** Advanced Use Only *** An alternate command to run instead of 'monitor' Some devices do not support the standard commands or may provide additional ones. Use this to specify an alternate, device-specific, command that implements the 'monitor' action.

pcmk_monitor_timeout = time [60s]

*** Advanced Use Only *** Specify an alternate timeout to use for 'monitor' actions instead of fencing-timeout Some devices need much more/less time to complete than normal. Use this to specify an alternate, device-specific, timeout for 'monitor' actions.

pcmk_monitor_retries = integer [2]

*** Advanced Use Only *** The maximum number of times to try the 'monitor' command within the timeout period Some devices do not support multiple connections. Operations may "fail" if the device is busy with another task. In that case, Pacemaker will automatically retry the operation if there is time remaining. Use this option to alter the number of times Pacemaker tries a 'monitor' action before giving up.

pcmk_status_action = string [status]

*** Advanced Use Only *** An alternate command to run instead of 'status' Some devices do not support the standard commands or may provide additional ones. Use this to specify an alternate, device-specific, command that implements the 'status' action.

pcmk_status_timeout = time [60s]

*** Advanced Use Only *** Specify an alternate timeout to use for 'status' actions instead of fencing-timeout Some devices need much more/less time to complete than normal. Use this to specify an alternate, device-specific, timeout for 'status' actions.

pcmk_status_retries = integer [2]

*** Advanced Use Only *** The maximum number of times to try the 'status' command within the timeout period Some devices do not support multiple connections. Operations may "fail" if the device is busy with another task. In that case, Pacemaker will automatically retry the operation if there is time remaining. Use this option to alter the number of times Pacemaker tries a 'status' action before giving up.

## AUTHOR
Andrew Beekhof <andrew@beekhof.net>

Author.


pacemaker-schedulerd

title: pacemaker-schedulerd(7)

summary: Pacemaker scheduler options

text:
# pacemaker-schedulerd(7)

## NAME
pacemaker-schedulerd - Pacemaker scheduler options

## SYNOPSIS
[no-quorum-policy=select] [shutdown-lock=boolean] [shutdown-lock-limit=time] [symmetric-cluster=boolean] [maintenance-mode=boolean] [start-failure-is-fatal=boolean] [enable-startup-probes=boolean] [fence-remote-without-quorum=boolean] [fencing-enabled=boolean] [stonith-enabled=boolean] [fencing-action=select] [stonith-action=select] [fencing-timeout=time] [stonith-timeout=time] [have-watchdog=boolean] [concurrent-fencing=boolean] [startup-fencing=boolean] [priority-fencing-delay=time] [node-pending-timeout=time] [cluster-delay=time] [batch-limit=integer] [migration-limit=integer] [stop-all-resources=boolean] [stop-removed-resources=boolean] [stop-orphan-resources=boolean] [cancel-removed-actions=boolean] [stop-orphan-actions=boolean] [pe-error-series-max=integer] [pe-warn-series-max=integer] [pe-input-series-max=integer] [node-health-strategy=select] [node-health-base=integer] [node-health-green=integer] [node-health-yellow=integer] [node-health-red=integer] [placement-strategy=select]

## DESCRIPTION
Cluster options used by Pacemaker's scheduler

## SUPPORTED PARAMETERS
no-quorum-policy = select [stop]

What to do when the cluster does not have quorum What to do when the cluster does not have quorum Allowed values: stop, freeze, ignore, demote, fence, suicide

shutdown-lock = boolean [false]

Whether to lock resources to a cleanly shut down node When true, resources active on a node when it is cleanly shut down are kept "locked" to that node (not allowed to run elsewhere) until they start again on that node after it rejoins (or for at most shutdown-lock-limit, if set). Stonith resources and Pacemaker Remote connections are never locked. Clone and bundle instances and the promoted role of promotable clones are currently never locked, though support could be added in a future release.

shutdown-lock-limit = time [0]

Do not lock resources to a cleanly shut down node longer than this If shutdown-lock is true and this is set to a nonzero time duration, shutdown locks will expire after this much time has passed since the shutdown was initiated, even if the node has not rejoined.

symmetric-cluster = boolean [true]

Whether resources can run on any node by default

maintenance-mode = boolean [false]

Whether the cluster should refrain from monitoring, starting, and stopping resources

start-failure-is-fatal = boolean [true]

Whether a start failure should prevent a resource from being recovered on the same node When true, the cluster will immediately ban a resource from a node if it fails to start there. When false, the cluster will instead check the resource's fail count against its migration-threshold.

enable-startup-probes = boolean [true]

*** Deprecated *** Whether the cluster should check for active resources during start-up

fence-remote-without-quorum = boolean [false]

*** Advanced Use Only *** Whether remote nodes can be fenced without quorum By default, an inquorate node can not fence Pacemaker Remote nodes that are part of its partition as long as the cluster thinks they can be restarted. If true, inquorate nodes will be able to fence remote nodes regardless.

fencing-enabled = boolean [true]

*** Advanced Use Only *** Whether nodes may be fenced as part of recovery If false, unresponsive nodes are immediately assumed to be harmless, and resources that were active on them may be recovered elsewhere. This can result in a "split-brain" situation, potentially leading to data loss and/or service unavailability.

stonith-enabled = boolean [true]

*** Deprecated *** *** Replaced with fencing-enabled *** *** Advanced Use Only *** Deprecated alias for fencing-enabled

fencing-action = select [reboot]

Action to send to fence device when a node needs to be fenced Action to send to fence device when a node needs to be fenced Allowed values: reboot, off

stonith-action = select [reboot]

*** Deprecated *** *** Replaced with fencing-action *** Deprecated alias for fencing-action Allowed values: reboot, off

fencing-timeout = time [60s]

How long to wait for on, off, and reboot fence actions to complete by default

stonith-timeout = time [60s]

*** Deprecated *** *** Replaced with fencing-timeout *** Deprecated alias for fencing-timeout

have-watchdog = boolean [false]

Whether watchdog integration is enabled This is set automatically by the cluster according to whether SBD is detected to be in use. User-configured values are ignored. The value `true` is meaningful if diskless SBD is used and `fencing-watchdog-timeout` is nonzero. In that case, if fencing is required, watchdog-based self-fencing will be performed via SBD without requiring a fencing resource explicitly configured.

concurrent-fencing = boolean [true]

*** Deprecated *** Allow performing fencing operations in parallel

startup-fencing = boolean [true]

*** Advanced Use Only *** Whether to fence unseen nodes at start-up Setting this to false may lead to a "split-brain" situation, potentially leading to data loss and/or service unavailability.

priority-fencing-delay = time [0]

Apply fencing delay targeting the lost nodes with the highest total resource priority Apply specified delay for the fencings that are targeting the lost nodes with the highest total resource priority in case we don't have the majority of the nodes in our cluster partition, so that the more significant nodes potentially win any fencing match, which is especially meaningful under split-brain of 2-node cluster. A promoted resource instance takes the base priority + 1 on calculation if the base priority is not 0. Any static/random delays that are introduced by `pcmk_delay_base/max` configured for the corresponding fencing resources will be added to this delay. This delay should be significantly greater than, safely twice, the maximum `pcmk_delay_base/max`. By default, priority fencing delay is disabled.

node-pending-timeout = time [0]

How long to wait for a node that has joined the cluster to join the controller process group Fence nodes that do not join the controller process group within this much time after joining the cluster, to allow the cluster to continue managing resources. A value of 0 means never fence pending nodes. Setting the value to 2h means fence nodes after 2 hours.

cluster-delay = time [60s]

Maximum time for node-to-node communication The node elected Designated Controller (DC) will consider an action failed if it does not get a response from the node executing the action within this time (after considering the action's own timeout). The "correct" value will depend on the speed and load of your network and cluster nodes.

batch-limit = integer [0]

Maximum number of jobs that the cluster may execute in parallel across all nodes The "correct" value will depend on the speed and load of your network and cluster nodes. If set to 0, the cluster will impose a dynamically calculated limit when any node has a high load.

migration-limit = integer [-1]

The number of live migration actions that the cluster is allowed to execute in parallel on a node (-1 means no limit)

stop-all-resources = boolean [false]

Whether the cluster should stop all active resources

stop-removed-resources = boolean [true]

*** Deprecated *** Whether to stop resources that were removed from the configuration

stop-orphan-resources = boolean [true]

*** Deprecated *** *** Replaced with stop-removed-resources *** Deprecated alias for stop-removed-resources

cancel-removed-actions = boolean [true]

*** Deprecated *** Whether to cancel recurring actions removed from the configuration

stop-orphan-actions = boolean [true]

*** Deprecated *** *** Replaced with cancel-removed-actions *** Deprecated alias for cancel-removed-actions

pe-error-series-max = integer [-1]

The number of scheduler inputs resulting in errors to save Zero to disable, -1 to store unlimited.

pe-warn-series-max = integer [5000]

The number of scheduler inputs resulting in warnings to save Zero to disable, -1 to store unlimited.

pe-input-series-max = integer [4000]

The number of scheduler inputs without errors or warnings to save Zero to disable, -1 to store unlimited.

node-health-strategy = select [none]

How cluster should react to node health attributes Requires external entities to create node attributes (named with the prefix "#health") with values "red", "yellow", or "green". Allowed values: none, migrate-on-red, only-green, progressive, custom

node-health-base = integer [0]

Base health score assigned to a node Only used when "node-health-strategy" is set to "progressive".

node-health-green = integer [0]

The score to use for a node health attribute whose value is "green" Only used when "node-health-strategy" is set to "custom" or "progressive".

node-health-yellow = integer [0]

The score to use for a node health attribute whose value is "yellow" Only used when "node-health-strategy" is set to "custom" or "progressive".

node-health-red = integer [-INFINITY]

The score to use for a node health attribute whose value is "red" Only used when "node-health-strategy" is set to "custom" or "progressive".

placement-strategy = select [default]

How the cluster should allocate resources to nodes How the cluster should allocate resources to nodes Allowed values: default, utilization, minimal, balanced

## AUTHOR
Andrew Beekhof <andrew@beekhof.net>

Author.


pam-script

title: pam-script(7)

text:
# pam-script(7)

## NAME
pam-script - a PAM module that can invoke scripts within the PAM stack.

## SYNOPSIS
pam-script.so [onerr=(success|fail)][dir=/some/path/]

## DESCRIPTION
pam-script allows you to execute scripts during authorization, passwd changes, and on session opening or closing.

Such scripts can perform necessary tasks or influence the outcome of the PAM stack. For example, if the following entry was included in pam.conf

sshd auth required pam_script

then if the script, pam_script_auth, exits with a non-zero value this would cause the user to be denied SSH access to the machine.

## OPTIONS
A summary of options is included below.

onerr=(success|fail)

the default behavior if the module can not find or execute the script. The default is to fail if the option is not given.

dir=/some/path/

where to find the pam-scripts to invoke for each of the various module-types as described below. The default is dir=/etc/pam-script if not given. List of scripts

pam_script_auth

Executed under auth which handles the authentication stage of establishing the user via some challenge-response (i.e. username/password)

pam_script_acct

invoked under account module-type for non-authentication based account management.

pam_script_passwd

invoked under passwd for changing the password tokens.

pam_script_ses_open

invoked when a session is first opened.

pam_script_ses_close

run after a session is first closed. All the scripts will be passed several environment variables: PAM_USER, PAM_RUSER, PAM_RHOST, PAM_SERVICE, PAM_AUTHTOK, PAM_TTY, and PAM_TYPE referring to the module-type. The pam_script.so arguments in the pam.conf will be passed on the command line, which can be used to modify the script behavior.

## FILES
/lib64/security/pam_script.so - the PAM module

/etc/pam-script - where the scripts should be placed by default

## VERSION
pam-script 1.1.8

## SEE ALSO
PAM(7) and the PAM "The System Administrators' Guide"

## AUTHOR

```
pam-script was written by Jeroen Nijhof <jeroen@jeroennijhof.nl>
with some additions and modifications by R.K. Owen, Ph.D. <rkowen@nersc.gov>.
```

```
This manual page was written by R.K. Owen <rkowen@nersc.gov>,
for the Debian project (but may be used by others).
```