5.12.4 Install the Windows updates(SYSTEM)
Function
In a Windows environment, update programs are automatically installed by the Windows Update feature.
The update programs that are subject to installation are those on the execution-target server that meet all of the following conditions:
- Update programs to be automatically installed by Microsoft
- Update programs that have not been installed yet
- Update program for installed software
Note that the following update programs are not subject to installation:
- Update programs whose numbers are included (as an exact match) in the exceptions list
- Update programs requiring user entry (such as service packs)
The exceptions list is a comma-separated list of programs numbers (such as KB9999999) specified by the property Windows.updateProgramExclusionList. Update programs whose numbers are included in this list are excluded from the installation target. You can specify a maximum of 1,024 bytes (including commas) for the list.
Each time Windows Update is executed, a text file (whose contents are described below) is output to a folder on the execution-target server. This folder is specified by the property Windows.updateResultOutputFolder. The format of the file name is YYYYMMDDhhmm.txt. (For example: 201312312345.txt)
- The output text file contains the following items:
(a) Host name
(b) Exceptions list
(c) List of the titles of update programs returned as search results
In the search results, each update program is output on a separate line. For each update program, "adding" (for programs that are subject to installation) or "skipping" (for programs that are not subject to installation) is also specified.
For each update program for which "skipping" is specified, a reason (whether installation was skipped because user entry was needed or because the program was included in the exceptions list) is also specified.
(d) ResultCode for the overall update program installation
The ResultCode values and their meanings are as follows:
0: Installation was not executed, 1: Installation is in progress, 2: Installation ended normally, 3: Part of the processing failed, 4: Installation failed, 5: Installation was canceled
(e) List of the titles of update programs that were installed
The ResultCode value for the update is output for each program.
(f) Whether restart is required
If "Necessary" is output, restart is necessary. If "Unnecessary" is output, restart is unnecessary.
(g) Termination code for the script itself
The termination codes and their meanings are as follows:
0: Normal, 27: Abnormal (error details can be checked in the task log), 41: Abnormal (a plug-in error was detected) or necessary properties were missing (an error was detected in the plug-in script)
(h) Titles of update programs in the search results that were excluded or that were not installed due to an installation error
Use situation
This plug-in can be used to apply Windows update programs when they are issued.
Prerequisites
See Release Notes for the latest support statuses of prerequisite products in the system, prerequisite products on the execution target server, and OSs of prerequisite products on the execution target server.
Prerequisite products for the system:
JP1/Automatic Operation 11-00 or later
Prerequisite products for the execution-target server:
None.
Supported OSs for the prerequisite products for the execution-target server:
- Windows Server 2008 R2 Standard/Enterprise/Datacenter
- Windows Server 2012 Standard/Datacenter or Windows Server 2012 R2 Standard/Datacenter
- Windows Server 2016 Standard/Datacenter
- Windows Server 2019 Standard/Datacenter
Note: Environments where Server Core is installed are excluded.
Conditions for using the execution-target server:
(1) The execution-target server must be running.
(2) The execution-target server must be able to access the website that allows Windows Update to be executed without using a proxy server.
(3) The execution-target server must be able to access the website that allows Windows Update to be executed from Internet Explorer (browser).
(4) The following service must be running:
- Windows Update
Cautions
(1) If an update program that performs automatic restart is installed, Windows automatically restarts the execution-target server.
(2) Do not simultaneously execute multiple instances of this plug-in on the same execution-target server.
Execution privilege
Users who belong to the Administrator group
Version
03.10.00
Plug-in tags
Configure OS,Windows
Plug-in name displayed in the task log
osWindowsUpdate_System
Return code
0: Normal
27: Error (Check with the task log about the error detail) Unidentified error
41: Error (An error has been detected in the component) Property not entered (An error has been detected in the component script)
Property list
The following table lists the properties:
|
Property key |
Property name |
Description |
Default value |
I/O type |
Required |
|---|---|---|---|---|---|
|
plugin.destinationHost |
Host name of the target server |
Specify the host name or IP address of the server on which this plugin will be executed. IPv6 addresses are not supported. |
-- |
Input |
R |
|
Windows.updateResultOutputFolder |
Folder name for file output of the result information |
Specifies the full path of the folder name on the execution server that is output the installation result information after executing Windows Update. |
-- |
Input |
R |
|
Windows.updateProgramExclusionList |
Windows Update exclusion list |
Specifies the program update number that excludes the application of a Windows Update. If specifying multiple numbers, use a comma to separate the numbers. |
-- |
Input |
O |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
R |
|
Windows.rebootNecessity |
Restart requirements |
Stores the value indicating whether the update result requires a restart (Necessary: required, Unnecessary: not required). |
-- |
Output |
R |