8.3 Details of commands used with the Smart Composer functionality

This subsection describes the input format and functions of each command used with the Smart Composer functionality.

Command storage destination
The commands used with the Smart Composer functionality are saved in the following directory:
  • In Windows
    Cosminexus-installation-directory\manager\bin\
  • In UNIX
    /opt/Cosminexus/manager/bin/
Common arguments
In each command, the following arguments will be specified as common arguments. You can set the default values to be used when the values are not specified for common arguments in .cmxrc (client settings property file) or cmxclient.properties (client common settings property file). For the .cmxrc file, see 4.3 .cmxrc (Client settings property file) in the uCosminexus Application Server Definition Reference Guide. For the cmxclient.properties file, see 4.4 cmxclient.properties (Client common settings property file) in the uCosminexus Application Server Definition Reference Guide.
Format

Command-name [-m host-name[: port-number]]
[-u management-user-ID] [-p management-user-password]
[-wait | -nowait] [-verbose | -noverbose]

Description
-m host-name[: port-number]
Indicates Management Server host name and the port number.
  • host-name
    Specifies the IP address in dot notation (xxx.xxx.xxx.xxx) or the host name that can be resolved. Specify each xxx as an integer within 0 to 255.
  • port-number
    Complies with the settings for Management Server. The default value is 28080.
-u management-user-ID
Sets the management user ID of Management Server that is specified in Management Server setup. For the Management Server setup, see 4.1.14 Set up Management Functionality in the uCosminexus Application Server System Setup and Operation Guide. When you try to enable the functionality for omitting the admin user account, the functionality is not enabled even though the admin user ID is specified. For the functionality for omitting the admin user account, see 4.1.15(3) Settings when the management user account is not set up in the uCosminexus Application Server System Setup and Operation Guide.
-p management-user-password
Sets the management user password of Management Server that is specified in Management Server setup. For the Management Server setup, see 4.1.14 Set up Management Functionality in the uCosminexus Application Server System Setup and Operation Guide. When you try to enable the functionality for omitting the admin user account, the functionality is not enabled even though the admin user password is specified. For the functionality for omitting the admin user account, see 4.1.15(3) Settings when the management user account is not set up in the uCosminexus Application Server System Setup and Operation Guide.
-wait | -nowait
Either specifies that the command will wait until processing is executable (-wait) or that the command will return an error without waiting (-nowait), when a command needs to be excluded from another command that is already running at the command runtime. For details, see the subsection
8.2 Exclusive control when multiple commands are executed concurrently.
-verbose | -noverbose
Either specifies that the detailed command execution result will be output (-verbose) or the execution result will not be output (-noverbose).
The specification of common arguments might be valid or invalid depending on the command. If an invalid argument is specified for the command, the argument is ignored. The following table describes the specification of common arguments for each command:

Table 8-8 Specifiable common arguments

Command nameCommon arguments
-m-u-p-wait
-nowait
-verbose
-noverbose
cmx_admin_passwdYYY----
cmx_build_modelYYYY--
cmx_build_systemYYYYY
cmx_change_modelYYYY--
cmx_delete_systemYYYYY
cmx_export_modelYYY----
cmx_list_modelYYY----
cmx_list_statusYYY----
cmx_resume_lbYYYYY
cmx_start_targetYYYYY
cmx_stop_targetYYYYY
cmx_test_lbYYYYY
cmx_trans_param----------
Legend:
Y: Specification of common arguments is valid.
--: Specification of common arguments is invalid. If specified, the argument will be ignored.
Note:
In all the commands for compatibility, the specification of common arguments is valid. For details on the commands for compatibility, see
8.1.3 List of commands for compatibility with earlier versions.

Termination code
The commands used with the Smart Composer functionality return values in the following range:

Table 8-9 Return values of commands used with the Smart Composer functionality

Return valuesMeaning
0The processing of the command terminated normally.
1 to 63A minor error occurred in the processing of the command.
64 to 127The processing of the command terminated abnormally.
Organization of this section
cmx_add_serverref (add a logical user server) (For compatibility)
cmx_admin_passwd (Set up a management user account of a Management Server)
cmx_build_model (Generate a Web system information model)
cmx_build_system (Build a Web system)
cmx_change_model (Change a Web system information model)
cmx_define_application (Associate a J2EE application and a Web system) (For compatibility)
cmx_define_resource (Associate a resource and a Web system) (For compatibility)
cmx_delete_serverref (Delete a logical user server) (For compatibility)
cmx_delete_system (Delete a Web system)
cmx_deploy_application (Deploy a J2EE application) (For compatibility)
cmx_deploy_resource (Deploy a resource) (For compatibility)
cmx_export_model (Output an Easy Setup definition file)
cmx_list_model (Get a Web system information model)
cmx_list_status (Display a status of service unit)
cmx_register_application (Register a J2EE application) (For compatibility)
cmx_register_resource (Register a resource) (For compatibility)
cmx_resume_lb (Restart load balancer settings)
cmx_scaleout_host (Changing information model of Web system)
cmx_start_application (Start a J2EE application) (For compatibility)
cmx_start_resource (Start a resource) (For compatibility)
cmx_start_target (Start the Web system or service unit)
cmx_stop_application (Stop a J2EE application) (For compatibility)
cmx_stop_resource (Stop a resource) (For compatibility)
cmx_stop_target (Stop a Web system or a service unit)
cmx_test_lb (Test connection with load balancer)
cmx_trans_param (Deploy an abstract parameter)
cmx_undefine_application (Disassociate J2EE applications and Web systems) (For compatibility)
cmx_undefine_resource (Disassociate resources and Web systems) (For compatibility)
cmx_undeploy_application (Undeploy a J2EE application) (For compatibility)
cmx_undeploy_resource (Undeploy a resource) (For compatibility)
cmx_unregister_application (Delete a J2EE application) (For compatibility)
cmx_unregister_resource (Delete a resource) (For compatibility)