Hitachi

uCosminexus Application Server Definition Reference Guide


4.10.2 Parameters used for setting up the definitions for the Web server

The following table describes the parameters used for setting up the definitions, for the Web server:

For details about the contents to be specified in param-value corresponding to "Value in param-name", see the description on the list of directives in the manual Cosminexus HTTP Server. In the table below, Default value means the value that is assumed when the parameter is not specified. VR is the version of Application Server on which parameters are introduced or changed.

Table 4‒8: Parameters used for setting up the definitions for the Web server

Value of param-name

Value of param-value

Specifiable value

Default value

VR

SetBy

Specifies how to set up the Web server.

item: Specified for each item.

text: The contents of httpsd.conf (Cosminexus HTTP Server definition file) are specified directly.

If you use a reverse proxy as the J2EE server linkage method (manager.web.send_request_method), do not specify text. If you want to directly specify the settings in configuration files, select the method that uses a redirector.

Even when you selected a redirector, you can use the following method to link via a reverse proxy:

  • For the SetBy parameter, specify text.

  • For the AllText parameter, specify the contents of the httpsd.conf file (Cosminexus HTTP Server definition file) that contains the reverse proxy settings.

For details about the reverse proxy settings, see 4.7 Setting the reverse proxy in the manual uCosminexus Application Server HTTP Server User Guide.

The following strings can be specified:

  • item

  • text

item

08-70

CoreDumpDirectory

Specifies the directory for dumping core. You can specify an absolute path or a relative path from the value specified in the ServerRoot directive. Note that the users and groups specified in the User and Group directives must be given write permission for the specified directory.

Note that this specified value is only enabled in UNIX.

Specify any string.

&{hws.home}/servers/HWS_server-name

06-50

Group

Specifies the group name used when server processes operate.

Note that this specified value is only enabled in UNIX.

Specify a string within 16 characters using alphanumeric characters and underscore (_).

bin

06-50

07-00

HWSKeepStartServers

Specifies whether to maintain the number of server processes at the number specified in the StartServers directive only.

If you specify On:

The running server processes are maintained at only the number specified in the StartServers directive. If the number of server processes becomes less than the value specified in the StartServers directive, new processes are generated.

  • prefork MPM

    This functionality is enabled when the value specified in each directive related to the process count has the following relationship:

    MinSpareServers < StartServers MaxClients

    and

    MinSpareServers < MaxSpareServers MaxClients

    If the value set in the StartServers directive is less than the value set in the MinSpareServers directive, the number of server processes is maintained at the value in the MinSpareServers directive.

  • worker MPM

    This functionality is enabled when the values specified for the directives related to the number of processes and number of threads have the following relationships:

    MinSpareThreads < StartServers × ThreadsPerChild MaxClients, and MinSpareThreads < MaxSpareThreads MaxClients

    If the value of the StartServers directive multiplied by the value of the ThreadsPerChild directive is smaller than the value specified for the MinSpareThreads directive, the number of server processes will be maintained according to the value specified for the MinSpareThreads directive.

If you specify Off:

The running server processes are not maintained at the number specified in the StartServers directive.

For details about the other directives related to the process count, see the manual Cosminexus HTTP Server.

Note that this specified value is only enabled in UNIX.

The following strings can be specified:

  • On

  • Off

Off

06-50

HWSLogTimeVerbose

Specifies whether an error log and a request log time, the time required for the request processing of the access log (%T), and the time at which request processing is started (%t) will be displayed in milliseconds.

If you specify On:

The time will be displayed up to milliseconds.

If you specify Off:

The time will be displayed up to milliseconds.

Note that an error log only includes the error log specified in the ErrorLog directive. The error log of the CGI script specified in the ScriptLog directive will not be considered.

The following strings can be specified:

  • On

  • Off

On

07-50

KeepAliveTimeout

