title: fence_sanbox2(8)

text:
# fence_sanbox2(8)

## NAME
fence_sanbox2 - Fence agent for QLogic SANBox2 FC switches

## DESCRIPTION
fence_sanbox2 is an I/O Fencing agent which can be used with QLogic SANBox2 FC switches. It logs into a SANBox2 switch via telnet and disables a specified port. Disabling the port which a machine is connected to effectively fences that machine. Lengthy telnet connections to the switch should be avoided while a GFS cluster is running because the connection will block any necessary fencing actions.

fence_sanbox2 accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent. fence_sanbox2 can be run by itself with command line options. This is useful for testing and for turning outlets on or off from scripts.

Vendor URL: http://www.qlogic.com

## PARAMETERS

-o, --action=[action]

Fencing action (Default Value: off)

-c, --command-prompt=[prompt]

Force Python regex for command prompt (Default Value: [' #> '])

-a, --ip=[ip]

IP address or hostname of fencing device This parameter is always required.

-u, --ipport=[port]

TCP/UDP port to use for connection with device (Default Value: 23)

-p, --password=[password]

Login password or passphrase

-S, --password-script=[script]

Script to run to retrieve password

-n, --plug=[id]

Physical plug number on device, UUID or identification of machine This parameter is always required.

-l, --username=[name]

Login name This parameter is always required.

-q, --quiet

Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.

-v, --verbose

Verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity.

--verbose-level

Level of debugging detail in output. Defaults to the number of --verbose flags specified on the command line, or to 1 if verbose=1 in a stonith device configuration (i.e., on stdin).

-D, --debug-file=[debugfile]

Write debug information to given file

-V, --version

Display version information and exit

-h, --help

Display help and exit

--plug-separator=[char]

Separator for plug parameter when specifying more than 1 plug (Default Value: ,)

-C, --separator=[char]

Separator for CSV created by 'list' operation (Default Value: ,)

--delay=[seconds]

Wait X seconds before fencing is started (Default Value: 0)

--disable-timeout=[true/false]

Disable timeout (true/false) (default: true when run from Pacemaker 2.0+)

--login-timeout=[seconds]

Wait X seconds for cmd prompt after login (Default Value: 5)

--power-timeout=[seconds]

Test X seconds for status change after ON/OFF (Default Value: 20)

--power-wait=[seconds]

Wait X seconds after issuing ON/OFF (Default Value: 0)

--shell-timeout=[seconds]

Wait X seconds for cmd prompt after issuing command (Default Value: 3)

--stonith-status-sleep=[seconds]

Sleep X seconds between status calls during a STONITH action (Default Value: 1)

--retry-on=[attempts]

Count of attempts to retry power on (Default Value: 1)

--telnet-path=[path]

Path to telnet binary (Default Value: /usr/bin/telnet)

## ACTIONS

on

Power on machine.

off

Power off machine.

status

This returns the status of the plug/virtual machine.

list

List available plugs with aliases/virtual machines if there is support for more then one device. Returns N/A otherwise.

list-status

List available plugs with aliases/virtual machines and their power state if it can be obtained without additional commands.

monitor

Check the health of fence device

metadata

Display the XML metadata describing this resource.

manpage

The operational behavior of this is not known.

validate-all

Validate if all required parameters are entered.

## STDIN PARAMETERS

action

Fencing action (Default Value: off)

command_prompt

Force Python regex for command prompt (Default Value: [' #> ']) Obsoletes: cmd_prompt

ip

IP address or hostname of fencing device This parameter is always required. Obsoletes: ipaddr

ipport

TCP/UDP port to use for connection with device (Default Value: 23)

password

Login password or passphrase Obsoletes: passwd

password_script

Script to run to retrieve password Obsoletes: passwd_script

plug

Physical plug number on device, UUID or identification of machine This parameter is always required. Obsoletes: port

username

Login name This parameter is always required. Obsoletes: login

quiet

Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.

verbose

Verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity.

verbose_level

Level of debugging detail in output. Defaults to the number of --verbose flags specified on the command line, or to 1 if verbose=1 in a stonith device configuration (i.e., on stdin).

debug_file

Write debug information to given file Obsoletes: debug

version

Display version information and exit

help

Display help and exit

plug_separator

Separator for plug parameter when specifying more than 1 plug (Default Value: ,)

separator

Separator for CSV created by 'list' operation (Default Value: ,)

delay

Wait X seconds before fencing is started (Default Value: 0)

disable_timeout

Disable timeout (true/false) (default: true when run from Pacemaker 2.0+)

login_timeout

Wait X seconds for cmd prompt after login (Default Value: 5)

power_timeout

Test X seconds for status change after ON/OFF (Default Value: 20)

power_wait

Wait X seconds after issuing ON/OFF (Default Value: 0)

shell_timeout

Wait X seconds for cmd prompt after issuing command (Default Value: 3)

stonith_status_sleep

Sleep X seconds between status calls during a STONITH action (Default Value: 1)

retry_on

Count of attempts to retry power on (Default Value: 1)

telnet_path

Path to telnet binary (Default Value: /usr/bin/telnet)


package: fence-agents-sbd

title: fence_sbd(8)

text:
# fence_sbd(8)

## NAME
fence_sbd - Fence agent for sbd

## DESCRIPTION
fence_sbd is an I/O Fencing agent which can be used in environments where sbd can be used (shared storage).

fence_sbd accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent. fence_sbd can be run by itself with command line options. This is useful for testing and for turning outlets on or off from scripts.

Vendor URL:

## PARAMETERS

-o, --action=[action]

Fencing action (Default Value: reboot)

--devices=[device_a,device_b]

SBD Device This parameter is always required.

-m, --method=[method]

Method to fence (onoff|cycle) (Default Value: cycle)

-n, --plug=[id]

Physical plug number on device, UUID or identification of machine This parameter is always required.

-q, --quiet

Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.

-v, --verbose

Verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity.

--verbose-level

Level of debugging detail in output. Defaults to the number of --verbose flags specified on the command line, or to 1 if verbose=1 in a stonith device configuration (i.e., on stdin).

-D, --debug-file=[debugfile]

Write debug information to given file

-V, --version

Display version information and exit

-h, --help

Display help and exit

--plug-separator=[char]

Separator for plug parameter when specifying more than 1 plug (Default Value: ,)

-C, --separator=[char]

Separator for CSV created by 'list' operation (Default Value: ,)

--delay=[seconds]

Wait X seconds before fencing is started (Default Value: 0)

--disable-timeout=[true/false]

Disable timeout (true/false) (default: true when run from Pacemaker 2.0+)

--login-timeout=[seconds]

Wait X seconds for cmd prompt after login (Default Value: 5)

--power-timeout=[seconds]

Test X seconds for status change after ON/OFF (Default Value: 30)

--power-wait=[seconds]

Wait X seconds after issuing ON/OFF (Default Value: 0)

--sbd-path=[path]

Path to SBD binary (Default Value: /usr/sbin/sbd)

--shell-timeout=[seconds]

Wait X seconds for cmd prompt after issuing command (Default Value: 3)

--stonith-status-sleep=[seconds]

Sleep X seconds between status calls during a STONITH action (Default Value: 1)

--retry-on=[attempts]

Count of attempts to retry power on (Default Value: 1)

## ACTIONS

on

Power on machine.

off

Power off machine.

reboot

Reboot machine.

status

This returns the status of the plug/virtual machine.

list

List available plugs with aliases/virtual machines if there is support for more then one device. Returns N/A otherwise.

list-status

List available plugs with aliases/virtual machines and their power state if it can be obtained without additional commands.

monitor

Check the health of fence device

metadata

Display the XML metadata describing this resource.

manpage

The operational behavior of this is not known.

validate-all

Validate if all required parameters are entered.

## STDIN PARAMETERS

action

Fencing action (Default Value: reboot)

devices

SBD Device This parameter is always required.

method

Method to fence (onoff|cycle) (Default Value: cycle)

plug

Physical plug number on device, UUID or identification of machine This parameter is always required. Obsoletes: port

quiet

Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.

verbose

Verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity.

verbose_level

Level of debugging detail in output. Defaults to the number of --verbose flags specified on the command line, or to 1 if verbose=1 in a stonith device configuration (i.e., on stdin).

debug_file

Write debug information to given file Obsoletes: debug

version

Display version information and exit

help

Display help and exit

plug_separator

Separator for plug parameter when specifying more than 1 plug (Default Value: ,)

separator

Separator for CSV created by 'list' operation (Default Value: ,)

delay

Wait X seconds before fencing is started (Default Value: 0)

disable_timeout

Disable timeout (true/false) (default: true when run from Pacemaker 2.0+)

login_timeout

Wait X seconds for cmd prompt after login (Default Value: 5)

power_timeout

Test X seconds for status change after ON/OFF (Default Value: 30)

power_wait

Wait X seconds after issuing ON/OFF (Default Value: 0)

sbd_path

Path to SBD binary (Default Value: /usr/sbin/sbd)

shell_timeout

Wait X seconds for cmd prompt after issuing command (Default Value: 3)

stonith_status_sleep

Sleep X seconds between status calls during a STONITH action (Default Value: 1)

retry_on

Count of attempts to retry power on (Default Value: 1)


package: fence-agents-scsi

title: fence_scsi(8)

text:
# fence_scsi(8)

## NAME
fence_scsi - Fence agent for SCSI persistent reservation

## DESCRIPTION
fence_scsi is an I/O Fencing agent that uses SCSI-3 persistent reservations to control access to shared storage devices. These devices must support SCSI-3 persistent reservations (SPC-3 or greater) as well as the "preempt-and-abort" subcommand. The fence_scsi agent works by having each node in the cluster register a unique key with the SCSI device(s). Reservation key is generated from "node id" (default) or from "node name hash" (RECOMMENDED) by adjusting "key_value" option. Using hash is recommended to prevent issues when removing nodes from cluster without full cluster restart. Once registered, a single node will become the reservation holder by creating a "write exclusive, registrants only" reservation on the device(s). The result is that only registered nodes may write to the device(s). When a node failure occurs, the fence_scsi agent will remove the key belonging to the failed node from the device(s). The failed node will no longer be able to write to the device(s). A manual reboot is required.

When used as a watchdog device you can define e.g. retry=1, retry-sleep=2 and verbose=yes parameters in /etc/sysconfig/stonith if you have issues with it failing.

fence_scsi accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent. fence_scsi can be run by itself with command line options. This is useful for testing and for turning outlets on or off from scripts.

Vendor URL:

## PARAMETERS

-o, --action=[action]

Fencing action (Default Value: off)

-a, --aptpl

Use the APTPL flag for registrations. This option is only used for the 'on' action.

-d, --devices=[devices]

List of devices to use for current operation. Devices can be comma or space separated list of raw devices (eg. /dev/sdc). Each device must support SCSI-3 persistent reservations. Optional if cluster is configured with clvm or lvmlockd.

