Current File : //lib/python2.7/site-packages/salt/modules/win_wua.pyo
�
���^c
@@ ss d Z d d l m Z m Z m Z d d l Z d d l Z d d l Z d d l Z d d l
m Z d d l m
Z
y d d l Z e Z Wn e k
r� e Z n Xe j e � Z i d d 6Z d � Z e e e e e e e d d d � Z e e d
� Z e e e e d d e e d � Z d � Z d
� Z d � Z d d d d d d d d � Z d � Z! d � Z" d � Z# d S( u�
Module for managing Windows Updates using the Windows Update Agent.
List updates on the system using the following functions:
- :py:func:`win_wua.available <salt.modules.win_wua.available>`
- :py:func:`win_wua.list <salt.modules.win_wua.list_>`
This is an easy way to find additional information about updates available to
to the system, such as the GUID, KB number, or description.
Once you have the GUID or a KB number for the update you can get information
about the update, download, install, or uninstall it using these functions:
- :py:func:`win_wua.get <salt.modules.win_wua.get>`
- :py:func:`win_wua.download <salt.modules.win_wua.download>`
- :py:func:`win_wua.install <salt.modules.win_wua.install>`
- :py:func:`win_wua.uninstall <salt.modules.win_wua.uninstall>`
The get function expects a name in the form of a GUID, KB, or Title and should
return information about a single update. The other functions accept either a
single item or a list of items for downloading/installing/uninstalling a
specific list of items.
The :py:func:`win_wua.list <salt.modules.win_wua.list_>` and
:py:func:`win_wua.get <salt.modules.win_wua.get>` functions are utility
functions. In addition to returning information about updates they can also
download and install updates by setting ``download=True`` or ``install=True``.
So, with py:func:`win_wua.list <salt.modules.win_wua.list_>` for example, you
could run the function with the filters you want to see what is available. Then
just add ``install=True`` to install everything on that list.
If you want to download, install, or uninstall specific updates, use
:py:func:`win_wua.download <salt.modules.win_wua.download>`,
:py:func:`win_wua.install <salt.modules.win_wua.install>`, or
:py:func:`win_wua.uninstall <salt.modules.win_wua.uninstall>`. To update your
system with the latest updates use :py:func:`win_wua.list
<salt.modules.win_wua.list_>` and set ``install=True``
You can also adjust the Windows Update settings using the
:py:func:`win_wua.set_wu_settings <salt.modules.win_wua.set_wu_settings>`
function. This function is only supported on the following operating systems:
- Windows Vista / Server 2008
- Windows 7 / Server 2008R2
- Windows 8 / Server 2012
- Windows 8.1 / Server 2012R2
As of Windows 10 and Windows Server 2016, the ability to modify the Windows
Update settings has been restricted. The settings can be modified in the Local
Group Policy using the ``lgpo`` module.
.. versionadded:: 2015.8.0
:depends: salt.utils.win_update
i ( t absolute_importt unicode_literalst print_functionN( t CommandExecutionError( t sixu listu list_c C@ sI t j j j � s t d f St s, t d f St j j j sE t d f St S( u4
Only works on Windows systems with PyWin32
u% WUA: Only available on Window systemsu WUA: Requires PyWin32 librariesu8 WUA: Missing Libraries required by salt.utils.win_update( t saltt utilst platformt
is_windowst Falset HAS_PYWIN32t
win_updatet True( ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_wua.pyt __virtual__S s
c C@ sh t j j j � } | j d | d | d | d | d | d | d | d | � }
| r^ |
j � S|
j � S( ut
.. versionadded:: 2017.7.0
List updates that match the passed criteria. This allows for more filter
options than :func:`list`. Good for finding a specific GUID or KB.
Args:
software (bool):
Include software updates in the results (default is True)
drivers (bool):
Include driver updates in the results (default is True)
summary (bool):
- True: Return a summary of updates available for each category.
- False (default): Return a detailed list of available updates.
skip_installed (bool):
Skip updates that are already installed. Default is False.
skip_hidden (bool):
Skip updates that have been hidden. Default is True.
skip_mandatory (bool):
Skip mandatory updates. Default is False.
skip_reboot (bool):
Skip updates that require a reboot. Default is False.
categories (list):
Specify the categories to list. Must be passed as a list. All
categories returned by default.
Categories include the following:
* Critical Updates
* Definition Updates
* Drivers (make sure you set drivers=True)
* Feature Packs
* Security Updates
* Update Rollups
* Updates
* Update Rollups
* Windows 7
* Windows 8.1
* Windows 8.1 drivers
* Windows 8.1 and later drivers
* Windows Defender
severities (list):
Specify the severities to include. Must be passed as a list. All
severities returned by default.
Severities include the following:
* Critical
* Important
Returns:
dict: Returns a dict containing either a summary or a list of updates:
.. code-block:: cfg
List of Updates:
{'<GUID>': {'Title': <title>,
'KB': <KB>,
'GUID': <the globally unique identifier for the update>
'Description': <description>,
'Downloaded': <has the update been downloaded>,
'Installed': <has the update been installed>,
'Mandatory': <is the update mandatory>,
'UserInput': <is user input required>,
'EULAAccepted': <has the EULA been accepted>,
'Severity': <update severity>,
'NeedsReboot': <is the update installed and awaiting reboot>,
'RebootBehavior': <will the update require a reboot>,
'Categories': [ '<category 1>',
'<category 2>',
...]
}
}
Summary of Updates:
{'Total': <total number of updates returned>,
'Available': <updates that are not downloaded or installed>,
'Downloaded': <updates that are downloaded but not installed>,
'Installed': <updates installed (usually 0 unless installed=True)>,
'Categories': { <category 1>: <total for that category>,
<category 2>: <total for category 2>,
... }
}
CLI Examples:
.. code-block:: bash
# Normal Usage (list all software updates)
salt '*' win_wua.available
# List all updates with categories of Critical Updates and Drivers
salt '*' win_wua.available categories=["Critical Updates","Drivers"]
# List all Critical Security Updates
salt '*' win_wua.available categories=["Security Updates"] severities=["Critical"]
# List all updates with a severity of Critical
salt '*' win_wua.available severities=["Critical"]
# A summary of all available updates
salt '*' win_wua.available summary=True
# A summary of all Feature Packs and Windows 8.1 Updates
salt '*' win_wua.available categories=["Feature Packs","Windows 8.1"] summary=True
t skip_hiddent skip_installedt skip_mandatoryt skip_reboott softwaret driverst
categoriest
severities( R R R t WindowsUpdateAgentt availablet summaryt list( R R R R R R R R R t wuat updates( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_wua.pyR c s c C@ sy t j j j � } | j | � } i } | s3 | rI | j | � | d <n | re | j | � | d <n | ro | S| j � S( u�
.. versionadded:: 2017.7.0
Returns details for the named update
Args:
name (str):
The name of the update you're searching for. This can be the GUID, a
KB number, or any part of the name of the update. GUIDs and KBs are
preferred. Run ``list`` to get the GUID for the update you're
looking for.
download (bool):
Download the update returned by this function. Run this function
first to see if the update exists, then set ``download=True`` to
download the update.
install (bool):
Install the update returned by this function. Run this function
first to see if the update exists, then set ``install=True`` to
install the update.
Returns:
dict: Returns a dict containing a list of updates that match the name if
download and install are both set to False. Should usually be a single
update, but can return multiple if a partial name is given.
If download or install is set to true it will return the results of the
operation.
.. code-block:: cfg
List of Updates:
{'<GUID>': {'Title': <title>,
'KB': <KB>,
'GUID': <the globally unique identifier for the update>
'Description': <description>,
'Downloaded': <has the update been downloaded>,
'Installed': <has the update been installed>,
'Mandatory': <is the update mandatory>,
'UserInput': <is user input required>,
'EULAAccepted': <has the EULA been accepted>,
'Severity': <update severity>,
'NeedsReboot': <is the update installed and awaiting reboot>,
'RebootBehavior': <will the update require a reboot>,
'Categories': [ '<category 1>',
'<category 2>',
...]
}
}
CLI Examples:
.. code-block:: bash
# Recommended Usage using GUID without braces
# Use this to find the status of a specific update
salt '*' win_wua.get 12345678-abcd-1234-abcd-1234567890ab
# Use the following if you don't know the GUID:
# Using a KB number
# Not all updates have an associated KB
salt '*' win_wua.get KB3030298
# Using part or all of the name of the update
# Could possibly return multiple results
# Not all updates have an associated KB
salt '*' win_wua.get 'Microsoft Camera Codec Pack'
u Downloadu Install( R R R R t searcht downloadt installR ( t nameR R R R t ret( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_wua.pyt get� s J c C@ s� t j j j � } | j d | d | d | d | d | � } i }
| sN | rd | j | � |
d <n | r� | j | � |
d <n |
s� | r� | j � S| j � S|
S( u�
.. versionadded:: 2017.7.0
Returns a detailed list of available updates or a summary. If download or
install is True the same list will be downloaded and/or installed.
Args:
software (bool):
Include software updates in the results (default is True)
drivers (bool):
Include driver updates in the results (default is False)
summary (bool):
- True: Return a summary of updates available for each category.
- False (default): Return a detailed list of available updates.
skip_installed (bool):
Skip installed updates in the results (default is False)
download (bool):
(Overrides reporting functionality) Download the list of updates
returned by this function. Run this function first with
``download=False`` to see what will be downloaded, then set
``download=True`` to download the updates.
install (bool):
(Overrides reporting functionality) Install the list of updates
returned by this function. Run this function first with
``install=False`` to see what will be installed, then set
``install=True`` to install the updates.
categories (list):
Specify the categories to list. Must be passed as a list. All
categories returned by default.
Categories include the following:
* Critical Updates
* Definition Updates
* Drivers (make sure you set drivers=True)
* Feature Packs
* Security Updates
* Update Rollups
* Updates
* Update Rollups
* Windows 7
* Windows 8.1
* Windows 8.1 drivers
* Windows 8.1 and later drivers
* Windows Defender
severities (list):
Specify the severities to include. Must be passed as a list. All
severities returned by default.
Severities include the following:
* Critical
* Important
Returns:
dict: Returns a dict containing either a summary or a list of updates:
.. code-block:: cfg
List of Updates:
{'<GUID>': {'Title': <title>,
'KB': <KB>,
'GUID': <the globally unique identifier for the update>
'Description': <description>,
'Downloaded': <has the update been downloaded>,
'Installed': <has the update been installed>,
'Mandatory': <is the update mandatory>,
'UserInput': <is user input required>,
'EULAAccepted': <has the EULA been accepted>,
'Severity': <update severity>,
'NeedsReboot': <is the update installed and awaiting reboot>,
'RebootBehavior': <will the update require a reboot>,
'Categories': [ '<category 1>',
'<category 2>',
...]
}
}
Summary of Updates:
{'Total': <total number of updates returned>,
'Available': <updates that are not downloaded or installed>,
'Downloaded': <updates that are downloaded but not installed>,
'Installed': <updates installed (usually 0 unless installed=True)>,
'Categories': { <category 1>: <total for that category>,
<category 2>: <total for category 2>,
... }
}
CLI Examples:
.. code-block:: bash
# Normal Usage (list all software updates)
salt '*' win_wua.list
# List all updates with categories of Critical Updates and Drivers
salt '*' win_wua.list categories=['Critical Updates','Drivers']
# List all Critical Security Updates
salt '*' win_wua.list categories=['Security Updates'] severities=['Critical']
# List all updates with a severity of Critical
salt '*' win_wua.list severities=['Critical']
# A summary of all available updates
salt '*' win_wua.list summary=True
# A summary of all Feature Packs and Windows 8.1 Updates
salt '*' win_wua.list categories=['Feature Packs','Windows 8.1'] summary=True
R R R R R u Downloadu Install( R R R R R R R R R ( R R R R R R R R R R R ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_wua.pyR K s � c C@ s� t j j j � } | j | � } | j � d k rB t d � � n t | t j � r` | g } n t | t j
� r� t j | � g } n | j � t | � k r� t d � � n | j
| � S( u
.. versionadded:: 2017.7.0
Downloads updates that match the list of passed identifiers. It's easier to
use this function by using list_updates and setting install=True.
Args:
names (str, list):
A single update or a list of updates to download. This can be any
combination of GUIDs, KB numbers, or names. GUIDs or KBs are
preferred.
.. note::
An error will be raised if there are more results than there are items
in the names parameter
Returns:
dict: A dictionary containing the details about the downloaded updates
CLI Examples:
.. code-block:: bash
# Normal Usage
salt '*' win_wua.download names=['12345678-abcd-1234-abcd-1234567890ab', 'KB2131233']
i u No updates foundu6 Multiple updates found, names need to be more specific( R R R R R t countR t
isinstanceR t string_typest
integer_typest text_typet lenR ( t namesR R ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_wua.pyR � s c C@ s� t j j j � } | j | � } | j � d k rB t d � � n t | t j � r` | g } n t | t j
� r� t j | � g } n | j � t | � k r� t d � � n | j
| � S( u�
.. versionadded:: 2017.7.0
Installs updates that match the list of identifiers. It may be easier to use
the list_updates function and set install=True.
Args:
names (str, list):
A single update or a list of updates to install. This can be any
combination of GUIDs, KB numbers, or names. GUIDs or KBs are
preferred.
.. note::
An error will be raised if there are more results than there are items
in the names parameter
Returns:
dict: A dictionary containing the details about the installed updates
CLI Examples:
.. code-block:: bash
# Normal Usage
salt '*' win_wua.install KB12323211
i u No updates foundu6 Multiple updates found, names need to be more specific( R R R R R R" R R# R R$ R% R& R' R ( R( R R ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_wua.pyR s c C@ sO t j j j � } | j | � } | j � d k rB t d � � n | j | � S( uV
.. versionadded:: 2017.7.0
Uninstall updates.
Args:
names (str, list):
A single update or a list of updates to uninstall. This can be any
combination of GUIDs, KB numbers, or names. GUIDs or KBs are
preferred.
Returns:
dict: A dictionary containing the details about the uninstalled updates
CLI Examples:
.. code-block:: bash
# Normal Usage
salt '*' win_wua.uninstall KB3121212
# As a list
salt '*' win_wua.uninstall guid=['12345678-abcd-1234-abcd-1234567890ab', 'KB1231231']
i u No updates found( R R R R R R" R t uninstall( R( R R ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_wua.pyR) J s
c C@ sJ i t d 6} t j j j � � t j j d � } Wd QX| j } | d k r� t
| � | _ | j � }
|
d k r� | | d <q� d | d <t
| d <n | d k r� | | _ | j � }
|
d k r� | | d <q� d | d <t
| d <n | d k r:| | _ | j � }
|
d k r#| | d <q:d | d <t
| d <n | d k r�| | _ | j � }
|
d k rt| | d <q�d | d <t
| d <n | d k rAi d
d 6d d
6d d 6d d 6d d 6d d 6d d 6d d 6} | | k r�d | d <t
| d <qA| | | _ | j � }
|
d k r*| | d <qAd | d <t
| d <n | d k rt | t j � sd j | � | d <t
| d <qd | k r�d j | � | d <t
| d <q| j d � } | d
| _ | j � }
|
d k r�| | d <qd | d <t
| d <n | d k r9t j j j � � t j j d � }
Wd QXd! |
_ | r�y! |
j d" d d# � | | d$ <Wq6t k
r�} | j \ } } } } d% j | d � | d <t
| d <q6Xq9t � r,y |
j d" � | | d$ <Wq6t k
r(} | j \ } } } } d% j | d � | d <t
| d <q6Xq9| | d$ <n t � | d& <| S(' uH
Change Windows Update settings. If no parameters are passed, the current
value will be returned.
Supported:
- Windows Vista / Server 2008
- Windows 7 / Server 2008R2
- Windows 8 / Server 2012
- Windows 8.1 / Server 2012R2
.. note:
Microsoft began using the Unified Update Platform (UUP) starting with
Windows 10 / Server 2016. The Windows Update settings have changed and
the ability to 'Save' Windows Update settings has been removed. Windows
Update settings are read-only. See MSDN documentation:
https://msdn.microsoft.com/en-us/library/aa385829(v=vs.85).aspx
Args:
level (int):
Number from 1 to 4 indicating the update level:
1. Never check for updates
2. Check for updates but let me choose whether to download and install them
3. Download updates but let me choose whether to install them
4. Install updates automatically
recommended (bool):
Boolean value that indicates whether to include optional or
recommended updates when a search for updates and installation of
updates is performed.
featured (bool):
Boolean value that indicates whether to display notifications for
featured updates.
elevated (bool):
Boolean value that indicates whether non-administrators can perform
some update-related actions without administrator approval.
msupdate (bool):
Boolean value that indicates whether to turn on Microsoft Update for
other Microsoft products
day (str):
Days of the week on which Automatic Updates installs or uninstalls
updates. Accepted values:
- Everyday
- Monday
- Tuesday
- Wednesday
- Thursday
- Friday
- Saturday
time (str):
Time at which Automatic Updates installs or uninstalls updates. Must
be in the ##:## 24hr format, eg. 3:00 PM would be 15:00. Must be in
1 hour increments.
Returns:
dict: Returns a dictionary containing the results.
CLI Examples:
.. code-block:: bash
salt '*' win_wua.set_wu_settings level=4 recommended=True featured=False
u Successu Microsoft.Update.AutoUpdateNu Levelu+ Settings failed to save. Check permissions.u Commentu Recommendedu Featuredu Elevatedi u Everydayi u Sundayi u Mondayi u Tuesdayi u Wednesdayi u Thursdayi u Fridayi u Saturdayue Day needs to be one of the following: Everyday,Monday, Tuesday, Wednesday, Thursday, Friday, Saturdayu DayuV Time argument needs to be a string; it may need tobe quoted. Passed {0}. Time not set.u :uD Time argument needs to be in 00:00 format. Passed {0}. Time not set.u Timeu Microsoft.Update.ServiceManageru My Appu$ 7971f918-a847-4430-9279-4a52d1efe18du u msupdateu Failed with failure code: {0}u Reboot( R R R t winapit Comt win32comt clientt Dispatcht Settingst Nonet intt NotificationLevelt SaveR t IncludeRecommendedUpdatest FeaturedUpdatesEnabledt NonAdministratorsElevatedt ScheduledInstallationDayR# R R$ t formatt splitt ClientApplicationIDt AddService2t Exceptiont argst _get_msupdate_statust
RemoveServicet get_needs_reboot( t levelt recommendedt featuredt elevatedt msupdatet dayt timeR t obj_aut obj_au_settingst resultt dayst tt obj_smt errort hrt msgt exct arg( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_wua.pyt set_wu_settingsq s� d
c C@ s i } d d d d d d d d g } t j j j � � t j j d � } Wd
QX| j } | j | d <| j | d <t
� | d
<t � | d <| j | d <| j
| d <| j | d <| j | d <| | j | d <| j d k r� d j | j � | d <n d j | j � | d <| S( uZ
Get current Windows Update settings.
Returns:
dict: A dictionary of Windows Update settings:
Featured Updates:
Boolean value that indicates whether to display notifications for
featured updates.
Group Policy Required (Read-only):
Boolean value that indicates whether Group Policy requires the
Automatic Updates service.
Microsoft Update:
Boolean value that indicates whether to turn on Microsoft Update for
other Microsoft Products
Needs Reboot:
Boolean value that indicates whether the machine is in a reboot
pending state.
Non Admins Elevated:
Boolean value that indicates whether non-administrators can perform
some update-related actions without administrator approval.
Notification Level:
Number 1 to 4 indicating the update level:
1. Never check for updates
2. Check for updates but let me choose whether to download and
install them
3. Download updates but let me choose whether to install them
4. Install updates automatically
Read Only (Read-only):
Boolean value that indicates whether the Automatic Update
settings are read-only.
Recommended Updates:
Boolean value that indicates whether to include optional or
recommended updates when a search for updates and installation of
updates is performed.
Scheduled Day:
Days of the week on which Automatic Updates installs or uninstalls
updates.
Scheduled Time:
Time at which Automatic Updates installs or uninstalls updates.
CLI Examples:
.. code-block:: bash
salt '*' win_wua.get_wu_settings
u Every Dayu Sundayu Mondayu Tuesdayu Wednesdayu Thursdayu Fridayu Saturdayu Microsoft.Update.AutoUpdateNu Featured Updatesu Group Policy Requiredu Microsoft Updateu Needs Rebootu Non Admins Elevatedu Notification Levelu Read Onlyu Recommended Updatesu
Scheduled Dayi
u 0{0}:00u Scheduled Timeu {0}:00( R R R* R+ R, R- R. R/ R5 t RequiredR> R@ R6 R2 t ReadOnlyR4 R7 t ScheduledInstallationTimeR8 ( R RF RH RI ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_wua.pyt get_wu_settingsb s6 1
c C@ s\ t j j j � � t j j d � } Wd QX| j } x! | D] } | j d k r; t Sq; Wt
S( uH
Check to see if Microsoft Update is Enabled
Return Boolean
u Microsoft.Update.ServiceManagerNu Microsoft Update( R R R* R+ R, R- R. t ServicesR R R ( RM t col_servicest service( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_wua.pyR> � s
c C@ s t j j j � S( u�
Determines if the system needs to be rebooted.
Returns:
bool: True if the system requires a reboot, otherwise False
CLI Examples:
.. code-block:: bash
salt '*' win_wua.get_needs_reboot
( R R R t needs_reboot( ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_wua.pyR@ � s ($ t __doc__t
__future__R R R t loggingt salt.utils.platformR t salt.utils.win_updatet salt.utils.winapit salt.exceptionsR t salt.extR t win32com.clientR, R R
t ImportErrorR t getLoggert __name__t logt __func_alias__R
R0 R R! R R R R) RS RW R> R@ ( ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/win_wua.pyt <module>9 s^
�\ � 4 4 ' � Z
Mini Shell