Class: Ansible::Ruby::Modules::Win_updates
- Inherits:
-
Base
- Object
- Ansible::Ruby::Models::Base
- Base
- Ansible::Ruby::Modules::Win_updates
- Defined in:
- lib/ansible/ruby/modules/generated/windows/win_updates.rb
Overview
Searches, downloads, and installs Windows updates synchronously by automating the Windows Update client.
Instance Method Summary collapse
-
#blacklist ⇒ Array<String>, ...
A list of update titles or KB numbers that can be used to specify which updates are to be excluded from installation.,If an available update does match one of the entries, then it is skipped and not installed.,Each entry can either be the KB article or Update title as a regex according to the PowerShell regex rules.
-
#category_names ⇒ Array<String>, ...
A scalar or list of categories to install updates from.
-
#log_path ⇒ String?
If set, C(win_updates) will append update progress to the specified file.
-
#reboot ⇒ :yes, ...
Ansible will automatically reboot the remote host if it is required and continue to install updates after the reboot.,This can be used instead of using a M(win_reboot) task after this one and ensures all updates for that category is installed in one go.,Async does not work when C(reboot=True).
-
#reboot_timeout ⇒ Integer?
The time in seconds to wait until the host is back online from a reboot.,This is only used if C(reboot=True) and a reboot is required.
-
#state ⇒ :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.
-
#use_scheduled_task ⇒ :yes, ...
Will not auto elevate the remote process with I(become) and use a scheduled task instead.,Set this to C(yes) when using this module with async on Server 2008, 2008 R2, or Windows 7, or on Server 2008 that is not authenticated with basic or credssp.,Can also be set to C(yes) on newer hosts where become does not work due to further privilege restrictions from the OS defaults.
-
#whitelist ⇒ Array<String>, ...
A list of update titles or KB numbers that can be used to specify which updates are to be searched or installed.,If an available update does not match one of the entries, then it is skipped and not installed.,Each entry can either be the KB article or Update title as a regex according to the PowerShell regex rules.,The whitelist is only validated on updates that were found based on I(category_names).
Methods inherited from Base
Methods inherited from Ansible::Ruby::Models::Base
attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates
Constructor Details
This class inherits a constructor from Ansible::Ruby::Models::Base
Instance Method Details
#blacklist ⇒ Array<String>, ...
Returns A list of update titles or KB numbers that can be used to specify which updates are to be excluded from installation.,If an available update does match one of the entries, then it is skipped and not installed.,Each entry can either be the KB article or Update title as a regex according to the PowerShell regex rules.
12 |
# File 'lib/ansible/ruby/modules/generated/windows/win_updates.rb', line 12 attribute :blacklist |
#category_names ⇒ Array<String>, ...
Returns A scalar or list of categories to install updates from.
16 |
# File 'lib/ansible/ruby/modules/generated/windows/win_updates.rb', line 16 attribute :category_names |
#log_path ⇒ String?
Returns If set, C(win_updates) will append update progress to the specified file. The directory must already exist.
32 |
# File 'lib/ansible/ruby/modules/generated/windows/win_updates.rb', line 32 attribute :log_path |
#reboot ⇒ :yes, ...
Returns Ansible will automatically reboot the remote host if it is required and continue to install updates after the reboot.,This can be used instead of using a M(win_reboot) task after this one and ensures all updates for that category is installed in one go.,Async does not work when C(reboot=True).
20 |
# File 'lib/ansible/ruby/modules/generated/windows/win_updates.rb', line 20 attribute :reboot |
#reboot_timeout ⇒ Integer?
Returns The time in seconds to wait until the host is back online from a reboot.,This is only used if C(reboot=True) and a reboot is required.
24 |
# File 'lib/ansible/ruby/modules/generated/windows/win_updates.rb', line 24 attribute :reboot_timeout |
#state ⇒ :installed, ...
Returns 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.
28 |
# File 'lib/ansible/ruby/modules/generated/windows/win_updates.rb', line 28 attribute :state |
#use_scheduled_task ⇒ :yes, ...
Returns Will not auto elevate the remote process with I(become) and use a scheduled task instead.,Set this to C(yes) when using this module with async on Server 2008, 2008 R2, or Windows 7, or on Server 2008 that is not authenticated with basic or credssp.,Can also be set to C(yes) on newer hosts where become does not work due to further privilege restrictions from the OS defaults.
40 |
# File 'lib/ansible/ruby/modules/generated/windows/win_updates.rb', line 40 attribute :use_scheduled_task |
#whitelist ⇒ Array<String>, ...
Returns A list of update titles or KB numbers that can be used to specify which updates are to be searched or installed.,If an available update does not match one of the entries, then it is skipped and not installed.,Each entry can either be the KB article or Update title as a regex according to the PowerShell regex rules.,The whitelist is only validated on updates that were found based on I(category_names). It will not force the module to install an update if it was not in the category specified.
36 |
# File 'lib/ansible/ruby/modules/generated/windows/win_updates.rb', line 36 attribute :whitelist |