-k, --key=[key]

Key to use for the current operation. This key should be unique to a node. For the "on" action, the key specifies the key use to register the local node. For the "off" action, this key specifies the key to be removed from the device(s).

-n, --plug=[nodename]

Name of the node to be fenced. The node name is used to generate the key value used for the current operation. This option will be ignored when used with the -k option. This parameter is always required.

--readonly

Open DEVICE read-only.

--suppress-errors

Error log suppression.

-f, --logfile

Log output (stdout and stderr) to file

-q, --quiet

Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.

-v, --verbose

Verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity.

--verbose-level

Level of debugging detail in output. Defaults to the number of --verbose flags specified on the command line, or to 1 if verbose=1 in a stonith device configuration (i.e., on stdin).

-D, --debug-file=[debugfile]

Write debug information to given file

-V, --version

Display version information and exit

-h, --help

Display help and exit

--plug-separator=[char]

Separator for plug parameter when specifying more than 1 plug (Default Value: ,)

--delay=[seconds]

Wait X seconds before fencing is started (Default Value: 0)

--disable-timeout=[true/false]

Disable timeout (true/false) (default: true when run from Pacemaker 2.0+)

--login-timeout=[seconds]

Wait X seconds for cmd prompt after login (Default Value: 5)

--power-timeout=[seconds]

Test X seconds for status change after ON/OFF (Default Value: 20)

--power-wait=[seconds]

Wait X seconds after issuing ON/OFF (Default Value: 0)

--shell-timeout=[seconds]

Wait X seconds for cmd prompt after issuing command (Default Value: 3)

--stonith-status-sleep=[seconds]

Sleep X seconds between status calls during a STONITH action (Default Value: 1)

--retry-on=[attempts]

Count of attempts to retry power on (Default Value: 1)

--corosync-cmap-path=[path]

Path to corosync-cmapctl binary (Default Value: /usr/sbin/corosync-cmapctl)

--key-value=<id|hash>

Method used to generate the SCSI key. "id" (default) uses the positional ID from "corosync-cmactl nodelist" output which can get inconsistent when nodes are removed from cluster without full cluster restart. "hash" uses part of hash made out of node names which is not affected over time but there is theoretical chance that hashes can collide as size of SCSI key is quite limited. (Default Value: id)

--sg_persist-path=[path]

Path to sg_persist binary (Default Value: /usr/bin/sg_persist)

--sg_turs-path=[path]

Path to sg_turs binary (Default Value: /usr/bin/sg_turs)

--vgs-path=[path]

Path to vgs binary (Default Value: /usr/sbin/vgs)

## ACTIONS

on

Power on machine.

off

Power off machine.

status

This returns the status of the plug/virtual machine.

monitor

Check the health of fence device

metadata

Display the XML metadata describing this resource.

manpage

The operational behavior of this is not known.

validate-all

Validate if all required parameters are entered.

## STDIN PARAMETERS

action

Fencing action (Default Value: off)

aptpl

Use the APTPL flag for registrations. This option is only used for the 'on' action.

devices

List of devices to use for current operation. Devices can be comma or space separated list of raw devices (eg. /dev/sdc). Each device must support SCSI-3 persistent reservations. Optional if cluster is configured with clvm or lvmlockd.

key

Key to use for the current operation. This key should be unique to a node. For the "on" action, the key specifies the key use to register the local node. For the "off" action, this key specifies the key to be removed from the device(s).

plug

Name of the node to be fenced. The node name is used to generate the key value used for the current operation. This option will be ignored when used with the -k option. This parameter is always required. Obsoletes: port

readonly

Open DEVICE read-only.

suppress_errors

Error log suppression. Obsoletes: suppress-errors

logfile

Log output (stdout and stderr) to file

quiet

Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.

verbose

Verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity.

verbose_level

Level of debugging detail in output. Defaults to the number of --verbose flags specified on the command line, or to 1 if verbose=1 in a stonith device configuration (i.e., on stdin).

debug_file

Write debug information to given file Obsoletes: debug

version

Display version information and exit

help

Display help and exit

plug_separator

Separator for plug parameter when specifying more than 1 plug (Default Value: ,)

delay

Wait X seconds before fencing is started (Default Value: 0)

disable_timeout

Disable timeout (true/false) (default: true when run from Pacemaker 2.0+)

login_timeout

Wait X seconds for cmd prompt after login (Default Value: 5)

power_timeout

Test X seconds for status change after ON/OFF (Default Value: 20)

power_wait

Wait X seconds after issuing ON/OFF (Default Value: 0)

shell_timeout

Wait X seconds for cmd prompt after issuing command (Default Value: 3)

stonith_status_sleep

Sleep X seconds between status calls during a STONITH action (Default Value: 1)

retry_on

Count of attempts to retry power on (Default Value: 1)

corosync_cmap_path

Path to corosync-cmapctl binary (Default Value: /usr/sbin/corosync-cmapctl)

key_value

Method used to generate the SCSI key. "id" (default) uses the positional ID from "corosync-cmactl nodelist" output which can get inconsistent when nodes are removed from cluster without full cluster restart. "hash" uses part of hash made out of node names which is not affected over time but there is theoretical chance that hashes can collide as size of SCSI key is quite limited. (Default Value: id)

sg_persist_path

Path to sg_persist binary (Default Value: /usr/bin/sg_persist)

sg_turs_path

Path to sg_turs binary (Default Value: /usr/bin/sg_turs)

vgs_path

Path to vgs binary (Default Value: /usr/sbin/vgs)


package: fence-agents-skalar

title: fence_skalar(8)

text:
# fence_skalar(8)

## NAME
fence_skalar - Skala-R Fence agent

## DESCRIPTION
fence_skalar is a Power Fencing agent for Skala-R.

fence_skalar accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent. fence_skalar can be run by itself with command line options. This is useful for testing and for turning outlets on or off from scripts.

Vendor URL: https://www.skala-r.ru/

## PARAMETERS

-o, --action=[action]

Fencing action (Default Value: reboot)

--force

vm_stop command parameter, force stop or not, default false

--graceful

vm_stop command parameter, graceful stop or not, default false

-a, --ip=[ip]

IP address or hostname of fencing device This parameter is always required.

-u, --ipport=[port]

TCP/UDP port to use for connection with device (Default Value: 80)

-p, --password=[password]

Login password or passphrase

-S, --password-script=[script]

Script to run to retrieve password

-n, --plug=[id]

Physical plug number on device, UUID or identification of machine This parameter is always required.

-z, --ssl

Use SSL connection with verifying certificate

--ssl-insecure

Use SSL connection without verifying certificate

--ssl-secure

Use SSL connection with verifying certificate

-l, --username=[name]

Login name This parameter is always required.

-q, --quiet

Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.

-v, --verbose

Verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity.

--verbose-level

Level of debugging detail in output. Defaults to the number of --verbose flags specified on the command line, or to 1 if verbose=1 in a stonith device configuration (i.e., on stdin).

-D, --debug-file=[debugfile]

Write debug information to given file

-V, --version

Display version information and exit

-h, --help

Display help and exit

--plug-separator=[char]

Separator for plug parameter when specifying more than 1 plug (Default Value: ,)

-C, --separator=[char]

Separator for CSV created by 'list' operation (Default Value: ,)

--delay=[seconds]

Wait X seconds before fencing is started (Default Value: 0)

--disable-timeout=[true/false]

Disable timeout (true/false) (default: true when run from Pacemaker 2.0+)

--login-timeout=[seconds]

Wait X seconds for cmd prompt after login (Default Value: 5)

--power-timeout=[seconds]

Test X seconds for status change after ON/OFF (Default Value: 20)

--power-wait=[seconds]

Wait X seconds after issuing ON/OFF (Default Value: 0)

--shell-timeout=[seconds]

Wait X seconds for cmd prompt after issuing command (Default Value: 3)

--stonith-status-sleep=[seconds]

Sleep X seconds between status calls during a STONITH action (Default Value: 1)

--retry-on=[attempts]

Count of attempts to retry power on (Default Value: 1)

--gnutlscli-path=[path]

Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)

## ACTIONS

on

Power on machine.

off

Power off machine.

reboot

Reboot machine.

status

This returns the status of the plug/virtual machine.

list

List available plugs with aliases/virtual machines if there is support for more then one device. Returns N/A otherwise.

list-status

List available plugs with aliases/virtual machines and their power state if it can be obtained without additional commands.

monitor

Check the health of fence device

metadata

Display the XML metadata describing this resource.

manpage

The operational behavior of this is not known.

validate-all

Validate if all required parameters are entered.

## STDIN PARAMETERS

action

Fencing action (Default Value: reboot)

force

vm_stop command parameter, force stop or not, default false

graceful

vm_stop command parameter, graceful stop or not, default false

ip

IP address or hostname of fencing device This parameter is always required. Obsoletes: ipaddr

ipport

TCP/UDP port to use for connection with device (Default Value: 80)

password

Login password or passphrase Obsoletes: passwd

password_script

Script to run to retrieve password Obsoletes: passwd_script

plug

Physical plug number on device, UUID or identification of machine This parameter is always required. Obsoletes: port

ssl

Use SSL connection with verifying certificate

ssl_insecure

Use SSL connection without verifying certificate

ssl_secure

Use SSL connection with verifying certificate

username

Login name This parameter is always required. Obsoletes: login

quiet

Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.

verbose

Verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity.

verbose_level

Level of debugging detail in output. Defaults to the number of --verbose flags specified on the command line, or to 1 if verbose=1 in a stonith device configuration (i.e., on stdin).

debug_file

Write debug information to given file Obsoletes: debug

version

Display version information and exit

help

Display help and exit

plug_separator

Separator for plug parameter when specifying more than 1 plug (Default Value: ,)

separator

Separator for CSV created by 'list' operation (Default Value: ,)

delay

Wait X seconds before fencing is started (Default Value: 0)

disable_timeout

Disable timeout (true/false) (default: true when run from Pacemaker 2.0+)

login_timeout

Wait X seconds for cmd prompt after login (Default Value: 5)

power_timeout

Test X seconds for status change after ON/OFF (Default Value: 20)

power_wait

Wait X seconds after issuing ON/OFF (Default Value: 0)

shell_timeout

Wait X seconds for cmd prompt after issuing command (Default Value: 3)

stonith_status_sleep

Sleep X seconds between status calls during a STONITH action (Default Value: 1)

retry_on

Count of attempts to retry power on (Default Value: 1)

gnutlscli_path

Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)


package: fence-agents-vbox

title: fence_vbox(8)

text:
# fence_vbox(8)

## NAME
fence_vbox - Fence agent for VirtualBox

## DESCRIPTION
fence_vbox is a Power Fencing agent which can be used with the virtual machines managed by VirtualBox. It logs via ssh to a dom0 where it runs VBoxManage to do all of the work.

