NAME

       fence_ldom - Fence agent for Sun LDOM

DESCRIPTION

       fence_ldom  is  an  I/O Fencing agent which can be used with LDoms virtual machines. This agent works so,
       that run ldm command on host machine. So ldm must be directly runnable.

       Very useful parameter is -c (or cmd_prompt in stdin mode).  This  must  be  set  to  something,  what  is
       displayed  after  successful login to host machine. Default string is space on end of string (default for
       root in bash). But (for example) csh use ], so in that case you must use parameter -c  with  argument  ].
       Very  similar  situation  is,  if  you use bash and login to host machine with other user than root. Than
       prompt is $, so again, you must use parameter -c.

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

PARAMETERS

       -o, --action=<action>
              Fencing Action (Default Value: reboot)

       -a, --ip=<ip>
              IP Address or Hostname This parameter is always required.

       -l, --username=<name>
              Login Name This parameter is always required.

       -p, --password=<password>
              Login password or passphrase

       -S, --password-script=<script>
              Script to retrieve password

       -x, --ssh
              SSH connection (Default Value: true)

       -k, --identity-file=<filename>
              Identity file for ssh

       -n, --plug=<id>
              Physical plug number or name of virtual machine This parameter is always required.

       -c, --command-prompt=<prompt>
              Force command prompt (Default Value:  $)

       -4, --inet4-only
              Forces agent to use IPv4 addresses only

       -6, --inet6-only
              Forces agent to use IPv6 addresses only

       -u, --ipport=<port>
              TCP port to use for connection with device

       -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 operation list (Default Value: ,)

       --power-timeout
              Test X seconds for status change after ON/OFF (Default Value: 20)

       --shell-timeout
              Wait X seconds for cmd prompt after issuing command (Default Value: 3)

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

       --power-wait
              Wait X seconds after issuing ON/OFF (Default Value: 0)

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

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

       monitor
              Check if fencing device is running. List available plugs/virtual machines or get status of machine
              (if it does not support more).

       metadata
               The operational behavior of this is not known.

STDIN PARAMETERS

       action Fencing Action (Default Value: reboot)

       ipaddr IP Address or Hostname This parameter is always required.

       login  Login Name This parameter is always required.

       passwd Login password or passphrase

       passwd_script
              Script to retrieve password

       secure SSH connection (Default Value: true)

       identity_file
              Identity file for ssh

       port   Physical plug number or name of virtual machine This parameter is always required.

       cmd_prompt
              Force command prompt (Default Value:  $)

       inet4_only
              Forces agent to use IPv4 addresses only

       inet6_only
              Forces agent to use IPv6 addresses only

       ipport TCP port to use for connection with device

       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 operation list (Default Value: ,)

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

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

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

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

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

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

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