Systemwalker Software Configuration Manager Operator's Guide

2.9.2 Creating Configuration Modification Templates

This section explains the flow of creating a configuration modification template. Create a configuration modification template based on the information provided by the software vendor described in manuals.

2.9.2.1 Definition of Template Information

Decide the information of a configuration modification template. Specify the following information:

Item	Description
Name	A template name. Specify a character string of up to 85 characters (excluding <, >, &, ", ', |, and ,). Names cannot be omitted.
Scope	The scope of the template. For dual-role administrators and infrastructure administrators, global is configured as the default value. Select the desired scope. For tenant administrators and tenant users, the scorpe is fixed to the tenant belonged to. Scopes cannot be omitted.
Description	A description of a tenant. Specify a character string of up to 256 characters. Descriptions can be omitted.

2.9.2.2 Definition of Process

Define the process to execute. Select the desired process from the following processes, and decide the order for execution. The same type of process can be selected multiple times. After this operation, specify a character string of up to 85 characters (excluding <, >, &, ", ', |, and ,) for the name of selected process. The name of the process type is configured as the default value. Process names cannot be omitted.

Process type	Description
Server operation check	Checks the operational status of the business server. Use this process to check the operational status of a server before installation.
Script execution	Transfers the specified scripts to the business server, and executes them. Use this process for executing the installer. Refer to "Creating Scripts and Specifying Commands" in the Operation Guide for information on the scripts that can be executed here.
OS restart	Restarts the OS of the business server. Use this process when restarting an OS after installing software that requires restarting after installation.
Command execution	Executes the commands specified for the business server. Use this process for executing the installer. Refer to "Creating Scripts and Specifying Commands" in the Operation Guide for information on the commands that can be executed here.
File distribution	Distributes the files specified for the business server. Use this process for distributing the installer. When files with the same names exist in the distribution destination, they are overwritten. When the business server is Linux or Solaris, the access authority of distributed files is 644.
File collection	Collects files from the business server, and stores them in the specified directory of the admin server. For the storage location, specify a directory under the reference directory that is the standard storage location. Use this process when collecting execution results such as installation logs, etc. When there is no directory for the storage location, one will be automatically created. When files with the same names exist in the storage location, they are overwritten. When the admin server is Linux, the access authority for the collected file is 755.

Reference directory for the storage location

The reference directories for the storage location are the following directories of the admin server. For details on how to modify the reference directory for the storage location, refer to "Changing the Reference Directory for the Storage Location" in the Operation Guide.

[Windows]

%ProgramData%\Fujitsu\SWCFMGM\storagedir

[Linux]

/var/opt/FJSVcfmgm/storagedir

2.9.2.2.1 Work Directory

A work directory is the directory created for each job on the business server, when configuration modification is executed. There are the following features:

• Script execution, scripts executed when commands are executed, and current directories of the commands

• Can be specified for file distribution, file collection, distribution destination, and collection files

• Automatically deleted when the job is completed

Note

• Note that the work directories are not deleted by command execution or by processing of script execution. If the work directories are deleted, configuration modification may not be executed correctly.

• When a job is completed, the work directory is not deleted in the following cases. In this case, manually delete the following directories after a job is completed. Be careful not to delete a work directory for which a job has not been completed by accident.

  • When the business server is not operating correctly

  • When command execution was performed asynchronously [Linux/Solaris]

  • When command execution was performed asynchronously and a command is being executed when the job is completed [Windows]

  [Windows]

  [Systemwalker Software Configuration Manager installation directory]\SWCFMGB\var\process\<Job ID>_<yyyyMMddHHmmss>

  [Linux/Solaris]

  /var/opt/FJSVcfmgb/process/<Job ID>_<yyyyMMddHHmmss>

2.9.2.3 Definition of Setting Information

Define the setting information of the process. Define the following setting information values according to the process types. For values, specify the fixed value or a parameter.

• For the fixed values, the values that can be specified differ depending on the setting information.

• For parameters, specify the parameter in the following format: For parameter names, alphanumeric characters (up to 256 characters), and ".", "_", and "-" can be used. However, parameter names must start with an alphabetic character. Parameter names cannot be omitted.

  {{Parameter name}}

• When specifying the work directory in the setting information, enter the variables. Enter the variables in the following format:

  #{Variable name}

  The available variable is shown below.

  Variable Name	Description
  work.directory	Work directory

• In some setting information, both the fixed value and the parameter can be specified at the same time.

  Example:

  timeout={{param}}

• A single parameter can be specified for multiple pieces of setting information. In this case, the setting information that can be specified differs based on the parameter types used. For details, refer to "Specifiable parameter types for setting information" in "2.9.2.4 Definition of Parameters".

  Process type	Setting information	Description	Use with parameters
  Server operation check	Target	The target of process execution. Targets cannot be omitted.	-
  	Monitoring time	The monitoring time of servers. Specify the monitoring time, in minutes, using a number between 0 and 1440. When 0 is specified, the operational status is checked once. When it has been confirmed that the server is operating, the operation completes normally. When a value larger than 0 is specified, the operation check can be executed multiple times during the specified monitoring time. The operation completes when the operational status is confirmed. 0 is configured as the default value. Monitoring time cannot be omitted.	-
  Script execution	Target	The target of process execution. Targets cannot be omitted.	-
  	Script	A script file for execution. Up to 155 alphanumeric characters, blank spaces, and the following symbols can be used in the file name. ~, _, -, ., (, ) Refer to "Creating Scripts and Specifying Commands" in the Operation Guide for information on the scripts that can be executed here. Scripts cannot be omitted.	-
  	Argument	An argument of the scripts to execute. Specify 3,800 or less characters, including the file names of the scripts. (*1) When omitted, the scripts are executed without arguments.	Y
  	Normal return value	A return value to determine that the operation has completed successfully. Specify the return value to use to determine that the operation has completed successfully. Multiple return values can be specified separated by commas ",". When all return values are used to indicate an operation was completed successfully, specify only an asterisk (*). When the same return value is specified multiple times, an error occurs. 0 is configured as the default value. Normal return values cannot be omitted.	Y
  	Single-user mode	Specify whether to execute at single-user execution level. This setting is only valid when the execution target is Linux or Solaris. When "true" is specified, the execution level is switched to single-user and then the script is executed. After the script is executed, the execution level is switched back to the level that it was before switchover. When "false" is specified, the script is executed without switching the execution level. When something other than "true" or "false" is specified, an error will occur. "false" is specified by default. In single-user mode, this item cannot be omitted.
  OS restart	Target	The target of process execution. Targets cannot be omitted.	-
  Command execution	Target	The target of process execution. Targets cannot be omitted.	-
  	Command	The file path of the command to execute. When the blank spaces are included in the file path, enclose the file path in double quotes """ based on the OS specifications. When the work directory is also included in the file path, enclose the file path in double quotes """. Refer to "Creating Scripts and Specifying Commands" in the Operation Guide for information on the commands that can be executed here. Commands cannot be omitted.	Y
  	Argument	An argument for the command to be executed. Specify using 3,800 or less characters, including commands. (*1) When omitted, the commands are executed without arguments.	Y
  	Normal return value	A return value to determine that the operation has completed successfully. Specify the return value to use to determine that the operation has completed successfully. Multiple return values can be specified separated by commas ",". When all return values are used to indicate an operation was completed successfully, specify only an asterisk (*). When the same return value is specified multiple times, an error occurs. 0 is configured as the default value. Normal return values cannot be omitted. When "true" is specified, the value specified for this item is ignored.	Y
  	Single-user mode	Specify whether to execute at single-user execution level. This setting is only valid when the execution target is Linux or Solaris. When "true" is specified, the execution level is switched to single-user and then the script is executed. After the script is executed, the execution level is switched back to the level that it was before switchover. When "false" is specified, the command is executed and waits for completion. When something other than "true" or "false" is specified, an error will occur. "false" is specified by default. In single-user mode, this item cannot be omitted.	-
  File distribution	Target	The target of process execution. Targets cannot be omitted.	-
  	Distribution file	A file to distribute. Alphanumeric characters, blank spaces, and the following symbols can be used for the file name. ~, _, -, ., (, ) Distribution files cannot be omitted.	-
  	Distribution destination	The directory path of the distribution destination of the file. Specify the directory path using an absolute path. Even if blank spaces are included in the directory path, it is not necessary to enclose the directory path in double quotes """. Environment variables cannot be used. Alphanumeric characters, blank spaces, double-byte characters, and the following symbols can be used for the directory name. ~, _, -, ., (, ) Specify using 254 or less characters, including the file names of the distribution files. (*1) Directories in the installation directory of this product cannot be specified. #{work.directory} (work directory) is configured as the default value. Distribution destinations cannot be omitted.	Y
  File collection	Target	The target of process execution. Targets cannot be omitted.	-
  	Collection file	The file path for file collection. Specify the file path using an absolute path. Even if blank spaces are included in the file path, it is not necessary to enclose the file path in double quotes """. Environment variables cannot be used. Specify a file path of up to 255 characters. (*1) Alphanumeric characters, blank spaces, and the following symbols can be used for the file name. ~, _, -, ., (, ) Alphanumeric characters, blank spaces, double-byte characters, and the following symbols can be used for the directory name. ~, _, -, ., (, ) It is only possible to collect one file. Wildcards, such as asterisks "*", cannot be used. Collection files cannot be omitted.	Y
  	Storage location	The directory path for the storage location of collection files. Specify the directory path using a relative path from the reference directory for the storage location. Directories above the reference directory for the storage location cannot be specified. Even if blank spaces are included in the directory path, it is not necessary to enclose the directory path in double quotes """. Environment variables cannot be used. Specify the file path of the reference directory for the storage location, including the file name of the collection file, using 254 characters or less. Alphanumeric characters, blank spaces, double-byte characters, and the following symbols can be used for the directory name. ~, _, -, ., (, ) The storage location cannot be omitted.	Y

  Y: Both a fixed value and a parameter can be specified at the same time.

  N: Either a fixed value or a parameter can be specified.

  *1: When the work directory is included in the specified value, the number of characters for the work directory must be 100.

2.9.2.4 Definition of Parameters

Defines the parameter. A description using 256 or less characters can be attached to a parameter. Descriptions can be omitted.

For the parameter, specify the values when executing configuration modification from the configuration modification template. The specifiable values differ based on the parameter types.

Parameter type	Description
Servers	A server. Specify a server among the business servers for the value.
File	A file. Specify a file from among the assets for the value. The file can also be uploaded from the management console. In this case, the file size that can be uploaded is up to 2 MB. A file name using a character string of up to 255 printable ASCII characters can be specified.
Character string	A character string. Specify the desired character string. Empty strings can also be specified.
Numeric value	A numeric value. Specify a numeric value from "-2,147,483,648" to "2,147,483,647".
Truth value	A truth value. Specify "true" or "false" for the truth value.
Password	A password. Specify the desired password using a character string. For the value, "****" is displayed. Empty strings can also be specified.

Specifiable parameter types for setting information

The following table shows the types of parameter that can be specified in the setting information. The parameter types that are not character strings can also be handled as character strings. When a server is handled as a character string, the IP address of the server used as the value is evaluated as a character string. When a file is handled as a character string, the name of the file used as the value is evaluated as a character string.

Process type	Setting information	Specifiable parameter type
Server operation check	Target	Servers
	Monitoring time	Numeric value
Script execution	Target	Servers
	Script	File
	Argument	Character string
	Normal return value	Character string
	Single-user mode	Truth-value
OS restart	Target	Servers
Command execution	Target	Servers
	Commands	Character string
	Argument	Character string
	Normal return value	Character string
	Single-user mode	Truth-value
File distribution	Target	Servers
	Distribution file	File
	Distribution destination	Character string
File collection	Target	Servers
	Collection file	Character string
	Storage location	Character string

2.9.2.5 Advisory Notes when Creating a Configuration Modification Template to Perform Software Installation

This section explains advisory notes about creating a configuration modification template to perform installation. Only software for which silent installation can be performed can be installed for configuration modification. Perform silent installation by executing commands or scripts according to the following advisory notes:

Software requiring restarting during installation

When the server must be restarted during installation, do so by executing commands or scripts after performing silent installation. When installing software that is automatically restarted during installation, use the following installation methods:

Software for which automatic restart during installation can be prevented

Perform silent installation preventing automatic restart by executing commands or scripts, and then restart the server.

Software for which automatic restart during installation cannot be prevented

Perform silent installation by executing commands or scripts. The last process of configuration modification must be command execution or script execution. When executing commands or scripts, perform silent installation asynchronously in order to recover the commands or scripts immediately after silent installation.

When using Windows, the commands can be executed asynchronously using Start-Process of PowerShell. OS standard start commands cannot be used. An example of the command to execute is shown below.

Example:

powershell -Command Start-Process -FilePath 'C:\wok\setup.exe'

Software for which the executing user must be specified during installation

When software requires installation using a user with Administrator authority or a domain user, perform silent installation after changing the executing user by executing commands or scripts. Based on the OS type of the business server, the executing user can be changed using the following methods:

[Windows]

Use PsTools provided by Microsoft. Distribute PsTools to the business server in advance, and then specify the command and user to use to execute PsTools. An example of the command to execute is shown below. For details on PsTools, refer to the information provided by Microsoft.

Example:

C:\tmp\PsExec.exe /accepteula \\localhost -u "cfmg.local\cfmgadmin" -p "systemwalker#1" "C:\work\setup.exe"

[Linux/Solaris]

Use the OS standard su command. An example of the command to execute is shown below.

Example:

su - cfmgadmin -c /tmp/setup.sh

Software for which a window opens during installation

When a window of Windows software is opened when performing silent installation, silent installation cannot be performed using commands or scripts. When executing commands or scripts, perform silent installation asynchronously in order to recover the commands or scripts immediately after silent installation.

When using Windows, the commands can be executed asynchronously using Start-Process of PowerShell. OS standard start commands cannot be used. An example of the command to execute is shown below.

Example:

powershell -Command Start-Process -FilePath 'C:\wok\setup.exe'