4.10.1 Tags that can be specified in the system for executing J2EE applications

This subsection describes the tags that can be specified in the system executing J2EE applications.

Organization of this subsection
(1) Definition of Web system attributes
(2) Definition of load balancer
(3) Definition of physical tier
(4) Definition of the service unit
(5) Definition of host

(1) Definition of Web system attributes

The following table describes the contents that can be defined as Web system attributes:

Tag namesContentsEasy Setup definition fileConfiguration definition change fileDefault
PU
web-systemDefines a Web system.
For defining the multiple Web systems, specify the <web-system> tag for each Web system.
O#1OO#2None
nameSpecifies a name for identifying the Web system, within 32 characters. This name must be unique within the management domain. Specify this name in the -s option of the Smart Composer functionality commands. The permitted name is a combination of alphanumeric characters, underscore (_), and hyphen (-).MMMNone
addition-modeSpecifies the addition mode.
  • DEPLOYED#3
    Specifies addition mode when scaling out the disk image using JP1/SC/DPM. If addition mode is specified, deployment of the J2EE application and resource adapter is not required during system construction.
  • NORMAL
    Specify this tag for a normal scale-out.
----ONORMAL
display-nameSpecifies the display name of the Web system within 128 characters. There are no restrictions on the permitted characters.OO--None
descriptionSpecifies a comment about the Web system within 1,024 characters. There are no restrictions on the permitted characters.OO--None
Legend:
P: Indicates the configuration definition change file, for changing logical server parameters.
U: Indicates the configuration definition change file, for adding a service unit or host.
M: Mandatory if a Web system is defined.
O: Optional.
--: Not applicable.
#1
This tag can be omitted if the Web system to be used is already defined using the Smart Composer functionality.
#2
This tag can be omitted if no service unit is to be added.
#3
For applying these settings, you must import and start the resource adapter in a batch using the Smart Composer functionality commands beforehand. For details, see 4.1.24 Starting the system (for CUI) in the uCosminexus Application Server System Setup and Operation Guide.

(2) Definition of load balancer

Define the load balancer under the <load-balancer> tag. The following table describes the contents that can be defined:

Tag namesContentsEasy Setup definition fileConfiguration definition change fileDefault
PU
load-balancerDefines a load balancer.
If the Smart Composer functionality is not used to set up the load balancer or to start and shut down the real server port, there is no need to define a load balancer (from the <load-balancer> tag through the </load-balancer> tag).
O----None
nameSpecifies a name for the load balancer, as a maximum of 32 characters. The permitted name is a combination of alphanumeric characters, underscore (_), and hyphen (-).O----None
load-balancer-typeSpecifies one of the following as the type of load balancer:
  • BIG-IPv9
  • BIG-IPv10.1
  • BIG-IPv10.2
  • BIG-IPv11
  • ACOS
Make sure that you specify this tag when you use the Smart Composer functionality to set up the load balancer.
M----None
display-nameSpecifies the display name of the load balancer, as a maximum of 128 characters. There are no restrictions on the permitted characters.O----None
descriptionSpecifies a comment about the load balancer, as a maximum of 1,024 characters. There are no restrictions on the permitted characters.O----None
cookie-switchingSpecifies that the cookie switching functionality is to be used.
This setting enables a series of HTTP requests to be processed by a single Web server or J2EE server.
O#----None
cookie-switching-enabledSpecifies true to use the cookie switching functionality and false to not use it.O----false
cookie-nameSpecifies the cookie name. The permitted characters are the combination of alphanumeric characters, the underscore (_), and the hyphen (-). The following name is used by the Web container and is case sensitive:
  • JSESSIONID

