| Key |
Returned |
Description |
|
failed_update_count
integer
|
always |
The number of updates that failed to install.
|
|
filtered_updates
dictionary
|
success |
Updates that were found but were filtered based on blacklist, whitelist or category_names. The return value is in the same form as updates, along with filtered_reason.
Sample:
see the updates return value
|
| |
filtered_reason
string
|
always |
The reason why this update was filtered.
This value has been deprecated since 1.7.0, use filtered_reasons which contain a list of all the reasons why the update is filtered.
Sample:
skip_hidden
|
| |
filtered_reasons
list
/ elements=string
added in 1.7.0
|
|
A list of reasons why the update has been filtered.
Can be accept_list, reject_list, hidden, category_names, or skip_optional.
Sample:
['category_names', 'accept_list']
|
|
found_update_count
integer
|
success |
The number of updates found needing to be applied.
Sample:
3
|
|
installed_update_count
integer
|
success |
The number of updates successfully installed or downloaded.
Sample:
2
|
|
reboot_required
boolean
|
success |
True when the target server requires a reboot to complete updates (no further updates can be installed until after a reboot).
Sample:
True
|
|
updates
dictionary
|
success |
Updates that were found/installed.
The key for each update is the id of the update.
|
| |
categories
list
/ elements=string
|
always |
A list of category strings for this update.
Sample:
['Critical Updates', 'Windows Server 2012 R2']
|
| |
downloaded
boolean
added in 1.7.0
|
always |
Was the update downloaded.
Sample:
True
|
| |
failure_hresult_code
boolean
|
on install or download failure |
The HRESULT code from a failed update.
Sample:
2147942402
|
| |
failure_msg
string
added in 1.7.0
|
on install or download failure and not running with async |
The error message with more details on the failure.
Sample:
Operation did not complete because there is no logged-on interactive user (WU_E_NO_INTERACTIVE_USER 0x80240020)
|
| |
id
string
|
always |
Internal Windows Update GUID.
Sample:
fb95c1c8-de23-4089-ae29-fd3351d55421
|
| |
installed
boolean
|
always |
Was the update successfully installed.
Sample:
True
|
| |
kb
list
/ elements=string
|
always |
A list of KB article IDs that apply to the update.
Sample:
['3004365']
|
| |
title
string
|
always |
Display name.
Sample:
Security Update for Windows Server 2012 R2 (KB3004365)
|