saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

modules.system: document platform support for "reboot witnessed" functions

Browse source 
The `system.{set,get}_reboot_required_witnessed` functions only work and
make sense on NI Linux RT systems. Highlight this in their
documentation.
This commit is contained in:
Elias Probst 2020-11-27 21:20:07 +00:00 • committed by Daniel Wozniak
parent efc09396b7
commit 14d89b6ae3
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
salt/modules/system.py
View file

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