Provided by: fence-agents_4.4.0-2_amd64 bug

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


       -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 of fencing device

       -u, --ipport=[port]
              TCP/UDP port to use for connection with device (Default  Value:  443)

       -p, --password=[password]
              Login password or passphrase

       -S, --password-script=[script]
              Script to run to retrieve password

       -n, --plug=[ip]
              IP  address  or hostname of fencing device (together with --port-as-ip)

       --redfish-uri=[uri]
              Base or starting Redfish URI (Default Value: /redfish/v1)

       -z, --ssl
              Use SSL connection with verifying certificate (Default Value: 1)

       --ssl-insecure
              Use SSL connection without verifying certificate

       --ssl-secure
              Use SSL connection with verifying certificate

       --systems-uri=[uri]
              Redfish Systems resource URI, i.e. /redfish/v1/Systems/System.Embedded.1

       -l, --username=[name]
              Login name This parameter is always required.

       -q, --quiet
              Disable logging to stderr. Does not affect --verbose or --debug-file or logging  to
              syslog.

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

       --login-timeout=[seconds]
              Wait X seconds for cmd prompt after login (Default Value: 5)

       --port-as-ip
              Make "port/plug" to be an alias to IP address

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

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

       monitor
              Check the health of fence device

       metadata
              Display the XML metadata describing this resource.

       manpage
               The operational behavior of this is not known.

       validate-all
              Validate if all required parameters are entered.

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

       ip     IP address or hostname of fencing device Obsoletes: ipaddr

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

       password
              Login password or passphrase Obsoletes: passwd

       password_script
              Script to run to retrieve password Obsoletes: passwd_script

       plug   IP address or hostname of fencing device (together  with  --port-as-ip)  Obsoletes:
              port

       redfish_uri
              Base  or  starting  Redfish URI (Default Value: /redfish/v1) Obsoletes: redfish-uri

       ssl    Use SSL connection with verifying certificate (Default Value: 1)

       ssl_insecure
              Use SSL connection without verifying certificate

       ssl_secure
              Use SSL connection with verifying certificate

       systems_uri
              Redfish Systems resource URI, i.e. /redfish/v1/Systems/System.Embedded.1 Obsoletes:
              systems-uri

       username
              Login name This parameter is always required. Obsoletes: login

       quiet  Disable  logging to stderr. Does not affect --verbose or --debug-file or logging to
              syslog.

       verbose
              Verbose mode

       debug_file
              Write debug information to given file Obsoletes: debug

       version
              Display version information and exit

       help   Display help and exit

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

       login_timeout
              Wait X seconds for cmd prompt after login (Default Value: 5)

       port_as_ip
              Make "port/plug" to be an alias to IP address

       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)

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