Gecko [ goons4good.org ]

Name	Size	Permission	Date
__pycache__	[ DIR ]	drwxr-xr-x	2022-10-11 05:09
decorators	[ DIR ]	drwxr-xr-x	2022-10-11 05:09
dockermod	[ DIR ]	drwxr-xr-x	2022-10-11 05:09
openstack	[ DIR ]	drwxr-xr-x	2022-10-11 05:09
pkg	[ DIR ]	drwxr-xr-x	2022-10-11 05:09
validate	[ DIR ]	drwxr-xr-x	2022-10-11 05:09
__init__.py	237 B	-rw-r--r--	2022-05-16 09:16
aggregation.py	5.17 KB	-rw-r--r--	2022-05-16 09:16
args.py	19.86 KB	-rw-r--r--	2022-05-16 09:16
asynchronous.py	4.07 KB	-rw-r--r--	2022-05-16 09:16
atomicfile.py	5.33 KB	-rw-r--r--	2022-05-16 09:16
aws.py	19.38 KB	-rw-r--r--	2022-05-16 09:16
azurearm.py	11.38 KB	-rw-r--r--	2022-05-16 09:16
beacons.py	517 B	-rw-r--r--	2022-05-16 09:16
boto3_elasticsearch.py	3.73 KB	-rw-r--r--	2022-05-16 09:16
boto3mod.py	8.36 KB	-rw-r--r--	2022-05-16 09:16
boto_elb_tag.py	3.02 KB	-rw-r--r--	2022-05-16 09:16
botomod.py	7.98 KB	-rw-r--r--	2022-05-16 09:16
cache.py	9.81 KB	-rw-r--r--	2022-05-16 09:16
cloud.py	117.04 KB	-rw-r--r--	2022-05-16 09:16
color.py	2.72 KB	-rw-r--r--	2022-05-16 09:16
compat.py	1.81 KB	-rw-r--r--	2022-05-16 09:16
configcomparer.py	3.88 KB	-rw-r--r--	2022-05-16 09:16
configparser.py	10.82 KB	-rw-r--r--	2022-05-16 09:16
context.py	6.8 KB	-rw-r--r--	2022-05-16 09:16
crypt.py	4.71 KB	-rw-r--r--	2022-05-16 09:16
ctx.py	1.42 KB	-rw-r--r--	2022-05-16 09:16
data.py	49.28 KB	-rw-r--r--	2022-05-16 09:16
dateutils.py	2.31 KB	-rw-r--r--	2022-05-16 09:16
debug.py	4.19 KB	-rw-r--r--	2022-05-16 09:16
dictdiffer.py	14.16 KB	-rw-r--r--	2022-05-16 09:16
dicttrim.py	3.9 KB	-rw-r--r--	2022-05-16 09:16
dictupdate.py	11.33 KB	-rw-r--r--	2022-05-16 09:16
dns.py	35.17 KB	-rw-r--r--	2022-05-16 09:16
doc.py	2.25 KB	-rw-r--r--	2022-05-16 09:16
entrypoints.py	2.28 KB	-rw-r--r--	2022-05-16 09:16
environment.py	2.2 KB	-rw-r--r--	2022-05-16 09:16
error.py	1.18 KB	-rw-r--r--	2022-05-16 09:16
etcd_util.py	14.22 KB	-rw-r--r--	2022-05-16 09:16
event.py	52.3 KB	-rw-r--r--	2022-05-16 09:16
extend.py	8.87 KB	-rw-r--r--	2022-05-16 09:16
extmods.py	5.67 KB	-rw-r--r--	2022-05-16 09:16
filebuffer.py	3.15 KB	-rw-r--r--	2022-05-16 09:16
files.py	27.6 KB	-rw-r--r--	2022-05-16 09:16
find.py	22.09 KB	-rw-r--r--	2022-05-16 09:16
fsutils.py	3.29 KB	-rw-r--r--	2022-05-16 09:16
functools.py	5.02 KB	-rw-r--r--	2022-05-16 09:16
gitfs.py	124.49 KB	-rw-r--r--	2022-05-16 09:16
github.py	1.52 KB	-rw-r--r--	2022-05-16 09:16
gzip_util.py	2.86 KB	-rw-r--r--	2022-05-16 09:16
hashutils.py	5.91 KB	-rw-r--r--	2022-05-16 09:16
http.py	34.36 KB	-rw-r--r--	2022-05-16 09:16
iam.py	1.22 KB	-rw-r--r--	2022-05-16 09:16
icinga2.py	754 B	-rw-r--r--	2022-05-16 09:16
idem.py	1.22 KB	-rw-r--r--	2022-05-16 09:16
immutabletypes.py	2.46 KB	-rw-r--r--	2022-05-16 09:16
itertools.py	2.36 KB	-rw-r--r--	2022-05-16 09:16
jid.py	3 KB	-rw-r--r--	2022-05-16 09:16
jinja.py	31.54 KB	-rw-r--r--	2022-05-16 09:16
job.py	6.01 KB	-rw-r--r--	2022-05-16 09:16
json.py	3.78 KB	-rw-r--r--	2022-05-16 09:16
kickstart.py	41.04 KB	-rw-r--r--	2022-05-16 09:16
kinds.py	493 B	-rw-r--r--	2022-05-16 09:16
lazy.py	3.06 KB	-rw-r--r--	2022-05-16 09:16
listdiffer.py	10.9 KB	-rw-r--r--	2022-05-16 09:16
locales.py	2.06 KB	-rw-r--r--	2022-05-16 09:16
mac_utils.py	14.01 KB	-rw-r--r--	2022-05-16 09:16
mako.py	3.63 KB	-rw-r--r--	2022-05-16 09:16
master.py	29.57 KB	-rw-r--r--	2022-05-16 09:16
mattermost.py	1.77 KB	-rw-r--r--	2022-05-16 09:16
memcached.py	3.56 KB	-rw-r--r--	2022-05-16 09:16
migrations.py	1.46 KB	-rw-r--r--	2022-05-16 09:16
mine.py	3.68 KB	-rw-r--r--	2022-05-16 09:16
minion.py	4.13 KB	-rw-r--r--	2022-05-16 09:16
minions.py	43.4 KB	-rw-r--r--	2022-05-16 09:16
mount.py	1.15 KB	-rw-r--r--	2022-05-16 09:16
msazure.py	5.36 KB	-rw-r--r--	2022-05-16 09:16
msgpack.py	4.69 KB	-rw-r--r--	2022-05-16 09:16
nacl.py	13.58 KB	-rw-r--r--	2022-05-16 09:16
namecheap.py	4.32 KB	-rw-r--r--	2022-05-16 09:16
napalm.py	23.79 KB	-rw-r--r--	2022-05-16 09:16
nb_popen.py	7.24 KB	-rw-r--r--	2022-05-16 09:16
network.py	71.07 KB	-rw-r--r--	2022-05-16 09:16
nxos.py	12.94 KB	-rw-r--r--	2022-05-16 09:16
nxos_api.py	4 KB	-rw-r--r--	2022-05-16 09:16
odict.py	13.16 KB	-rw-r--r--	2022-05-16 09:16
oset.py	6.41 KB	-rw-r--r--	2022-05-16 09:16
pagerduty.py	3.03 KB	-rw-r--r--	2022-05-16 09:16
parsers.py	125.31 KB	-rw-r--r--	2022-05-16 09:16
path.py	10.78 KB	-rw-r--r--	2022-05-16 09:16
pbm.py	9.81 KB	-rw-r--r--	2022-05-16 09:16
platform.py	5.16 KB	-rw-r--r--	2022-05-16 09:16
powershell.py	4.15 KB	-rw-r--r--	2022-05-16 09:16
preseed.py	2.64 KB	-rw-r--r--	2022-05-16 09:16
process.py	43.34 KB	-rw-r--r--	2022-05-16 09:16
profile.py	3.21 KB	-rw-r--r--	2022-05-16 09:16
proxy.py	331 B	-rw-r--r--	2022-05-16 09:16
psutil_compat.py	3.65 KB	-rw-r--r--	2022-05-16 09:16
pushover.py	4.51 KB	-rw-r--r--	2022-05-16 09:16
pycrypto.py	5.39 KB	-rw-r--r--	2022-05-16 09:16
pydsl.py	13.74 KB	-rw-r--r--	2022-05-16 09:16
pyobjects.py	10.75 KB	-rw-r--r--	2022-05-16 09:16
reactor.py	19.09 KB	-rw-r--r--	2022-05-16 09:16
reclass.py	752 B	-rw-r--r--	2022-05-16 09:16
roster_matcher.py	3.55 KB	-rw-r--r--	2022-05-16 09:16
rsax931.py	8.07 KB	-rw-r--r--	2022-05-16 09:16
s3.py	8.78 KB	-rw-r--r--	2022-05-16 09:16
saltclass.py	14.27 KB	-rw-r--r--	2022-05-16 09:16
sanitizers.py	2.51 KB	-rw-r--r--	2022-05-16 09:16
schedule.py	70.67 KB	-rw-r--r--	2022-05-16 09:16
schema.py	54.26 KB	-rw-r--r--	2022-05-16 09:16
sdb.py	4.04 KB	-rw-r--r--	2022-05-16 09:16
slack.py	3.57 KB	-rw-r--r--	2022-05-16 09:16
smb.py	11.16 KB	-rw-r--r--	2022-05-16 09:16
smtp.py	3.27 KB	-rw-r--r--	2022-05-16 09:16
ssdp.py	14.75 KB	-rw-r--r--	2022-05-16 09:16
ssh.py	769 B	-rw-r--r--	2022-05-16 09:16
state.py	8.43 KB	-rw-r--r--	2022-05-16 09:16
stringio.py	355 B	-rw-r--r--	2022-05-16 09:16
stringutils.py	16.63 KB	-rw-r--r--	2022-05-16 09:16
systemd.py	5.51 KB	-rw-r--r--	2022-05-16 09:16
templates.py	23.92 KB	-rw-r--r--	2022-05-16 09:16
textformat.py	5.03 KB	-rw-r--r--	2022-05-16 09:16
thin.py	31.64 KB	-rw-r--r--	2022-05-16 09:16
timed_subprocess.py	4.06 KB	-rw-r--r--	2022-05-16 09:16
timeout.py	1.53 KB	-rw-r--r--	2022-05-16 09:16
timeutil.py	2.4 KB	-rw-r--r--	2022-05-16 09:16
url.py	4.96 KB	-rw-r--r--	2022-05-16 09:16
user.py	10.92 KB	-rw-r--r--	2022-05-16 09:16
value.py	247 B	-rw-r--r--	2022-05-16 09:16
vault.py	19.23 KB	-rw-r--r--	2022-05-16 09:16
verify.py	26.97 KB	-rw-r--r--	2022-05-16 09:16
versions.py	16.32 KB	-rw-r--r--	2022-05-16 09:16
virt.py	3.24 KB	-rw-r--r--	2022-05-16 09:16
virtualbox.py	22.43 KB	-rw-r--r--	2022-05-16 09:16
vmware.py	129.74 KB	-rw-r--r--	2022-05-16 09:16
vsan.py	17.18 KB	-rw-r--r--	2022-05-16 09:16
vt.py	30.25 KB	-rw-r--r--	2022-05-16 09:16
vt_helper.py	4.4 KB	-rw-r--r--	2022-05-16 09:16
win_chcp.py	3.7 KB	-rw-r--r--	2022-05-16 09:16
win_dacl.py	94.69 KB	-rw-r--r--	2022-05-16 09:16
win_dotnet.py	4.75 KB	-rw-r--r--	2022-05-16 09:16
win_functions.py	12.69 KB	-rw-r--r--	2022-05-16 09:16
win_lgpo_auditpol.py	8.48 KB	-rw-r--r--	2022-05-16 09:16
win_lgpo_netsh.py	17.87 KB	-rw-r--r--	2022-05-16 09:16
win_network.py	12.41 KB	-rw-r--r--	2022-05-16 09:16
win_osinfo.py	2.83 KB	-rw-r--r--	2022-05-16 09:16
win_pdh.py	13.85 KB	-rw-r--r--	2022-05-16 09:16
win_reg.py	30.05 KB	-rw-r--r--	2022-05-16 09:16
win_runas.py	10.55 KB	-rw-r--r--	2022-05-16 09:16
win_service.py	5.2 KB	-rw-r--r--	2022-05-16 09:16
win_system.py	14.47 KB	-rw-r--r--	2022-05-16 09:16
win_update.py	40.36 KB	-rw-r--r--	2022-05-16 09:16
winapi.py	818 B	-rw-r--r--	2022-05-16 09:16
xdg.py	316 B	-rw-r--r--	2022-05-16 09:16
xmlutil.py	13.91 KB	-rw-r--r--	2022-05-16 09:16
yaml.py	348 B	-rw-r--r--	2022-05-16 09:16
yamldumper.py	3.38 KB	-rw-r--r--	2022-05-16 09:16
yamlencoding.py	1.55 KB	-rw-r--r--	2022-05-16 09:16
yamlloader.py	6.21 KB	-rw-r--r--	2022-05-16 09:16
yamlloader_old.py	8.33 KB	-rw-r--r--	2022-05-16 09:16
yast.py	619 B	-rw-r--r--	2022-05-16 09:16
zeromq.py	1.65 KB	-rw-r--r--	2022-05-16 09:16
zfs.py	19.2 KB	-rw-r--r--	2022-05-16 09:16

