4.3.2 Contents specified in the Easy Setup definition file

Tag name

Describes the tag to be set.

Occurrence pattern

Indicates the occurrence frequency of the tag.

Contents

Indicates the contents defined in the key.

Specifiable value

Indicates the value that you can specify in the tag. Displays hyphen (-) when there is no value that you can specify.

Omitting tags

Indicates whether you can omit the key appearing in the definition format.

Omitting values

Indicates whether you can omit the value of the key appearing in the definition format.

Default

Indicates a valid specification value when the contents specified in the key are omitted. Displays "None" when a default value does not exist.

Version

Indicates the version of the Application Server that you can define.

<web-system>

0 or more times

Defines a Web system.

For defining the multiple Web systems, specify the <web-system> tag for each Web system.

--

None

07-00

<name>

Once

You must define this tag.

The <name> tag specifies a name for identifying the Web system.

Specify a string within 32 characters having alphanumeric characters or underscore (_) and hyphen (-).

None

06-50

<display-name>

0 or once

The <display-name> tag specifies a display name of a Web system.

There are no restrictions on the permitted characters.

Specify any string within 128 characters.

None

06-50

<description>

0 or once

The <description> tag specifies comments for a Web system.

There are no restrictions on the permitted characters.

Specify any string within 1024 characters.

None

06-50

<load-balancer>

0 or once

Defines a load balancer.

--

None

06-50

<name>

0 or once

Specifies name of the load balancer.

Specify a string within 32 characters having alphanumeric characters or underscore (_) and hyphen (-).

None

06-50

<load-balancer-type>

Once

Specifies one of the following as the type of load balancer:

The following strings can be specified:

• BIG-IPv9

• BIG-IPv10.1

• BIG-IPv10.2

• BIG-IPv11

• ACOS

None

06-50

<display-name>

0 or once

Specifies display name of the load balancer.

There are no restrictions on the permitted characters.

Specify any string within 128 characters.

None

06-50

<description>

0 or once

Specifies comments for the load balancer.

There are no restrictions on the permitted characters.

Specify any string within 1024 characters.

None

06-50

<cookie-switching>

0 or once

The <cookie-switching> tag is specified when using the cookie switching functionality of the load balancer.

--

None

06-51

<cookie-switching-enabled>

0 or once

The <cookie-switching-enabled> tag is specified when using the cookie switching functionality.

The following strings can be specified:

• true

• false

false

06-51

<cookie-name>

0 or once

Specifies cookie name by alphanumeric characters or underscore "_".

The following name is used by the Web container and is case sensitive:

• JSESSIONID

• In BIG-IP

  Secify a character string of 64 characters or less.

  Note that the 1^st character must be specified as an upper case or lower case character.

• For ACOS

  Specify a character string of 63 characters or less.

CMX_SERVER_ID

06-51

<server-id-rule>

0 or once

In version 08-53 or later versions, do not specify a value in this tag. If specified, the value is disabled.

--

None

06-51

<management-host>

Once

Specifies the management IP address or host name set up in the load balancer.

The following strings can be specified:

• Host name

• IPv4 address

None

07-50

<redundant-management-host>

Once

In a system with redundant load balancers, specifies the management IP address or host name set up in the second load balancer.

The following strings can be specified:

• Host name

• IPv4 address

None

07-50

<virtual-server>

Once

Defines a virtual server.

--

None

06-50

<virtual-server-name>

Once

Specifies the virtual server name.

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.

Specify a string within 31 characters using alphanumeric characters or underscore (_), period (.), and hyphen (-).

None

06-50

<display-name>

0 or once

Specifies the display name of the virtual server.

Specify any string within 128 characters.

None

06-50

<description>

0 or once

Specifies a comment about the virtual server.

Specify any string within 1024 characters.

None

06-50

<ip-address>

Once

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.

The following strings can be specified:

• Host name

• IPv4 address

None

06-50

<http-port>

Once

Specifies the HTTP port number of the virtual server, in the range from 1 to 65535.

Specify an integer from 1 to 65535.

None

06-50

<tier>

One or more times

You must define this tag.

Defines the physical tier.

--

None

06-50

<tier-type>

Once

You must define this tag.

Specifies the types of physical tiers.

The following strings can be specified:

• combined-tier

• http-tier

• j2ee-tier

• ctm-tier

• free-tier

None

06-50

<j2ee-server-count>

0 or once

Specifies the number of J2EE servers deployed on one host when ctm-tier is specified in the <tier-type> tag.

Specify an integer from 0 to 32.

1

07-10

<configuration>

0 or more times

Defines the configuration to be applied to all the logical servers in the physical tier for each type of logical server.

--

None

06-50

<logical-server-type>

Once

You must define this tag.

Specifies the types of logical servers for defining the configuration.

The following strings can be specified:

• web-server

• j2ee-server

• performance-tracer

• ctm-domain-manager

• component-transaction-monitor

• smart-agent

None

06-50

<server-no>

0 or once

Specifies the number for identifying the J2EE server when a common configuration is specified for specific J2EE servers within the physical tier.