Specifies the request waiting time for the KeepAlive connection in seconds. If a next request does not arrive from the client even after the lapse of time is greater than this time, the connection will be terminated. In KeepAlive, the server process is occupied with a specific client. If more time is required than the standard time for moving from a certain Web page to the next Web page, KeepAlive causes the timeout to occur, terminates the connection, and applies the server process to the processing of other requests.

For details about directives, see the manual Cosminexus HTTP Server.

Specify the value using an integer from 0 to 65535.

3

06-50

ServerName

Specifies the server name and port number of Cosminexus HTTP Server.

Specify the server name using FQDN (Fully Qualified Domain Name) or IP address.

For details on the contents specified, see the manual Cosminexus HTTP Server.

Server name and port number

www.example.com

08-70

Listen

Specifies an IP address and a port number that will receive a request. Unlike the Port directive, multiple values can be specified. You specify this tag for defining a virtual host. If you specify the Listen directive, the Port directive and the BindAddress directive will be ignored.

You can also specify IPv6 address as the IP address. When you specify IPv6 address, enclose the IPv6 address within square brackets ([ ]). However, if you omit the IP address and specify only the port number, only the requests using the IPv4 address will be received. Therefore, when using the IPv6 address, make sure that you specify the IPv6 address in the Listen directive.

The values that can be specified are as follows:

  • IPv4 address#3: Port number

  • Host name#3: Port number

  • @myhost: Port number

None

07-50

LogLevel

Specifies error levels to be output in an error log. The log of a level higher than the specified level will be output. However, the notice level log will be output regardless of this specification. Also, the messages, output before the level specification analysis ends such as when Cosminexus HTTP Server starts, might be output regardless of this specification.

The following are the error levels in their order of superiority:

  • emerg: Emergency message

  • alert: Prompt processing request message

  • crit: Critical status message

  • error: General error message

  • warn: Warning level message

  • notice: Standard but important message

  • info: Information message, trace of external module and CGI program runtime module#1

  • debug: Debug level message, internal module trace, and module trace corresponding to info#1

The following strings can be specified:

  • emerg

  • alert

  • crit

  • error

  • warn

  • notice

  • info

  • debug

info

06-50

MaxClients

Specifies the maximum number of clients that can be connected at the same time.

When the server starts, the number of processes specified in the StartServer directive start and wait for requests. If many requests are issued concurrently, multiple processes process the requests. If the number of processes waiting for the requests becomes less than the number specified in the MinSpareServers directive, new processes will be generated gradually. At this time, processes are generated until the process count reaches the number specified in this directive. After this, when the request processing ends and the processes waiting for requests increase, the processes will be terminated up to the number specified in the MaxSpareServers directive.

For details about the other directives related to the process count, see the manual Cosminexus HTTP Server.

Note that this specified value takes effect only in UNIX and when the value of the manager.web.send_request_method parameter is redirector.

Specify the value using an integer from 1 to 1024.

150

06-50

StartServers

Specifies the number of server processes used for starting the Web server. For details about the other directives related to the process count, see the manual Cosminexus HTTP Server.

Note that this specified value takes effect only in UNIX and when the value of the manager.web.send_request_method parameter is redirector.

Specify the value using an integer from 0 to 1024.

5

06-50

ThreadsPerChild

Specifies the number of threads to be started as the server. The specified thread count indicates the maximum number of concurrent connections of the server.

For details about directives, see the manual Cosminexus HTTP Server.

Note that this value is enabled only in Windows.

Specify the value using an integer from 1 to 1024.

50

06-50

User

Specifies the user name used when the server process is running.

Note that this specified value is only enabled in UNIX.

Specify a string within 16 characters using alphanumeric characters and underscore (_).

bin

06-50

07-00

DocumentRoot

Specifies an absolute path for the document root directory storing the contents.

For details about directives, see the manual Cosminexus HTTP Server.

Specify any string.

&amp;{hws.home}/htdocs

08-00

AppendDirectives

Specifies the directive contents to be added when a Web server is set up for each item (item is specified in the SetBy parameter).#2 You cannot use multibyte characters. For details about specifiable directives, see the manual HTTP Server.

