Provided by: fence-agents_4.4.0-2_amd64 bug

NAME

       fence_zvm - Power Fencing agent for GFS on System z z/VM Clusters

SYNOPSIS

       fence_zvm [OPTION]...

DESCRIPTION

       fence_zvm  is  a  Power  Fencing  agent  used  on a GFS virtual machine in a System z z/VM
       cluster.  It uses the SMAPI interface to recycle an active image.

       fence_zvm accepts options on the command line as well as from stdin.  fence_node sends the
       options  through  stdin  when  it  execs  the  agent.  fence_zvm can be run by itself with
       command line options which is useful for testing.

       Vendor URL: http://www.sinenomine.net

OPTIONS

       -o --action
              Fencing action: "off"  -  deactivate  virtual  machine;  "on"  -  activate  virtual
              machine;  "metadata"  - display device metadata" - describe fence agent parameters;
              "status" - state of virtual machine

       --delay seconds
              Time to delay fencing action in seconds

       -n --plug target
              Name of virtual machine to recycle.

       -h --help
              Print out a help message describing available options, then exit.

       -a --ip smapi Server
              Name of SMAPI server virtual machine. To be consistent with other fence agents this
              name  is  a  little  misleading:  it  is the name of the virtual machine not its IP
              address or hostname.

       --zvmsys z/VM System
              Name of z/VM on which the SMAPI server virtual machine resides. Optional - defaults
              to system on which the node is running.

       -h --help
              Display usage information

       -t --timeout = < shutdown timeout >
              Amount  of  grace time to give the virtual machine to shutdown cleanly before being
              forcibly terminated. Currently, this option is ignored.

STDIN PARAMETERS

       agent = < param >
              This option is used by fence_node(8) and is ignored by fence_zvm.

       action = < action >
              Fencing action: "off" - fence off device; "metadata"  -  display  device  metadata;
              "status" - state of device

       port = < target >
              Name of virtual machine to recycle.

       ipaddr= < server name >
              Name  of  SMAPI  server  virtual  machine. To be consistent with other fence agents
              thisname is a little misleading: it is the name of the virtual machine not  its  IP
              address or hostname.

       timeout = < shutdown timeout >
              Amount  of  grace time to give the virtual machine to shutdown cleanly before being
              forcibly terminated. Currently, this option is ignored.

SEE ALSO

       fence(8), fenced(8), fence_node(8)

NOTES

       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_CHARACTERISTICS

       Where  XXXXXXX  is  the  name  of  the  virtual  machine used in the authuser field of the
       request. This virtual machine also has to be authorized to access the  system's  directory
       manager.

       In  addition,  the  VM directory entry that defines this virtual machine requires the IUCV
       ANY statement (or IUCV <userid of SMAPI Server>). This authorizes use of IUCV  to  connect
       to the SMAPI server.

                                                                                     fence_zvm(8)