NAME

       fence_ibm_vpc - Fence agent for IBM Cloud VPC

DESCRIPTION

       fence_ibm_vpc is a Power Fencing agent which can be used with IBM Cloud VPC to fence virtual machines.

       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: https://www.ibm.com

PARAMETERS

       --apikey=[key]
              API Key This parameter is always required.

       --limit=[number]
              Number of nodes returned by API (Default Value: 50)

       --proxy=[http://<URL>:<PORT>]
              Network proxy (Default Value: )

       --region=[region]
              Region This parameter is always required.

       --token-file=[path]
              Path to the token cache file (Default Value: /run/fence-agents/fence_ibm_vpc/[hash].token)

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

       -n, --plug=[id]
              Physical plug number on device, UUID  or  identification  of  machine  This  parameter  is  always
              required.

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

       --power-timeout=[seconds]
              Test X seconds for status change after ON/OFF (Default Value: 30)

       --power-wait=[seconds]
              Wait X seconds after issuing ON/OFF (Default Value: 1)

       --shell-timeout=[seconds]
              Wait X seconds for cmd prompt after issuing command (Default Value: 15)

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

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

       apikey API Key This parameter is always required.

       limit  Number of nodes returned by API (Default Value: 50)

       proxy  Network proxy (Default Value: )

       region Region This parameter is always required.

       token_file
              Path to the token cache file (Default Value: /run/fence-agents/fence_ibm_vpc/[hash].token)

       action Fencing action (Default Value: reboot)

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

       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)

       power_timeout
              Test X seconds for status change after ON/OFF (Default Value: 30)

       power_wait
              Wait X seconds after issuing ON/OFF (Default Value: 1)

       shell_timeout
              Wait X seconds for cmd prompt after issuing command (Default Value: 15)

       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)

fence_ibm_vpc (Fence Agent)                        2009-10-20                                     FENCE_AGENT(8)