Rename

"""
Win System Utils

Functions shared with salt.modules.win_system and salt.grains.pending_reboot

.. versionadded:: 3001
"""
# NOTE: DO NOT USE RAW STRINGS IN THIS MODULE! UNICODE_LITERALS DOES NOT PLAY
# NICELY WITH RAW STRINGS CONTAINING \u or \U.

import logging

import salt.utils.win_reg
import salt.utils.win_update

try:
    import win32api
    import win32con

HAS_WIN32_MODS = True
except ImportError:
    HAS_WIN32_MODS = False

log = logging.getLogger(__name__)

# Define the module's virtual name
__virtualname__ = "win_system"
MINION_VOLATILE_KEY = "SYSTEM\\CurrentControlSet\\Services\\salt-minion\\Volatile-Data"
REBOOT_REQUIRED_NAME = "Reboot required"

def __virtual__():
    """
    Only works on Windows systems
    """
    if not salt.utils.platform.is_windows():
        return (
            False,
            "win_system salt util failed to load: "
            "The util will only run on Windows systems",
        )
    if not HAS_WIN32_MODS:
        return (
            False,
            "win_system salt util failed to load: "
            "The util will only run on Windows systems",
        )
    return __virtualname__

def get_computer_name():
    """
    Get the Windows computer name. Uses the win32api to get the current computer
    name.

.. versionadded:: 3001

Returns:
        str: Returns the computer name if found. Otherwise returns ``False``.

Example:

.. code-block:: python

import salt.utils.win_system
        salt.utils.win_system.get_computer_name()
    """
    name = win32api.GetComputerNameEx(win32con.ComputerNamePhysicalDnsHostname)
    return name if name else False

