cmx_start_target (Start the Web system or service unit)
- Organization of this page
Format
-
To start a Web system
cmx_start_target [Common-arguments] [-s web-system-name] [-unit service-unit-name] -mode { ALL|READY } [-strict] -
To start a system containing a logical server that is not associated with the Web system
cmx_start_target [Common-arguments] -ns
Function
This command starts a system. The operations differ when a Web system is started and when a system containing a logical server that is not associated with the Web system is started. The following is the description for each operation:
-
When you start a Web system
This command sets the status of the service unit configuring the start target to the operating status or the ready status depending on the specified mode. In the operating status, all the logical servers in the service unit are running and the requests are distributed from the load balancer. In the ready status, all the logical servers in the service unit are running and the distribution of requests from the load balancer is controlled.
If a service unit is specified in the command option, the specific service unit will be started and if the service unit is not specified, all the service units in the Web system will be started.
You can confirm the status of the service unit with the cmx_list_status command. For details on the types of service unit status and the methods of referencing the service unit status, see cmx_list_status.
-
When you start a system containing a logical server that is not associated with the Web system
This command starts all the logical servers contained in the system configuring the start target and sets the status to the operating status. An already running logical server continues to be in the operating status and is not restarted by this operation.
You can reference the status of the logical server that is not associated with the Web system by specifying the -ns option in the cmx_list_status command. For details on the types of logical server status and the methods of referencing the logical server status, see cmx_list_status.
Arguments
- -s web-system-name
-
Specifies the Web system name.
If you omit this option, the value set in the cmx.websystem.name key of the .cmxrc file or the cmxclient.properties file will be used. Note that if the cmx.websystem.name key is not specified in the .cmxrc file and the cmxclient.properties file and if you execute the cmx_start_target command by omitting the -s option, an error occurs.
- -unit service-unit-name
-
Specifies the service unit name.
- -mode { ALL|READY }
-
Specifies the start mode.
-
ALL
Upgrades the stopped status, blockade status, and the ready status to the operating status.
-
READY
Upgrades the stopped status and the blockade status to the ready status.
You cannot downgrade a service unit in the operating status to the ready status.
-
- -strict
-
Specify this option to interrupt the starting of subsequent logical servers, when an attempt to start a logical server fails.
If you execute the cmx_start_target command by omitting the -strict option and if an attempt to start a logical server fails, the starting of the subsequent logical servers continues.
- -ns
-
Specify this option to start a system containing the logical server that is not associated with the Web system.
Input examples
cmx_start_target -s sample-system -unit unit1 -mode ALL
Return values
- 0:
-
The command is terminated normally.
- 1:
-
The command is terminated with a warning.
- 64:
-
The command is terminated abnormally.
The following table describes the details of the return values:
|
Return values |
For one service unit |
For multiple service units |
|---|---|---|
|
0 |
All the logical servers are started successfully. |
All the service units are started successfully#1. |
|
1 |
-- |
Some of the service units have failed#2 to start. |
|
64 |
Some of the logical servers have failed to start. |
All the service units have failed#2 to start. |
Legend
--: None.
#1 The successful starting of a service unit means all the logical servers in the service unit started successfully.
#2 The failed starting of a service unit means some of the logical servers in the service unit has failed to start.
Notes
-
Take caution when you specify the service unit for CTM or for the integrated naming scheduler server in the -unit option. In this case, specifying READY for the -mode option causes an error to occur. If READY is specified for the -mode option when the -unit option is omitted, the status of the service unit for CTM or for the integrated naming scheduler server in the web system is elevated to working.
-
The logical user server included in the service unit configuring the start target is started, irrespective of whether the -mode option is specified. When the logical user server is included in the service unit configuring the start target and if an attempt to start the logical user server fails, this description assumes that the service unit has also failed to start. In this case, the cmx_start_target command specifying the -unit option terminates abnormally and the cmx_start_target command that does not specify the -unit option terminates with a warning.
-
When you start a service unit for the CTM on which multiple J2EE servers are deployed, even if the start processing fails on some of the J2EE servers, the start processing is executed for all the J2EE servers. In this case, the cmx_start_target command will terminate abnormally.
-
If service units are started in a batch, the logical server that configures the service units is started in an ascending order of the startup sequence that is set for each logical server. With the Smart Composer functionality, the process continues as it is even if the logical server fails to start during the batch starting process. However, the batch starting process is aborted if the logical server fails to start in the case of a system with a logical server that is not related to the Web system. If the logical server fails to start, errors such as problems in receiving requests or processing the received requests occur. When the -strict option is specified for a batch startup, the batch startup of service unit can be aborted if the startup of the logical server fails.
The process for each system is explained with an example when the logical J2EE server fails to start in the following startup sequence:
Startup sequence of the logical server
-
Logical performance trace
-
Logical J2EE server
-
Logical Web server
-
System processing when batch starting is continued.
A logical Web server is started and request is received. The received request cannot be processed because the logical J2EE server fails to start.
-
System processing when the batch startup is aborted
A logical Web server is not started. Therefore, a request cannot be received.
-