4.2.2 .cmxrc (client setting properties file)

Organization of this subsection

(1) Format
(2) File storage location
(3) Functionality
(4) Specifiable keys
(5) Examples of coding
(6) Precautions

(1) Format

This file is in the Java properties format.

To Page Top

(2) File storage location

The file is stored in the home directory of an OS user who executes commands.

To Page Top

(3) Functionality

This file is used to set default values for common arguments of the commands provided by the Smart Composer functionality. You use this file to set default values for an individual client.

Copy and use the following template files:

In Windows

Cosminexus-installation-directory\manager\config\templates\.cmxrc
In UNIX

/opt/Cosminexus/manager/config/templates/.cmxrc

To Page Top

(4) Specifiable keys

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a parameter is not specified.

VR is the version of Application Server on which parameters are introduced or changed.

Key name	Contents	Specifiable value	Default value	VR
`cmx.connect.host`^#1	Sets host names and IP addresses to be assumed when the `-m` option is omitted in common arguments. The IP address can be specified as a regular expression using meta characters. If the IP address is specified as a regular expression, the matching IP address will be used from the available local IP addresses.^#2	The values that can be specified are as follows: Host name IPv4 address	None	06-50
`cmx.connect.userid`	Sets the user ID to be assumed when the `-u` option is omitted in the common arguments. Specification of this key is ignored if the functionality to omit the management user account is enabled.	User ID of management user account of Management Server	None	06-50
`cmx.connect.passwd`	Sets the password to be assumed when the `-p` option is omitted in the common arguments. Specification of this key is ignored if the functionality to omit the management user account is enabled.	Management user account password of Management Server	None	06-50
`cmx.wait`	Sets `true` to treat the `-wait` option in the common argument as the default, and `false` to treat the `-nowait` option as the default.	The following strings can be specified: `true` `false`	false	06-50
`cmx.verbose`	Sets `true` to treat the `-verbose` option in the common argument as the default, and `false` to treat the `-noverbose` option as the default.	The following strings can be specified: `true` `false`	false	06-50
`cmx.websystem.name`	Specifies the Web system name when the `-s` option of the following commands is omitted: `cmx_build_system`^#3 `cmx_delete_system` `cmx_list_model`^#5 `cmx_list_status` `cmx_resume_lb`^#4 `cmx_start_target` `cmx_stop_target` `cmx_test_lb`^#4	Web system name	None	07-50
`cmx.lb`^#4	Specifies operations for the virtual server of the load balancer, when the `-lb` option of the `cmx_delete_system` command is omitted. `keepvs`:The virtual server is not deleted. `deletevs`:The virtual server is deleted.	The following strings can be specified: `keepvs` `deletevs`	None	07-10
`cmx.encoding`	Specifies a character encoding assumed when the `-encoding` option of the `cmx_export_model` command is omitted. For details about specifiable values, see cmx_export_model (Output an Easy Setup definition file) in the uCosminexus Application Server Command Reference Guide.	Character encoding name	UTF-8	07-50
`cmx.indent`	Specifies the indent size assumed when the `-indent` option of the `cmx_export_model` command is omitted. For details about specifiable values, see cmx_export_model (Output an Easy Setup definition file) in the uCosminexus Application Server Command Reference Guide.	Integers from 0 to 8	2	07-50
`cmx.myhost`	Specifies the host name of the management server machine assumed when the `-myhost` option of the `cmx_export_model` command is omitted. For details about specifiable values, see cmx_export_model (Output an Easy Setup definition file) in the uCosminexus Application Server Command Reference Guide.	Host name	None	07-50

#1

In the following cases, if a value is specified in webserver.connector.http.bind_host of mserver.properties, also specify the same value in the cmx.connect.host key:

When operating the system for executing J2EE applications in the host unit management model
In the system for executing batch applications

#2

If the IP address subnet used in the communication with the Administration Agent in the management domain is fixed, and if the IP address to be specified is coded as 192\\.168\\.0\\..+, the IP address matches with the IP address starting with 192.168.0. (for example, 192.168.0.32 or 192.168.0.128), so the setup file can be distributed to all the hosts and can be used without modifications. For details on the regular expressions, check the specifications for the java.util.regex.Pattern class in Java.

If multiple IP addresses matching with the specified regular expression are detected, the IP address with the smallest value is used. For example, if 192.168.0.32 and 192.168.0.128 are detected, 192.168.0.32 will be used. In this case, the used IP address is not always the intended IP address, therefore, make sure to code a regular expression such as 192\\.168\\.0\\.1.. to match with only one IP address.

Note the following points for specifying the IP address as a regular expression:

When specifying a backslash (\), specify a double backslash (\\). A double backslash (\\) will replace a single backslash (\).
Do not specify a colon (:). The text after the colon is considered as a port number.

If a value is specified in webserver.connector.http.bind_host of mserver.properties, specify the same value.

#3

If the -f option is specified when the cmx_build_system command is executed, the key settings are not applied.

#4

Cannot be used in the system for executing batch applications.

#5

When the cmx.websystem.name key is set up, and if you use the cmx_list_model command for acquiring all the registered Web system information models, specify the -all option.

To Page Top

(5) Examples of coding

cmx.connect.host=localhost:28080
cmx.connect.userid=admin
cmx.connect.passwd=p1574809
cmx.wait=true
#cmx.verbose=false
cmx.websystem.name=MyWebSystem
cmx.lb=deletevs

To Page Top

(6) Precautions

You must set appropriate access permissions for this file, because sensitive information, such as the user ID and password, is specified in the file.
To use non-ASCII characters, match the character encoding between the settings file and the OS locale during execution of commands provided by the Smart Composer functionality. Moreover, when using Japanese, do not specify character strings that include Unicode-encoded characters.
If a parameter is missing or invalid, the default value is assumed.
The settings (true and false) are not case sensitive.

To Page Top