def get_pending_computer_name():
    """
    Get a pending computer name. If the computer name has been changed, and the
    change is pending a system reboot, this function will return the pending
    computer name. Otherwise, ``None`` will be returned. If there was an error
    retrieving the pending computer name, ``False`` will be returned, and an
    error message will be logged to the minion log.

.. versionadded:: 3001

Returns:
        str:
            Returns the pending name if pending restart. Returns ``None`` if not
            pending restart.

Example:

.. code-block:: python

import salt.utils.win_system
        salt.utils.win_system.get_pending_computer_name()
    """
    current = get_computer_name()
    try:
        pending = salt.utils.win_reg.read_value(
            hive="HKLM",
            key="SYSTEM\\CurrentControlSet\\Services\\Tcpip\\Parameters",
            vname="NV Hostname",
        )["vdata"]
    except TypeError:
        # This should never happen as the above key and vname are system names
        # and should always be present
        return None
    if pending:
        return pending if pending.lower() != current.lower() else None

def get_pending_component_servicing():
    """
    Determine whether there are pending Component Based Servicing tasks that
    require a reboot.

If any the following registry keys exist then a reboot is pending:

``HKLM:\\\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Component Based Servicing\\RebootPending``
    ``HKLM:\\\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Component Based Servicing\\RebootInProgress``
    ``HKLM:\\\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Component Based Servicing\\PackagesPending``

.. versionadded:: 3001

Returns:
        bool: ``True`` if there are pending Component Based Servicing tasks,
        otherwise ``False``

CLI Example:

.. code-block:: bash

salt '*' system.get_pending_component_servicing
    """
    # So long as one of the registry keys exists, a reboot is pending
    base_key = "SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Component Based Servicing"
    sub_keys = ("RebootPending", "RebootInProgress", "PackagesPending")
    for sub_key in sub_keys:
        key = "\\".join((base_key, sub_key))
        if salt.utils.win_reg.key_exists(hive="HKLM", key=key):
            return True

