setupwizard command (system setup, unsetup, and copy)
- Organization of this page
Format
- Start setup wizard
setupwizard
- Batch setup that uses the setup information file
setupwizard -f setup-information-file [-force]
- Export of the Easy Setup definition file
setupwizard -export -omd easy-setup-definition-file
- Duplication of system
setupwizard -f setup-information-file -md easy-setup-definition-file [-force]
- Unset up
setupwizard -clean [-force]
- Display contents of the setup information file
setupwizard -view -f setup-information-file
- Display how to use command
setupwizard -h|-help
Functions
-
Start of setup wizard
Start the setup wizard.
-
Package setup that uses setup information file
Package setup is carried out according to the information in setup information file specified in -f option. If you specify -force option, group setup is carried out without confirming the contents of setup information file.
-
Export Easy Setup definition file
Exports easy setup definition file. Specify easy setup definition file output destination and file name in -omd option. Easy setup definition file which is exported becomes an input file at the time of system replication.
-
System replication
Replicate the system according to the information of the following files.
-
Setup information file specified in -f option
-
Easy setup definition file specified in -md option
If you specify -force option, replicate the system without confirming the contents of setup information file.
However, the following information does not correspond to the contents of setup information file but it corresponds to the contents of easy setup definition file.
-
Web system settings
-
JDBC driver settings (If data base setting is selected as Do)
-
-
Unset-up
Performs unset up of system set up by Setup Wizard or a system configured by other than the Setup Wizard. If you specify -force option, unsetup is carried out without confirming whether to unsetup.
-
Display contents of setup information file
Display contents of setup information file specified in -f option.
-
Display how to use command
Display how to use setupwizard command.
Arguments
- -f setup-information-file
-
Specify setup information file path.
- -export
-
Specified when easy setup definition file is to be exported.
- -omd easy-setup-definition-file
-
Specify easy setup definition file path which is to be exported.
- -md easy-setup-definition-file
-
Specify easy setup definition file used in system replication.
- -clean
-
Specified when unsetup of system is to be carried out.
- -force
-
Specified when the following operation is to be executed without confirming the process.
-
Group setup that uses setup information file
-
Unsetup
-
System replication
-
- -view
-
Specify if you want to display contents of setup information file.
- -h|-help
-
Specify if you want to display how to use setupwizard command.
Input examples
-
Input example 1
Start setup wizard
Setupwizard
-
Input example 2
Batch setup that uses the setup information file
setupwizard -f Cosminexus-installation-directory/manager/setup/config/setupwizard.dat -force
-
Input example 3
Export the Easy Setup definition file
setupwizard -export -omd arbitrary-directory/file-name-of-easy-setup-definition-file
-
Input example 4
System replication
setupwizard -f Cosminexus-installation-directory/manager/setup/config/setupwizard_success.dat -md arbitrary-directory/file-name-of-easy-setup-definition-file
-
Input example 5
Unset up without confirming implementation
setupwizard -clean -force
-
Input example 6
Display contents of the setup information file
setupwizard -view -f Cosminexus-installation-directory/manager/setup/config/setupwizard.dat
-
Input example 7
Display how to use command
setupwizard -h
Return values
- 0:
-
Stopped normally.
- 1:
-
Error has occurred at the time of execution.
- 2:
-
Syntax error has occurred.
Notes
-
User who can execute command are as below. If the command is executed by user other than those mentioned below, error may occur.
- In Windows
-
Execute the command as a user with administrator privileges. In the case of other Windows OS, users with administrator rights can execute commands.
- In UNIX
-
User who has root authority can execute command.
-
If you try to set up by specifying the -force option in the batch setup by using the setup information file, and if the setup fails, snapshot log is collected automatically as a document for troubleshooting. The contents of this snapshot log and the storage destination are as follows:
- Storage destination of snapshot log
-
Output-destination-of-setup-wizard-log/snapshot.zip
- Contents of snapshot log
-
Range indicated in Cosminexus-installation-directory/manager/config/snapshotlog.conf
Output-destination-of-setup-wizard-log/setupwizard number-of-files.log
Output-destination-of-setup-wizard-log/maintenance/setupwizard number-of-files.log
Cosminexus-installation-directory/manager/setup/config/
Cosminexus-installation-directory/manager/setup/tmp/
Output-destination-of-setup-wizard-log is the output destination specified in setup.log.dir of setup.cfg. For setup.cfg, see 8.2.18. setup.cfg (Setup file for the Setup Wizard) in the uCosminexus Application Server Definition Reference Guide.
-
The Easy Setup definition file that is to be specified in -md option is the easy setup definition file that is exported by -export option. If you specify any other Easy Setup definition file, system replication may fail.
-
If command is executed by specifying -export option, it is required that Management Server has already started. If Management Server is not started, command execution may fail.
-
If you execute the command by specifying the -clean option in the following environment, KEOS28058-I message is output and command ends with end code 0.
-
Environment where setup is not executed
-
Environment where the command (unsetup) is executed once with the -clean option.
-
Environment where Management Server is not setup
-
-
While executing the command, do not stop by Ctrl + C key externally. If it is stopped, execute the setup wizard once again. If error occurs even after executing the setup wizard again, restart the OS.