NAME

       fence_mpath - Fence agent for multipath persistent reservation

DESCRIPTION

       fence_mpath  is  an  I/O fencing agent that uses SCSI-3 persistent reservations to control
       access multipath devices. Underlying devices must support SCSI-3  persistent  reservations
       (SPC-3  or  greater) as well as the "preempt-and-abort" subcommand.  The fence_mpath agent
       works by having an unique key for each pair of node and device that has to be set also  in
       /etc/multipath.conf.  Once registered, a single node will become the reservation holder by
       creating a "write exclusive, registrants only" reservation on the device(s). The result is
       that  only  registered  nodes  may write to the device(s). When a node failure occurs, the
       fence_mpath agent will remove the key belonging to the failed node from the device(s). The
       failed node will no longer be able to write to the device(s). A manual reboot is required.

       fence_mpath  accepts  options  on  the  command  line  as well as from stdin. Fenced sends
       parameters through stdin when it execs the agent. fence_mpath 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.sourceware.org/dm/

PARAMETERS

       -o, --action=[action]
              Fencing action (Default Value: off)

       -d, --devices=[devices]
              List of devices to use for current operation. Devices can be  comma-separated  list
              of device-mapper multipath devices (eg. /dev/dm-3). Each device must support SCSI-3
              persistent reservations. This parameter is always required.

       -k, --key=[key]
              Key to use for the current operation. This key should be unique to a node and  have
              to  be  written  in /etc/multipath.conf. For the "on" action, the key specifies the
              key use to register the local node. For the "off" action, this  key  specifies  the
              key to be removed from the device(s). 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

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

       --mpathpersist-path=[path]
              Path to mpathpersist binary (Default Value: /usr/sbin/mpathpersist)

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

       --store-path=[path]
              Path  to  directory  where  fence  agent  can  store  information  (Default  Value:
              /var/run/cluster)

       --retry-on=[attempts]
              Count of attempts to retry power on (Default Value: 1)

       --use-sudo
              Use sudo (without password) when calling 3rd party software

       --sudo-path=[path]
              Path to sudo binary (Default Value: /usr/bin/sudo)

ACTIONS

       on     Power on machine.

       off    Power off machine.

       status This returns the status of the plug/virtual machine.

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

       devices
              List of devices to use for current operation. Devices can be  comma-separated  list
              of device-mapper multipath devices (eg. /dev/dm-3). Each device must support SCSI-3
              persistent reservations. This parameter is always required.

       key    Key to use for the current operation. This key should be unique to a node and  have
              to  be  written  in /etc/multipath.conf. For the "on" action, the key specifies the
              key use to register the local node. For the "off" action, this  key  specifies  the
              key to be removed from the device(s). 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

       delay  Wait X seconds before fencing is started (Default Value: 0)

       login_timeout
              Wait X seconds for cmd prompt after login (Default Value: 5)

       mpathpersist_path
              Path to mpathpersist binary (Default Value: /usr/sbin/mpathpersist)

       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)

       store_path
              Path  to  directory  where  fence  agent  can  store  information  (Default  Value:
              /var/run/cluster)

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

       sudo   Use sudo (without password) when calling 3rd party software

       sudo_path
              Path to sudo binary (Default Value: /usr/bin/sudo)