NAME

       fence_zvmip - Fence agent for use with z/VM Virtual Machines

DESCRIPTION

       The fence_zvm agent is intended to be used with with z/VM SMAPI service via TCP/IP

       To   use  this  agent  the  z/VM SMAPI service needs to be configured to allow the virtual
       machine running this agent to connect to it and issue the image_recycle  operation.   This
       involves  updating  the  VSMWORK1  AUTHLIST  VMSYS:VSMWORK1.  file.  The entry should look
       something similar to this:

       Column 1                   Column 66                Column 131

          |                          |                        |
          V                          V                        V

       XXXXXXXX                      ALL                      IMAGE_OPERATIONS

       Where XXXXXXX is the name of the virtual  machine  used  in  the  authuser  field  of  the
       request.

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

       -l, --username=[name]
              Login name This parameter is always required.

       -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.

       -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)

       --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.0)

       --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.

       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

       ipaddr IP address or hostname of fencing device This parameter is always required.

       ipport TCP/UDP port to use for connection with device (Default Value: 44444)

       login  Login name This parameter is always required.

       method Method to fence (onoff|cycle) (Default Value: onoff)

       passwd Login password or passphrase

       passwd_script
              Script to run to retrieve password

       port   Physical plug number on device, UUID or identification of machine This parameter is
              always required.

       verbose
              Verbose mode

       debug  Write debug information to given file

       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)

       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.0)

       retry_on
              Count of attempts to retry power on (Default Value: 1)