By default, vbox needs to log in as a user that is a member of the vboxusers group. Also, you must allow ssh login in your sshd_config.

fence_vbox accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent. fence_vbox can be run by itself with command line options. This is useful for testing and for turning outlets on or off from scripts.

Vendor URL: https://www.virtualbox.org/

## PARAMETERS

-o, --action=[action]

Fencing action (Default Value: reboot)

-c, --command-prompt=[prompt]

Force Python regex for command prompt (Default Value: ['\[EXPECT\]#'])

-k, --identity-file=[filename]

Identity file (private key) for SSH

-4, --inet4-only

Forces agent to use IPv4 addresses only

-6, --inet6-only

Forces agent to use IPv6 addresses only

-a, --ip=[ip]

IP address or hostname of fencing device This parameter is always required.

-u, --ipport=[port]

TCP/UDP port to use for connection with device (Default Value: 22)

-p, --password=[password]

Login password or passphrase

-S, --password-script=[script]

Script to run to retrieve password

-n, --plug=[id]

Physical plug number on device, UUID or identification of machine This parameter is always required.

-x, --ssh

Use SSH connection (Default Value: 1)

--ssh-options=[options]

SSH options to use (Default Value: -t '/bin/bash -c "PS1=\[EXPECT\]# HISTFILE=/dev/null /bin/bash --noprofile --norc"')

-l, --username=[name]

Login name This parameter is always required.

-q, --quiet

Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.

-v, --verbose

Verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity.

--verbose-level

Level of debugging detail in output. Defaults to the number of --verbose flags specified on the command line, or to 1 if verbose=1 in a stonith device configuration (i.e., on stdin).

-D, --debug-file=[debugfile]

Write debug information to given file

-V, --version

Display version information and exit

-h, --help

Display help and exit

--plug-separator=[char]

Separator for plug parameter when specifying more than 1 plug (Default Value: ,)

-C, --separator=[char]

Separator for CSV created by 'list' operation (Default Value: ,)

--delay=[seconds]

Wait X seconds before fencing is started (Default Value: 0)

--disable-timeout=[true/false]

Disable timeout (true/false) (default: true when run from Pacemaker 2.0+)

--host-os=[os]

Operating system of the host (linux|macos|windows) (Default Value: linux)

--login-timeout=[seconds]

Wait X seconds for cmd prompt after login (Default Value: 5)

--missing-as-off

Missing port returns OFF instead of failure

--power-timeout=[seconds]

Test X seconds for status change after ON/OFF (Default Value: 20)

--power-wait=[seconds]

Wait X seconds after issuing ON/OFF (Default Value: 0)

--shell-timeout=[seconds]

Wait X seconds for cmd prompt after issuing command (Default Value: 3)

--stonith-status-sleep=[seconds]

Sleep X seconds between status calls during a STONITH action (Default Value: 1)

--vboxmanage-path=[path]

Path to VBoxManage on the host (Default Value: VBoxManage)

--retry-on=[attempts]

Count of attempts to retry power on (Default Value: 1)

--use-sudo

Use sudo (without password) when calling 3rd party software

--ssh-path=[path]

Path to ssh binary (Default Value: /usr/bin/ssh)

--sudo-path=[path]

Path to sudo binary (Default Value: /usr/bin/sudo)

## ACTIONS

on

Power on machine.

off

Power off machine.

reboot

Reboot machine.

status

This returns the status of the plug/virtual machine.

list

List available plugs with aliases/virtual machines if there is support for more then one device. Returns N/A otherwise.

list-status

List available plugs with aliases/virtual machines and their power state if it can be obtained without additional commands.

monitor

Check the health of fence device

metadata

Display the XML metadata describing this resource.

manpage

The operational behavior of this is not known.

validate-all

Validate if all required parameters are entered.

## STDIN PARAMETERS

action

Fencing action (Default Value: reboot)

command_prompt

Force Python regex for command prompt (Default Value: ['\[EXPECT\]#']) Obsoletes: cmd_prompt

identity_file

Identity file (private key) for SSH

inet4_only

Forces agent to use IPv4 addresses only

inet6_only

Forces agent to use IPv6 addresses only

ip

IP address or hostname of fencing device This parameter is always required. Obsoletes: ipaddr

ipport

TCP/UDP port to use for connection with device (Default Value: 22)

password

Login password or passphrase Obsoletes: passwd

password_script

Script to run to retrieve password Obsoletes: passwd_script

plug

Physical plug number on device, UUID or identification of machine This parameter is always required. Obsoletes: port

ssh

Use SSH connection (Default Value: 1) Obsoletes: secure

ssh_options

SSH options to use (Default Value: -t '/bin/bash -c "PS1=\[EXPECT\]# HISTFILE=/dev/null /bin/bash --noprofile --norc"')

username

Login name This parameter is always required. Obsoletes: login

quiet

Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.

verbose

Verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity.

verbose_level

Level of debugging detail in output. Defaults to the number of --verbose flags specified on the command line, or to 1 if verbose=1 in a stonith device configuration (i.e., on stdin).

debug_file

Write debug information to given file Obsoletes: debug

version

Display version information and exit

help

Display help and exit

plug_separator

Separator for plug parameter when specifying more than 1 plug (Default Value: ,)

separator

Separator for CSV created by 'list' operation (Default Value: ,)

delay

Wait X seconds before fencing is started (Default Value: 0)

disable_timeout

Disable timeout (true/false) (default: true when run from Pacemaker 2.0+)

host_os

Operating system of the host (linux|macos|windows) (Default Value: linux)

login_timeout

Wait X seconds for cmd prompt after login (Default Value: 5)

missing_as_off

Missing port returns OFF instead of failure

power_timeout

Test X seconds for status change after ON/OFF (Default Value: 20)

power_wait

Wait X seconds after issuing ON/OFF (Default Value: 0)

shell_timeout

Wait X seconds for cmd prompt after issuing command (Default Value: 3)

stonith_status_sleep

Sleep X seconds between status calls during a STONITH action (Default Value: 1)

vboxmanage_path

Path to VBoxManage on the host (Default Value: VBoxManage)

retry_on

Count of attempts to retry power on (Default Value: 1)

use_sudo

Use sudo (without password) when calling 3rd party software Obsoletes: sudo

ssh_path

Path to ssh binary (Default Value: /usr/bin/ssh)

sudo_path

Path to sudo binary (Default Value: /usr/bin/sudo)


package: fence-agents-virsh

title: fence_virsh(8)

text:
# fence_virsh(8)

## NAME
fence_virsh - Fence agent for virsh

## DESCRIPTION
fence_virsh is a Power Fencing agent which can be used with the virtual machines managed by libvirt. It logs via ssh to a dom0 and there run virsh command, which does all work.

By default, virsh needs root account to do properly work. So you must allow ssh login in your sshd_config.

fence_virsh accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent. fence_virsh can be run by itself with command line options. This is useful for testing and for turning outlets on or off from scripts.

Vendor URL: http://libvirt.org

## PARAMETERS

-o, --action=[action]

Fencing action (Default Value: reboot)

-c, --command-prompt=[prompt]

Force Python regex for command prompt (Default Value: ['\[EXPECT\]#'])

-k, --identity-file=[filename]

Identity file (private key) for SSH

-4, --inet4-only

Forces agent to use IPv4 addresses only

-6, --inet6-only

Forces agent to use IPv6 addresses only

-a, --ip=[ip]

IP address or hostname of fencing device This parameter is always required.

-u, --ipport=[port]

TCP/UDP port to use for connection with device (Default Value: 22)

-p, --password=[password]

Login password or passphrase

-S, --password-script=[script]

Script to run to retrieve password

-n, --plug=[id]

Physical plug number on device, UUID or identification of machine This parameter is always required.

-x, --ssh

Use SSH connection (Default Value: 1)

--ssh-options=[options]

SSH options to use (Default Value: -t '/bin/bash -c "PS1=\[EXPECT\]# /bin/bash --noprofile --norc"')

-l, --username=[name]

Login name This parameter is always required.

-q, --quiet

Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.

-v, --verbose

Verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity.

--verbose-level

Level of debugging detail in output. Defaults to the number of --verbose flags specified on the command line, or to 1 if verbose=1 in a stonith device configuration (i.e., on stdin).

-D, --debug-file=[debugfile]

Write debug information to given file

-V, --version

Display version information and exit

-h, --help

Display help and exit

--plug-separator=[char]

Separator for plug parameter when specifying more than 1 plug (Default Value: ,)

-C, --separator=[char]

Separator for CSV created by 'list' operation (Default Value: ,)

--delay=[seconds]

Wait X seconds before fencing is started (Default Value: 0)

--disable-timeout=[true/false]

Disable timeout (true/false) (default: true when run from Pacemaker 2.0+)

--login-timeout=[seconds]

Wait X seconds for cmd prompt after login (Default Value: 5)

--missing-as-off

Missing port returns OFF instead of failure

--power-timeout=[seconds]

Test X seconds for status change after ON/OFF (Default Value: 20)

--power-wait=[seconds]

Wait X seconds after issuing ON/OFF (Default Value: 0)

--shell-timeout=[seconds]

Wait X seconds for cmd prompt after issuing command (Default Value: 3)

--stonith-status-sleep=[seconds]

Sleep X seconds between status calls during a STONITH action (Default Value: 1)

--retry-on=[attempts]

Count of attempts to retry power on (Default Value: 1)

--use-sudo

Use sudo (without password) when calling 3rd party software

--ssh-path=[path]

Path to ssh binary (Default Value: /usr/bin/ssh)

--sudo-path=[path]

Path to sudo binary (Default Value: /usr/bin/sudo)

## ACTIONS

on

Power on machine.

off

Power off machine.

reboot

Reboot machine.

status

This returns the status of the plug/virtual machine.

list

List available plugs with aliases/virtual machines if there is support for more then one device. Returns N/A otherwise.

list-status

List available plugs with aliases/virtual machines and their power state if it can be obtained without additional commands.

monitor

Check the health of fence device

metadata

Display the XML metadata describing this resource.

manpage

The operational behavior of this is not known.

validate-all

Validate if all required parameters are entered.

## STDIN PARAMETERS

action

Fencing action (Default Value: reboot)

command_prompt

Force Python regex for command prompt (Default Value: ['\[EXPECT\]#']) Obsoletes: cmd_prompt

identity_file

Identity file (private key) for SSH

inet4_only

Forces agent to use IPv4 addresses only

inet6_only

Forces agent to use IPv6 addresses only

ip

IP address or hostname of fencing device This parameter is always required. Obsoletes: ipaddr

ipport

TCP/UDP port to use for connection with device (Default Value: 22)

password

Login password or passphrase Obsoletes: passwd

password_script

Script to run to retrieve password Obsoletes: passwd_script

