From 14d89b6ae38cee56e44f4c689748b19e0f97df5c Mon Sep 17 00:00:00 2001 From: Elias Probst Date: Fri, 27 Nov 2020 21:20:07 +0000 Subject: [PATCH] modules.system: document platform support for "reboot witnessed" functions The `system.{set,get}_reboot_required_witnessed` functions only work and make sense on NI Linux RT systems. Highlight this in their documentation. --- salt/modules/system.py | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/salt/modules/system.py b/salt/modules/system.py index 5d1be5f6fd2..784892c337a 100644 --- a/salt/modules/system.py +++ b/salt/modules/system.py @@ -651,6 +651,10 @@ NILRT_REBOOT_WITNESS_PATH = "/var/volatile/tmp/salt/reboot_witnessed" @depends("_is_nilrt_family") def set_reboot_required_witnessed(): """ + .. note:: + + This only applies to Minions running on NI Linux RT + This function is used to remember that an event indicating that a reboot is required was witnessed. This function writes to a temporary filesystem so the event gets cleared upon reboot. @@ -681,6 +685,10 @@ def set_reboot_required_witnessed(): @depends("_is_nilrt_family") def get_reboot_required_witnessed(): """ + .. note:: + + This only applies to Minions running on NI Linux RT + Determine if at any time during the current boot session the salt minion witnessed an event indicating that a reboot is required.