cmx_stop_target (Stop a Web system or a service unit)
- Organization of this page
Format
-
To stop a Web system
cmx_stop_target [Common-arguments] [-s web-system-name] [-unit service-unit-name] -mode { ALL|HOLD } -
To stop a system containing a logical server that is not associated with the Web system
cmx_stop_target [Common-arguments] -ns [-normal]
Function
-
To stop a Web system
This command sets the status of service units, configuring stop targets, to the stopped status or the blockade status depending on the specified mode. In the stopped status, all the logical servers in the service unit are stopped and the distribution of requests from the load balancer is controlled. In the blockade status, the Web server in the service unit is terminated in a planned manner (other logical servers 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 stopped and if the service unit is not specified, all the service units in the Web system will be stopped.
Note that in this command, the Web server is terminated in a planned manner so that a client request that is being processed is not interrupted.
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.
-
To stop a system containing a logical server that is not associated with the Web system
This command stops all the logical servers included in the start target. A logical server that has already stopped continues to remain in the stopped status.
Additionally, this command terminates the Web server in a planned manner. Planned termination means the command waits for the processing of all the requests received currently to end, and then stops the logical server. For not terminating the Web server in a planned manner, you specify the -normal option.
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_stop_target command by omitting the -s option, an error occurs.
- -unit service-unit-name
-
Specifies the service unit name.
- -mode { ALL | HOLD }
-
Specifies the stop mode.
-
ALL
Downgrades the operating status, ready status, and the blockade status to the stopped status.
-
HOLD
Downgrades the operating status and the ready status to the blockade status.
You cannot upgrade a service unit, from the stopped status to the blockade status.
-
- -ns
-
Specify this option to stop a system containing the logical server that is not associated with the Web system.
- -normal
-
You specify this option, for not terminating the Web server in a planned manner. If you execute the cmx_stop_target command without specifying this option, the Web server will terminate in a planned manner.
Input examples
cmx_stop_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.
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 HOLD for the -mode option causes an error to occur. If HOLD 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 does not change from working.
-
When a logical server is included in a service unit building stop targets, and if you specify HOLD in the -mode option, the service unit will be blocked, but the logical user server will not stop. Also, when a logical user server is included in the service unit building stop targets, and if you specify ALL in the -mode option, the logical user server will be stopped. If an attempt to stop the logical user server fails, this description assumes that the service unit has also failed to stop. In this case, the cmx_stop_target command specifying the -unit option terminates abnormally and the cmx_stop_target command that does not specify the -unit option terminates with a warning.
-
When you stop a service unit for the CTM on which multiple J2EE servers are deployed, even if the stop processing fails on some of the J2EE servers, the stop processing is executed for all the J2EE servers. In this case, the cmx_stop_target command will terminate abnormally.
-
If service unit is stopped in a batch, then a service unit which is to be stopped is cut from load balancer function and all logical servers within the service unit are stopped after processing the request during operation. Logical servers are stopped in descending order of the startup sequence that is set for each logical server.
In case of batch stop, the operation when logical server fails to stop differs according to the system that is stopped.
-
In case of Web system
If logical Web server fails to stop, batch stop process is aborted. If any other logical server fails to stop, the process continues.
-
In case of system with logical server that is not related to Web system
A process is continued even if logical server fails to stop. If logical Web server fails to stop, receiving of requests is continued. In this case, -mode option is specified at the time of batch stop and a target system is first changed to blockade state and then changed to stop state.
-