plug

Physical plug number on device, UUID or identification of machine This parameter is always required. Obsoletes: port

ssh

Use SSH connection (Default Value: 1) Obsoletes: secure

ssh_options

SSH options to use (Default Value: -t '/bin/bash -c "PS1=\[EXPECT\]# /bin/bash --noprofile --norc"')

username

Login name This parameter is always required. Obsoletes: login

quiet

Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.

verbose

Verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity.

verbose_level

Level of debugging detail in output. Defaults to the number of --verbose flags specified on the command line, or to 1 if verbose=1 in a stonith device configuration (i.e., on stdin).

debug_file

Write debug information to given file Obsoletes: debug

version

Display version information and exit

help

Display help and exit

plug_separator

Separator for plug parameter when specifying more than 1 plug (Default Value: ,)

separator

Separator for CSV created by 'list' operation (Default Value: ,)

delay

Wait X seconds before fencing is started (Default Value: 0)

disable_timeout

Disable timeout (true/false) (default: true when run from Pacemaker 2.0+)

login_timeout

Wait X seconds for cmd prompt after login (Default Value: 5)

missing_as_off

Missing port returns OFF instead of failure

power_timeout

Test X seconds for status change after ON/OFF (Default Value: 20)

power_wait

Wait X seconds after issuing ON/OFF (Default Value: 0)

shell_timeout

Wait X seconds for cmd prompt after issuing command (Default Value: 3)

stonith_status_sleep

Sleep X seconds between status calls during a STONITH action (Default Value: 1)

retry_on

Count of attempts to retry power on (Default Value: 1)

use_sudo

Use sudo (without password) when calling 3rd party software Obsoletes: sudo

ssh_path

Path to ssh binary (Default Value: /usr/bin/ssh)

sudo_path

Path to sudo binary (Default Value: /usr/bin/sudo)


package: fence-agents-vmware

title: fence_vmware(8)

text:
# fence_vmware(8)

## NAME
fence_vmware - Fence agent for VMWare

## DESCRIPTION
fence_vmware is a Power Fencing agent which can be used with the VMware ESX, VMware ESXi or VMware Server to fence virtual machines.

Before you can use this agent, it must be installed VI Perl Toolkit or vmrun command on every node you want to make fencing.

VI Perl Toolkit is preferred for VMware ESX/ESXi and Virtual Center. Vmrun command is only solution for VMware Server 1/2 (this command will works against ESX/ESXi 3.5 up2 and VC up2 too, but not cluster aware!) and is available as part of VMware VIX API SDK package. VI Perl and VIX API SDK are both available from VMware web pages (not int RHEL repository!).

You can specify type of VMware you are connecting to with -d switch (or vmware_type for stdin). Possible values are esx, server2 and server1.Default value is esx, which will use VI Perl. With server1 and server2, vmrun command is used.

After you have successfully installed VI Perl Toolkit or VIX API, you should be able to run fence_vmware_helper (part of this agent) or vmrun command. This agent supports only vmrun from version 2.0.0 (VIX API 1.6.0).

fence_vmware accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent. fence_vmware can be run by itself with command line options. This is useful for testing and for turning outlets on or off from scripts.

Vendor URL: http://www.vmware.com

## PARAMETERS

-o, --action=[action]

Fencing action (Default Value: reboot)

-e, --exec=[command]

Command to execute

-k, --identity-file=[filename]

Identity file (private key) for SSH

-4, --inet4-only

Forces agent to use IPv4 addresses only

-6, --inet6-only

Forces agent to use IPv6 addresses only

-a, --ip=[ip]

IP address or hostname of fencing device

-u, --ipport=[port]

TCP/UDP port to use for connection with device (Default Value: 22)

-p, --password=[password]

Login password or passphrase

-S, --password-script=[script]

Script to run to retrieve password

-n, --plug=[ip]

IP address or hostname of fencing device (together with --port-as-ip)

-x, --ssh

Use SSH connection (Default Value: 1)

--ssh-options=[options]

SSH options to use

-l, --username=[name]

Login name This parameter is always required.

-d, --vmware_type=[type]

Type of VMware to connect (Default Value: esx)

-s, --vmware-datacenter=[dc]

VMWare datacenter filter

-q, --quiet

Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.

-v, --verbose

Verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity.

--verbose-level

Level of debugging detail in output. Defaults to the number of --verbose flags specified on the command line, or to 1 if verbose=1 in a stonith device configuration (i.e., on stdin).

-D, --debug-file=[debugfile]

Write debug information to given file

-V, --version

Display version information and exit

-h, --help

Display help and exit

--plug-separator=[char]

Separator for plug parameter when specifying more than 1 plug (Default Value: ,)

--delay=[seconds]

Wait X seconds before fencing is started (Default Value: 0)

--disable-timeout=[true/false]

Disable timeout (true/false) (default: true when run from Pacemaker 2.0+)

--login-timeout=[seconds]

Wait X seconds for cmd prompt after login (Default Value: 5)

--port-as-ip

Make "port/plug" to be an alias to IP address

--power-timeout=[seconds]

Test X seconds for status change after ON/OFF (Default Value: 20)

--power-wait=[seconds]

Wait X seconds after issuing ON/OFF (Default Value: 0)

--shell-timeout=[seconds]

Wait X seconds for cmd prompt after issuing command (Default Value: 3)

--stonith-status-sleep=[seconds]

Sleep X seconds between status calls during a STONITH action (Default Value: 1)

--retry-on=[attempts]

Count of attempts to retry power on (Default Value: 1)

--ssh-path=[path]

Path to ssh binary (Default Value: /usr/bin/ssh)

## ACTIONS

on

Power on machine.

off

Power off machine.

reboot

Reboot machine.

status

This returns the status of the plug/virtual machine.

monitor

Check the health of fence device

metadata

Display the XML metadata describing this resource.

manpage

The operational behavior of this is not known.

validate-all

Validate if all required parameters are entered.

## STDIN PARAMETERS

action

Fencing action (Default Value: reboot)

exec

Command to execute

identity_file

Identity file (private key) for SSH

inet4_only

Forces agent to use IPv4 addresses only

inet6_only

Forces agent to use IPv6 addresses only

ip

IP address or hostname of fencing device Obsoletes: ipaddr

ipport

TCP/UDP port to use for connection with device (Default Value: 22)

password

Login password or passphrase Obsoletes: passwd

password_script

Script to run to retrieve password Obsoletes: passwd_script

plug

IP address or hostname of fencing device (together with --port-as-ip) Obsoletes: port

ssh

Use SSH connection (Default Value: 1) Obsoletes: secure

ssh_options

SSH options to use

username

Login name This parameter is always required. Obsoletes: login

vmware_type

Type of VMware to connect (Default Value: esx)

vmware_datacenter

VMWare datacenter filter

quiet

Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.

verbose

Verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity.

verbose_level

Level of debugging detail in output. Defaults to the number of --verbose flags specified on the command line, or to 1 if verbose=1 in a stonith device configuration (i.e., on stdin).

debug_file

Write debug information to given file Obsoletes: debug

version

Display version information and exit

help

Display help and exit

plug_separator

Separator for plug parameter when specifying more than 1 plug (Default Value: ,)

delay

Wait X seconds before fencing is started (Default Value: 0)

disable_timeout

Disable timeout (true/false) (default: true when run from Pacemaker 2.0+)

login_timeout

Wait X seconds for cmd prompt after login (Default Value: 5)

port_as_ip

Make "port/plug" to be an alias to IP address

power_timeout

Test X seconds for status change after ON/OFF (Default Value: 20)

power_wait

Wait X seconds after issuing ON/OFF (Default Value: 0)

shell_timeout

Wait X seconds for cmd prompt after issuing command (Default Value: 3)

stonith_status_sleep

Sleep X seconds between status calls during a STONITH action (Default Value: 1)

retry_on

Count of attempts to retry power on (Default Value: 1)

ssh_path

Path to ssh binary (Default Value: /usr/bin/ssh)


package: fence-agents-vmware-rest

title: fence_vmware_rest(8)

text:
# fence_vmware_rest(8)

## NAME
fence_vmware_rest - Fence agent for VMware REST API

## DESCRIPTION
fence_vmware_rest is a Power Fencing agent which can be used with VMware API to fence virtual machines.

NOTE: If there's more than 1000 VMs there is a filter parameter to work around the API limit. See https://code.vmware.com/apis/62/vcenter-management#/VM%20/get_vcenter_vm for full list of filters.

fence_vmware_rest accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent. fence_vmware_rest can be run by itself with command line options. This is useful for testing and for turning outlets on or off from scripts.

Vendor URL: https://www.vmware.com

## PARAMETERS

-o, --action=[action]

Fencing action (Default Value: reboot)

-a, --ip=[ip]

IP address or hostname of fencing device This parameter is always required.

-u, --ipport=[port]

TCP/UDP port to use for connection with device (Default Value: 80)

-t, --notls

Disable TLS negotiation and force SSL3.0. This should only be used for devices that do not support TLS1.0 and up.

-p, --password=[password]

Login password or passphrase

-S, --password-script=[script]

Script to run to retrieve password

-n, --plug=[id]

Physical plug number on device, UUID or identification of machine This parameter is always required.

-z, --ssl

Use SSL connection with verifying certificate

--ssl-insecure

Use SSL connection without verifying certificate

--ssl-secure

Use SSL connection with verifying certificate

-l, --username=[name]

Login name This parameter is always required.

--api-path=[path]

The path part of the API URL (Default Value: /rest)

--filter=[filter]

Filter to only return relevant VMs. It can be used to avoid the agent failing when more than 1000 VMs should be returned.

-q, --quiet

Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.

-v, --verbose

Verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity.

--verbose-level

Level of debugging detail in output. Defaults to the number of --verbose flags specified on the command line, or to 1 if verbose=1 in a stonith device configuration (i.e., on stdin).

-D, --debug-file=[debugfile]

Write debug information to given file

-V, --version

Display version information and exit

-h, --help

Display help and exit

--plug-separator=[char]

Separator for plug parameter when specifying more than 1 plug (Default Value: ,)

-C, --separator=[char]

Separator for CSV created by 'list' operation (Default Value: ,)

--delay=[seconds]

Wait X seconds before fencing is started (Default Value: 0)

--disable-timeout=[true/false]

Disable timeout (true/false) (default: true when run from Pacemaker 2.0+)

--login-timeout=[seconds]

Wait X seconds for cmd prompt after login (Default Value: 5)

--power-timeout=[seconds]

Test X seconds for status change after ON/OFF (Default Value: 20)

--power-wait=[seconds]

Wait X seconds after issuing ON/OFF (Default Value: 1)

--shell-timeout=[seconds]

Wait X seconds for cmd prompt after issuing command (Default Value: 5)

--stonith-status-sleep=[seconds]

