Description
Registers, deletes, and lists software information installed on the managed server.
Use this command to register installed software information so that the information collection source will display the manually registered software in the management console as installed software and configure the software parameters.
Synopsis
[Windows]
swcfmg_installedsoftware.exe { -add -file <Installed software information file path> [-e <Character encoding>] | -delete -file <Installed software information file path> [-e <Character encoding>] | -list [{-serverid <Server ID>,... | -ip <IP address>,...} ] [ -file <Output file path>] [-e<Character encoding>] [-all] } |
[Linux]
swcfmg_installedsoftware { -add -file <Installed software information file path> [-e <Character encoding>] | -delete -file <Installed software information file path> [-e <Character encoding>] | -list [{-serverid <Server ID>,... | -ip <IP address>,...} ] [ -file <Output file path>] [-e<Character encoding>] [-all] } |
Options
Registers installed software information using the specified installed software information file
The installed software information file is in CSV format. Refer to "6.3.2 Installed Software Information File" for information on installed software information files.
Deletes installed software information using the specified installed software information file.
The installed software information file is in CSV format. Refer to "6.3.2 Installed Software Information File" for information on installed software information files.
Use this command to output registered installed software information in CSV format.
Specifies the server ID or the IP address of the server that outputs the installed software information.
If this option is omitted, the installed software information on all servers will be output.
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.
The information collection source outputs all the installed software information included in all of the software of the information collection source in addition to the manually registered installed software.
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 value
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 installed software information file. |
50 | The installed software information file description is incorrect. |
70 | The specified server does not exist. |
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]
Administrator privileges are required. Execute this command as an administrator.
This command can be executed on the admin server.
[Linux]
This command can only be executed by the system administrator (superuser).
This 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 installed software information file is not registered in Systemwalker Software Configuration Manager as a managed server.
An error will occur if software information with the software ID listed in the installed software information file is not registered in Systemwalker Software Configuration Manager.
When registering a multi-instance installed software, specify the software IDs and installation locations separated by semicolons (";") for software-id.
When the information collection source registers the information of installed software which was not manually registered during the discovery of software patch information, the corresponding installed software information is deleted when the information registered using this command cannot be collected.
An error will occur if a combination of registered server ID and software ID or IP address and software ID already exists in the installed software information file.
Behavior is not guaranteed if the character encoding specified for this command does not match the character encoding used in the installed software information file. Ensure that the character encoding matches.
Use this command to delete installed software information if the installed software information was erroneously set for the managed server or the software was uninstalled from the server in question.
Use this command to delete the installed software information if a managed server registered in Systemwalker Software Configuration Manager is deleted.
An error will occur if the server with the server ID or the IP address listed in the installed software information file is not registered in Systemwalker Software Configuration Manager as a managed server.
An error will occur if software information with the software ID listed in the installed software information file is not registered in Systemwalker Software Configuration Manager.
When deleting a multi-instance installed software, specify the software IDs and installation locations separated by semicolons (";") for software-id.
When the information collection source deletes the information of installed software which was not manually registered during the discovery of software patch information, the corresponding installed software information is reregistered when the information deleted using this command can be collected.
An error will occur if, in the combination of server ID and software ID or IP address and software ID specified in the installed software information file, the relevant server exists but the software ID has not been set as installed software.
Installed software to which patches have already been applied cannot be deleted.
Behavior is not guaranteed if the character encoding specified for this command does not match the character encoding used in the installed software information file. Ensure that the character encoding matches.
If no installed software information has been registered, only the header information will be output.
#host-name,servergroup-name,server-id,ipaddress,software-id,software-name,version,os-type,vendor |
If there is an error in the installed software information file, registration and deletion of the installed software 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.(software-id) |
|
Mandatory elements are not specified. | Enter the mandatory items in the line indicated. |
The same server and software id are specified in another line. | A combination of the same server and software 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 software does not exist. | Software information corresponding to "software-id" in the line indicated does not exist. Specify the existing software ID. |
The installed software has already been registered. | The software information in the line indicated has already been registered. |
The specified installed software does not exist. | The combination of server ID and software ID or IP address and software ID in the line indicated has not been registered as installed software information. |
The specified installed software cannot be deleted. | As patches have been applied to the installed software in the line indicated, the software cannot be deleted. |
Installation directory is not specified. | The specified software is installed as a multi-instance software. Specify the installation location. |
Examples
Registration
[Windows]
swcfmg_installedsoftware.exe -add -file C:\work\installedsoftwareinfo.csv |
[Linux]
swcfmg_installedsoftware -add -file /tmp/installedsoftwareinfo.csv |
Deletion
[Windows]
swcfmg_installedsoftware.exe -delete -file C:\work\installedsoftwareinfo.csv |
[Linux]
swcfmg_installedsoftware -delete -file /tmp/installedsoftwareinfo.csv |
List display
[Windows]
swcfmg_installedsoftware.exe -list -file C:\work\installedsoftwareinfo.csv |
[Linux]
swcfmg_installedsoftware -list -file /tmp/installedsoftwareinfo.csv |
Execution results/output format
List display
#host-name,servergroup-name,server-id,ipaddress,software-id,software-name,version,os-type,vendor
Server01,Servergroup01,UB5IFK3AT@Direct,10.10.10.11,UDP000001,ABCDE-Software,1.0,Windows,ABCDE Company
Server01,Servergroup01,UB5IFK3AT@Direct,10.10.10.11,UDP000002,FGHIJ-Software,1.0,Windows,ABCDE Company
Server02,Servergroup02,FGGF436GF@Direct,10.10.10.12,UDP000001,ABCDE-Software,1.0,Windows,ABCDE Company
Output of the software information has started. Output of the software information has ended.
Note that the following header information is added to the first line of the CSV file that is output:
#host-name,servergroup-name,server-id,ipaddress,software-id,software-name,version,os-type,vendor
