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/).
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)
- -6, --inet6-only
-
Forces agent to use IPv6 addresses only
- -a, --ip=[ip]
-
IP Address or Hostname This parameter is always required.
- -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.
- -C, --cipher=[cipher]
-
Ciphersuite to use (same as ipmitool -C parameter) (Default Value: 0)
- -L, --privlvl=[level]
-
Privilege level on IPMI device (Default Value: administrator)
- -o, --action=[action]
-
Fencing Action (Default Value: reboot)
- -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: 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)
- --delay=[seconds]
-
Wait X seconds before fencing is started (Default Value: 0)
- --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)
- --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.
- monitor
-
Check the health of fence device
- metadata
-
Display the XML metadata describing this resource.
STDIN PARAMETERS
- ipport
-
TCP/UDP port to use for connection with device (Default Value: 623)
- inet6_only
-
Forces agent to use IPv6 addresses only
- ipaddr
-
IP Address or Hostname This parameter is always required.
- 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.
- cipher
-
Ciphersuite to use (same as ipmitool -C parameter) (Default Value: 0)
- privlvl
-
Privilege level on IPMI device (Default Value: administrator)
- action
-
Fencing Action (Default Value: reboot)
- 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: 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)
- delay
-
Wait X seconds before fencing is started (Default Value: 0)
- 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)
- retry_on
-
Count of attempts to retry power on (Default Value: 1)
- sudo
-
Use sudo (without password) when calling 3rd party sotfware.