Current File : //lib/python2.7/site-packages/salt/utils/win_update.pyo
�
���^c @@ s! 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
Z d d l m Z d d l
m Z d d l m Z y" d d l Z d d l Z e Z Wn e k
r� e Z n Xe j e � Z d Z d � Z d e f d
� � YZ d e f d � � YZ d
� Z d S( u/
Classes for working with Windows Update Agent
i ( t absolute_importt print_functiont unicode_literalsN( t six( t range( t CommandExecutionErroru
win_updatec C@ s0 t j j j � s t d f St s, t d f St S( Nu$ win_update: Not available on Windowsu win_update: Missing pywin32( t saltt utilst platformt
is_windowst Falset HAS_PYWIN32t __virtualname__( ( ( s9 /usr/lib/python2.7/site-packages/salt/utils/win_update.pyt __virtual__ s
t Updatesc B@ sa e Z d Z i d d 6d d 6Z i d d 6d d 6d d 6Z d � Z d
� Z d � Z d � Z RS(
uU
Wrapper around the 'Microsoft.Update.UpdateColl' instance
Adds the list and summary functions. For use by the WindowUpdateAgent class.
Usage:
.. code-block:: python
# Create an instance
updates = Updates()
# Bind to the collection object
found = updates.updates
# This exposes Collections properties and methods
# https://msdn.microsoft.com/en-us/library/windows/desktop/aa386107(v=vs.85).aspx
found.Count
found.Add
# To use custom functions, use the original instance
# Return the number of updates inside the collection
updates.count()
# Return a list of updates in the collection and details in a dictionary
updates.list()
# Return a summary of the contents of the updates collection
updates.summary()
u Softwarei u Driveri u Never Requires Rebooti u Always Requires Rebootu Can Require Rebootc C@ s2 t j j j � � t j j d � | _ Wd QXd S( ud
Initialize the updates collection. Can be accessed via
``Updates.updates``
u Microsoft.Update.UpdateCollN( R R t winapit Comt win32comt clientt Dispatcht updates( t self( ( s9 /usr/lib/python2.7/site-packages/salt/utils/win_update.pyt __init__L s c C@ s
| j j S( uN
Return how many records are in the Microsoft Update Collection
Returns:
int: The number of updates in the collection
Code Example:
.. code-block:: python
import salt.utils.win_update
updates = salt.utils.win_update.Updates()
updates.count()
( R t Count( R ( ( s9 /usr/lib/python2.7/site-packages/salt/utils/win_update.pyt countT s c C@ sW | j � d k r d St j d � i } x'| j D] } i | j j d 6t j | j � d 6| j | j
d 6| j d 6t | j
� d 6t | j � d 6t | j � d
6t | j � d 6t | j � d 6t j | j � d
6t | j j � d 6| j | j j d 6g | j D] } d | ^ q d 6g | j D] } | j ^ q,d 6| | j j <q3 W| S( uK
Create a dictionary with the details for the updates in the collection.
Returns:
dict: Details about each update
.. 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>',
...]
}
}
Code Example:
.. code-block:: python
import salt.utils.win_update
updates = salt.utils.win_update.Updates()
updates.list()
i u Nothing to returnu* Building a detailed report of the results.u guidu Titleu Typeu Descriptionu
Downloadedu Installedu Mandatoryu EULAAcceptedu NeedsRebootu Severityu UserInputu RebootBehavioru KBu KBsu
Categories( R t logt debugR t Identityt UpdateIDR t text_typet Titlet update_typest Typet Descriptiont boolt IsDownloadedt IsInstalledt IsMandatoryt EulaAcceptedt RebootRequiredt MsrcSeverityt InstallationBehaviort CanRequestUserInputt reboot_behaviort RebootBehaviort KBArticleIDst
Categoriest Name( R t resultst updatet item( ( s9 /usr/lib/python2.7/site-packages/salt/utils/win_update.pyt liste s, %
!1c C@ s� | j � d k r d Si d d 6d d 6d d 6d d 6i d 6i d 6} xq| j D]f} | d c d 7<t j j j | j � r� t j j j | j � r� | d c d 7<n t j j j | j � r� t j j j | j � r� | d c d 7<n t j j j | j � r| d c d 7<n xO | j D]D } | j | d k rW| d | j c d 7<q$d | d | j <q$W| j
rP | j
| d k r�| d | j
c d 7<q�d | d | j
<qP qP W| S(
uq
Create a dictionary with a summary of the updates in the collection.
Returns:
dict: Summary of the contents of the collection
.. code-block:: cfg
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>,
... }
}
Code Example:
.. code-block:: python
import salt.utils.win_update
updates = salt.utils.win_update.Updates()
updates.summary()
i u Nothing to returnu Totalu Availableu
Downloadedu Installedu
Categoriesu Severityi ( R R R R t datat is_trueR# R$ R. R/ R( ( R R0 R1 t category( ( s9 /usr/lib/python2.7/site-packages/salt/utils/win_update.pyt summary� s6
( t __name__t
__module__t __doc__R R+ R R R3 R7 ( ( ( s9 /usr/lib/python2.7/site-packages/salt/utils/win_update.pyR ' s
Dt WindowsUpdateAgentc B@ s, e Z d Z i d d 6d d 6d d 6d d 6d d
6d d 6d
d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d d 6d! d" 6d# d$ 6d% d& 6d' d( 6d) d* 6d+ d, 6d- d. 6d/ d0 6d1 d2 6Z d3 � Z d4 � Z d5 � Z e e e e e e d< d< d6 � Z
d7 � Z d8 � Z d9 � Z
d: � Z d; � Z RS(= u:
Class for working with the Windows update agent
u' WinHTTP Send/Receive failed: 0x8024402Ci,@$�u Download failed: 0x80240034i4 $�u# Invalid search criteria: 0x80240032i2 $�u Cancelled by policy: 0x8024002Fi/ $�u Missing source: 0x8024002Di- $�u Missing source: 0x8024002Ci, $�u! Uninstall not allowed: 0x80240028i( $�u Prevented by policy: 0x80240025i% $�u No Updates: 0x80240024i$ $�u" Service being shutdown: 0x8024001Ei $�u# Self Update in Progress: 0x8024001Bi $�u& Exclusive Install Conflict: 0x80240019i $�u Install not allowed: 0x80240016i $�u Duplicate item: 0x80240013i $�u Operation cancelled: 0x8024000Bi $�u! Operation in progress: 0x80240009i $�u Access Denied: 0x8024044iD $�u$ Unsupported search scope: 0x80240045iE $�u Access is denied: 0x80070005i �u Setup in progress: 0x8024004AI�������u! Install still pending: 0x00242015I $ ����u Already downloaded: 0x00240008I $ ����u Already uninstalled: 0x00240007I $ ����u Already installed: 0x00240006I $ ����u Reboot required: 0x00240005I $ ����c C@ sQ t j j j � �/ t j j d � | _ t j j d � | _ Wd QX| j � d S( u"
Initialize the session and load all updates into the ``_updates``
collection. This collection is used by the other class functions instead
of querying Windows update (expensive).
Need to look at the possibility of loading this into ``__context__``
u Microsoft.Update.Sessionu Microsoft.Update.UpdateCollN(
R R R R R R R t _sessiont _updatest refresh( R ( ( s9 /usr/lib/python2.7/site-packages/salt/utils/win_update.pyR s c C@ s7 t � } | j } x | j D] } | j | � q W| S( u*
Get the contents of ``_updates`` (all updates) and puts them in an
Updates class to expose the list and summary functions.
Returns:
Updates: An instance of the Updates class with all updates for the
system.
.. code-block:: python
import salt.utils.win_update
wua = salt.utils.win_update.WindowsUpdateAgent()
updates = wua.updates()
# To get a list
updates.list()
# To get a summary
updates.summary()
( R R R= t Add( R R t foundR1 ( ( s9 /usr/lib/python2.7/site-packages/salt/utils/win_update.pyR * s
c
C@ s� d } | j j � } d | j _ yB | j | � } | j j d k rb t j d | � d j | � SWn� t j
k
r� } | j \ } } } } y | j | d } Wn t
k
r� d j | � } n Xt j d | | � t | � � n X| j | _ d S(
u�
Refresh the contents of the ``_updates`` collection. This gets all
updates in the Windows Update system and loads them into the collection.
This is the part that is slow.
Code Example:
.. code-block:: python
import salt.utils.win_update
wua = salt.utils.win_update.WindowsUpdateAgent()
wua.refresh()
u Type='Software' or Type='Driver'u Salt: Load Updatesi u No Updates found for:
%su No Updates found: {0}i u Unknown Failure: {0}u Search Failed: %s
%sN( R< t CreateUpdateSearchert ClientApplicationIDt SearchR R R R t formatt
pywintypest com_errort argst
fail_codest KeyErrort errorR R= (
R t
search_stringt searcherR0 RJ t hrt msgt exct argt failure_code( ( s9 /usr/lib/python2.7/site-packages/salt/utils/win_update.pyR> G s"
c
C@ ss t � } | j }
xZ| j D]O} t j j j | j � rF | rF q n t j j j | j � rj | rj q n t j j j | j � r� | r� q n t j j j | j
j � r� | r� q n | r� | j d k r� q n | r� | j d k r� q n | d k r:t } x) | j D] }
|
j | k r t } q q W| s:q q:n | d k r^| j | k r^q q^n |
j | � q W| S( uQ
Gets a list of all updates available on the system that match the passed
criteria.
Args:
skip_hidden (bool): Skip hidden updates. Default is True
skip_installed (bool): Skip installed updates. Default is True
skip_mandatory (bool): Skip mandatory updates. Default is False
skip_reboot (bool): Skip updates that can or do require reboot.
Default is False
software (bool): Include software updates. Default is True
drivers (bool): Include driver updates. Default is True
categories (list): Include updates that have these categories.
Default is none (all categories).
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): Include updates that have these severities.
Default is none (all severities).
Severities include the following:
* Critical
* Important
.. note:: All updates are either software or driver updates. If both
``software`` and ``drivers`` is False, nothing will be returned.
Returns:
Updates: An instance of Updates with the results of the search.
Code Example:
.. code-block:: python
import salt.utils.win_update
wua = salt.utils.win_update.WindowsUpdateAgent()
# Gets all updates and shows a summary
updates = wua.available
updates.summary()
# Get a list of Critical updates
updates = wua.available(categories=['Critical Updates'])
updates.list()
i i N( R R R= R R R4 R5 t IsHiddenR$ R% R) R, R t NoneR
R. R/ t TrueR( R? ( R t skip_hiddent skip_installedt skip_mandatoryt skip_reboott softwaret driverst
categoriest
severitiesR R@ R1 t matchR6 ( ( s9 /usr/lib/python2.7/site-packages/salt/utils/win_update.pyt availablep s8 N
c C@ s5 t � } | j } t | t j � r0 | g } n t | t j � rW t j | � g } n x� | j D]� } x� | D]� } | | j j k r� | j
| � qn n | g | j D] } d | ^ q� k r� | j
| � qn n | g | j D] } | ^ q� k r| j
| � qn n | | j k rn | j
| � qn qn qn Wqa W| S( u+
Search for either a single update or a specific list of updates. GUIDs
are searched first, then KB numbers, and finally Titles.
Args:
search_string (str, list): The search string to use to find the
update. This can be the GUID or KB of the update (preferred). It can
also be the full Title of the update or any part of the Title. A
partial Title search is less specific and can return multiple
results.
Returns:
Updates: An instance of Updates with the results of the search
Code Example:
.. code-block:: python
import salt.utils.win_update
wua = salt.utils.win_update.WindowsUpdateAgent()
# search for a single update and show its details
updates = wua.search('KB3194343')
updates.list()
# search for a list of updates and show their details
updates = wua.search(['KB3195432', '12345678-abcd-1234-abcd-1234567890ab'])
updates.list()
u KB(
R R t
isinstanceR t string_typest
integer_typesR R= R R R? R- R ( R RK R R@ R1 t findR2 ( ( s9 /usr/lib/python2.7/site-packages/salt/utils/win_update.pyt search� s*
&
"
c C@ s$ | j � d k r* i t d 6d d 6} | S| j j � } d | j _ t j j j � � t j
j d � } Wd QXi i d 6} x� | j D]� } | j
j } i | d | <| j | d | d <t | j � | d | d <t j j j | j � st j d
| j � | j � n t j j j | j � s� t j d | � t j d | j � | j | � q� q� W| j d k r�i t d 6d d 6} | S| | _ y t j d
� | j � } Wn t j k
r,} | j \ } }
} } y | j | d }
Wn t! k
r d j" | � }
n Xt j# d |
� t$ |
� � n Xi d d 6d d 6d d 6d d 6d d 6d d 6} t j d � t j | | j% � | | j% | d <| j% d k r�t j d � t | d <n t j d � t | d <xN t& | j � D]= } | j' | � j
j } | | j( | � j% | d | d <q�W| S( u�
Download the updates passed in the updates collection. Load the updates
collection using ``search`` or ``available``
Args:
updates (Updates): An instance of the Updates class containing a
the updates to be downloaded.
Returns:
dict: A dictionary containing the results of the download
Code Example:
.. code-block:: python
import salt.utils.win_update
wua = salt.utils.win_update.WindowsUpdateAgent()
# Download KB3195454
updates = wua.search('KB3195454')
results = wua.download(updates)
i u Successu Nothing to downloadu Updatesu Salt: Download Updateu Microsoft.Update.UpdateCollNu Titleu AlreadyDownloadedu Accepting EULA: %su To Be Downloaded: %su
Title: %su Downloading Updatesi u Unknown Failure: {0}u Download Failed: %su Download Not Startedu Download In Progressi u Download Succeededi u Download Succeeded With Errorsi u Download Failedi u Download Abortedu Download Completeu Messageu Downloaded Successfullyu Result( i i () R R
R< t CreateUpdateDownloaderRB R R R R R R R R R R R R" R# R4 R5 R& R R t
AcceptEulaR? R RT R t DownloadRE RF RG RH RI RD RJ R t
ResultCodeR t Itemt GetUpdateResult( R R t rett
downloadert
download_listR1 t uidt resultRJ RM RN RO RP RQ t result_codet i( ( s9 /usr/lib/python2.7/site-packages/salt/utils/win_update.pyt download( sn
&c C@ s? | j � d k r* i t d 6d d 6} | S| j j � } d | j _ t j j j � � t j
j d � } Wd QXi i d 6} x� | j D]� } | j
j } i | d | <| j | d | d <t | j � | d | d <t j j j | j � s� t j d
| � t j d | j � | j | � q� q� W| j d k rMi t d 6d d 6} | S| | _ y t j d � | j � } Wn t j k
r�} | j \ } }
} } y | j | d
}
Wn t k
r�d j | � }
n Xt j! d |
� t" |
� � n Xi d d 6d d 6d d 6d d 6d d 6d d
6} t j d � t j | | j# � | | j# | d <| j# d$ k r�t | d <| j$ | d <t j d | j$ � n t j d � t | d <i d d 6d d 6d! d 6} xs t% | j � D]b } | j& | � j
j } | | j' | � j# | d | d" <| | j& | � j( j) | d | d# <q�W| S(% u
Install the updates passed in the updates collection. Load the updates
collection using the ``search`` or ``available`` functions. If the
updates need to be downloaded, use the ``download`` function.
Args:
updates (Updates): An instance of the Updates class containing a
the updates to be installed.
Returns:
dict: A dictionary containing the results of the installation
Code Example:
.. code-block:: python
import salt.utils.win_update
wua = salt.utils.win_update.WindowsUpdateAgent()
# install KB3195454
updates = wua.search('KB3195454')
results = wua.download(updates)
results = wua.install(updates)
i u Successu Nothing to installu Updatesu Salt: Install Updateu Microsoft.Update.UpdateCollNu Titleu AlreadyInstalledu To Be Installed: %su
Title: %su Installing Updatesi u Unknown Failure: {0}u Install Failed: %su Installation Not Startedu Installation In Progressi u Installation Succeededi u" Installation Succeeded With Errorsi u Installation Failedi u Installation Abortedu Install Completeu Messageu NeedsRebootu NeedsReboot: %su Install Failedu Never Rebootu
Always Rebootu Poss Rebootu Resultu RebootBehavior( i i (* R R
R< t CreateUpdateInstallerRB R R R R R R R R R R R R" R$ R4 R5 R R R? R RT R t InstallRE RF RG RH RI RD RJ R Rg R' R Rh Ri R) R, ( R R Rj t installert install_listR1 Rm Rn RJ RM RN RO RP RQ Ro t rebootRp ( ( s9 /usr/lib/python2.7/site-packages/salt/utils/win_update.pyt install� sr
")c
C@ s� | j � d k r* i t d 6d d 6} | S| j j � } d | j _ t j j j � � t j
j d � } Wd QXi i d 6} x� | j D]� } | j
j } i | d | <| j | d | d <t | j � | d | d <t j j j | j � r� t j d
| � t j d | j � | j | � q� q� W| j d k rNi t d 6d d 6} | S| | _ y t j d � | j � } Wn�t j k
r6} | j \ } }
} } y | j | d
}
Wn t k
r�d j | � }
n X| d
d k rt j d � y� x� | D]� } x� | j D]� } d d d g } | j! | � d j" � } xr | D]j } d | | j# � k rB| j$ d � d } | | d <d d d d j | � d d g } | j! | � qBqBWq
Wq�WWn^ t% k
r} t j d � t j d d j& | � � t j d | � t% d j | � � � n Xt j d! � t' | d <d" | d# <t( � | d$ <t j d% | d$ � | j) � i d& d 6d' d 6d( d) 6} x� | j* D]� } | j
j } xo | D]g } | j
j | k r�| j s�d* | d | d+ <n d, | d | d+ <| | j+ j, | d | d- <q�q�Wq�W| St j- d. |
� t% |
� � n Xi d/ d 6d0 d 6d* d) 6d1 d2 6d, d3 6d4 d
6} t j d5 � t j | | j. � | | j. | d# <| j. d7 k r�t' | d <| j/ | d$ <t j d% | j/ � n t j d6 � t | d <i d& d 6d' d 6d( d) 6} xs t0 | j � D]b } | j1 | � j
j } | | j2 | � j. | d | d+ <| | j1 | � j+ j, | d | d- <qW| S(8 u)
Uninstall the updates passed in the updates collection. Load the updates
collection using the ``search`` or ``available`` functions.
.. note:: Starting with Windows 10 the Windows Update Agent is unable to
uninstall updates. An ``Uninstall Not Allowed`` error is returned. If
this error is encountered this function will instead attempt to use
``dism.exe`` to perform the uninstallation. ``dism.exe`` may fail to
to find the KB number for the package. In that case, removal will fail.
Args:
updates (Updates): An instance of the Updates class containing a
the updates to be uninstalled.
Returns:
dict: A dictionary containing the results of the uninstallation
Code Example:
.. code-block:: python
import salt.utils.win_update
wua = salt.utils.win_update.WindowsUpdateAgent()
# uninstall KB3195454
updates = wua.search('KB3195454')
results = wua.uninstall(updates)
i u Successu Nothing to uninstallu Updatesu Salt: Install Updateu Microsoft.Update.UpdateCollNu Titleu AlreadyUninstalledu To Be Uninstalled: %su
Title: %su Uninstalling Updatesi u Unknown Failure: {0}i( $�u/ Uninstall Failed with WUA, attempting with DISMu dismu /Onlineu
/Get-Packagesu kbu : i u DismPackageu /Remove-Packageu /PackageName:{0}u /Quietu
/NoRestartu Uninstall using DISM failedu Command: %su u Error: %su Uninstall using DISM failed: {0}u Uninstall Completed using DISMu Uninstalled using DISMu Messageu NeedsRebootu NeedsReboot: %su Never Rebootu
Always Rebootu Poss Rebooti u Uninstallation Succeededu Resultu Uninstallation Failedu RebootBehavioru Uninstall Failed: %su Uninstallation Not Startedu Uninstallation In Progressu$ Uninstallation Succeeded With Errorsi i u Uninstallation Abortedu Uninstall Completeu Uninstall Failed( i i (3 R R
R< Rr RB R R R R R R R R R R R R" R$ R4 R5 R R R? R R t UninstallRE RF RG RH RI RD R- t _runt
splitlinest lowert splitR t joinRT t needs_rebootR> R= R) R, RJ Rg R' R Rh Ri ( R R Rj Rt t uninstall_listR1 Rm Rn RJ RM RN RO RP RQ R2 t kbt cmdt pkg_listt pkgRv Ro Rp ( ( s9 /usr/lib/python2.7/site-packages/salt/utils/win_update.pyt uninstall s� $
'
"&c C@ s� t | t j � r* t j j j | � } n yB t j | � t j
| d t d t j d t j �} | j
� SWnN t t f k
r� } t j d d j | � � t j d | � t | � � n Xd S( u�
Internal function for running commands. Used by the uninstall function.
Args:
cmd (str, list): The command to run
Returns:
str: The stdout of the command
t shellt stdoutt stderru Command Failed: %su u Error: %sN( R_ R R` R R RG t shlex_splitR R t
subprocesst PopenRT t PIPEt communicatet OSErrort IOErrorR} R ( R R� t pRO ( ( s9 /usr/lib/python2.7/site-packages/salt/utils/win_update.pyRy � s
N( R8 R9 R: RH R R R> RT R
RS R^ Rc Rq Rw R� Ry ( ( ( s9 /usr/lib/python2.7/site-packages/salt/utils/win_update.pyR; � sT
* n B p o �c C@ sA t j j j � � t j j d � } Wd QXt j j j | j � S( u
Determines if the system needs to be rebooted.
Returns:
bool: True if the system requires a reboot, False if not
CLI Examples:
.. code-block:: bash
import salt.utils.win_update
salt.utils.win_update.needs_reboot()
u Microsoft.Update.SystemInfoN(
R R R R R R R R4 R5 R' ( t obj_sys( ( s9 /usr/lib/python2.7/site-packages/salt/utils/win_update.pyR~ � s (! R: t
__future__R R R t loggingR� t salt.utils.argsR t salt.utils.datat salt.utils.winapit salt.extR t salt.ext.six.movesR t salt.exceptionsR t win32com.clientR RE RT R t ImportErrorR
t getLoggerR8 R R R
t objectR R; R~ ( ( ( s9 /usr/lib/python2.7/site-packages/salt/utils/win_update.pyt <module> s.
�� � �
Mini Shell