New in version 2.0.
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| category_names | no | [u'CriticalUpdates', u'SecurityUpdates', u'UpdateRollups'] |
| A scalar or list of categories to install updates from |
| log_path | no | If set, win_updates will append update progress to the specified file. The directory must already exist. | ||
| state | no | installed |
| Controls whether found updates are returned as a list or actually installed. This module also supports Ansible check mode, which has the same effect as setting state=searched |
# Install all security, critical, and rollup updates
- win_updates:
category_names:
- SecurityUpdates
- CriticalUpdates
- UpdateRollups
# Install only security updates
- win_updates:
category_names: SecurityUpdates
# Search-only, return list of found updates (if any), log to c:\ansible_wu.txt
- win_updates:
category_names: SecurityUpdates
state: searched
log_path: c:\ansible_wu.txt
Common return values are documented here Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| installed_update_count | The number of updates successfully installed | success | int | 2 | ||||||||||||||||||||||||||||||
| reboot_required | True when the target server requires a reboot to complete updates (no further updates can be installed until after a reboot) | success | boolean | True | ||||||||||||||||||||||||||||||
| failed_update_count | The number of updates that failed to install | always | int | 0 | ||||||||||||||||||||||||||||||
| found_update_count | The number of updates found needing to be applied | success | int | 3 | ||||||||||||||||||||||||||||||
| updates | List of updates that were found/installed | success | complex | None | ||||||||||||||||||||||||||||||
| contains: |
| |||||||||||||||||||||||||||||||||
Note
win_updates must be run by a user with membership in the local Administrators groupwin_updates will use the default update service configured for the machine (Windows Update, Microsoft Update, WSUS, etc)win_updates does not manage reboots, but will signal when a reboot is required with the reboot_required return value.win_updates can take a significant amount of time to complete (hours, in some cases). Performance depends on many factors, including OS version, number of updates, system load, and update server load.win_updates runs the module as a scheduled task, this task is set to start and continue to run even if the Windows host swaps to battery power. This behaviour was changed from Ansible 2.4, before this the scheduled task would fail to start on battery power.This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For more information about Red Hat’s this support of this module, please refer to this knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/win_updates_module.html