Description
Registers, deletes, and lists patch information applied to a managed server.
The information collection item displays manually registered patches as applied patches in the management console.
Synopsis
[Windows]
swcfmg_patch_applied.exe { -add -file "Applied patch information file path" [-e "Character encoding"] | |
[Linux]
swcfmg_patch_applied { -add -file "Applied patch information file path" [-e "Character encoding"] | |
Options
Registers applied patch information using the specified applied patch information file.
The applied patch information file is in CSV format. For details on the applied patch information file, refer to "6.4.2 Applied Patch Information File".
Deletes applied patch information using the specified applied patch information file.
The applied patch information file is in CSV format. For details on the applied patch information file, refer to "6.4.2 Applied Patch Information File".
Outputs the applied patch information registered using this command in CSV format. This file is in CSV format. For details on the file, refer to "6.2.3 Collection Information CSV File". If -file "Output file path" is omitted, information will be output to the standard output for the command. If the specified file does not exist, a new file will be created. If the file exists, the existing file will be overwritten. If output to the file fails due to an error, no new file will be created. If an existing file was to be overwritten, it will be kept as is without being overwritten.
Specify the output file path.
If this option is omitted, information will be output to the standard output for the command.
If the specified file does not exist, a new file will be created. If the file exists, the existing file will be overwritten.
If output to the file fails due to an error, no new file will be created. If an existing file was to be overwritten, it will be kept as is without being overwritten.
For details on the output file, refer to "6.4.2 Applied Patch Information File" in File Reference.
Outputs not only the applied patches whose information collection source is manually registered, but all the applied patch information of all information collection sources.
Specify the character encoding for the file.
The character encodings below can be specified (single-byte uppercase characters must be used):
UTF-8
If this option is omitted, the character encoding of the execution environment of this command will be used.
Return values
Return Value | Meaning |
|---|---|
0 | Completed normally. |
10 | A parameter error has occurred. |
20 | There is an error in the specified I/O file path. |
30 | The specified character encoding is incorrect. |
40 | Failed to read the applied patch information file. |
50 | The applied patch information file description is incorrect. |
100 | Systemwalker Software Configuration Manager is not running. |
101 | A command that cannot be executed at the same time as this command is executing. |
102 | You do not have the privileges required to execute this command. |
110 | A write error has occurred. |
200 | Setup has not been performed. |
255 | A system error has occurred. |
Command location
Admin server
[Windows]
<Systemwalker Software Configuration Manager installation directory>\SWCFMGM\bin
[Linux]
/opt/FJSVcfmgm/bin
Privilege required for execution
[Windows]
The command can be executed on the admin server.
[Linux]
The command can be executed on the admin server.
Notes
Commands provided by Systemwalker Software Configuration Manager cannot be executed simultaneously. An exclusive control error will occur if a command is executed while another command is still executing.
Execute this command while Systemwalker Software Configuration Manager is running.
An error will occur if the server with the server ID or the IP address listed in the applied patch information file is not registered in Systemwalker Software Configuration Manager as a managed server.
An error will occur if the software information with the software ID listed in the applied patch information file is not registered in Systemwalker Software Configuration Manager.
When registering an applied patch for installed software for which the installation destinations are configured, specify the software IDs and installation locations separated by semicolons (";") for software-id.
When the information collection source registers the information of an applied patch which was not manually registered during the discovery of software patch information, the corresponding applied patch information is deleted when the information registered using this command cannot be collected.
An error will occur if a combination of a registered server ID or IP address, a software ID, and a patch ID already exists in the applied patch information file.
Behavior is not guaranteed if the character encoding specified for this command does not match the character encoding specified in the applied patch information file. Ensure that the character encoding matches.
Use this command to delete applied patch information if the applied patch information was wrongly set for the managed server or the patch was deleted from the corresponding server.
An error will occur if the server with the server ID or the IP address listed in the applied patch information file is not registered in Systemwalker Software Configuration Manager as a managed server.
An error will occur if the software information with the software ID listed in the applied patch information file is not registered in Systemwalker Software Configuration Manager.
When deleting applied patch information for installed software for which the installation destinations are configured, specify the software IDs and installation locations separated by semicolons (";") for software-id.
When the information collection source deletes the information of an applied patch which was not manually registered during the discovery of software patch information, the corresponding applied patch information is reregistered when the information deleted using this command can be collected.
An error will occur if a combination of a registered server ID or IP address, a software ID, and patch ID is used and the applied patch information is not registered.
Behavior is not guaranteed if the character encoding specified for this command does not match the character encoding specified in the applied patch information file. Ensure that the character encoding matches.
If no applied patch information has been registered, only the header information will be output.
#server,software-id,patch-id
If there is an error in the applied patch information file, registration and deletion of the applied patch information will be canceled. An error message similar to the following will be output to the trace log:
The file description is incorrect. [Line number:n][Cause: Cause]One of the following messages will be output in [Cause]:
Message | Meaning |
|---|---|
Number of elements. | Review the number of elements in the line indicated. |
The specified elements are invalid.(patch-id) | The patch in the line indicated cannot be applied to the software in the line indicated. |
Mandatory elements are not specified. | Enter the mandatory items in the line indicated. |
The same server, software id, and patch id are specified in another line. | A combination of the same server, software ID, and patch ID is already specified in one of the preceding lines. |
The specified server does not exist. | The server corresponding to "server" in the line indicated does not exist. Specify the server ID or IP address of the existing server. |
The specified patch does not exist. | Patch information corresponding to "patch-id" in the line indicated does not exist. Specify an existing patch ID. |
The applied patch has already been registered. | The applied patch information in the line indicated has already been registered. |
The specified applied patch does not exist. | The combination of the server ID or IP address, software ID, and patch ID in the line indicated has not been registered as applied patch information. |
Examples
Registration
[Windows]
swcfmg_patch_applied.exe -add -file C:\work\appliedpatchinfo.csv
[Linux]
swcfmg_patch_applied -add -file /tmp/appliedpatchinfo.csv
Deletion
[Windows]
swcfmg_patch_applied.exe -delete -file C:\work\appliedpatchinfo.csv
[Linux]
swcfmg_patch_applied -file /tmp/appliedpatchinfo.csv
List display
[Windows]
swcfmg_patch_applied.exe -list -file C:\work\appliedpatchinfo.csv
[Linux]
swcfmg_patch_applied -add -list -file /tmp/appliedpatchinfo.csv