NAME¶

fence_rhevm - Fence agent for RHEV-M REST API

DESCRIPTION¶

fence_rhevm is an I/O Fencing agent which can be used with RHEV-M REST API to fence virtual machines.

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

PARAMETERS¶

-o, --action=[action]

Fencing Action (Default Value: reboot)

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

-l, --username=[name]

Login Name This parameter is always required.

-t, --notls

Disable TLS negotiation, force SSL 3.0 (Default Value: 1)

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

-z, --ssl

SSL connection

--ssl-insecure

SSL connection without verifying fence device's certificate

--ssl-secure

SSL connection with verifying fence device's certificate

--use-cookies

Reuse cookies for authentication

--api-path=[path]

The path of the API URL (Default Value: /ovirt-engine/api)

--disable-http-filter

Set HTTP Filter header to false

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

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

--gnutlscli-path=[path]

Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)

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)

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

login

Login Name This parameter is always required.

notls

Disable TLS negotiation, force SSL 3.0 (Default Value: 1)

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.

ssl

SSL connection

ssl_insecure

SSL connection without verifying fence device's certificate

ssl_secure

SSL connection with verifying fence device's certificate

use_cookies

Reuse cookies for authentication

api_path

The path of the API URL (Default Value: /ovirt-engine/api)

disable_http_filter

Set HTTP Filter header to false

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

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)

gnutlscli_path

Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)