return False

def get_pending_domain_join():
    """
    Determine whether there is a pending domain join action that requires a
    reboot.

If any the following registry keys exist then a reboot is pending:

``HKLM:\\\\SYSTEM\\CurrentControlSet\\Services\\Netlogon\\AvoidSpnSet``
    ``HKLM:\\\\SYSTEM\\CurrentControlSet\\Services\\Netlogon\\JoinDomain``

.. versionadded:: 3001

Returns:
        bool: ``True`` if there is a pending domain join action, otherwise
        ``False``

Example:

.. code-block:: python

import salt.utils.win_system
        salt.utils.win_system.get_pending_domain_join()
    """
    base_key = "SYSTEM\\CurrentControlSet\\Services\\Netlogon"
    sub_keys = ("AvoidSpnSet", "JoinDomain")

# If any keys are present then there is a reboot pending.
    for sub_key in sub_keys:
        key = "\\".join((base_key, sub_key))
        if salt.utils.win_reg.key_exists(hive="HKLM", key=key):
            return True

return False

def get_pending_file_rename():
    """
    Determine whether there are pending file rename operations that require a
    reboot.

A reboot is pending if any of the following value names exist and have value
    data set:

- ``PendingFileRenameOperations``
    - ``PendingFileRenameOperations2``

in the following registry key:

``HKLM:\\\\SYSTEM\\CurrentControlSet\\Control\\Session Manager``

.. versionadded:: 3001

Returns:
        bool: ``True`` if there are pending file rename operations, otherwise
        ``False``

Example:

.. code-block:: python

import salt.utils.win_system
        salt.utils.win_system.get_pending_file_rename()
    """
    vnames = ("PendingFileRenameOperations", "PendingFileRenameOperations2")
    key = "SYSTEM\\CurrentControlSet\\Control\\Session Manager"
    for vname in vnames:
        reg_ret = salt.utils.win_reg.read_value(hive="HKLM", key=key, vname=vname)
        if reg_ret["success"]:
            if reg_ret["vdata"] and (reg_ret["vdata"] != "(value not set)"):
                return True
    return False

