cmx_list_status (Display a status of service unit)
- Organization of this page
Format
-
To acquire the status of service units in Web systems
cmx_list_status [Common-arguments] [-s web-system-name] [-unit service-unit-name]
-
To acquire the status of the logical servers that are not associated with Web systems
cmx_list_status [Common-arguments] -ns
Function
To acquire the status of the service unit in the Web system
This command acquires the service unit operating status and the executed status of the cmx_build_system command for the service unit and outputs the acquired results to standard output.
-
Service unit operating status
This command acquires the service unit executed status and outputs the acquired results to standard output. The following is the status that is output for the service unit operating status:
-
working
Displays the operating status. This status indicates that all the logical servers in the service unit are running and that the requests are distributed from the load balancer (blockade status). In the absence of a load balancer, this status indicates that the cmx_start_target command is executed by specifying ALL in the -mode option.
-
ready
Displays the ready status. This status indicates that all the logical servers in the service unit are running and that the distribution of requests from the load balancer is controlled (Blockade status). In the absence of a load balancer, this status indicates that the cmx_start_target command is executed by specifying READY in the -mode option.
Normally, operations such as application testing are executed after changing the stopped status to the ready status, the application is not deployed, and the external connections are not established.
-
hold
Displays the blockade status. This status indicates that the Web server in the service unit is terminated in a planned manner (another logical server is running) and the distribution of requests from the load balancer is controlled (Blockade status). Normally, operations such as substitution of J2EE applications are executed after changing the operating status to the blockade status.
Note that the only difference between the blockade status and ready status is whether the Web server is running.
-
stopped
Displays the stopped status. This status indicates that all the logical servers in the service unit are stopped and that the distribution of requests from the load balancer is controlled (Blockade status).
-
no working
Indicates no working status. This status indicates that a part of the logical server in the service unit is running or all the logical servers have stopped, and the requests from the load balancer are distributed (Blockade cancellation status). This status is not output if the load balancer is not present.
-
no ready
Indicates no ready status. This status indicates that the Web server in the service unit is stopped and a part of the other logical server is running, or the Web server in the service unit is running and a part of the logical server is running or all the logical servers have stopped, and the distribution of requests from the load balancer is controlled (Blockade status).
-
-
Executed status of the cmx_build_system command.
This command acquires the executed status of the cmx_build_system command for the service unit and outputs the acquired results to standard output as done (executed) and not done (not executed). Execution status of the cmx_build_system command that is output is as follows:
-
done
Displays the executed status. This status indicates that the cmx_build_system command is executed, and the load balancer and the logical server are already set up.
-
not done
Displays the executed status. This status indicates that an attempt to execute the cmx_build_system command has failed (any of the load balancer or the logical server is not setup or is not distributed).
-
If the service unit is specified in the command option, the specific service unit will be displayed and if the service unit is not specified in the command option, all the units in the Web system will be displayed.
To learn about the operating status of each J2EE application and each logical server, you use the mngsvrutil command. For details on the mngsvrutil command, see mngsvrutil (Management Server management command) in 7.2 Details of commands used with Management Server
To acquire the status of the logical server that is not associated with the Web system
-
Logical server operating status
This command acquires the status of the logical server and outputs the acquired results in the standard output. For the status that is output for the service unit operating state, see 4.4 Monitoring the logical server operations in the uCosminexus Application Server Management Portal User Guide.
-
Executed status of the distribution of logical server preference information
This command acquires the executed status of the distribution of logical server preference information and outputs the acquired result to standard output as done (executed) and not done (not executed). The status, specifying that the preference information be distributed, indicates the following types of status:
-
Status indicating that the cmx_build_system command was executed with the -ns option in the argument and the system setup was completed normally.
-
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_list_status command by omitting the -s option, an error occurs.
- -unit service-unit-name
-
Specifies the service unit name.
- -ns
-
Specify this option to acquire the status of the logical server that is not associated with the Web system.
Output format
This command is output in the CSV format.
-
To display the status of the service unit in the Web system
service-unit-name, web-system-name, execution-status-of-cmx_build_system, service-unit-operating-state
-
To display the status of the logical server that is not associated with the Web system
logical-server-name, execution-status-of-distribution-of-logical-server-preference-information#, logical-server-operating-state
- #
-
If the type of logical server is not J2EE server, or Web server, the execution status of the distribution of logical server preference information is displayed as a null character.
Input and Output examples
-
To display the status of the service unit in the Web system
>cmx_list_status -s sample-system unit01, sample-system, done, working unit02, sample-system, done, ready unit03, sample-system, done, hold unit04, sample-system, done, stopped unit05, sample-system, done, no working unit06, sample-system, not done, no ready
-
To display the status of the logical server that is not associated with the Web system
>cmx_list_status -ns PRF01, , working J2EE01, done, working HTTP01, done, working
Return values
- 0:
-
The command is terminated normally.
- 1:
-
The command is terminated with a warning.
- 64:
-
The command is terminated abnormally.
Notes
-
For a service unit of CTM and a service unit for the integrated naming scheduler server, the status of the service unit operating state displays three status types; working, stopped, and no ready.
-
When multiple J2EE servers are deployed on a service unit for CTM, if the service unit starts normally and some of the J2EE servers terminate abnormally, the operating status of the service unit displays no working or no ready.