Sleep X seconds between status calls during a STONITH action (Default Value: 1)

--retry-on=[attempts]

Count of attempts to retry power on (Default Value: 1)

--gnutlscli-path=[path]

Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)

## ACTIONS

on

Power on machine.

off

Power off machine.

reboot

Reboot machine.

status

This returns the status of the plug/virtual machine.

list

List available plugs with aliases/virtual machines if there is support for more then one device. Returns N/A otherwise.

list-status

List available plugs with aliases/virtual machines and their power state if it can be obtained without additional commands.

monitor

Check the health of fence device

metadata

Display the XML metadata describing this resource.

manpage

The operational behavior of this is not known.

validate-all

Validate if all required parameters are entered.

## STDIN PARAMETERS

action

Fencing action (Default Value: reboot)

ip

IP address or hostname of fencing device This parameter is always required. Obsoletes: ipaddr

ipport

TCP/UDP port to use for connection with device (Default Value: 80)

notls

Disable TLS negotiation and force SSL3.0. This should only be used for devices that do not support TLS1.0 and up.

password

Login password or passphrase Obsoletes: passwd

password_script

Script to run to retrieve password Obsoletes: passwd_script

plug

Physical plug number on device, UUID or identification of machine This parameter is always required. Obsoletes: port

ssl

Use SSL connection with verifying certificate

ssl_insecure

Use SSL connection without verifying certificate

ssl_secure

Use SSL connection with verifying certificate

username

Login name This parameter is always required. Obsoletes: login

api_path

The path part of the API URL (Default Value: /rest)

filter

Filter to only return relevant VMs. It can be used to avoid the agent failing when more than 1000 VMs should be returned.

quiet

Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.

verbose

Verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity.

verbose_level

Level of debugging detail in output. Defaults to the number of --verbose flags specified on the command line, or to 1 if verbose=1 in a stonith device configuration (i.e., on stdin).

debug_file

Write debug information to given file Obsoletes: debug

version

Display version information and exit

help

Display help and exit

plug_separator

Separator for plug parameter when specifying more than 1 plug (Default Value: ,)

separator

Separator for CSV created by 'list' operation (Default Value: ,)

delay

Wait X seconds before fencing is started (Default Value: 0)

disable_timeout

Disable timeout (true/false) (default: true when run from Pacemaker 2.0+)

login_timeout

Wait X seconds for cmd prompt after login (Default Value: 5)

power_timeout

Test X seconds for status change after ON/OFF (Default Value: 20)

power_wait

Wait X seconds after issuing ON/OFF (Default Value: 1)

shell_timeout

Wait X seconds for cmd prompt after issuing command (Default Value: 5)

stonith_status_sleep

Sleep X seconds between status calls during a STONITH action (Default Value: 1)

retry_on

Count of attempts to retry power on (Default Value: 1)

gnutlscli_path

Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)


package: fence-agents-vmware-soap

title: fence_vmware_soap(8)

text:
# fence_vmware_soap(8)

## NAME
fence_vmware_soap - Fence agent for VMWare over SOAP API

## DESCRIPTION
fence_vmware_soap is a Power Fencing agent which can be used with the virtual machines managed by VMWare products that have SOAP API v4.1+.

Name of virtual machine (-n / port) has to be used in inventory path format (e.g. /datacenter/vm/Discovered virtual machine/myMachine). In the cases when name of yours VM is unique you can use it instead. Alternatively you can always use UUID to access virtual machine.

fence_vmware_soap accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent. fence_vmware_soap can be run by itself with command line options. This is useful for testing and for turning outlets on or off from scripts.

Vendor URL: http://www.vmware.com

## PARAMETERS

-o, --action=[action]

Fencing action (Default Value: reboot)

-a, --ip=[ip]

IP address or hostname of fencing device This parameter is always required.

-u, --ipport=[port]

TCP/UDP port to use for connection with device (Default Value: 80)

-t, --notls

Disable TLS negotiation and force SSL3.0. This should only be used for devices that do not support TLS1.0 and up.

-p, --password=[password]

Login password or passphrase

-S, --password-script=[script]

Script to run to retrieve password

-n, --plug=[id]

Physical plug number on device, UUID or identification of machine This parameter is always required.

-z, --ssl

Use SSL connection with verifying certificate

--ssl-insecure

Use SSL connection without verifying certificate

--ssl-secure

Use SSL connection with verifying certificate

-l, --username=[name]

Login name This parameter is always required.

-q, --quiet

Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.

-v, --verbose

Verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity.

--verbose-level

Level of debugging detail in output. Defaults to the number of --verbose flags specified on the command line, or to 1 if verbose=1 in a stonith device configuration (i.e., on stdin).

-D, --debug-file=[debugfile]

Write debug information to given file

-V, --version

Display version information and exit

-h, --help

Display help and exit

--plug-separator=[char]

Separator for plug parameter when specifying more than 1 plug (Default Value: ,)

-C, --separator=[char]

Separator for CSV created by 'list' operation (Default Value: ,)

--delay=[seconds]

Wait X seconds before fencing is started (Default Value: 0)

--disable-timeout=[true/false]

Disable timeout (true/false) (default: true when run from Pacemaker 2.0+)

--login-timeout=[seconds]

Wait X seconds for cmd prompt after login (Default Value: 5)

--power-timeout=[seconds]

Test X seconds for status change after ON/OFF (Default Value: 20)

--power-wait=[seconds]

Wait X seconds after issuing ON/OFF (Default Value: 0)

--shell-timeout=[seconds]

Wait X seconds for cmd prompt after issuing command (Default Value: 3)

--stonith-status-sleep=[seconds]

Sleep X seconds between status calls during a STONITH action (Default Value: 1)

--retry-on=[attempts]

Count of attempts to retry power on (Default Value: 1)

--gnutlscli-path=[path]

Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)

## ACTIONS

on

Power on machine.

off

Power off machine.

reboot

Reboot machine.

status

This returns the status of the plug/virtual machine.

list

List available plugs with aliases/virtual machines if there is support for more then one device. Returns N/A otherwise.

list-status

List available plugs with aliases/virtual machines and their power state if it can be obtained without additional commands.

monitor

Check the health of fence device

metadata

Display the XML metadata describing this resource.

manpage

The operational behavior of this is not known.

validate-all

Validate if all required parameters are entered.

## STDIN PARAMETERS

action

Fencing action (Default Value: reboot)

ip

IP address or hostname of fencing device This parameter is always required. Obsoletes: ipaddr

ipport

TCP/UDP port to use for connection with device (Default Value: 80)

notls

Disable TLS negotiation and force SSL3.0. This should only be used for devices that do not support TLS1.0 and up.

password

Login password or passphrase Obsoletes: passwd

password_script

Script to run to retrieve password Obsoletes: passwd_script

plug

Physical plug number on device, UUID or identification of machine This parameter is always required. Obsoletes: port

ssl

Use SSL connection with verifying certificate

ssl_insecure

Use SSL connection without verifying certificate

ssl_secure

Use SSL connection with verifying certificate

username

Login name This parameter is always required. Obsoletes: login

quiet

Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.

verbose

Verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity.

verbose_level

Level of debugging detail in output. Defaults to the number of --verbose flags specified on the command line, or to 1 if verbose=1 in a stonith device configuration (i.e., on stdin).

debug_file

Write debug information to given file Obsoletes: debug

version

Display version information and exit

help

Display help and exit

plug_separator

Separator for plug parameter when specifying more than 1 plug (Default Value: ,)

separator

Separator for CSV created by 'list' operation (Default Value: ,)

delay

Wait X seconds before fencing is started (Default Value: 0)

disable_timeout

Disable timeout (true/false) (default: true when run from Pacemaker 2.0+)

login_timeout

Wait X seconds for cmd prompt after login (Default Value: 5)

power_timeout

Test X seconds for status change after ON/OFF (Default Value: 20)

power_wait

Wait X seconds after issuing ON/OFF (Default Value: 0)

shell_timeout

Wait X seconds for cmd prompt after issuing command (Default Value: 3)

stonith_status_sleep

Sleep X seconds between status calls during a STONITH action (Default Value: 1)

retry_on

Count of attempts to retry power on (Default Value: 1)

gnutlscli_path

Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)


package: fence-agents-vmware-vcloud

title: fence_vmware_vcloud(8)

text:
# fence_vmware_vcloud(8)

## NAME
fence_vmware_vcloud - Fence agent for VMware vCloud Director API

## DESCRIPTION
fence_vmware_vcloud is a Power Fencing agent which can be used with VMware vCloud Director API to fence virtual machines.

fence_vmware_vcloud accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent. fence_vmware_vcloud can be run by itself with command line options. This is useful for testing and for turning outlets on or off from scripts.

Vendor URL: https://www.vmware.com

## PARAMETERS

-o, --action=[action]

Fencing action (Default Value: reboot)

-a, --ip=[ip]

IP address or hostname of fencing device This parameter is always required.

-u, --ipport=[port]

TCP/UDP port to use for connection with device (Default Value: 80)

-t, --notls

Disable TLS negotiation and force SSL3.0. This should only be used for devices that do not support TLS1.0 and up.

-p, --password=[password]

Login password or passphrase

-S, --password-script=[script]

Script to run to retrieve password

-n, --plug=[id]

Physical plug number on device, UUID or identification of machine This parameter is always required.

-z, --ssl

Use SSL connection with verifying certificate

--ssl-insecure

Use SSL connection without verifying certificate

--ssl-secure

Use SSL connection with verifying certificate

-l, --username=[name]

Login name This parameter is always required.

--api-path=[path]

The path part of the API URL (Default Value: /api)

-q, --quiet

Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.

-v, --verbose

Verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity.

--verbose-level

Level of debugging detail in output. Defaults to the number of --verbose flags specified on the command line, or to 1 if verbose=1 in a stonith device configuration (i.e., on stdin).

-D, --debug-file=[debugfile]

Write debug information to given file

-V, --version

Display version information and exit

-h, --help

Display help and exit

--plug-separator=[char]

Separator for plug parameter when specifying more than 1 plug (Default Value: ,)

-C, --separator=[char]

Separator for CSV created by 'list' operation (Default Value: ,)

--delay=[seconds]

Wait X seconds before fencing is started (Default Value: 0)

--disable-timeout=[true/false]

Disable timeout (true/false) (default: true when run from Pacemaker 2.0+)

--login-timeout=[seconds]

Wait X seconds for cmd prompt after login (Default Value: 5)

--power-timeout=[seconds]

Test X seconds for status change after ON/OFF (Default Value: 20)

--power-wait=[seconds]

Wait X seconds after issuing ON/OFF (Default Value: 1)

--shell-timeout=[seconds]

Wait X seconds for cmd prompt after issuing command (Default Value: 5)

--stonith-status-sleep=[seconds]

Sleep X seconds between status calls during a STONITH action (Default Value: 1)