def get_pending_servermanager():
    """
    Determine whether there are pending Server Manager tasks that require a
    reboot.

A reboot is pending if the ``CurrentRebootAttempts`` value name exists and
    has an integer value. The value name resides in the following registry key:

``HKLM:\\\\SOFTWARE\\Microsoft\\ServerManager``

.. versionadded:: 3001

Returns:
        bool: ``True`` if there are pending Server Manager tasks, otherwise
        ``False``

Example:

.. code-block:: python

import salt.utils.win_system
        salt.utils.win_system.get_pending_servermanager()
    """
    vname = "CurrentRebootAttempts"
    key = "SOFTWARE\\Microsoft\\ServerManager"

# There are situations where it's possible to have '(value not set)' as
    # the value data, and since an actual reboot won't be pending in that
    # instance, just catch instances where we try unsuccessfully to cast as int.

reg_ret = salt.utils.win_reg.read_value(hive="HKLM", key=key, vname=vname)
    if reg_ret["success"]:
        try:
            if int(reg_ret["vdata"]) > 0:
                return True
        except ValueError:
            pass
    return False

def get_pending_dvd_reboot():
    """
    Determine whether the DVD Reboot flag is set.

The system requires a reboot if the ``DVDRebootSignal`` value name exists
    at the following registry location:

``HKLM:\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\RunOnce``

.. versionadded:: 3001

Returns:
        bool: ``True`` if the above condition is met, otherwise ``False``

Example:

.. code-block:: python

import salt.utils.win_system
        salt.utils.win_system.get_pending_dvd_reboot()
    """
    # So long as the registry key exists, a reboot is pending.
    return salt.utils.win_reg.value_exists(
        hive="HKLM",
        key="SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\RunOnce",
        vname="DVDRebootSignal",
    )