In BIG-IP 1500, specify a character string of 1 to 64 characters. Note that the 1st character must be specified as an upper case or lower case character.
In ACOS, specify a character string of 1 to 63 characters.
O----CMX_SERVER_ID
server-id-ruleIn version 08-53 or later versions, do not specify a value in this tag. If specified, the value is disabled.O----None
management-hostSpecifies the management IP address or host name set up in the load balancer. Specifies the management IP address in dot notations (xxx.xxx.xxx.xxx) where xxx is an integer in the range from 0 to 255. A host name can be a combination of alphanumeric characters, underscore (_), and hyphen (-).
If the same load balancer is between multiple Web systems, specify the same management IP address or host name in the Web systems sharing the load balancer.
M----None
redundant-management-hostIn a system with redundant load balancers, specifies the management IP address or host name set up in the second load balancer. Specifies the management IP address in dot notations (xxx.xxx.xxx.xxx) where xxx is an integer in the range from 0 to 255. A host name can be a combination of alphanumeric characters, underscore (_), and hyphen (-).
If the same load balancer is between multiple Web systems, specify the same management IP address or host name in the Web systems sharing the load balancer.
O----None
virtual-serverDefines a virtual server.M----None
virtual-server-nameSpecifies the name of the virtual server as from 1 to 31 characters. The permitted characters are the combination of alphanumeric characters, underscore (_), and hyphen (-).
If multiple Web systems are to share the same load balancer, make sure that the specified virtual server name is not duplicated among the sharing Web systems.
M----None
display-nameSpecifies the display name of the virtual server.O----None
descriptionSpecifies a comment about the virtual server.O----None
ip-addressSpecifies the IP address of the virtual server.
If multiple Web systems are to share the same load balancer, make sure that the virtual server's IP address is not duplicated among the sharing Web systems.
M----None
http-portSpecifies the HTTP port number of the virtual server, in the range from 1 to 65535.
For BIG-IP v9 or ACOS, if the same load balancer is shared between multiple Web systems, make sure that the HTTP port number of the virtual server is not repeated in the sharing Web systems.
M----None
Legend:
P: Indicates the configuration definition change file, for changing logical server parameters.
U: Indicates the configuration definition change file, for adding a service unit or host.
M: Mandatory if a load balancer is defined.
O: Optional.
--: Not applicable.
#
This tag can be omitted when the load balancer's cookie switching functionality is not used.

(3) Definition of physical tier

Define the physical tier according to the configuration of the built system. Define the physical tier under the <tier> tag. The following table describes the contents that can be defined:

Tag namesContentsEasy Setup definition fileConfiguration definition change fileDefault
PU
tierDefines the physical tier.
There are six types of physical tiers; combined-tier, http-tier, j2ee-tier, sfo-tier, ctm-tier and free-tier. Each physical tier combines single or multiple tiers to configure a Web system.
The specifiable physical tier configurations as follows:
  • combined-tier configuration
  • http-tier and j2ee-tier configuration
  • j2ee-tier configuration
  • Configuration in which the sfo-tier is combined with the combined-tier
  • Configuration in which the sfo-tier is combined with the http-tier and j2ee-tier
  • ctm-tier configuration
  • free-tier configuration
In the combined-tier configuration
Configure the Web server and J2EE server included in the service unit on one host, and define them in one <tier> tag.
In the http-tier and j2ee-tier configuration
Configure the Web server and J2EE server included in the service unit on different hosts, and define them in two <tier> tags.
In the j2ee-tier configuration
Configure the J2EE server included in the service unit on one host, and define in one <tier> tag. When using the j2ee-tier configuration, the in-process HTTP server functionality must be enabled.
For sfo-tier to be configured with the combination of combined-tier or http-tier and j2ee-tier
Configure the session failover server (SFO server) included in the service unit on one host, and define in one <tier> tag.
In the ctm-tier configuration
The ctm-tier defines tags in a Web system different from the Web system defining the combined-tier, http-tier, j2ee-tier, and sfo-tier. The ctm-tier defines tags separately for the integrated naming scheduler server and for CTM.
  • Web system for the integrated naming scheduler server
    Configures the CTM-related logical server#1 included in the service unit on one host, and define in one <tier> tag.
  • Web system for CTM
    Configures the CTM-related logical server#1 and J2EE server included in the service unit on one host, and define in one <tier> tag.
In the free-tier configuration
A configuration that does not match the definition of any other physical tier is defined as 1 tier tag.
MO#2--None
tier-typeSpecifies one of the following as the type of physical tier:
  • combined-tier
  • http-tier
  • j2ee-tier
  • sfo-tier
  • ctm-tier
  • free-tier