--retry-on=[attempts]

Count of attempts to retry power on (Default Value: 1)

--gnutlscli-path=[path]

Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)

## ACTIONS

on

Power on machine.

off

Power off machine.

reboot

Reboot machine.

status

This returns the status of the plug/virtual machine.

list

List available plugs with aliases/virtual machines if there is support for more then one device. Returns N/A otherwise.

list-status

List available plugs with aliases/virtual machines and their power state if it can be obtained without additional commands.

monitor

Check the health of fence device

metadata

Display the XML metadata describing this resource.

manpage

The operational behavior of this is not known.

validate-all

Validate if all required parameters are entered.

## STDIN PARAMETERS

action

Fencing action (Default Value: reboot)

ip

IP address or hostname of fencing device This parameter is always required. Obsoletes: ipaddr

ipport

TCP/UDP port to use for connection with device (Default Value: 80)

notls

Disable TLS negotiation and force SSL3.0. This should only be used for devices that do not support TLS1.0 and up.

password

Login password or passphrase Obsoletes: passwd

password_script

Script to run to retrieve password Obsoletes: passwd_script

plug

Physical plug number on device, UUID or identification of machine This parameter is always required. Obsoletes: port

ssl

Use SSL connection with verifying certificate

ssl_insecure

Use SSL connection without verifying certificate

ssl_secure

Use SSL connection with verifying certificate

username

Login name This parameter is always required. Obsoletes: login

api_path

The path part of the API URL (Default Value: /api)

quiet

Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.

verbose

Verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity.

verbose_level

Level of debugging detail in output. Defaults to the number of --verbose flags specified on the command line, or to 1 if verbose=1 in a stonith device configuration (i.e., on stdin).

debug_file

Write debug information to given file Obsoletes: debug

version

Display version information and exit

help

Display help and exit

plug_separator

Separator for plug parameter when specifying more than 1 plug (Default Value: ,)

separator

Separator for CSV created by 'list' operation (Default Value: ,)

delay

Wait X seconds before fencing is started (Default Value: 0)

disable_timeout

Disable timeout (true/false) (default: true when run from Pacemaker 2.0+)

login_timeout

Wait X seconds for cmd prompt after login (Default Value: 5)

power_timeout

Test X seconds for status change after ON/OFF (Default Value: 20)

power_wait

Wait X seconds after issuing ON/OFF (Default Value: 1)

shell_timeout

Wait X seconds for cmd prompt after issuing command (Default Value: 5)

stonith_status_sleep

Sleep X seconds between status calls during a STONITH action (Default Value: 1)

retry_on

Count of attempts to retry power on (Default Value: 1)

gnutlscli_path

Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)


package: fence-agents-wti

title: fence_wti(8)

text:
# fence_wti(8)

## NAME
fence_wti - Fence agent for WTI

## DESCRIPTION
fence_wti is a Power Fencing agent which can be used with the WTI Network Power Switch (NPS). It logs into an NPS via telnet or ssh and boots a specified plug. Lengthy telnet connections to the NPS should be avoided while a GFS cluster is running because the connection will block any necessary fencing actions.

fence_wti accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent. fence_wti can be run by itself with command line options. This is useful for testing and for turning outlets on or off from scripts.

Vendor URL: http://www.wti.com

## PARAMETERS

-o, --action=[action]

Fencing action (Default Value: reboot)

-c, --command-prompt=[prompt]

Force Python regex for command prompt (Default Value: ['RSM>', 'MPC>', 'IPS>', 'TPS>', 'NBB>', 'NPS>', 'VMR>'])

-k, --identity-file=[filename]

Identity file (private key) for SSH

-4, --inet4-only

Forces agent to use IPv4 addresses only

-6, --inet6-only

Forces agent to use IPv6 addresses only

-a, --ip=[ip]

IP address or hostname of fencing device This parameter is always required.

-u, --ipport=[port]

TCP/UDP port to use for connection with device (Default Value: 23)

-p, --password=[password]

Login password or passphrase

-S, --password-script=[script]

Script to run to retrieve password

-n, --plug=[id]

Physical plug number on device, UUID or identification of machine This parameter is always required.

-x, --ssh

Use SSH connection

--ssh-options=[options]

SSH options to use

-l, --username=[name]

Login name

-q, --quiet

Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.

-v, --verbose

Verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity.

--verbose-level

Level of debugging detail in output. Defaults to the number of --verbose flags specified on the command line, or to 1 if verbose=1 in a stonith device configuration (i.e., on stdin).

-D, --debug-file=[debugfile]

Write debug information to given file

-V, --version

Display version information and exit

-h, --help

Display help and exit

--plug-separator=[char]

Separator for plug parameter when specifying more than 1 plug (Default Value: ,)

-C, --separator=[char]

Separator for CSV created by 'list' operation (Default Value: ,)

--delay=[seconds]

Wait X seconds before fencing is started (Default Value: 0)

--disable-timeout=[true/false]

Disable timeout (true/false) (default: true when run from Pacemaker 2.0+)

--login-timeout=[seconds]

Wait X seconds for cmd prompt after login (Default Value: 10)

--power-timeout=[seconds]

Test X seconds for status change after ON/OFF (Default Value: 20)

--power-wait=[seconds]

Wait X seconds after issuing ON/OFF (Default Value: 0)

--shell-timeout=[seconds]

Wait X seconds for cmd prompt after issuing command (Default Value: 3)

--stonith-status-sleep=[seconds]

Sleep X seconds between status calls during a STONITH action (Default Value: 1)

--retry-on=[attempts]

Count of attempts to retry power on (Default Value: 1)

--ssh-path=[path]

Path to ssh binary (Default Value: /usr/bin/ssh)

--telnet-path=[path]

Path to telnet binary (Default Value: /usr/bin/telnet)

## ACTIONS

on

Power on machine.

off

Power off machine.

reboot

Reboot machine.

status

This returns the status of the plug/virtual machine.

list

List available plugs with aliases/virtual machines if there is support for more then one device. Returns N/A otherwise.

list-status

List available plugs with aliases/virtual machines and their power state if it can be obtained without additional commands.

monitor

Check the health of fence device

metadata

Display the XML metadata describing this resource.

manpage

The operational behavior of this is not known.

validate-all

Validate if all required parameters are entered.

## STDIN PARAMETERS

action

Fencing action (Default Value: reboot)

command_prompt

Force Python regex for command prompt (Default Value: ['RSM>', 'MPC>', 'IPS>', 'TPS>', 'NBB>', 'NPS>', 'VMR>']) Obsoletes: cmd_prompt

identity_file

Identity file (private key) for SSH

inet4_only

Forces agent to use IPv4 addresses only

inet6_only

Forces agent to use IPv6 addresses only

ip

IP address or hostname of fencing device This parameter is always required. Obsoletes: ipaddr

ipport

TCP/UDP port to use for connection with device (Default Value: 23)

password

Login password or passphrase Obsoletes: passwd

password_script

Script to run to retrieve password Obsoletes: passwd_script

plug

Physical plug number on device, UUID or identification of machine This parameter is always required. Obsoletes: port

ssh

Use SSH connection Obsoletes: secure

ssh_options

SSH options to use

username

Login name Obsoletes: login

quiet

Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.

verbose

Verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity.

verbose_level

Level of debugging detail in output. Defaults to the number of --verbose flags specified on the command line, or to 1 if verbose=1 in a stonith device configuration (i.e., on stdin).

debug_file

Write debug information to given file Obsoletes: debug

version

Display version information and exit

help

Display help and exit

plug_separator

Separator for plug parameter when specifying more than 1 plug (Default Value: ,)

separator

Separator for CSV created by 'list' operation (Default Value: ,)

delay

Wait X seconds before fencing is started (Default Value: 0)

disable_timeout

Disable timeout (true/false) (default: true when run from Pacemaker 2.0+)

login_timeout

Wait X seconds for cmd prompt after login (Default Value: 10)

power_timeout

Test X seconds for status change after ON/OFF (Default Value: 20)

power_wait

Wait X seconds after issuing ON/OFF (Default Value: 0)

shell_timeout

Wait X seconds for cmd prompt after issuing command (Default Value: 3)

stonith_status_sleep

Sleep X seconds between status calls during a STONITH action (Default Value: 1)

retry_on

Count of attempts to retry power on (Default Value: 1)

ssh_path

Path to ssh binary (Default Value: /usr/bin/ssh)

telnet_path

Path to telnet binary (Default Value: /usr/bin/telnet)


package: fence-agents-xenapi

title: fence_xenapi(8)

text:
# fence_xenapi(8)

## NAME
fence_xenapi - Fence agent for Citrix XenServer over XenAPI

## DESCRIPTION
fence_xenapi is a Power Fencing agent used on Citrix XenServer hosts. It uses the XenAPI, supplied by Citrix, to establish an XML-RPC session to a XenServer host. Once the session is established, further XML-RPC commands are issued in order to switch on, switch off, restart and query the status of virtual machines running on the host.

fence_xenapi accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent. fence_xenapi can be run by itself with command line options. This is useful for testing and for turning outlets on or off from scripts.

Vendor URL: http://www.xenproject.org

## PARAMETERS

-o, --action=[action]

Fencing action (Default Value: reboot)

-p, --password=[password]

Login password or passphrase

-S, --password-script=[script]

Script to run to retrieve password

-n, --plug=[id]

Physical plug number on device, UUID or identification of machine This parameter is always required.

-s, --session-url

URL to connect to XenServer on This parameter is always required.

-l, --username=[name]

Login name

-q, --quiet

Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.

-v, --verbose

Verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity.

--verbose-level

Level of debugging detail in output. Defaults to the number of --verbose flags specified on the command line, or to 1 if verbose=1 in a stonith device configuration (i.e., on stdin).

-D, --debug-file=[debugfile]

Write debug information to given file

-V, --version

Display version information and exit

-h, --help

Display help and exit

--plug-separator=[char]

Separator for plug parameter when specifying more than 1 plug (Default Value: ,)

-C, --separator=[char]

Separator for CSV created by 'list' operation (Default Value: ,)

--delay=[seconds]

Wait X seconds before fencing is started (Default Value: 0)

--disable-timeout=[true/false]

Disable timeout (true/false) (default: true when run from Pacemaker 2.0+)

--login-timeout=[seconds]

Wait X seconds for cmd prompt after login (Default Value: 5)

--power-timeout=[seconds]

Test X seconds for status change after ON/OFF (Default Value: 20)

--power-wait=[seconds]

Wait X seconds after issuing ON/OFF (Default Value: 0)

--shell-timeout=[seconds]

Wait X seconds for cmd prompt after issuing command (Default Value: 3)

--stonith-status-sleep=[seconds]

Sleep X seconds between status calls during a STONITH action (Default Value: 1)

--retry-on=[attempts]

