FENCE_AGENT(8)						      System Manager's Manual						    FENCE_AGENT(8)

NAME

       fence_virsh - Fence agent for virsh

DESCRIPTION

       fence_virsh is an I/O Fencing agent which can be used with the virtual machines managed by libvirt. It logs via ssh to a dom0 and there run
       virsh command, which does all work.

       By default, virsh needs root account to do properly work. So you must allow ssh login in your sshd_config.

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

PARAMETERS


       -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

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

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

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

       -u, --ipport=[port]
	      TCP/UDP port to use for connection with device (Default Value: 22)

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

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

       -S, --password-script=[script]
	      Script to retrieve password

       -k, --identity-file=[filename]
	      Identity file for ssh

       --ssh-options=[options]
	      SSH options to use (Default Value: -t '/bin/bash -c "PS1=#  /bin/bash --noprofile --norc"')

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

       -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=[seconds]
	      Test X seconds for status change after ON/OFF (Default Value: 20)

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

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

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

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

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

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

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 the health of fence device

       metadata
	      Display the XML metadata describing this resource.

STDIN PARAMETERS


       ipaddr IP Address or Hostname This parameter is always required.

       login  Login Name This parameter is always required.

       passwd Login password or passphrase

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

       secure SSH connection (Default Value: 1)

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

       ipport TCP/UDP port to use for connection with device (Default Value: 22)

       inet4_only
	      Forces agent to use IPv4 addresses only

       inet6_only
	      Forces agent to use IPv6 addresses only

       passwd_script
	      Script to retrieve password

       identity_file
	      Identity file for ssh

       ssh_options
	      SSH options to use (Default Value: -t '/bin/bash -c "PS1=#  /bin/bash --noprofile --norc"')

       action Fencing Action (Default Value: reboot)

       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)

       sudo   Use sudo (without password) when calling 3rd party sotfware.

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