MM--None
j2ee-server-countSpecifies the number of J2EE servers to be deployed on one host, when ctm-tier is specified in the <tier-type> tag, as an integer in the range from 0 to 32.
  • In the Web system for the integrated naming scheduler server
    Specify 0.
  • Web system for CTM
    Specifies the number of J2EE servers to be deployed in one host for each Web system.
Note that when the configuration of the Web system is changed, the number of J2EE servers cannot be changed.
O----1
configurationDefines the configuration to be applied to all the logical servers in the physical tier for each type of logical server. For example, to define two configurations, such as Web server and J2EE server, use two <configuration> tags for definition, one for defining the Web server and the other for defining the J2EE server.O#3M#4--None
logical-server-typeSpecifies the types of logical servers for defining the configuration. The following are the specifiable types the logical servers:
  • web-server:Web server
  • j2ee-server:J2EE server
  • sfo-server:Session failover server (SFO server)
  • performance-tracer:Performance tracer
  • ctm-domain-manager:CTM domain manager
  • component-transaction-monitor:CTM
  • smart-agent:Smart Agent
The logical server that can define the configuration varies according to the physical tier type.
In combined-tier
Web server, J2EE server, and performance tracer
In http-tier
Web server and performance tracer
In j2ee-tier
J2EE server and performance tracer
In sfo-tier
Session failover server (SFO server) and performance tracer
In ctm-tier
The logical servers that can be defined are different for each Web system.
  • In the Web system for the integrated naming scheduler server
    CTM domain manager, CTM, Smart Agent, and the performance tracer
  • Web system for CTM
    CTM domain manager, CTM, Smart Agent, J2EE server, and performance tracer
MM--None
server-noSpecifies the number for identifying the J2EE server when a common configuration is specified for specific J2EE servers within the physical tier. The specifiable range is from 1 to the value specified in <j2ee-server-count>. Specify a unique number in the physical tier. You can only specify this tag when ctm-tier is specified in the <tier-type> tag, and when the <j2ee-server-count> tag is specified.
This tag must not be specified if a common configuration is to be specified for all the J2EE servers within the physical tier.
OO--None
param#5Defines the name and value of a parameter used for setting up the logical server environment. Enclose one parameter in each <param> tag.MM--None
param-name#5Specifies the name of the parameter used for setting up the environment for the logical server.MM--None
param-value#5Specifies the value to be set up in the parameter specified in the <param-name> tag. For specifying the multiple values in a parameter, specify the <param-value> tag for each value.MO#6--None
Legend:
P: Indicates the configuration definition change file, for changing logical server parameters.
U: Indicates the configuration definition change file, for adding a service unit or host.
M: Mandatory if a Web system is defined.
O: Optional.
--: Not applicable.
Note:
In a physical tier definition, you cannot specify the logical server configuration included in the user server and free-tier configuration. Specify these logical server configurations using unit definitions.
#1
The CTM-related logical server has the CTM domain manager, CTM, and Smart Agent.
#2
This tag can be omitted if the physical tier definition is not changed.
#3
This tag can be omitted if the environment settings assumed in the Management Server during creation of the logical server are used for operations.
#4
This tag can be omitted if the cmx_trans_param command is used for expanding the abstract parameter to create the physical tier configuration.
#5
The parameters specifiable in the <param> tag depend on the logical server type. Additionally, the logical server to be defined depends on the configuration pattern of the system. For checking the logical servers to be defined, see 4.11 System configuration patterns and defined logical servers. For details on the parameters that can be specified in each logical server, see the sections from 4.12 onwards as per the type of logical server used.
#6
This tag can be omitted if the parameter specified in the <param-name> tag is to be deleted.

(4) Definition of the service unit

Define the service unit under the <unit> tag. The following table describes the contents that can be defined:

Tag namesContentsEasy Setup definition fileConfiguration definition change fileDefault
PU
unitDefines a service unit.
For defining the multiple service units, specify the <unit> tag for each service unit to be defined.
MO#1MNone
nameSpecifies a name for identifying the service unit, as a maximum of 32 characters. This name must be unique within the Web system. Specify this name in the -unit option of the Smart Composer functionality commands. The permitted name is a combination of alphanumeric characters, underscore (_), and hyphen (-).MO#2MNone
display-nameSpecifies the display name of the service unit within 128 characters. There are no restrictions on the permitted characters.OOONone
descriptionSpecifies a comment about the service unit within 1,024 characters. There are no restrictions on the permitted characters.OOONone
allocated-hostDefines the reference to the host that configures a service unit. Specify only one <allocated-host> tag. You can specify multiple <allocated-host> tags in a Web system with free-tier configuration.MMMNone
host-refSpecifies the host name specified in the <name> tag in the host definition, the host name defined in the already setup Web system, or @myhost.
When specifying @myhost, the value in the <host-name> tag in the host definition is automatically set up during the system setup.
If there are multiple hosts, the same host cannot be shared in the same service unit.
MMMNone
hosts-forSpecifies one of the following values as the type of physical tier to which the host specified in the <host-ref> tag belongs:
  • combined-tier
  • http-tier
  • j2ee-tier
  • sfo-tier
  • ctm-tier
  • free-tier
MMMNone
define-serverDefines the configuration for each logical server that belongs to the physical tier specified in the <hosts-for> tag. For example, if http-tier is specified in the <hosts-for> tag, you can define one logical server for each of the Web server and the performance tracer. For defining multiple logical servers, specify the <define-server> tag for each logical server.O#3MO#3None
logical-server-nameSpecifies a name for identifying the logical server or cluster within 128 characters. Specify this name in the -s option of the Smart Composer functionality commands. The permitted name is a combination of alphanumeric characters, underscore (_), and hyphen (-).O--Ocmx_Web-system-name_service-unit-name_type_serial-number
display-nameSpecifies the display name of the logical server within 128 characters. There are no restrictions on the permitted characters.OOONone
descriptionSpecifies a comment about the logical server within 1,024 characters. There are no restrictions on the permitted characters.OOONone
logical-server-typeSpecifies the types of logical servers for defining the configuration. The following are the specifiable types the logical servers:
  • web-server:Web server
  • j2ee-server:J2EE server
  • sfo-server:Session failover server (SFO server)
  • performance-tracer:Performance tracer
  • ctm-domain-manager:CTM domain manager
  • component-transaction-monitor:CTM
  • smart-agent:Smart Agent
  • naming-service:Naming service
  • user-server:User server
MMMNone

The logical server that can define the configuration of the host varies according to the physical tier type.
In combined-tier
Web server, J2EE server, performance tracer, and user server
In http-tier
Web server, performance tracer, and user server
In j2ee-tier
J2EE server, performance tracer, and user server
In sfo-tier
Session failover server (SFO server), performance tracer, and user server
In ctm-tier
The logical servers that can be defined are different for each Web system.
  • In the Web system for the integrated naming scheduler server
    CTM domain manager, CTM, Smart Agent, performance tracer, and user server
  • Web system for CTM
    CTM domain manager, CTM, Smart Agent, J2EE server, performance tracer, and user server
In free-tier
Web server, J2EE server, session failover server (SFO server), CTM domain manager, CTM, Smart Agent, Naming Service, performance tracer, Web server cluster, J2EE server cluster, and user server

