![[Contents]](FIGURE/CONTENT.GIF)
uCosminexus Application Server, Definition Reference Guide
![[Index]](FIGURE/INDEX.GIF)
![[Back]](FIGURE/FRONT.GIF)
![[Next]](FIGURE/AFTER.GIF)
This subsection describes the tags that can be specified in the system executing J2EE applications.
The following table describes the contents that can be defined as Web system attributes:
| Tag names | Contents | Easy Setup definition file | Configuration definition change file | Default | |
|---|---|---|---|---|---|
| P | U | ||||
| web-system | Defines a Web system. For defining the multiple Web systems, specify the <web-system> tag for each Web system. |
O#1 | O | O#2 | None |
| name | Specifies 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 (-). | M | M | M | None |
| addition-mode | Specifies the addition mode.
|
-- | -- | O | NORMAL |
| display-name | Specifies the display name of the Web system within 128 characters. There are no restrictions on the permitted characters. | O | O | -- | None |
| description | Specifies a comment about the Web system within 1,024 characters. There are no restrictions on the permitted characters. | O | O | -- | None |
Define the load balancer under the <load-balancer> tag. The following table describes the contents that can be defined:
| Tag names | Contents | Easy Setup definition file | Configuration definition change file | Default | |
|---|---|---|---|---|---|
| P | U | ||||
| load-balancer | Defines 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 |
| name | Specifies 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-type | Specifies one of the following as the type of load balancer:
|
M | -- | -- | None |
| display-name | Specifies the display name of the load balancer, as a maximum of 128 characters. There are no restrictions on the permitted characters. | O | -- | -- | None |
| description | Specifies a comment about the load balancer, as a maximum of 1,024 characters. There are no restrictions on the permitted characters. | O | -- | -- | None |
| cookie-switching | Specifies 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-enabled | Specifies true to use the cookie switching functionality and false to not use it. | O | -- | -- | false |
| cookie-name | Specifies 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:
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-rule | In version 08-53 or later versions, do not specify a value in this tag. If specified, the value is disabled. | O | -- | -- | None |
| management-host | Specifies 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-host | In 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-server | Defines a virtual server. | M | -- | -- | None |
| virtual-server-name | Specifies 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-name | Specifies the display name of the virtual server. | O | -- | -- | None |
| description | Specifies a comment about the virtual server. | O | -- | -- | None |
| ip-address | Specifies 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-port | Specifies 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 |
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 names | Contents | Easy Setup definition file | Configuration definition change file | Default | |
|---|---|---|---|---|---|
| P | U | ||||
| tier | Defines 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:
|
M | O#2 | -- | None |
| tier-type | Specifies one of the following as the type of physical tier:
|
M | M | -- | None |
| j2ee-server-count | Specifies 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.
|
O | -- | -- | 1 |
| configuration | Defines 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#3 | M#4 | -- | None |
| logical-server-type | Specifies the types of logical servers for defining the configuration. The following are the specifiable types the logical servers:
|
M | M | -- | None |
| server-no | Specifies 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. |
O | O | -- | None |
| param#5 | Defines the name and value of a parameter used for setting up the logical server environment. Enclose one parameter in each <param> tag. | M | M | -- | None |
| param-name#5 | Specifies the name of the parameter used for setting up the environment for the logical server. | M | M | -- | None |
| param-value#5 | Specifies 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. | M | O#6 | -- | None |
Define the service unit under the <unit> tag. The following table describes the contents that can be defined:
| Tag names | Contents | Easy Setup definition file | Configuration definition change file | Default | |
|---|---|---|---|---|---|
| P | U | ||||
| unit | Defines a service unit. For defining the multiple service units, specify the <unit> tag for each service unit to be defined. |
M | O#1 | M | None |
| name | Specifies 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 (-). | M | O#2 | M | None |
| display-name | Specifies the display name of the service unit within 128 characters. There are no restrictions on the permitted characters. | O | O | O | None |
| description | Specifies a comment about the service unit within 1,024 characters. There are no restrictions on the permitted characters. | O | O | O | None |
| allocated-host | Defines 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. | M | M | M | None |
| host-ref | Specifies 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. |
M | M | M | None |
| hosts-for | Specifies one of the following values as the type of physical tier to which the host specified in the <host-ref> tag belongs:
|
M | M | M | None |
| define-server | Defines 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#3 | M | O#3 | None |
| logical-server-name | Specifies 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 | -- | O | cmx_Web-system-name_service-unit-name_type_serial-number |
| display-name | Specifies the display name of the logical server within 128 characters. There are no restrictions on the permitted characters. | O | O | O | None |
| description | Specifies a comment about the logical server within 1,024 characters. There are no restrictions on the permitted characters. | O | O | O | None |
| logical-server-type | Specifies the types of logical servers for defining the configuration. The following are the specifiable types the logical servers:
|
M | M | M | None |
The logical server that can define the configuration of the host varies according to the physical tier type.
|
|||||
| cluster-ref | Specifies 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-no | Specifies 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. | O | O | O | None |
| configuration | Defines 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>. |
O | O | O | None |
| param#4 | Defines the name and value of a parameter used for setting up the logical server environment. Enclose one parameter in each <param> tag. | M | M | M | None |
| param-name#4 | Specifies 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. | M | M | M | None |
| param-value#4 | Specifies 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. | M | O#5 | M | None |
Define the information about the host to be used under the <host> tag. The following table describes the contents that can be defined:
| Tag names | Contents | Easy Setup definition file | Configuration definition change file | Default | |
|---|---|---|---|---|---|
| P | U | ||||
| host | Defines 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#2 | None |
| host-name | Specifies 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 | -- | M | None |
| display-name | Specifies the host display name within 128 characters. There are no restrictions on the permitted characters. | O | -- | O | None |
| description | Specifies a comment about the host within 1,024 characters. There are no restrictions on the permitted characters. | O | -- | O | None |
| agent-host | Specifies 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 | -- | O | Value specified in host-name |
| agent-port | Specifies the port number of the Cosminexus Administration Agent, in the range from 1 to 65535. | O | -- | O | 20295 |
All Rights Reserved. Copyright (C) 2012, 2015, Hitachi, Ltd.