def get_pending_update():
    """
    Determine whether there are pending updates that require a reboot.

If either of the following registry keys exists, a reboot is pending:

``HKLM:\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\WindowsUpdate\\Auto Update\\RebootRequired``
    ``HKLM:\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\WindowsUpdate\\Auto Update\\PostRebootReporting``

.. versionadded:: 3001

Returns:
        bool: ``True`` if any of the above conditions are met, otherwise
        ``False``

Example:

.. code-block:: python

import salt.utils.win_system
        salt.utils.win_system.get_pending_update()
    """
    # So long as any of the registry keys exists, a reboot is pending.
    base_key = (
        "SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\WindowsUpdate\\Auto Update"
    )
    sub_keys = ("RebootRequired", "PostRebootReporting")
    for sub_key in sub_keys:
        key = "\\".join((base_key, sub_key))
        if salt.utils.win_reg.key_exists(hive="HKLM", key=key):
            return True

return False

def get_reboot_required_witnessed():
    """
    Determine if at any time during the current boot session the salt minion
    witnessed an event indicating that a reboot is required.

This function will return ``True`` if an install completed with exit
    code 3010 during the current boot session and can be extended where
    appropriate in the future.

If the ``Reboot required`` value name exists in the following location and
    has a value of ``1`` then the system is pending reboot:

``HKLM:\\\\SYSTEM\\CurrentControlSet\\Services\\salt-minion\\Volatile-Data``

.. versionadded:: 3001

Returns:
        bool: ``True`` if the ``Requires reboot`` registry flag is set to ``1``,
        otherwise ``False``

Example:

.. code-block:: python

import salt.utils.win_system
        salt.utils.win_system.get_reboot_required_witnessed()

"""
    value_dict = salt.utils.win_reg.read_value(
        hive="HKLM", key=MINION_VOLATILE_KEY, vname=REBOOT_REQUIRED_NAME
    )
    return value_dict["vdata"] == 1

