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¶

-o, --action=[action]

Fencing Action (Default Value: reboot)

-c, --command-prompt=[prompt]

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

-k, --identity-file=[filename]

Identity file for ssh

-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 This parameter is always required.

-u, --ipport=[port]

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

-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

-n, --plug=[id]

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

-x, --ssh

SSH connection (Default Value: 1)

--ssh-options=[options]

SSH options to use (Default Value: -t '/bin/bash -c "PS1=

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

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

--use-sudo

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

--ssh-path=[path]

Path to ssh binary (Default Value: /usr/bin/ssh)

--sudo-path=[path]

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

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.

STDIN PARAMETERS¶

action

Fencing Action (Default Value: reboot)

cmd_prompt

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

identity_file

Identity file for ssh

inet4_only

Forces agent to use IPv4 addresses only

inet6_only

Forces agent to use IPv6 addresses only

ipaddr

IP Address or Hostname This parameter is always required.

ipport

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

login

Login Name This parameter is always required.

passwd

Login password or passphrase

passwd_script

Script to retrieve password

port

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

secure

SSH connection (Default Value: 1)

ssh_options

SSH options to use (Default Value: -t '/bin/bash -c "PS1=

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

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)

sudo

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

ssh_path

Path to ssh binary (Default Value: /usr/bin/ssh)

sudo_path

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