Description
Adds, updates, deletes, lists, and acquires parameter settings definitions. Also, uploads or downloads the script package associated with parameter settings definitions.
Use a parameter settings definition input file as the input file for adding, updating, or acquiring. The parameter settings definition input file is in XML format. Refer to "2.1 Definition of Parameters to be Set" for details.
Uses a script package for uploading and downloading. The script package is a zip file. Refer to "2.1.5 Package Files" for details.
Synopsis
[Windows]
swcfmg_param_settingdef.exe { -add -file <Parameter settings definition file path> | -update -id <Parameter settings definition ID> -file <Parameter settings definition file path> | -delete -id <Parameter settings definition ID>,... | -list [-file <Output file path>] [-e <Character encoding>] | -get -id <Parameter settings definition ID> -file <Output file path> | -upload -id <Parameter settings definition ID> -file <Script package file path> | -download -id <Parameter settings definition ID> -dir <Output directory path> } |
[Linux]
swcfmg_param_settingdef { -add -file <Parameter settings definition file path> | -update -id <Parameter settings definition ID> -file <Parameter settings definition file path> | -delete -id <Parameter settings definition ID>,... | -list [-file <Output file path>] [-e <Character encoding>] | -get -id <Parameter settings definition ID> -file <Output file path> | -upload -id <Parameter settings definition ID> -file <Script package file path> | -download -id <Parameter settings definition ID> -dir <Output directory path> } |
Options
Adds the parameter settings definition using the specified parameter settings definition file. The input file is a parameter settings definition XML file.
A parameter settings definition ID is generated for the newly added parameter settings definition. Outputs this ID to standard output.
Format of ID to be generated
The parameter settings definition ID is automatically assigned a number according to the following rule:
SS (prefix) + 8-digit number Example: SS00000001
Output format for standard output
The parameter settings definition ID is output in the following format:
[<Parameter settings definition ID>]
Updates the parameter settings definition that has the specified ID, using the specified parameter settings definition file path. The input file is a parameter settings definition XML file.
Deletes the parameter settings definition from the parameter settings definition ID. Also, deletes the association (if any) between the software and the parameter settings definition. Multiple parameter settings definition IDs can be specified by delimiting them with ',' (comma).
Uses a parameter settings definition list file in CSV format to output a list of registered parameter settings definitions.
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.
Output format for standard output
Outputs the list of parameter settings definitions in the following format:
Item No. | Item | Remarks |
|---|---|---|
1 | Parameter settings definition ID | Outputs the parameter settings definition ID. |
2 | Is the definition predefined in the product? | Outputs whether the parameter settings definition is predefined in the product. |
3 | Parameter settings definition name | Outputs the parameter settings definition name. |
4 | Parameter settings method | Outputs the parameter settings method. |
5 | Script package file name | Outputs the name of the script package file. |
Header format
Insert the header in the first line of the CSV file using the format shown below. The header is output even if there is no information to be output to the file.
#Definition ID,Product predefined,Definition name,Method,Package name |
Outputs the parameter settings definition that has the specified ID to the specified output file path. The output file is a parameter settings definition XML file.
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.
Uploads the script package to the parameter settings definition that has the specified ID. The input file is a script package zip file.
Script packages that can be uploaded are subject to the following conditions. An error will occur if conditions other than these are used.
File extension must be .zip.
Ensure that the file extension is .zip.
File size must be no greater than 2 MB.
The maximum uploadable file size is 2 MB.
Store the startup script in the root.
Store the startup script (startup.cmd or startup.sh) in the root of the zip file rather than under the directory.
Downloads the script package registered in the parameter settings definition that has the specified ID. Outputs script package zip files to the output directory path.
Ensure that no files exist in the output directory, or an error will occur.
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 | The specified I/O path is incorrect. |
30 | The specified character encoding is incorrect. |
40 | Unable to analyze the file. |
50 | The file description is incorrect. |
70 | The specified ID does not exist. |
71 | The specified ID is product-predefined. |
72 | The package has not been registered in the specified ID. |
73 | The package has not been correctly registered in the specified ID. |
80 | Cannot be deleted because there is a predefined parameter associated with the parameter settings definition targeted for deletion. |
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. |
120 | There is not enough free disk space for the media library. |
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/execution environment
[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.
The method cannot be changed if the software and a parameter setting definition are associated or a script package is registered.
Use this command to delete information about parameter settings definitions that no longer need to be managed by Systemwalker Software Configuration Manager.
Before deleting a parameter settings definition, ensure that there are no associated predefined parameters. The parameter settings definition cannot be deleted if such information exists.
If no parameter settings definitions have been registered, only the header information will be output.
#Definition ID,Product predefined,Definition name,Method,Package name |
If a parameter settings definition file is invalid, the registration and update of the parameter settings definitions will be canceled and the following error message will be output:
An error occurred during XML file validation. [Details:<Details >] |
Examples
Add
[Windows]
swcfmg_param_settingdef.exe -add -file C:\work\paramsettingdef.xml |
[Linux]
swcfmg_param_settingdef -add -file /tmp/paramsettingdef.xml |
Update
[Windows]
swcfmg_param_settingdef.exe -update -id SS00000001 -file C:\work\paramsettingdef.xml |
[Linux]
swcfmg_param_settingdef -update -id SS00000001 -file /tmp/paramsettingdef.xml |
Delete
[Windows]
swcfmg_param_settingdef.exe -delete -id SS00000001 |
[Linux]
swcfmg_param_settingdef -delete -id SS00000001 |
List
[Windows]
swcfmg_param_settingdef.exe -list |
[Linux]
swcfmg_param_settingdef -list |
Acquire
[Windows]
swcfmg_param_settingdef.exe -get -id SS00000001 -file C:\work\paramsettingdef.xml |
[Linux]
swcfmg_param_settingdef -get -id SS00000001 -file /tmp/paramsettingdef.xml |
Upload
[Windows]
swcfmg_param_settingdef.exe -upload -id SS00000001 -file C:\work\paramsettingdef.zip |
[Linux]
swcfmg_param_settingdef -upload -id SS00000001 -file /tmp/paramsettingdef.zip |
Download
[Windows]
swcfmg_param_settingdef.exe -download -id SS00000001 -dir C:\work\paramsettingdef |
[Linux]
swcfmg_param_settingdef -download -id SS00000001 -dir /tmp/paramsettingdef |