Count of attempts to retry power on (Default Value: 1)

## ACTIONS

on

Power on machine.

off

Power off machine.

reboot

Reboot machine.

status

This returns the status of the plug/virtual machine.

list

List available plugs with aliases/virtual machines if there is support for more then one device. Returns N/A otherwise.

list-status

List available plugs with aliases/virtual machines and their power state if it can be obtained without additional commands.

monitor

Check the health of fence device

metadata

Display the XML metadata describing this resource.

manpage

The operational behavior of this is not known.

validate-all

Validate if all required parameters are entered.

## STDIN PARAMETERS

action

Fencing action (Default Value: reboot)

password

Login password or passphrase Obsoletes: passwd

password_script

Script to run to retrieve password Obsoletes: passwd_script

plug

Physical plug number on device, UUID or identification of machine This parameter is always required. Obsoletes: port

session_url

URL to connect to XenServer on This parameter is always required.

username

Login name Obsoletes: login

quiet

Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.

verbose

Verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity.

verbose_level

Level of debugging detail in output. Defaults to the number of --verbose flags specified on the command line, or to 1 if verbose=1 in a stonith device configuration (i.e., on stdin).

debug_file

Write debug information to given file Obsoletes: debug

version

Display version information and exit

help

Display help and exit

plug_separator

Separator for plug parameter when specifying more than 1 plug (Default Value: ,)

separator

Separator for CSV created by 'list' operation (Default Value: ,)

delay

Wait X seconds before fencing is started (Default Value: 0)

disable_timeout

Disable timeout (true/false) (default: true when run from Pacemaker 2.0+)

login_timeout

Wait X seconds for cmd prompt after login (Default Value: 5)

power_timeout

Test X seconds for status change after ON/OFF (Default Value: 20)

power_wait

Wait X seconds after issuing ON/OFF (Default Value: 0)

shell_timeout

Wait X seconds for cmd prompt after issuing command (Default Value: 3)

stonith_status_sleep

Sleep X seconds between status calls during a STONITH action (Default Value: 1)

retry_on

Count of attempts to retry power on (Default Value: 1)


package: fence-agents-zvm

title: fence_zvmip(8)

text:
# fence_zvmip(8)

## NAME
fence_zvmip - Fence agent for use with z/VM Virtual Machines

## DESCRIPTION
fence_zvmip is a Power Fencing agent for z/VM SMAPI service via TCP/IP.

The z/VM SMAPI service must be configured so that the virtual machine running the agent can connect to the service, access the system's directory manager, and shortly thereafter run image_deactivate and image_activate. This involves updating the VSMWORK1 NAMELIST and VSMWORK1 AUTHLIST VMSYS:VSMWORK1 files.

The NAMELIST entry assigns all the required functions to one nick and should look similar to this:

:nick.ZVM_FENCE

:list.

IMAGE_ACTIVATE

IMAGE_DEACTIVATE

IMAGE_STATUS_QUERY

CHECK_AUTHENTICATION

IMAGE_NAME_QUERY_DM

The AUTHLIST entry authorizes the user to perform all the functions associated with the nick, and should look similar to this:

Column 1 Column 66 Column 131

| | |

V V V

XXXXXXXX ALL ZVM_FENCE

where XXXXXXXX is the name of the user in the authuser field of the request.

Refer to the official z/VM documentation for complete instructions and reference materials.

fence_zvmip accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent. fence_zvmip can be run by itself with command line options. This is useful for testing and for turning outlets on or off from scripts.

Vendor URL: http://www.ibm.com

## PARAMETERS

-o, --action=[action]

Fencing action (Default Value: reboot)

-4, --inet4-only

Forces agent to use IPv4 addresses only

-6, --inet6-only

Forces agent to use IPv6 addresses only

-a, --ip=[ip]

IP address or hostname of fencing device This parameter is always required.

-u, --ipport=[port]

TCP/UDP port to use for connection with device (Default Value: 44444)

-m, --method=[method]

Method to fence (onoff|cycle) (Default Value: onoff)

-p, --password=[password]

Login password or passphrase

-S, --password-script=[script]

Script to run to retrieve password

-n, --plug=[id]

Physical plug number on device, UUID or identification of machine This parameter is always required.

-z, --ssl

Use SSL connection with verifying certificate (Default) (Default Value: 1)

--ssl-insecure

Use SSL connection without verifying certificate

--ssl-secure

Use SSL connection with verifying certificate

-l, --username=[name]

Login name This parameter is always required.

--disable-ssl

Don't use SSL

-q, --quiet

Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.

-v, --verbose

Verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity.

--verbose-level

Level of debugging detail in output. Defaults to the number of --verbose flags specified on the command line, or to 1 if verbose=1 in a stonith device configuration (i.e., on stdin).

-D, --debug-file=[debugfile]

Write debug information to given file

-V, --version

Display version information and exit

-h, --help

Display help and exit

--plug-separator=[char]

Separator for plug parameter when specifying more than 1 plug (Default Value: ,)

-C, --separator=[char]

Separator for CSV created by 'list' operation (Default Value: ,)

--delay=[seconds]

Wait X seconds before fencing is started (Default Value: 0)

--disable-timeout=[true/false]

Disable timeout (true/false) (default: true when run from Pacemaker 2.0+)

--login-timeout=[seconds]

Wait X seconds for cmd prompt after login (Default Value: 5)

--missing-as-off

Missing port returns OFF instead of failure (Default Value: 1)

--power-timeout=[seconds]

Test X seconds for status change after ON/OFF (Default Value: 20)

--power-wait=[seconds]

Wait X seconds after issuing ON/OFF (Default Value: 0)

--shell-timeout=[seconds]

Wait X seconds for cmd prompt after issuing command (Default Value: 5)

--stonith-status-sleep=[seconds]

Sleep X seconds between status calls during a STONITH action (Default Value: 1)

--retry-on=[attempts]

Count of attempts to retry power on (Default Value: 1)

--gnutlscli-path=[path]

Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)

## ACTIONS

on

Power on machine.

off

Power off machine.

reboot

Reboot machine.

status

This returns the status of the plug/virtual machine.

list

List available plugs with aliases/virtual machines if there is support for more then one device. Returns N/A otherwise.

list-status

List available plugs with aliases/virtual machines and their power state if it can be obtained without additional commands.

monitor

Check the health of fence device

metadata

Display the XML metadata describing this resource.

manpage

The operational behavior of this is not known.

validate-all

Validate if all required parameters are entered.

## STDIN PARAMETERS

action

Fencing action (Default Value: reboot)

inet4_only

Forces agent to use IPv4 addresses only

inet6_only

Forces agent to use IPv6 addresses only

ip

IP address or hostname of fencing device This parameter is always required. Obsoletes: ipaddr

ipport

TCP/UDP port to use for connection with device (Default Value: 44444)

method

Method to fence (onoff|cycle) (Default Value: onoff)

password

Login password or passphrase Obsoletes: passwd

password_script

Script to run to retrieve password Obsoletes: passwd_script

plug

Physical plug number on device, UUID or identification of machine This parameter is always required. Obsoletes: port

ssl

Use SSL connection with verifying certificate (Default) (Default Value: 1)

ssl_insecure

Use SSL connection without verifying certificate

ssl_secure

Use SSL connection with verifying certificate

username

Login name This parameter is always required. Obsoletes: login

disable_ssl

Don't use SSL

quiet

Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.

verbose

Verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity.

verbose_level

Level of debugging detail in output. Defaults to the number of --verbose flags specified on the command line, or to 1 if verbose=1 in a stonith device configuration (i.e., on stdin).

debug_file

Write debug information to given file Obsoletes: debug

version

Display version information and exit

help

Display help and exit

plug_separator

Separator for plug parameter when specifying more than 1 plug (Default Value: ,)

separator

Separator for CSV created by 'list' operation (Default Value: ,)

delay

Wait X seconds before fencing is started (Default Value: 0)

disable_timeout

Disable timeout (true/false) (default: true when run from Pacemaker 2.0+)

login_timeout

Wait X seconds for cmd prompt after login (Default Value: 5)

missing_as_off

Missing port returns OFF instead of failure (Default Value: 1)

power_timeout

Test X seconds for status change after ON/OFF (Default Value: 20)

power_wait

Wait X seconds after issuing ON/OFF (Default Value: 0)

shell_timeout

Wait X seconds for cmd prompt after issuing command (Default Value: 5)

stonith_status_sleep

Sleep X seconds between status calls during a STONITH action (Default Value: 1)

retry_on

Count of attempts to retry power on (Default Value: 1)

gnutlscli_path

Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)


package: fence-sanlock

title: fence_sanlock(8)

text:
# fence_sanlock(8)

## NAME
fence_sanlock - fence agent using watchdog and shared storage leases

## SYNOPSIS
fence_sanlock [OPTIONS]

## DESCRIPTION
fence_sanlock uses the watchdog device to reset nodes, in conjunction with three daemons: fence_sanlockd, sanlock, and wdmd.

The watchdog device, controlled through /dev/watchdog, is available when a watchdog kernel module is loaded. A module should be loaded for the available hardware. If no hardware watchdog is available, or no module is loaded, the "softdog" module will be loaded, which emulates a hardware watchdog device.

Shared storage must be configured for sanlock to use from all hosts. This is generally an lvm lv (non-clustered), but could be another block device, or NFS file. The storage should be 1GB of fully allocated space. After being created, the storage must be initialized with the command:

\# fence_sanlock -o sanlock_init -p /path/to/storage

The fence_sanlock agent uses sanlock leases on shared storage to verify that hosts have been reset, and to notify fenced nodes that are still running, that they should be reset.

The fence_sanlockd init script starts the wdmd, sanlock and fence_sanlockd daemons before the cluster or fencing systems are started (e.g. cman, corosync and fenced). The fence_sanlockd daemon is started with the -w option so it waits for the path and host_id options to be provided when they are available.

Unfencing must be configured for fence_sanlock in cluster.conf. The cman init script does unfencing by running fence_node -U, which in turn runs fence_sanlock with the "on" action and local path and host_id values taken from cluster.conf. fence_sanlock in turn passes the path and host_id values to the waiting fence_sanlockd daemon. With these values, fence_sanlockd joins the sanlock lockspace and acquires a resource lease for the local host. It can take several minutes to complete these unfencing steps.

Once unfencing is complete, the node is a member of the sanlock lockspace named "fence" and the node's fence_sanlockd process holds a resource lease named "hN", where N is the node's host_id. (To verify this, run the commands "sanlock client status" and "sanlock client host_status", which show state from the sanlock daemon, or "sanlock direct dump <path>" which shows state from shared storage.)

When fence_sanlock fences a node, it tries to acquire that node's resource lease. sanlock will not grant the lease until the owner (the node being fenced) has been reset by its watchdog device. The time it takes to acquire the lease is 140 seconds from the victim's last lockspace renewal timestamp on the shared storage. Once acquired, the victim's lease is released, and fencing completes successfully.