Specify a unique number in the physical tier.

For 1 to the value specified for <j2ee-server-count>

None

07-10

<param>

One or more times

You must define this tag.

Defines the name and value of a parameter used for setting up the logical server environment.

--

None

06-50

<param-name>

Once

The <param-name> tag specifies the parameter name.

For details about specifiable values, see the description in 4.8 System configuration patterns and defined logical servers.

None

06-50

<param-value>

One or more times

The <param-value> tag specifies the value set for parameters.

For details about specifiable values, see the description in 4.8 System configuration patterns and defined logical servers.

None

06-50

<unit>

One or more times

You must define this tag.

Defines a service unit.

--

None

06-50

<name>

Once

You must define this tag.

The <name> tag specifies the name for identifying the service unit.

Specify a string within 32 characters using alphanumeric characters or underscore (_) and hyphen (-).

None

06-50

<display-name>

0 or once

The <display-name> tag specifies the display name of the service unit. There are no restrictions on the permitted characters.

Specify any string within 128 characters.

None

06-50

<description>

0 or once

The <description> tag specifies the comments for the service unit. There are no restrictions on the permitted characters.

Specify any string within 1024 characters.

None

06-50

<allocated-host>

One or more times

You must define this tag.

Defines the reference to the host that configures a service unit.

--

None

06-50

<host-ref>

Once

You must define this tag.

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.

The values that can be specified are as follows:

• Host name

• IPv4 address

• @myhost

None

06-50

<hosts-for>

Once

You must define this tag.

Specifies the type of physical tier to which the host specified in the <host-ref> tag belongs.

The following strings can be specified:

• combined-tier

• http-tier

• j2ee-tier

• ctm-tier

• free-tier

None

06-50

<define-server>

0 or more times

Defines the configuration for each logical server that belongs to the physical tier specified in the <hosts-for> tag.

--

None

07-00

<logical-server-name>

0 or once

The <logical-server-name> tag specifies the name for identifying a logical server or a cluster.

Specify a string within 128 characters using alphanumeric characters or underscore (_) and hyphen (-).

cmx_Web-system-name_service-unit-name_type_serial-number

07-00

<display-name>

0 or once

The <display-name> tag specifies the display name of the logical server. There are no restrictions on the permitted characters.

Specify any string within 128 characters.

None

07-00

<description>

0 or once

The <description> tag specifies the comments for a logical server. There are no restrictions on the permitted characters.

Specify any string within 1024 characters.

None

07-00

<logical-server-type>

Once

You must define this tag.

Specifies the types of logical servers for defining the configuration.

The following strings can be specified:

• web-server

• j2ee-server

• performance-tracer

• ctm-domain-manager

• component-transaction-monitor

• smart-agent

• naming-service

• user-server

None

07-00

<cluster-ref>

0 or once

Specifies the cluster name when setting up a logical server as a cluster member.

Specify a string within 128 characters using alphanumeric characters or underscore (_) and hyphen (-).

None

07-50

<server-no>

0 or once

Specifies the number for identifying the J2EE server when a configuration is specified for a specific J2EE server in the service unit. Specify a unique number on the host.

For 1 to the value specified for <j2ee-server-count>

None

07-10

<configuration>

0 or once

Defines the configuration to be applied for each logical server.

--

None

07-00

<param>

One or more times

You must define this tag.

Defines the name and value of a parameter used for setting up the logical server environment.

--

None

07-00

<param-name>

Once

The <param-name> tag specifies the parameter name.

For details about specifiable values, see the description in 4.8 System configuration patterns and defined logical servers.

None

07-00

<param-value>

One or more times

The <param-value> tag specifies the value set for parameters.

For details about specifiable values, see the description in 4.8 System configuration patterns and defined logical servers.

None

07-00

<host>

0 or more times

Defines a host.

--

None

06-50

<host-name>

Once

The <host-name> tag specifies a name or an IP address for identifying a host.

If the host is connected to multiple network segments and have multiple IP addresses, set either of the following items:

• IP address in the network used for communication between servers or between a load balancer and server

• Host name in the network used for communication between servers or between a load balancer and server

The following strings can be specified:

• Host name

• IPv4 address

• @myhost

None

07-50

<display-name>

0 or once

Specifies the display name of the host. There are no restrictions on the permitted characters.

Specify any string within 128 characters.

None

06-50

<description>

0 or once

Specifies a comment about the host within 1,024 characters. There are no restrictions on the permitted characters.

Specify any string within 1024 characters.

None

06-50

<agent-host>

0 or once

Specifies the host name, IP address, or @myhost of the Cosminexus Administration Agent.

If the host is connected to multiple network segments and have multiple IP addresses, set either of the following items:

• IP address in the network used for communication between Management Server and a server

• Host name in the network used for communication between Management Server and a server

The following strings can be specified:

• Host name

• IPv4 address

• @myhost

Value specified in host-name

07-50

<agent-port>

0 or once

The <agent-port> tag specifies a port number of the Cosminexus Administration Agent.

Specify an integer from 1 to 65535.

20295

06-50