fence_eaton_ssh - Man Page
Fence agent for Eaton ePDU G3 over SSH
Description
fence_eaton_ssh is a fence agent that connects to Eaton ePDU devices. It logs into device via ssh and reboot a specified outlet.
fence_eaton_ssh accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent. fence_eaton_ssh 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.eaton.com/
Parameters
- -o, --action=[action]
Fencing action (Default Value: reboot)
- -c, --command-prompt=[prompt]
Force Python regex for command prompt
- -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
- -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 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)
- --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.
- 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 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
- 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 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)
- ssh_path
Path to ssh binary (Default Value: /usr/bin/ssh)