NAME¶

fence_imm - Fence agent for IPMI

fence_ilo3 - Fence agent for HP iLO3 (symlink)

fence_ilo4 - Fence agent for HP iLO4 (symlink)

fence_imm - Fence agent for IBM Integrated Management Module (symlink)

fence_idrac - Fence agent for Dell iDRAC (symlink)

DESCRIPTION¶

fence_ipmilan is an I/O Fencing agentwhich can be used with machines controlled by IPMI.This agent calls support software ipmitool (http://ipmitool.sf.net/).

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

PARAMETERS¶

-o, --action=[action]

Fencing Action (Default Value: reboot)

-A, --auth=[auth]

IPMI Lan Auth type.

-C, --cipher=[cipher]

Ciphersuite to use (same as ipmitool -C parameter)

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

-P, --lanplus

Use Lanplus to improve security of connection (Default Value: 0)

-l, --username=[name]

Login Name

-m, --method=[method]

Method to fence (onoff|cycle) (Default Value: onoff)

-p, --password=[password]

Login password or passphrase

-S, --password-script=[script]

Script to retrieve password

-L, --privlvl=[level]

Privilege level on IPMI device (Default Value: administrator)

-t [seconds] Timeout (sec) for IPMI operation

Timeout (sec) for IPMI operation

-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

--delay=[seconds]

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

--ipmitool-path=[path]

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

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

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

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

diag

Pulse a diagnostic interrupt to the processor(s).

STDIN PARAMETERS¶

action

Fencing Action (Default Value: reboot)

auth

IPMI Lan Auth type.

cipher

Ciphersuite to use (same as ipmitool -C parameter)

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

lanplus

Use Lanplus to improve security of connection (Default Value: 0)

login

Login Name

method

Method to fence (onoff|cycle) (Default Value: onoff)

passwd

Login password or passphrase

passwd_script

Script to retrieve password

privlvl

Privilege level on IPMI device (Default Value: administrator)

timeout

Timeout (sec) for IPMI operation

verbose

Verbose mode

debug

Write debug information to given file

version

Display version information and exit

help

Display help and exit

delay

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

ipmitool_path

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

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

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.

sudo_path

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