Description
Registers, updates, deletes, and lists patch information managed by Systemwalker Software Configuration Manager.
Synopsis
[Windows]
swcfmg_patch_def.exe { -add [-sourceid "Information collection source ID"] -file "Patch information file path" [-e "Character encoding"] | |
[Linux]
swcfmg_patch_def { -add [-sourceid "Information collection source ID"] -file "Patch information file path" [-e "Character encoding"] | |
Options
Registers patch information using the specified patch information file. The patch information is registered as a patch of the information collection source specified using the information collection source ID. When the information collection source ID is omitted, it is registered as a manually registered patch.
The patch information file is in CSV format. For details on the patch information file, refer to "6.4.1 Patch Information File".
Updates patch information using the specified patch information file. Updates the patches of the information collection source specified using the information collection source ID. When the information collection source ID is omitted, a manually registered patch is updated.
The patch information file is in CSV format. For details on the patch information file, refer to "6.4.1 Patch Information File".
Specify a patch ID to delete registered patch information. Multiple patch IDs can be specified by delimiting them with "," (commas).
The patch IDs are configured during registration of this command or discovery of the software information. Specifying -list enables patch information to be checked from the output patch information.
Outputs registered patch information in CSV format.
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.
For details on the output file, refer to "6.4.1 Patch Information File".
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 patch information file. |
50 | The patch information file description is incorrect. |
70 | The specified information collection source ID or patch ID does not exist. |
80 | As the applied patch information is registered in the patch information to be deleted, it cannot be deleted. |
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.
Using this command, the information collection source cannot register, update, or delete the patches of UpdateAdvisor.
Only the value of the definition item can be registered and updated.
Patch information is registered in accordance with the patch information file.
The value of the identification item cannot be omitted. When all identification items are the same, patches are recognized as being the same. Therefore, when the same patch is already registered, an error occurs.
Note the following when specifying a value for the collection item of a patch.
The collection item of the target software cannot be omitted.
Specify the software ID of the software to be patched in the collection item of the target software. When there are multiple software to be patched, specify the software separated by semicolons (";").
Behavior is not guaranteed if the character encoding specified for this command does not match the character encoding specified in the patch information file. Ensure that the character encoding matches.
When updating registered patch information, it is advisable to edit the file that is listed, then treat the edited file as the input file for updating.
The value of the identification item cannot be omitted. In addition, the value of the identification item cannot be updated.
An error will occur in the input file if the description does not include "Patch ID". When updating, always include "Patch ID".
Note the following when specifying a value for the collection item of a patch.
The collection item of the target software cannot be omitted.
Specify the software ID of the software to be patched in the collection item of the target software. When there are multiple software to be patched, specify the software separated by semicolons (";").
Do not delete the software to which the corresponding patches have already been applied from the collection items of the target software.
Use this command to delete patch information that no longer needs to be managed by Systemwalker Software Configuration Manager.
Before deleting patch information, confirm the following:
The corresponding patch is not registered as an applied patch
If no patch information has been registered, only the header information will be output.
#patch-id,patch-info,...
If there is an error in the patch information file, registration and update of the patch information will be canceled. An error message similar to the following will be output to the standard output:
CFMGC20005 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. |
Mandatory elements are not specified. | Enter the mandatory items in the line indicated. |
The same patch is specified in another line. | The same patch information is already specified in one of the preceding lines. |
The specified elements are invalid. | An invalid value is entered in the element in "()" in the line indicated. Enter a valid value. For details on available values, refer to "6.4.1 Patch Information File". Omit the values of collection items which are not definition items. |
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 patch has already been registered. | The patch information in the line indicated has already been registered. |
Examples
Registration
[Windows]
swcfmg_patch_def.exe -add -file C:\work\patchinfo.csv
[Linux]
swcfmg_patch_def -add -file /tmp/patchinfo.csv
Update
[Windows]
swcfmg_patch_def.exe -update -file C:\work\patchinfo.csv
[Linux]
swcfmg_patch_def -update -file /tmp/patchinfo.csv
Deletion
[Windows]
swcfmg_patch_def.exe -delete -id 34GR4GJLJ@Direct,34GR4GJLJ@Direct,34GR4GJLJ@Direc
[Linux]
swcfmg_patch_def -delete -id 34GR4GJLJ@Direct,34GR4GJLJ@Direct,34GR4GJLJ@Direct
List display
[Windows]
swcfmg_patch_def.exe -list -file C:\work\patchinfo.csv
[Linux]
swcfmg_patch_def -list -file C:\work\patchinfo.csv