Provided by: fence-agents-zvm_4.15.0-1ubuntu2_all
NAME
fence_zvmip - Fence agent for use with z/VM Virtual Machines
DESCRIPTION
fence_zvmip is a Power Fencing agent for z/VM SMAPI service via TCP/IP. The z/VM SMAPI service must be configured so that the virtual machine running the agent can connect to the service, access the system's directory manager, and shortly thereafter run image_deactivate and image_activate. This involves updating the VSMWORK1 NAMELIST and VSMWORK1 AUTHLIST VMSYS:VSMWORK1 files. The NAMELIST entry assigns all the required functions to one nick and should look similar to this: :nick.ZVM_FENCE :list. IMAGE_ACTIVATE IMAGE_DEACTIVATE IMAGE_STATUS_QUERY CHECK_AUTHENTICATION IMAGE_NAME_QUERY_DM The AUTHLIST entry authorizes the user to perform all the functions associated with the nick, and should look similar to this: Column 1 Column 66 Column 131 | | | V V V XXXXXXXX ALL ZVM_FENCE where XXXXXXXX is the name of the user in the authuser field of the request. Refer to the official z/VM documentation for complete instructions and reference materials. 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) -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 (Default Value: 44444) -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] Physical plug number on device, UUID or identification of machine This parameter is always required. -z, --ssl Use SSL connection with verifying certificate (Default) (Default Value: 1) --ssl-insecure Use SSL connection without verifying certificate --ssl-secure Use SSL connection with verifying certificate -l, --username=[name] Login name This parameter is always required. --disable-ssl Don't use SSL -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) --missing-as-off Missing port returns OFF instead of failure (Default Value: 1) --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: 5) --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) --gnutlscli-path=[path] Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
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 fencing device This parameter is always required. Obsoletes: ipaddr ipport TCP/UDP port to use for connection with device (Default Value: 44444) 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 Physical plug number on device, UUID or identification of machine This parameter is always required. Obsoletes: port ssl Use SSL connection with verifying certificate (Default) (Default Value: 1) ssl_insecure Use SSL connection without verifying certificate ssl_secure Use SSL connection with verifying certificate username Login name This parameter is always required. Obsoletes: login disable_ssl Don't use SSL 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) missing_as_off Missing port returns OFF instead of failure (Default Value: 1) 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: 5) 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) gnutlscli_path Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)