Scroll to navigation

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

NAME

fence_redfish - I/O Fencing agent for Redfish

DESCRIPTION

fence_redfish is an I/O Fencing agent which can be used with Out-of-Band controllers that support Redfish APIs. These controllers provide remote access to control power on a server.

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

PARAMETERS

Fencing action (Default Value: reboot)
IP address or hostname of fencing device
TCP/UDP port to use for connection with device (Default Value: 443)
Login password or passphrase
Script to run to retrieve password
IP address or hostname of fencing device (together with --port-as-ip)
Base or starting Redfish URI (Default Value: /redfish/v1)
Use SSL connection with verifying certificate (Default Value: 1)
Use SSL connection without verifying certificate
Use SSL connection with verifying certificate
Redfish Systems resource URI, i.e. /redfish/v1/Systems/System.Embedded.1
Login name This parameter is always required.
Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.
Verbose mode
Write debug information to given file
Display version information and exit
Display help and exit
Wait X seconds before fencing is started (Default Value: 0)
Wait X seconds for cmd prompt after login (Default Value: 5)
Make "port/plug" to be an alias to IP address
Test X seconds for status change after ON/OFF (Default Value: 20)
Wait X seconds after issuing ON/OFF (Default Value: 0)
Wait X seconds for cmd prompt after issuing command (Default Value: 3)
Count of attempts to retry power on (Default Value: 1)
Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)

ACTIONS

Power on machine.
Power off machine.
Reboot machine.
This returns the status of the plug/virtual machine.
Check the health of fence device
Display the XML metadata describing this resource.

The operational behavior of this is not known.
Validate if all required parameters are entered.

STDIN PARAMETERS

Fencing action (Default Value: reboot)
IP address or hostname of fencing device Obsoletes: ipaddr
TCP/UDP port to use for connection with device (Default Value: 443)
Login password or passphrase Obsoletes: passwd
Script to run to retrieve password Obsoletes: passwd_script
IP address or hostname of fencing device (together with --port-as-ip) Obsoletes: port
Base or starting Redfish URI (Default Value: /redfish/v1) Obsoletes: redfish-uri
Use SSL connection with verifying certificate (Default Value: 1)
Use SSL connection without verifying certificate
Use SSL connection with verifying certificate
Redfish Systems resource URI, i.e. /redfish/v1/Systems/System.Embedded.1 Obsoletes: systems-uri
Login name This parameter is always required. Obsoletes: login
Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.
Verbose mode
Write debug information to given file Obsoletes: debug
Display version information and exit
Display help and exit
Wait X seconds before fencing is started (Default Value: 0)
Wait X seconds for cmd prompt after login (Default Value: 5)
Make "port/plug" to be an alias to IP address
Test X seconds for status change after ON/OFF (Default Value: 20)
Wait X seconds after issuing ON/OFF (Default Value: 0)
Wait X seconds for cmd prompt after issuing command (Default Value: 3)
Count of attempts to retry power on (Default Value: 1)
Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
2009-10-20 fence_redfish (Fence Agent)