fence_ipdu8
Fence agent for ipdu over snmp
Overview
fence_ipdu is a Power Fencing agent which can be used with the IBM iPDU network power switch. It logs into a device via SNMP and reboots a specified outlet. It supports SNMP v3 with all combinations of authenticity/privacy settings.
The fence agent accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent. The agent 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)
- -c, --community=[community]
-
Set the community string (Default Value: private)
- -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: 161)
- -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.
- -b, --snmp-auth-prot=[prot]
-
Set authentication protocol (MD5|SHA)
- -P, --snmp-priv-passwd=[pass]
-
Set privacy protocol password
- -R, --snmp-priv-passwd-script
-
Script to run to retrieve privacy password
- -B, --snmp-priv-prot=[prot]
-
Set privacy protocol (DES|AES)
- -E, --snmp-sec-level=[level]
-
Set security level (noAuthNoPriv|authNoPriv|authPriv)
- -d, --snmp-version=[version]
-
Specifies SNMP version to use (1|2c|3) (Default Value: 3)
- -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)
--snmpget-path=[path]-
Path to snmpget binary (Default Value: /usr/bin/snmpget)
--snmpset-path=[path]-
Path to snmpset binary (Default Value: /usr/bin/snmpset)
--snmpwalk-path=[path]-
Path to snmpwalk binary (Default Value: /usr/bin/snmpwalk)
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)
community-
Set the community string (Default Value: private)
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: 161)
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
snmp_auth_prot-
Set authentication protocol (MD5|SHA)
snmp_priv_passwd-
Set privacy protocol password
snmp_priv_passwd_script-
Script to run to retrieve privacy password
snmp_priv_prot-
Set privacy protocol (DES|AES)
snmp_sec_level-
Set security level (noAuthNoPriv|authNoPriv|authPriv)
snmp_version-
Specifies SNMP version to use (1|2c|3) (Default Value: 3)
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)
snmpget_path-
Path to snmpget binary (Default Value: /usr/bin/snmpget)
snmpset_path-
Path to snmpset binary (Default Value: /usr/bin/snmpset)
snmpwalk_path-
Path to snmpwalk binary (Default Value: /usr/bin/snmpwalk)
History
- Debian 13 (Trixie): the text shown here
- Debian 12 (Bookworm)
- Debian 11 (Bullseye)
- Debian 10 (Buster)
- Debian 9 (Stretch)