fence_sbd man page

fence_sbd — Fence agent for sbd

Description

fence_sbd is 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

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

Write debug information to given file

-V, --version

Display version information and exit

-h, --help

Display help and exit

-C, --separator=[char]

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

--delay=[seconds]

Wait X seconds before fencing is started (Default Value: 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)

--sbd-path=[path]

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

--shell-timeout=[seconds]

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

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

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

debug_file

Write debug information to given file Obsoletes: debug

version

Display version information and exit

help

Display help and exit

separator

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

delay

Wait X seconds before fencing is started (Default Value: 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)

sbd_path

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

shell_timeout

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

retry_on

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

Info

2009-10-20 fence_sbd (Fence Agent)