cmx_build_system (Build a Web system)

Organization of this page

Format
Function
Arguments
Input examples
Return values
Notes

Format

Building a Web system
- To build a Web system from the Easy Setup definition file
  
  cmx_build_system [Common-arguments] -f Easy-Setup-definition-file
  
  [-lb {keepvs|deletevs}][-sd]
- To build a Web system on the basis of the registered information model
  
  cmx_build_system [Common-arguments] [-s web-system-name]
  
  [-lb {keepvs|deletevs}]
- To build a system containing logical servers that are not associated with Web systems
  
  cmx_build_system [Common-arguments] -ns
Changing parameters of the built system
- To change parameters of the built system with the Easy Setup definition file
  
  cmx_build_system [Common-arguments] -f Easy-Setup-definition-file -change

Function

This command builds Web systems. Additionally, this command also changes parameters of the built system.

Building a Web system

This command builds a Web system in conformity with the registered Web system information model or the command generates a Web system information model in accordance with the Easy Setup definition file, and then builds the Web system as per the information model.

The cmx_build_system command sets up a Web server and a J2EE server for each host and the environment for each logical server. Additionally, this command also creates a virtual server and a real server as and when required in the load balancer.

The method of building Web systems differs when you build a Web system on the basis of the registered information model, when you build a Web system using the Easy Setup definition file or when you build a system containing the logical server that is not associated with the Web system.
- To build a Web system using the Easy Setup definition file
  
  This command builds a Web system information model according to the contents of the specified Easy Setup definition file. After that, this command builds a Web system according to the information model. You can build the Web system without registering the model using the cmx_build_model command in advance. The setting information of the logical server is distributed regardless of whether the setting information is distributed to the server of each host. If you want to distribute only the setting information of the logical server for which the setting information is not distributed, specify the -sd option and execute the command.
- To build a Web system on the basis of the registered information model
  
  This command builds a Web system according to the Web system information model registered using the cmx_build_model command or the cmx_change_model command.
- To build a system containing the logical server that is not associated with the Web system
  
  This command builds a system containing logical servers that are not associated with Web systems, according to the Web system information model that is registered using the cmx_build_model command or the cmx_change_model command.
Changing parameters of the built system

By specifying the -change option, you change parameters of the built system into the parameters defined in the Easy Setup definition file specified using the -f option.
- To change parameters of the built system by specifying the -change option
  
  Specify the Easy Setup definition file with the changed parameters in the -f option, and then you specify the -change option. The Web system information model is re-generated with the changed parameters as per the contents of the Easy Setup definition file specified in the -f option. Furthermore, the Web system is rebuilt on the basis of the information model. However, you cannot change the configuration.

When you build a Web system, if a logical server name is not defined in the Easy Setup definition file, the logical server name is defined on Management Server. Note that when you build the Web system according to the registered information model, the logical server name is defined when the cmx_build_model command is executed. The following are the rules for defining the logical server name on Management Server:

Rules for defining the logical server name

The logical server name is defined in the following format:

Format

cmx_web-System-name_Service-unit-name_Type_Serial-number

Type depends on the logical server type. The following table describes the relationship between the logical server type and type:

Table 8‒7: Relationship between the logical server type and type
Logical server type	Type
Logical Web server	HTTP
Logical J2EE server	J2EE
Logical performance tracer	PRF
Logical CTM domain manager	CTMDM
Logical CTM	CTM
Logical Smart Agent	SA
Logical user server	USER

Basically 01 is set as serial-number. However, when multiple logical servers are deployed such as the system that uses CTM, a unique number is assigned.

Real server name when ACOS is used

When using ACOS as the load balancer, the cmx_build_system command creates a real server with the following name as the real server showing the destination to which the load balancer distributes requests; therefore, make sure that you do not delete the real server by mistake:

Format

cmx_rs_IP-address-of-Web-server-machine

To Page Top

Arguments

-s web-system-name

Specifies the Web system name.

The specified Web system is built from the registered information model.

If you omit this option, the value that is set in the cmx.websystem.name key of the .cmxrc file or the cmxclient.properties file is 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_build_system command by omitting the -s option, an error occurs.

The -s option is invalid, when the -f option is specified.

-lb

This option is valid only when the type of load balancer used is BIG-IPv9, BIG-IPv10.1, and BIG-IPv10.2.

Specifies whether to initialize the virtual server of load balancer. Specify this option to scale out Web systems that use the load balancer built with the host-based management model.

keepvs

Initializes the virtual server of the load balancer. You specify this option, when multiple hosts share the virtual server of the load balancer.
deletevs

Initializes the virtual server of the load balancer.

If you omit this option, the value set in the cmx.lb key of the .cmxrc file or the cmxclient.properties file will be used. Note that if the cmx.lb key is not specified in the .cmxrc file and the cmxclient.properties file and if you omit the -lb option, deletevs is used. 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.

-sd

The setting information of only that logical server, for which the setting information is not distributed, is distributed to the server of each host. Set up this option when you do not want to distribute the setting information to the server of each host forcefully (overwrite).

-ns

You specify this option to build the system containing the logical server that is not associated with the Web system using the registered information model.

When you specify this option, you must use the cmx_build_model command to register the information model. For details on the cmx_build_model command, see cmx_build_model.

-change

You specify this option to change parameters.

This option re-generates the Web system information model according to the contents of the Easy Setup definition file that is specified in the -f option. This option also re-builds the Web system on the basis of the information model.

To Page Top

Input examples

To build a Web system using the Easy Setup definition file
```
cmx_build_system -f MyWebSystemDef.xml
```
To build a Web system on the basis of the registered information model
```
cmx_build_system -s sample-system
```
To build a system containing the logical server that is not associated with the Web system
```
cmx_build_system -ns
```
To change parameters of the built system using the Easy Setup definition file
```
cmx_build_system -f MyWebSystemDef2.xml -change
```

To Page Top

Return values

0:: The command terminated normally.
1:: The command terminated with a warning.
64:: The command terminated abnormally.

To Page Top

Notes

When you specify the -change option, note the following points:

If an attempt is made to make changes, apart from changing the parameters of the built Web system, an error occurs.
If the schema version of the Easy Setup definition file that is specified in the -f option is earlier than the schema version of the Easy Setup definition file that is used for building the system, operations might not function normally.
If the schema version of the Easy Setup definition file used for building the system is earlier than the version 2.1, you specify the <host-ref> tag for the host definition in the Easy Setup definition file that is specified with the -f option as follows:

Value specified for the <host-ref> tag

Value specified within the <operational-ip> tag of the host definition in the Easy Setup definition file used for building a system.

To Page Top