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.2.2 .cmxrc (client setting properties file) in the uCosminexus Application Server Definition Reference Guide. For the cmxclient.properties file, see 4.2.3 cmxclient.properties (common client setting properties 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 Setting the 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 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 Setting the 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 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‒5: Specifiable common arguments Command name
Common arguments
-m
-u
-p
-wait
-nowait
-verbose
-noverbose
cmx_admin_passwd
Y
Y
Y
--
--
cmx_build_model
Y
Y
Y
Y
--
cmx_build_system
Y
Y
Y
Y
Y
cmx_change_model
Y
Y
Y
Y
--
cmx_delete_system
Y
Y
Y
Y
Y
cmx_export_model
Y
Y
Y
--
--
cmx_list_model
Y
Y
Y
--
--
cmx_list_status
Y
Y
Y
--
--
cmx_resume_lb
Y
Y
Y
Y
Y
cmx_start_target
Y
Y
Y
Y
Y
cmx_stop_target
Y
Y
Y
Y
Y
cmx_test_lb
Y
Y
Y
Y
Y
cmx_trans_param
--
--
--
--
--
- Legend:
-
Y: Specification of common arguments is valid.
--: Specification of common arguments is invalid. If specified, the argument will be ignored.
- Termination code
-
The commands used with the Smart Composer functionality return values in the following range:
Table 8‒6: Return values of commands used with the Smart Composer functionality Return values
Meaning
0
The processing of the command terminated normally.
1 to 63
A minor error occurred in the processing of the command.
64 to 127
The processing of the command terminated abnormally.