Description
Registers, updates, deletes, and lists software information managed by Systemwalker Software Configuration Manager.
Use this command to register software information to ensure that software not collected by discovery (software incompatible with UpdateAdvisor (middleware)) will be displayed as installed software on the management console, or to allow software parameters to be configured.
Synopsis
[Windows]
swcfmg_software.exe { -add -file <Software information file path> [-e <Character encoding>] | -update -file <Software information file path> [-e <Character encoding>] | -delete -id <Software ID>,... | -list [ -file <Output file path>] [-e <Character encoding>] } |
[Linux]
swcfmg_software { -add -file <Software information file path> [-e <Character encoding>] | -update -file <Software information file path> [-e <Character encoding>] | -delete -id <Software ID>,... | -list [-file <Output file path>] [-e <Character encoding>] } |
Options
Registers software information using the specified software information file
The software information file is in CSV format. Refer to "4.2.1 Software Information File" for information on software information files.
Updates software information using the specified software information file
The software information file is in CSV format. Refer to "4.2.1 Software Information File" for information on software information files.
Deletes registered software information. Multiple software IDs can be specified by delimiting them with ',' (comma).
The software ID is automatically set during software information registration. Specifying -list allows the software ID to be checked from the software information output.
Outputs registered software 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 the file cannot be output because of an error, either a new file will not be created or, if an existing file was to be overwritten, the existing file will be kept as it is, without being overwritten.
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 software information file. |
50 | The software information file description is incorrect. |
70 | The specified software ID does not exist. |
80 | The software information targeted for deletion cannot be deleted because the parameter settings information or the installed software information has been registered. |
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. If using Windows Server 2008 or later as your operating system, 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
This command cannot be executed simultaneously with other commands. 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.
Software information is registered in accordance with the software information file.
An error will occur in the input file if the description includes <Software ID>. Do not include <Software ID> when registering software information for the first time.
An error will occur if information that has the same <Product name>, <Version> and <Platform> is judged to be all the same software and is already registered.
Behavior is not guaranteed if the character encoding specified for this command does not match the character encoding used in the software information file. Ensure that the character encoding matches.
When updating registered software information, it is advisable to edit the file that is listed, then treat the edited file as the input file for updating.
An error will occur in the input file if the description does not include <Software ID>. When updating, always include <Software ID>.
Use this command to delete software information that no longer needs to be managed by Systemwalker Software Configuration Manager.
Before deleting software information, ensure that there is no installation information for the software in question, nor any parameter settings information or parameter collection information. The software information cannot be deleted if such information exists.
If no software information has been registered, only the header information will be output.
#Software ID,Software name,Version,OS type,Vendor |
If there is an error in the software information file, registration and update of the software information will be canceled. An error message similar to the following will be output to the standard output:
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 software is specified in another line. | The same software information is already specified in one of the preceding lines. |
The specified elements are invalid. (Software ID) | The (Software ID) in the line indicated is invalid. The (Software ID) cannot be set at registration. |
The specified software does not exist. | Software information corresponding to the (Software ID) in the line indicated does not exist. Specify the existing software ID. |
The software has already been registered. | The software information in the line indicated has already been registered. |
Examples
Registration
[Windows]
swcfmg_software.exe -add -file C:\work\softwareinfo.csv |
[Linux]
swcfmg_software -add -file /tmp/softwareinfo.csv |
Update
[Windows]
swcfmg_software.exe -update -file C:\work\softwareinfo.csv |
[Linux]
swcfmg_software -update -file /tmp/softwareinfo.csv |
Deletion
[Windows]
swcfmg_software.exe -delete -id UDP00001,UDP00002,UDP00003 |
[Linux]
swcfmg_software -delete -id UDP00001,UDP00002,UDP00003 |
List display
[Windows]
swcfmg_software.exe -list -file C:\work\softwareinfo.csv |
[Linux]
swcfmg_software -list -file /tmp/softwareinfo.csv |
Execution results/output format
List display
#Software ID,Software name,Version,OS type,Vendor 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:
#Software ID,Software name,Version,OS type,Vendor
