NAME¶

fence_ifmib - Fence agent for IF MIB

DESCRIPTION¶

fence_ifmib is an I/O Fencing agent which can be used with any SNMP IF-MIB capable device.

It was written with managed ethernet switches in mind, in order to fence iSCSI SAN connections. However, there are many devices that support the IF-MIB interface. The agent uses IF-MIB::ifAdminStatus to control the state of an interface.

fence_ifmib accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent. fence_ifmib 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.ietf.org/wg/concluded/ifmib.html

PARAMETERS¶

-o, --action=[action]

Fencing Action (Default Value: off)

-c, --community=[community]

Set the community string

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

-l, --username=[name]

Login Name

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

-b, --snmp-auth-prot=[prot]

Set authentication protocol (MD5|SHA)

-P, --snmp-priv-passwd=[pass]

Set privacy protocol password

-R, --snmp-priv-passwd-script

Script to run to retrieve privacy password

-B, --snmp-priv-prot=[prot]

Set privacy protocol (DES|AES)

-E, --snmp-sec-level=[level]

Set security level (noAuthNoPriv|authNoPriv|authPriv)

-d, --snmp-version=[version]

Specifies SNMP version to use (1,2c,3) (Default Value: 2c)

-u, --udpport

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

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

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.

STDIN PARAMETERS¶

action

Fencing Action (Default Value: off)

community

Set the community string

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.

login

Login Name

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.

snmp_auth_prot

Set authentication protocol (MD5|SHA)

snmp_priv_passwd

Set privacy protocol password

snmp_priv_passwd_script

Script to run to retrieve privacy password

snmp_priv_prot

Set privacy protocol (DES|AES)

snmp_sec_level

Set security level (noAuthNoPriv|authNoPriv|authPriv)

snmp_version

Specifies SNMP version to use (1,2c,3) (Default Value: 2c)

udpport

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

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)