Do not specify the PidFile directive as an additional directive. If you do so, the logical web server fails to start. The information specified for this parameter is output to a file generated by Management Server. Also note that the following Include directive is added at the end of the httpsd.conf file (HTTP Server definition file) by Management Server:

  • Include HTTP-Server-installation-directory/servers/HWS_logical-web-server's-real-server-name/conf/httpsd_manager.conf

Note that redundantly specified directives that must not be specified redundantly are also added to the preceding file.

Check the contents of the httpsd.conf file (HTTP Server definition file) and the httpsd_manager.conf file for redundantly specified directives that must not be specified redundantly. If there are such directives, modify the web server definition to eliminate the redundancy. For the directives that must not be specified redundantly, see the manual HTTP Server.

Specify any string.

None

08-70

AllText#4

Specifies the contents of httpsd.conf (Cosminexus HTTP Server definition file) when the Web server files are directly set up (text is specified in the SetBy parameter). #2 For details on httpsd.conf (Cosminexus HTTP Server definition file), see the manual Cosminexus HTTP Server.

Specify any string.

None

08-70

HWSPrfId

Specifies the character string that was specified as the PRF identifier when the PRF daemon was started. Note, however, that this specification is ignored if you use a redirector.

Specify a string that is 0 to 31 characters long and consists of alphanumeric characters and/or symbols.

Specifying a string that begins with CTM, ctm, TSC, or tsc results in an error. For symbols, only an underscore (_) can be used.

PRF identifier of the PRF daemon of the same service unit as this web server

11-00

MaxClients.worker

Specifies the maximum number of clients that can connect simultaneously (the MaxClients directive).

When a server starts, the number of processes specified by the StartServers directive start and wait for requests.

If many requests occur simultaneously, the requests are processed by using multiple threads. If the number of threads that remain waiting for requests becomes smaller than the number specified for the MinSpareThreads directive, new processes are generated. At this time, processes are generated until the number of threads reaches the number specified for this directive. Thereafter, when request processing finishes and the threads waiting for requests increase, processes are finished until the number of threads is at or below the number specified for the MaxSpareThreads directive.

For details about directives, see the manual Cosminexus HTTP Server.

Note that this specified value takes effect only in UNIX and when the value of the manager.web.send_request_method parameter is reverseproxy.

Specify an integer in the range from the value of ThreadsPerChild.worker to (1,000 × ThreadsPerChild.worker).

400

11-00

ThreadsPerChild.worker

Specifies the number of server threads that are generated with respect to a single server process (the ThreadsPerChild directive).

For details about directives, see the manual Cosminexus HTTP Server.

Note that this specified value takes effect only in UNIX and when the value of the manager.web.send_request_method parameter is reverseproxy.

Specify an integer in the range from 1 to 1,000.

40

11-00

StartServers.worker

Specifies the number of server processes when a Web server starts (the StartServers directive).

For details about directives, see the manual Cosminexus HTTP Server.

Note that this specified value takes effect only in UNIX and when the value of the manager.web.send_request_method parameter is reverseproxy.

Specify an integer from 0 to (MaxClients.worker ÷ ThreadsPerChild.worker).

2

11-00

#1

You can specify settings to output the module trace in the request log instead of the error log. For more details, see the manual Cosminexus HTTP Server.

#2

Specify the param-value value in the CDATA section.

(Example)

<param-name>AppendDirectives</param-name>

<param-value>

<![CDATA[

<Location /server-status>

:

</Location>

]]>

</param-value>

#3

When specifying an IPv4 address or host name, specify the value of the <host-name> tag in the host definition. If you specify a different value, a warning message (KEOS24186-W) might be output, and the settings might not be what you intend.

Host names are character strings of a maximum of 255 characters in length, and can consist of alphanumeric characters, underscores (_), periods (.), and hyphens (-).

Port numbers are halfwidth numeric character values from 1 to 65535.

#4

If you have built multiple logical Web servers, you need to specify a unique value for each logical Web server for the PidFile directive.