Scroll to navigation

FENCE_AGENT(8) System Manager's Manual FENCE_AGENT(8)

NAME

fence_vmware_rest - Fence agent for VMware REST API

DESCRIPTION

fence_vmware_rest is a Power Fencing agent which can be used with VMware API to fence virtual machines.

NOTE: If there's more than 1000 VMs there is a filter parameter to work around the API limit. See https://code.vmware.com/apis/62/vcenter-management#/VM%20/get_vcenter_vm for full list of filters.

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

PARAMETERS

Fencing action (Default Value: reboot)
IP address or hostname of fencing device This parameter is always required.
TCP/UDP port to use for connection with device (Default Value: 80)
Disable TLS negotiation and force SSL3.0. This should only be used for devices that do not support TLS1.0 and up.
Login password or passphrase
Script to run to retrieve password
Physical plug number on device, UUID or identification of machine This parameter is always required.
Use SSL connection with verifying certificate
Use SSL connection without verifying certificate
Use SSL connection with verifying certificate
Login name This parameter is always required.
The path part of the API URL (Default Value: /rest)
Filter to only return relevant VMs. It can be used to avoid the agent failing when more than 1000 VMs should be returned.
Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.
Verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity.
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).
Write debug information to given file
Display version information and exit
Display help and exit
Separator for plug parameter when specifying more than 1 plug (Default Value: ,)
Separator for CSV created by 'list' operation (Default Value: ,)
Wait X seconds before fencing is started (Default Value: 0)
Disable timeout (true/false) (default: true when run from Pacemaker 2.0+)
Wait X seconds for cmd prompt after login (Default Value: 5)
Test X seconds for status change after ON/OFF (Default Value: 20)
Wait X seconds after issuing ON/OFF (Default Value: 1)
Wait X seconds for cmd prompt after issuing command (Default Value: 5)
Sleep X seconds between status calls during a STONITH action (Default Value: 1)
Count of attempts to retry power on (Default Value: 1)
Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)

ACTIONS

Power on machine.
Power off machine.
Reboot machine.
This returns the status of the plug/virtual machine.
List available plugs with aliases/virtual machines if there is support for more then one device. Returns N/A otherwise.
List available plugs with aliases/virtual machines and their power state if it can be obtained without additional commands.
Check the health of fence device
Display the XML metadata describing this resource.

The operational behavior of this is not known.
Validate if all required parameters are entered.

STDIN PARAMETERS

Fencing action (Default Value: reboot)
IP address or hostname of fencing device This parameter is always required. Obsoletes: ipaddr
TCP/UDP port to use for connection with device (Default Value: 80)
Disable TLS negotiation and force SSL3.0. This should only be used for devices that do not support TLS1.0 and up.
Login password or passphrase Obsoletes: passwd
Script to run to retrieve password Obsoletes: passwd_script
Physical plug number on device, UUID or identification of machine This parameter is always required. Obsoletes: port
Use SSL connection with verifying certificate
Use SSL connection without verifying certificate
Use SSL connection with verifying certificate
Login name This parameter is always required. Obsoletes: login
The path part of the API URL (Default Value: /rest)
Filter to only return relevant VMs. It can be used to avoid the agent failing when more than 1000 VMs should be returned.
Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.
Verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity.
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).
Write debug information to given file Obsoletes: debug
Display version information and exit
Display help and exit
Separator for plug parameter when specifying more than 1 plug (Default Value: ,)
Separator for CSV created by 'list' operation (Default Value: ,)
Wait X seconds before fencing is started (Default Value: 0)
Disable timeout (true/false) (default: true when run from Pacemaker 2.0+)
Wait X seconds for cmd prompt after login (Default Value: 5)
Test X seconds for status change after ON/OFF (Default Value: 20)
Wait X seconds after issuing ON/OFF (Default Value: 1)
Wait X seconds for cmd prompt after issuing command (Default Value: 5)
Sleep X seconds between status calls during a STONITH action (Default Value: 1)
Count of attempts to retry power on (Default Value: 1)
Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
2009-10-20 fence_vmware_rest (Fence Agent)