cmx_export_model (Output an Easy Setup definition file)
- Organization of this page
Format
cmx_export_model [Common-arguments] [-indent indent-size] [-myhost host-name-to-be-replaced] [-encoding character-encoding-name] -o output-file
Function
This command outputs the Easy Setup definition file in accordance with the contents of a built Web system.
Arguments
- -indent indent-size
-
Specifies the indent size of the tags in the Easy Setup definition file. You specify the value within 0 to 8 as the single-byte space characters to be moved to the right, from the upper tags as the starting position of the lower tags.
- Output examples when -indent 4 is specified
<web-system> Δ Δ Δ Δ<name>MyWebSystem</name> Δ Δ Δ Δ<tier> Δ Δ Δ Δ Δ Δ Δ Δ<tier-type>combined-tier</tier-type> Δ Δ Δ Δ</tier> :
Legend
Δ: 1 single-byte space character
If you omit this option, the value set in the cmx.indent key of the .cmxrc file or the cmxclient.properties file is used. Note that if the cmx.indent key is not specified in the .cmxrc file and the cmxclient.properties file and if you execute the cmx_export_model command by omitting the -indent option, 2 is specified.
- -myhost host-name-to-be-replaced
-
Specifies the host name of Management Server machine for the Easy Setup definition file to be output.
You specify this option to migrate the host-based management model system to another host.
If you omit this option, the value set in the cmx.myhost key of the .cmxrc file or the cmxclient.properties file is used. Note that if the cmx.myhost key is not specified in the .cmxrc file and the cmxclient.properties file and if you execute the cmx_export_model command by omitting the -myhost option, the host name of Management Server machine will not set in the output Easy Setup definition file.
Note that this option is valid in the migration destination environment in the following cases:
-
An IP address matching with the IP address of Management Server machine in the migration destination environment or a host name that can be converted into an IP address matching with the IP address of Management Server machine in the migration destination environment is specified in <host-name> of the host definition.
-
The localhost or loopback address is specified in <host-name> of the host definition.
If you specify a host name that does not achieve the above conditions, the specification becomes invalid.
The specified value is the host name of Management Server machine in the migration destination environment or @myhost. The following is the description related to the substitution of the host name, when you specify the host name of Management Server machine in the migration destination environment and when you specify @myhost:
- When the host name of Management Server machine in the migration destination environment is specified
-
If you specify the host name of Management Server machine in the migration destination environment, the following tag values are substituted by the specified host name in the output Easy Setup definition file:
-
<host-name> tag in the host definition
-
<host-ref> tag in the unit definition
-
Host name of the parameter specified in the logical server configuration
-
- When @myhost is specified
-
If you specify @myhost, the following tag values are substituted by @myhost in the output Easy Setup definition file:
-
<host-ref> tag in the unit definition
-
Host name of the parameter specified in the logical server configuration
If you specify @myhost, the host definition is not output. However, when @myhost is specified, if you specify a value within the <display-name> tag, <description> tag, <agent-host> tag, or the <agent-port> tag in the host definition, the host definition is output.
-
-
- -encoding character-encoding-name
-
Specifies the character encoding for the Easy Setup definition file that is output. If the value is not specified, UTF-8 is set up.
You can set up the character encoding supported in JavaVM. For details on the character encoding supported in JavaVM, see the description related to the supported encoding in JDK documentation.
If you omit this option, the value set in the cmx.encoding key of the .cmxrc file or the cmxclient.properties file is used. Note that if the cmx.encoding key is not specified in the .cmxrc file and the cmxclient.properties file and if you execute the cmx_export_model command by omitting the -encoding option, UTF-8 will set up.
- -o output-file
-
Specifies the output destination of the Easy Setup definition file.
Input examples
Cosminexus-installation-directory\manager\bin\cmx_export_model -o c: \temp\MyWebSystemexport.xml
Output format
The cmx_export_model command will be output as the Easy Setup definition file in the XML file format. For examples of the Easy Setup definition file that is output, see 4.3 Easy Setup definition file in the uCosminexus Application Server Definition Reference Guide.