cluster-refSpecifies the cluster name when setting up a logical server as a cluster member.
If the logical server to be set up as a cluster member is the J2EE server, this tag specifies the J2EE server cluster name, and for the Web server this tag specifies the Web server cluster name.
Logical servers other than the J2EE server and Web server cannot be set up as a cluster member.
This tag is defined only for the free-tier configuration.
O----None
server-noSpecifies the number for identifying the J2EE server when a configuration is specified for a specific J2EE server in the service unit. The specifiable range is from 1 to the value specified in <j2ee-server-count>. Specify a unique number on the host. Make sure that you specify this tag when specifying the J2EE server configuration when <j2ee-server-count> tag is specified in the physical tier definition.OOONone
configurationDefines the configuration to be applied for each logical server.
If the environment settings defined in the physical tier definition are to be used for operation, there is no need to define the<configuration> tag.
This tag cannot be specified when J2EE server cluster or Web server cluster is specified in <logical-server-type>.
OOONone
param#4Defines the name and value of a parameter used for setting up the logical server environment. Enclose one parameter in each <param> tag.MMMNone
param-name#4Specifies the name of the parameter used for setting up the environment for the logical server. For the specifiable parameter names, see 4.11 System configuration patterns and defined logical servers.MMMNone
param-value#4Specifies the value to be set up in the parameter specified in the <param-name> tag. For specifying the multiple values in a parameter, specify the <param-value> tag for each value. For details on the parameter settings, see 4.11 System configuration patterns and defined logical servers.MO#5MNone
Legend:
P: Indicates the configuration definition change file, for changing logical server parameters.
U: Indicates the configuration definition change file, for adding a service unit or host.
M: Mandatory if a Web system is defined.
O: Optional.
--: Not applicable.
Note:
You cannot set up the logical server configuration included in the free-tier configuration, in the configuration change definition file.
#1
This tag can be omitted if the service unit definition is not changed.
#2
Can be omitted when cmx.websystem.name is specified in the client setting properties file or common client setting properties file.
#3
This tag can be omitted if the configuration is not defined for each logical server.
#4
The parameters specifiable in the <param> tag depend on the logical server type. Additionally, the logical server to be defined depends on the configuration pattern of the system. For checking the logical servers to be defined, see 4.11 System configuration patterns and defined logical servers. For details on the parameters that can be specified in each logical server, see the sections from 4.12 onwards as per the type of logical server used.
#5
This tag can be omitted if the parameter specified in the <param-name> tag is to be deleted.

(5) Definition of host

Define the information about the host to be used under the <host> tag. The following table describes the contents that can be defined:

Tag namesContentsEasy Setup definition fileConfiguration definition change fileDefault
PU
hostDefines a host.
For defining multiple hosts, specify the host tag for each host. A host can be shared among multiple Web systems.
O#1--O#2None
host-nameSpecifies a name or IP address for identifying the host within 32 characters.
A host name can be a combination of alphanumeric characters, underscore (_), and hyphen (-). Specifies the management IP address in dot notations (xxx.xxx.xxx.xxx) where xxx is an integer in the range from 0 to 255.
When specifying the host name for which the IP address cannot be changed, an error occurs during the system setup.
You can also specify @myhost in the <host-name> tag. If you specify @myhost, the host name is automatically replaced with the host name for the management server machine in the destination environment during system setup.
M--MNone
display-nameSpecifies the host display name within 128 characters. There are no restrictions on the permitted characters.O--ONone
descriptionSpecifies a comment about the host within 1,024 characters. There are no restrictions on the permitted characters.O--ONone
agent-hostSpecifies the host name or IP address of the Cosminexus Administration Agent. Specifies the host name within 32 characters. The permitted name is a combination of alphanumeric characters, underscore (_), and hyphen (-). Specifies the IP address in dot notations (xxx.xxx.xxx.xxx) where xxx is an integer in the range from 0 to 255.
You can also specify @myhost in the <agent-host> tag. When specifying @myhost, the value in the <host-name> tag in the host definition is automatically set up during the system setup.
O--OValue specified in host-name
agent-portSpecifies the port number of the Cosminexus Administration Agent, in the range from 1 to 65535.O--O20295
Legend:
P: Indicates the configuration definition change file, for changing logical server parameters.
U: Indicates the configuration definition change file, for adding a service unit or host.
M: Mandatory if a host is defined.
O: Optional.
--: Not applicable.
Note:
The host definition is not output when @myhost is specified in the <host-ref> tag in the unit definition, and the values in the <display-name> tag, <description> tag, <agent-host> tag, or <agent-port> tag in the host definition are omitted. In such a case, the Management Server automatically generates a value in the <host-name> tag of the host definition, as and when required. The host name is the computer name automatically created in the Management Server in Windows, and is the host name set up using the hostname command in UNIX. If the host does not contain any logical servers, the Management Server automatically deletes that host.
#1
This tag can be omitted if the host to be used is already defined using the Smart Composer functionality.
#2
This tag can be omitted if the host definition is not changed.