NAME

       fence_sanbox2 - Fence agent for QLogic SANBox2 FC switches

DESCRIPTION

       fence_sanbox2  is an I/O Fencing agent which can be used with QLogic SANBox2 FC switches.  It logs into a
       SANBox2 switch via telnet and disables a specified port. Disabling  the port which a machine is connected
       to  effectively  fences  that machine. Lengthy telnet connections to the switch should be avoided while a
       GFS cluster is running because the connection will block any necessary fencing actions.

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

PARAMETERS

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

       -c, --command-prompt=[prompt]
              Force Python regex for command prompt (Default Value: [' #> '])

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

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

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

       -q, --quiet
              Disable logging to stderr. Does not affect --verbose or --debug logging to syslog.

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

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

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

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

ACTIONS

       on     Power on machine.

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

       command_prompt
              Force Python regex for command prompt (Default Value: [' #> ']) Obsoletes: cmd_prompt

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

       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

       username
              Login name This parameter is always required. Obsoletes: login

       quiet  Disable logging to stderr. Does not affect --verbose or --debug logging to syslog.

       verbose
              Verbose mode

       debug_file
              Write debug information to given file Obsoletes: debug

       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)

       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)

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

       telnet_path
              Path to telnet binary (Default Value: /usr/bin/telnet)