Provided by: fence-agents_4.5.2-1ubuntu0.1_amd64
NAME
fence_pve - Fencing agent for the Proxmox Virtual Environment
DESCRIPTION
The fence_pve agent can be used to fence virtual machines acting as nodes in a virtualized cluster. fence_pve accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent. fence_pve 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.proxmox.com/
PARAMETERS
-o, --action=[action] Fencing action (Default Value: reboot) -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 a node within the Proxmox cluster. This parameter is always required. -u, --ipport=[port] TCP/UDP port to use for connection with device (Default Value: 8006) -m, --method=[method] Method to fence (onoff|cycle) (Default Value: onoff) -p, --password=[password] Login password or passphrase -S, --password-script=[script] Script to run to retrieve password -n, --plug=[id] Id of the virtual machine. This parameter is always required. -l, --username=[name] Login name (Default Value: root@pam) -N, --nodename Node on which machine is located. (Optional, will be automatically determined) --vmtype Virtual machine type lxc or qemu. (Default: qemu) (Default Value: qemu) -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) --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. 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) inet4_only Forces agent to use IPv4 addresses only inet6_only Forces agent to use IPv6 addresses only ip IP Address or Hostname of a node within the Proxmox cluster. This parameter is always required. Obsoletes: ipaddr ipport TCP/UDP port to use for connection with device (Default Value: 8006) method Method to fence (onoff|cycle) (Default Value: onoff) password Login password or passphrase Obsoletes: passwd password_script Script to run to retrieve password Obsoletes: passwd_script plug Id of the virtual machine. This parameter is always required. Obsoletes: port username Login name (Default Value: root@pam) Obsoletes: login nodename Node on which machine is located. (Optional, will be automatically determined) Obsoletes: node_name vmtype Virtual machine type lxc or qemu. (Default: qemu) (Default Value: qemu) 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) 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)