def set_reboot_required_witnessed():
    """
    This function is used to remember that an event indicating that a reboot is
    required was witnessed. This function relies on the salt-minion's ability to
    create the following volatile registry key in the *HKLM* hive:

*SYSTEM\\CurrentControlSet\\Services\\salt-minion\\Volatile-Data*

Because this registry key is volatile, it will not persist beyond the
    current boot session. Also, in the scope of this key, the name *'Reboot
    required'* will be assigned the value of *1*.

For the time being, this function is being used whenever an install
    completes with exit code 3010 and can be extended where appropriate in the
    future.

.. versionadded:: 3001

Returns:
        bool: ``True`` if successful, otherwise ``False``

Example:

.. code-block:: python

import salt.utils.win_system
        salt.utils.win_system.set_reboot_required_witnessed()
    """
    return salt.utils.win_reg.set_value(
        hive="HKLM",
        key=MINION_VOLATILE_KEY,
        volatile=True,
        vname=REBOOT_REQUIRED_NAME,
        vdata=1,
        vtype="REG_DWORD",
    )

def get_pending_update_exe_volatile():
    """
    Determine whether there is a volatile update exe that requires a reboot.

Checks ``HKLM:\\Microsoft\\Updates``. If the ``UpdateExeVolatile`` value
    name is anything other than 0 there is a reboot pending

.. versionadded:: 3001

Returns:
        bool: ``True`` if there is a volatile exe, otherwise ``False``

Example:

.. code-block:: python

import salt.utils.win_system
        salt.utils.win_system.get_pending_update_exe_volatile()
    """
    key = "SOFTWARE\\Microsoft\\Updates"
    reg_ret = salt.utils.win_reg.read_value(
        hive="HKLM", key=key, vname="UpdateExeVolatile"
    )
    if reg_ret["success"]:
        try:
            if int(reg_ret["vdata"]) != 0:
                return True
        except ValueError:
            pass
    return False

def get_pending_windows_update():
    """
    Check the Windows Update system for a pending reboot state.

This leverages the Windows Update System to determine if the system is
    pending a reboot.

.. versionadded:: 3001

Returns:
        bool: ``True`` if the Windows Update system reports a pending update,
        otherwise ``False``

Example:

.. code-block:: python

import salt.utils.win_system
        salt.utils.win_system.get_pending_windows_update()
    """
    return salt.utils.win_update.needs_reboot()

def get_pending_reboot():
    """
    Determine whether there is a reboot pending.

.. versionadded:: 3001

Returns:
        bool: ``True`` if the system is pending reboot, otherwise ``False``

Example:

.. code-block:: python

import salt.utils.win_system
        salt.utils.win_system.get_pending_reboot()
    """
    # Order the checks for reboot pending in most to least likely.
    checks = (
        get_pending_update,
        get_pending_windows_update,
        get_pending_update_exe_volatile,
        get_pending_file_rename,
        get_pending_servermanager,
        get_pending_component_servicing,
        get_pending_dvd_reboot,
        get_reboot_required_witnessed,
        get_pending_computer_name,
        get_pending_domain_join,
    )

for check in checks:
        if check():
            return True

return False

def get_pending_reboot_details():
    """
    Determine which check is signalling that the system is pending a reboot.
    Useful in determining why your system is signalling that it needs a reboot.

.. versionadded:: 3001

Returns:
        dict: A dictionary of the results of each function that checks for a
        pending reboot

Example:

.. code-block:: python

import salt.utils.win_system
        salt.utils.win_system.get_pending_reboot_details()
    """
    return {
        "Pending Component Servicing": get_pending_component_servicing(),
        "Pending Computer Rename": get_pending_computer_name() is not None,
        "Pending DVD Reboot": get_pending_dvd_reboot(),
        "Pending File Rename": get_pending_file_rename(),
        "Pending Join Domain": get_pending_domain_join(),
        "Pending ServerManager": get_pending_servermanager(),
        "Pending Update": get_pending_update(),
        "Pending Windows Update": get_pending_windows_update(),
        "Reboot Required Witnessed": get_reboot_required_witnessed(),
        "Volatile Update Exe": get_pending_update_exe_volatile(),
    }