From 3ea95247a182598f8b0d4aa24f417569f3efaa82 Mon Sep 17 00:00:00 2001
From: Oyvind Albrigtsen <oalbrigt@redhat.com>
Date: Mon, 24 Jul 2023 12:13:16 +0200
Subject: [PATCH 24/46] fa-dev-guide: add reboot_cycle() section

---
 doc/fa-dev-guide.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/doc/fa-dev-guide.md b/doc/fa-dev-guide.md
index 8c349274..0ab8f770 100644
--- a/doc/fa-dev-guide.md
+++ b/doc/fa-dev-guide.md
@@ -127,6 +127,31 @@ def get_list(conn, options):
 	return outlets
 ```
 
+### reboot_cycle()
+***The reboot cycle method is not recommended as it might report success before the node is powered off.***
+- fence_ipmilan contains a minimal reboot_cycle() approach.
+- Add "method" to the device_opt list.
+- Update all_opt["method"]["help"] with a warning that it might report success before the node is powered off.
+- Add reboot_cycle function to fence_action() call in main().
+
+Example:
+```
+def reboot_cycle(_, options):
+        output = _run_command(options, "cycle")
+        return bool(re.search('chassis power control: cycle', str(output).lower()))
+...
+
+def main():
+...
+        device_opt = [ ..., "method" ]
+...
+        all_opt["method"]["help"] = "-m, --method=[method]          Method to fence (onoff|cycle) (Default: onoff)\n" \
+                                    "WARNING! This fence agent might report success before the node is powered off. " \
+                                    "You should use -m/method onoff if your fence device works correctly with that option."
+...
+        result = fence_action(None, options, set_power_status, get_power_status, None, reboot_cycle)
+```
+
 ### define_new_opts()
 Specifies device specific parameters with defaults.
 - getopt is ":" for parameters that require a value and "" for parameters that get set without a value (e.g. -v)
-- 
2.25.1