fence_ipmilan (8) - Linux Manuals

fence_ipmilan: Fence agent for IPMI

NAME

fence_ipmilan - Fence agent for IPMI

fence_ilo3 - Fence agent for HP iLO3 (symlink)

fence_ilo4 - Fence agent for HP iLO4 (symlink)

fence_imm - Fence agent for IBM Integrated Management Module (symlink)

fence_idrac - Fence agent for Dell iDRAC (symlink)

DESCRIPTION

fence_ipmilan is an I/O Fencing agentwhich can be used with machines controlled by IPMI.This agent calls support software ipmitool (http://ipmitool.sf.net/). WARNING! This fence agent might report success before the node is powered off. You should use -m/method onoff if your fence device works correctly with that option.

fence_ipmilan accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent. fence_ipmilan 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

        

-u, --ipport=[port]
TCP/UDP port to use for connection with device (Default Value: 623)         
-n, --plug=[ip]
IP address or hostname of fencing device (together with --port-as-ip)         
-6, --inet6-only
Forces agent to use IPv6 addresses only         
-a, --ip=[ip]
IP Address or Hostname         
-S, --password-script=[script]
Script to retrieve password         
-m, --method=[method]
Method to fence (onoff|cycle) (Default Value: onoff)         
-4, --inet4-only
Forces agent to use IPv4 addresses only         
-p, --password=[password]
Login password or passphrase         
-P, --lanplus
Use Lanplus to improve security of connection (Default Value: 0)         
-A, --auth=[auth]
IPMI Lan Auth type.         
-o, --action=[action]
Fencing Action (Default Value: reboot)         
-C, --cipher=[cipher]
Ciphersuite to use (same as ipmitool -C parameter)         
-L, --privlvl=[level]
Privilege level on IPMI device (Default Value: administrator)         
-t [seconds] Timeout (sec) for IPMI operation
Timeout (sec) for IPMI operation         
-l, --username=[name]
Login Name         
-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         
--power-wait=[seconds]
Wait X seconds after issuing ON/OFF (Default Value: 2)         
--login-timeout=[seconds]
Wait X seconds for cmd prompt after login (Default Value: 5)         
--delay=[seconds]
Wait X seconds before fencing is started (Default Value: 0)         
--power-timeout=[seconds]
Test X seconds for status change after ON/OFF (Default Value: 20)         
--ipmitool-path=[path]
Path to ipmitool binary (Default Value: /usr/bin/ipmitool)         
--shell-timeout=[seconds]
Wait X seconds for cmd prompt after issuing command (Default Value: 3)         
--port-as-ip
Make "port/plug" to be an alias to IP address         
--retry-on=[attempts]
Count of attempts to retry power on (Default Value: 1)         
--use-sudo
Use sudo (without password) when calling 3rd party sotfware.

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.         
diag
Pulse a diagnostic interrupt to the processor(s).

STDIN PARAMETERS

        

ipport
TCP/UDP port to use for connection with device (Default Value: 623)         
port
IP address or hostname of fencing device (together with --port-as-ip)         
inet6_only
Forces agent to use IPv6 addresses only         
ipaddr
IP Address or Hostname         
passwd_script
Script to retrieve password         
method
Method to fence (onoff|cycle) (Default Value: onoff)         
inet4_only
Forces agent to use IPv4 addresses only         
passwd
Login password or passphrase         
lanplus
Use Lanplus to improve security of connection (Default Value: 0)         
auth
IPMI Lan Auth type.         
action
Fencing Action (Default Value: reboot)         
cipher
Ciphersuite to use (same as ipmitool -C parameter)         
privlvl
Privilege level on IPMI device (Default Value: administrator)         
timeout
Timeout (sec) for IPMI operation         
login
Login Name         
verbose
Verbose mode         
debug
Write debug information to given file         
version
Display version information and exit         
help
Display help and exit         
power_wait
Wait X seconds after issuing ON/OFF (Default Value: 2)         
login_timeout
Wait X seconds for cmd prompt after login (Default Value: 5)         
delay
Wait X seconds before fencing is started (Default Value: 0)         
power_timeout
Test X seconds for status change after ON/OFF (Default Value: 20)         
ipmitool_path
Path to ipmitool binary (Default Value: /usr/bin/ipmitool)         
shell_timeout
Wait X seconds for cmd prompt after issuing command (Default Value: 3)         
port_as_ip
Make "port/plug" to be an alias to IP address         
retry_on
Count of attempts to retry power on (Default Value: 1)         
sudo
Use sudo (without password) when calling 3rd party sotfware.