Systemwalker Software Configuration Manager Reference Guide

1.4.12 swcfmg_configuration_change (Configuration Modification Command)

Description

Performs configuration modification of the managed server based on the configuration modification template.

Synopsis

[Windows]

swcfmg_configuration_change.exe

-userid <User ID> -templateid <Template ID> [-jobname <Job name>] [ -file <Parameter file path> [-e <Character encoding>] [-wait] | -batch <Batch parameter file path> [-e <Character encoding>] | -parameter <Parameter name>=<Parameter value>,...[-wait]]

[Linux]

swcfmg_configuration_change

-userid <User ID> -templateid <Template ID> [-jobname <Job name>] [ -file <Parameter file path> [-e <Character encoding>] [-wait] | -batch <Batch parameter file path> [-e <Character encoding>] | -parameter <Parameter name>=<Parameter value>,...[-wait]]

Options

-userid <User ID>

Performs configuration modification. Specify the user to be the administrator of the executed job for the user ID. The user must be a tenant administrator, tenant user, or a dual-role administrator that holds privileges to execute configuration modification of the specified server.

-templateid <Configuration modification template ID>

Specify a template ID of the configuration modification template to use.

-jobname <Job name>

Specify the job name of the job to be executed. Specify the job name using up to 85 characters (<, >, &, ", ', and | cannot be used). When omitted, the template name is specified for the job name. When the -batch option is specified, specification of this option is ignored.

-file <Parameter file path>

Specify the parameter using the CSV file. Describe one parameter per line in the CSV file. There are two columns in the CSV format. Specify the parameter name in the name of column 1, and the parameter value in the name of column 2. No values can be omitted. It is necessary to describe all parameters defined in the template. An example of the specifications of the CSV file is as follows:

Example:

param1,value1

param2,value2

--e <Character encoding>

Specify the character encoding for the file.

The following character encoding can be specified. Use uppercase letters.

• UTF-8

If this option is omitted, the character encoding for the environment in which this command is to be executed will be used in the input file.

-batch "Batch parameter file path"

Performs multiple configuration modifications as a batch. Specify the parameters using the CSV file.
The first line of the CSV file is the header line. The second and subsequent lines of the CSV files are body lines.
Each body line holds one configuration modification.

In the first column of each body line, specify the job name of the reconfiguration. Job names can be omitted. When a job name is omitted, the template name is used as the job name. The content of the first column of the header line is ignored.

Each column other than the first column represents a parameter. In the header line, specify the parameter names in the configuration modification template. In the body lines, specify the parameter values corresponding to the parameter names in the header line.

Example:

jobName,param1,param2

job1,value11,value12

job2,value21,value22

The job name of the first configuration modification is "job1".
The value of parameter param1 is "value11". The value of parameter param2 is "value12".
The job name of the second configuration modification is "job2".
The value of parameter param1 is "value21". The value of parameter param2 is "value22".

-parameter "Parameter name"="Parameter value",...

Specify the parameter using the argument of the command. Specify the parameter name and the parameter value separated by an equals sign, '='. Multiple parameter IDs can be specified by delimiting them with ',' (commas). It is necessary to specify all parameters defined in the template. When symbols or special characters are included in parameter values, specify the parameters referring to the "Notes" below. When symbols or special characters are included in a parameter value, it is recommended to specify the parameter using the "-file" option.
An example of specification of the "-parameter" option is as follows:

Example:

-parameter param1=value1,param2=value2

-wait

When the job turns to the following status, the command returns. When this option is omitted, after the job starts, the command returns immediately.

• completed: Completed

• selecting_abnormal: Selecting (abnormal)

• completed_abnormal: Completed (abnormal)

• canceled: Canceled

After this command is completed, configuration modification is executed as a job. The job ID of the job to be executed is output to the standard output.

• Output format for standard output:

  [Job ID]

Specification method of parameter values

The methods to specify the parameter values differ depending on the parameter types.

Parameter Type	Specified As	Example
Server	Specify the server ID or IP address of the business server used for the value.	192.168.1.1
Character string	Specify a string different from the value. Specify "#{work.directory}" for the work directory.	C:\work
File	An asset or a file on the admin server can be specified for the value. Asset Specify the asset ID and the asset version in the following format: When the asset version is omitted, the latest version is selected. media://[Asset ID]/[Asset version] File on the admin server Specify a file on the admin server using an absolute path. The largest specifiable file size is 2 MB or smaller. When specifying a larger size file, select it from the assets.	media://000000002/1 media://000000003 C:\work\install.bat
Numeric value	Specify a numeric value for the value.	100
Truth-value	Specify the truth-value for the value.	true
Password	Specify a string different from the value.	password

Return value

Return value	Meaning
0	The command has terminated normally. [When specifying the "-wait" option] The status of the job turned to Complete.
10	A parameter error has occurred.
20	The specified I/O path is incorrect.
30	The specified character encoding is incorrect.
50	The file description is incorrect. The parameter value or the setting information value is incorrect.
70	The specified user or template is incorrect.
81	The privileges required to use the specified template are not possessed.
90	[When specifying the "-wait" option] The status of the job turned to Selecting (abnormal).
91	[When specifying the "-wait" option] The status of the job turned to Completed (abnormal).
92	[When specifying the "-wait" option] The status of the job turned to Canceled.
100	Systemwalker Software Configuration Manager is not running.
103	Connection to the directory service failed.
200	Setup has not been performed.
255	A system error has occurred.

Command location

[Windows]

[Systemwalker Software Configuration Manager installation directory]\SWCFMGM\bin

[Linux]

/opt/FJSVcfmgm/bin

Privilege required

[Windows]

• Administrator privileges are required. Execute as an administrator.

• This command can be executed on the admin server.

• This command can be executed at the same time as other commands.

[Linux]

• This command can only be executed by the system administrator (superuser).

• This command can be executed on the admin server.

• This command can be executed at the same time as other commands.

Notes

• Execute this command while Systemwalker Software Configuration Manager is running.

• Configuration information of the admin server cannot be changed.

• When specifying the parameter using the "-parameter" option, and symbols are included in the parameter value, note the following points depending on the OS specifications. It is recommended to specify the parameter using the "-file" option.

  [Windows]

  • It is not possible to specify blank spaces or the following symbols for the parameter value.
    Specify the parameter value using the "-file" option.

    ,, =, "

  • When the following characters are included in the parameter value, unexpected behavior may be caused. Escape using '^'.

    & | < > ( )

  • To use '%' for a parameter value, and not deploy environment variables, escape '%' using '^'.

  [Linux]

  • When the following characters are included in the parameter value, unexpected behavior may be caused. It is recommended to specify the entire value of the "-parameter" option using double quotes '"'.

    " $ @ & ' ( ) ^ | [ ] { } ; * ? < > ` \

  • When including blank spaces in the parameter value, enclose the entire value of the "-parameter" option with double quotes '"'.

  • When the entire value of the "-parameter" option is enclosed with double quotes '"', and when the following symbols are included in the parameter value, unexpected behavior may be caused. Escape it using a backslash '\'.

    " $ ` \

  • When the following characters are included in the parameter value, enclose the value with '\"'

    ,, =, "

  • Specify '\"\"' for the parameter value '"'.

  Example: An example of specification of the "-parameter" option is as follows:

  [Windows]

  Parameter Name	Parameter Value
  param1	value
  param2	(x86)

  -parameter param1=value,param2=^(x86^)

  [Linux]

  Parameter Name	Parameter Value
  param1	"value"
  param2	C:\Program Files (x86)

  -parameter "param1=\"\"\"value\"\"\",param2=\"C:\\Program Files (x86)\""

• When there are errors in the input file, a 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 parameters are not specified. ()	Parameters enclosed with "()" are not specified.
  Mandatory elements are not specified.	Enter the mandatory elements in the given line.
  The parameter does not exist.	The parameter of the relevant line is not defined in the template.
  The same parameter is specified in another line.	The same parameter is already defined in one of the preceding lines.
  The parameter value is not valid as a type.	The parameter value of the relevant line is not the value stipulated based on the parameter type. Check if the parameter value is stipulated based on the parameter type referring to "Definition of Parameters" in the "Operator's Guide". Server Check that the specified server is managed by Systemwalker Software Configuration Manager. File Asset Check that the specified asset or version exists. Check that the files have been uploaded to the asset. File on the admin server Check that the name of the specified file is a string up to 255 printable ASCII characters. Check that the specified file exists in the specified file path, and the file size is 2 MB or smaller. Numeric value Check that the specified numeric values are in the range between "-2,147,483,648" and "2,147,483,647". Truth-value Check that the specified truth-value is "true" or "false".

• When there are errors in the specified setting information or a parameter, a message similar to the following will be output to the standard output: The setting information, value, and cause of the incorrect process are output. Review the values described for the parameter or the configuration modification template. Refer to "Definition of Setting Information" in the Operator's Guide to review the value.

  CFMGC30605 The specified settings information is incorrect. [Process name: Process name][Setting information: Setting information][Value: Value][Cause: Cause]

  One of the following information will be output in Settings Information:

  Setting Information	Cause	Meaning
  target: target	Operation not permitted for the specified server.	The privileges necessary to execute configuration modification on the specified server are not possessed. Refer to "Login Users" in the "Operator's Guide" and check whether the privileges to perform the configuration modification specified using the "-userid" are possessed When the user is the tenant user specified using "-userid", check whether the user possesses the server group of the displayed server. When the user is the tenant administrator, check whether they manage the server group of the server displayed in the managed tenant.
  	Operation not permitted for admin server.	Scripts cannot be executed for the admin server.
  script: script	The script is incorrect.	The specified script is incorrect. Check the following: When the OS of the script execution target server is "Windows", the extension of the script file is "bat" or "cmd"
  script: script distributionFile: distribution file	Operation not permitted for the specified asset.	The privileges required to use the specified asset are not possessed. Check if the specified user can use the relevant asset using the "-userid" option.
  successValues: normal return value monitorTime: monitoring time script: script distributionFile: distribution file command: command argument: argument destinationDirectory: distribution destination collectionFile: collection file storageDirectory: storage location singleUserMode: Single-user mode	The number of characters of value is invalid.	The number of characters is invalid.
  	The value contains invalid characters.	Unavailable characters are included.
  	The value is invalid.	An invalid value.

Example

[Windows]

swcfmg_configuration_change.exe -userid user001 -templateid 000000001 -file C:\work\param.csv

[Linux]

swcfmg_configuration_change -userid user001 -templateid 000000001 -file /tmp/param.csv