Live nodes being fenced

When a live node is being fenced, fence_sanlock will continually fail to acquire the victim's lease, because the victim continues to renew its lockspace membership on storage, and the fencing node sees it is alive. This is by design. As long as the victim is alive, it must continue to renew its lockspace membership on storage. The victim must not allow the remote fence_sanlock to acquire its lease and consider it fenced while it is still alive.

At the same time, a victim knows that when it is being fenced, it should be reset to avoid blocking recovery of the rest of the cluster. To communicate this, fence_sanlock makes a "request" on storage for the victim's resource lease. On the victim, fence_sanlockd, which holds the resource lease, is configured to receive SIGUSR1 from sanlock if anyone requests its lease. Upon receiving the signal, fence_sanlockd knows that it is a fencing victim. In response to this, fence_sanlockd allows its wdmd connection to expire, which in turn causes the watchdog device to fire, resetting the node.

The watchdog reset will obviously have the effect of stopping the victim's lockspace membership renewals. Once the renewals stop, fence_sanlock will finally be able to acquire the victim's lease after waiting a fixed time from the final lockspace renewal.

Loss of shared storage

If access to shared storage with sanlock leases is lost for 80 seconds, sanlock is not able to renew the lockspace membership, and enters recovery. This causes sanlock clients holding leases, such as fence_sanlockd, to be notified that their leases are being lost. In response, fence_sanlockd must reset the node, much as if it was being fenced.

Daemons killed/crashed/hung

If sanlock, fence_sanlockd daemons are killed abnormally, or crash or hang, their wdmd connections will expire, causing the watchdog device to fire, resetting the node. fence_sanlock from another node will then run and acquire the victim's resource lease. If the wdmd daemon is killed abnormally or crashes or hangs, it will not pet the watchdog device, causing it to fire and reset the node.

Time Values

The specific times periods referenced above, e.g. 140, 80, are based on the default sanlock i/o timeout of 10 seconds. If sanlock is configured to use a different i/o timeout, these numbers will be different.

## OPTIONS
-o action

The agent action:

on

Enable the local node to be fenced. Used by unfencing.

off

Disable another node.

status

Test if a node is on or off. A node is on if it's lease is held, and off is it's lease is free.

metadata

Print xml description of required parameters.

sanlock_init

Initialize sanlock leases on shared storage.

-p path

The path to shared storage with sanlock leases.

-i host_id

The host_id, from 1-128.

## STDIN PARAMETERS
Options can be passed on stdin, with the format key=val. Each key=val pair is separated by a new line.

action=on|off|status

See -o

path=/path/to/shared/storage

See -p

host_id=num

See -i

## FILES
Example cluster.conf configuration for fence_sanlock.

(For cman based clusters in which fenced runs agents.)

Also see cluster.conf(5), fenced(8), fence_node(8).

```
<clusternode name="node01" nodeid="1">

        <fence>

        <method name="1">

        <device name="wd" host_id="1"/>

        </method>

        </fence>

        <unfence>

        <device name="wd" host_id="1" action="on"/>

        </unfence>
</clusternode>
<clusternode name="node02" nodeid="2">

        <fence>

        <method name="1">

        <device name="wd" host_id="2"/>

        </method>

        </fence>

        <unfence>

        <device name="wd" host_id="2" action="on"/>

        </unfence>
</clusternode>
<fencedevice name="wd" agent="fence_sanlock" path="/dev/fence/leases"/>
```

Example dlm.conf configuration for fence_sanlock.

(For non-cman based clusters in which dlm_controld runs agents.)

Also see dlm.conf(5), dlm_controld(8).

```
device wd /usr/sbin/fence_sanlock path=/dev/fence/leases
connect wd node=1 host_id=1
connect wd node=2 host_id=2
unfence wd
```

## TEST
To test fence_sanlock directly, without clustering:

```
1. Initialize storage
node1: create 1G lv on shared storage /dev/fence/leases
node1: fence_sanlock -o sanlock_init -p /dev/fence/leases
2. Start services
node1: service fence_sanlockd start
node2: service fence_sanlockd start
3. Enable fencing
node1: fence_sanlock -o on -p /dev/fence/leases -i 1
node2: fence_sanlock -o on -p /dev/fence/leases -i 2
This "unfence" step may take a couple minutes.
4. Verify hosts and leases
node1: sanlock status
s fence:1:/dev/fence/leases:0
r fence:h1:/dev/fence/leases:1048576:1 p 2465
node2: sanlock status
s fence:2:/dev/fence/leases:0
r fence:h2:/dev/fence/leases:2097152:1 p 2366
node1: sanlock host_status
lockspace fence
1 timestamp 717
2 timestamp 678
node2: sanlock host_status
lockspace fence
1 timestamp 738
2 timestamp 678
5. Fence node2
node1: fence_sanlock -o off -p /dev/fence/leases -i 2
This may take a few minutes to return.
When node2 is not dead before fencing, sanlock on node1 will log errors
about failing to acquire the lease while node2 is still alive.  This is
expected.
6. Success
node1 fence_sanlock should exit 0 after node2 is reset by its watchdog.
```

## SEE ALSO
fence_sanlockd(8), sanlock(8), wdmd(8)


title: fence_sanlockd(8)

summary: daemon for fence_sanlock agent

text:
# fence_sanlockd(8)

## NAME
fence_sanlockd - daemon for fence_sanlock agent

## SYNOPSIS
fence_sanlockd [OPTIONS]

## DESCRIPTION
The fence_sanlockd daemon is used by the fence_sanlock agent. See fence_sanlock(8), for full description.

## OPTIONS
-D

Enable debugging to stderr and don't fork.

-p path

Path to shared storage with sanlock leases.

-i host_id

Local sanlock host_id (1-128).

-w

Wait for fence_sanlockd -s to send options (p,i).

-s

Send options (p,i) to waiting fence_sanlockd -w.

-1

Send SIGUSR1 to running fence_sanlockd.

## SEE ALSO
fence_sanlock(8), sanlock(8), wdmd(8), fence_node(8), fenced(8)


package: fence-virt

title: fence_virt(8)

text:
# fence_virt(8)

## NAME
fence_virt - Fence agent for virtual machines

## DESCRIPTION
fence_virt is a Power Fencing agent which can be used with virtual machines.

NOTE: reboot-action does not power on nodes that are powered off.

fence_virt accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent. fence_virt can be run by itself with command line options. This is useful for testing and for turning outlets on or off from scripts.

Vendor URL: https://libvirt.org

## PARAMETERS

-d

Specify (stdin) or increment (command line) debug level

-D

Serial device (default=/dev/ttyS1) (Default Value: /dev/ttyS1)

-P

Serial Parameters (default=115200,8N1) (Default Value: 115200,8N1)

-A

VM Channel IP address (default=10.0.2.179) (Default Value: 10.0.2.179)

-p

TCP, Multicast, VMChannel, or VM socket port (default=1229) (Default Value: 1229)

-n

Virtual Machine (domain name) to fence This parameter is always required.

-o

Fencing action (null, off, on, [reboot], status, list, list-status, monitor, validate-all, metadata) (Default Value: reboot)

-t

Fencing timeout (in seconds; default=30) (Default Value: 30)

-T

IP address to connect to in TCP mode (default=127.0.0.1 / ::1) (Default Value: 127.0.0.1)

-S

vm socket CID to connect to in vsock mode (Default Value: 2)

-C

Authentication (none, sha1, [sha256], sha512) (Default Value: sha256)

-c

Packet hash strength (none, sha1, [sha256], sha512) (Default Value: sha256)

-k

Shared key file (default=/etc/cluster/fence_xvm.key) (Default Value: /etc/cluster/fence_xvm.key)

-w

Fencing delay (in seconds; default=0) (Default Value: 0)

## ACTIONS

null

The operational behavior of this is not known.

on

Power on machine.

off

Power off machine.

reboot

Reboot machine.

metadata

Display the XML metadata describing this resource.

status

This returns the status of the plug/virtual machine.

monitor

Check the health of fence device

list

List available plugs with aliases/virtual machines if there is support for more then one device. Returns N/A otherwise.

list-status

List available plugs with aliases/virtual machines and their power state if it can be obtained without additional commands.

validate-all

Validate if all required parameters are entered.

## STDIN PARAMETERS

debug

Specify (stdin) or increment (command line) debug level

serial_device

Serial device (default=/dev/ttyS1) (Default Value: /dev/ttyS1)

serial_params

Serial Parameters (default=115200,8N1) (Default Value: 115200,8N1)

channel_address

VM Channel IP address (default=10.0.2.179) (Default Value: 10.0.2.179)

ipport

TCP, Multicast, VMChannel, or VM socket port (default=1229) (Default Value: 1229)

plug

Virtual Machine (domain name) to fence This parameter is always required. Obsoletes: port

action

Fencing action (null, off, on, [reboot], status, list, list-status, monitor, validate-all, metadata) (Default Value: reboot)

timeout

Fencing timeout (in seconds; default=30) (Default Value: 30)

ipaddr

IP address to connect to in TCP mode (default=127.0.0.1 / ::1) (Default Value: 127.0.0.1)

vsock

vm socket CID to connect to in vsock mode (Default Value: 2)

auth

Authentication (none, sha1, [sha256], sha512) (Default Value: sha256)

hash

Packet hash strength (none, sha1, [sha256], sha512) (Default Value: sha256)

key_file

Shared key file (default=/etc/cluster/fence_xvm.key) (Default Value: /etc/cluster/fence_xvm.key)

delay

Fencing delay (in seconds; default=0) (Default Value: 0)


package: fence-virtd

title: fence_virtd(8)

text:
# fence_virtd(8)

## NAME
fence_virtd - Fencing host for virtual machines

## DESCRIPTION
fence_virtd is a host daemon designed to route fencing requests for virtual machines.

Fence_virt and fence_xvm talk to fence_virtd, which supports multiple backend plugins, including:

- libvirt for single-node operation

- Corosync CPG and libvirt when using Linux-cluster release 3.0.0 or later

- libvirt-qpid for multi-node, non-cluster operation

For compatibility, fence_xvm from linux-cluster release 2 may talk to fence_virtd.

fence_virtd accepts a few options on the command line, but most options are read from fence_virt.conf.

## PARAMETERS
-d

Specify debug level, e.g. "-d99"

-c

Interactively prompt user for configuration information

-f

Specify an alternate configuration file instead of /etc/fence_virt.conf

-F

Do not fork into background after starting (overrides any setting in fence_virt.conf)

-w

Wait for backend to be available (overrides any setting in fence_virt.conf)

-p

Specify the full path to the pid file used to record the active process pid.

## SEE ALSO
fence_virt(8), fence_xvm(8), fence(8), fence_virt.conf(5)