pluginConfiguration - Web Server Plugin (pluginConfiguration)

Properties used when generating the web server plugin configuration file

NameTypeDefaultDescription
pluginInstallRootstring/opt/IBM/WebSphere/PluginsWeb server plugin installation location in file system of web server host
webserverNamestringwebserver1Name of the web server where this configuration will be used. Used to generate the plugin log file location if that is not specified explicitly by Log file name or directory.
webserverPortint
Min: -1

Max: 65535
80Web server HTTP port
webserverSecurePortint
Min: -1

Max: 65535
443Web server HTTPS port
sslKeyringLocationstring${pluginInstallRoot}/config/${webserverName}/plugin-key.kdbThe fully qualified path to the SSL keyring file on the web server host
sslStashfileLocationstring${pluginInstallRoot}/config/${webserverName}/plugin-key.sthThe fully qualified path to the SSL stashfile on the web server host
sslCertlabelstringSpecifies the label of the certificate within the keyring that the plug-in is to use when the web container requests a client certificate from the plug-in.
ipv6PreferredbooleanfalseUsed when resolving an application server host name of {null} or {0}, to prefer the type of address when possible
httpEndpointRefA reference to top level httpEndpoint element (string).defaultHttpEndpointSpecify the identifier of the http endpoint to include in the generated plugin-cfg.xml file. The endpoint defines the server in the cluster. The default value is 'defaultHttpEndpoint'.
connectTimeoutA period of time with second precision5sIdentifies the maximum amount of time that the application server should maintain a connection with the web server. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
serverIOTimeoutA period of time with second precision900sIdentifies the maximum amount of time that the web server plugin waits to send a request or receive a response from the application server. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
wsServerIOTimeoutA period of time with second precisionIdentifies the maximum amount of time that the web server plugin waits to send a request or receive a websocket response from the application server. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
wsServerIdleTimeoutA period of time with second precisionIdentifies the maximum amount of time that the web server plugin waits to terminate an idle websocket connection. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
extendedHandshakebooleanfalseIf true, the web server plugin uses an extended handshake to determine if the application server is running.
waitForContinuebooleanfalseIf false (the default value), the web server plugin sends the "Expect: 100-continue" header with HTTP requests that have a message body. When set to true, the web server plugin sends the "Expect: 100-continue" header with every HTTP request. Consider setting this value to true if you have a firewall between the web server and the application server, and are sensitive to requests retries with no request body.
logFileNamePath to a fileA fully qualified path to to the web server plug-in log file. Directory component must already exist. For Apache-based web servers, a path that begins with a pipe character is interpreted as an external piped logger. If specified, the path overrides logDirLocation.
logDirLocationPath to a directory${pluginInstallRoot}/logs/${webserverName}Deprecated: Identifies the directory where the http_plugin.log file is located. See Log file name.
serverIOTimeoutRetryint
Min: -1

Max: 65535
-1Limits the number of request retries after a read or write timeout. The default value, {-1}, applies no additional limits, so retries are limited by the number of available servers in the cluster. A {0} value indicates there should be no retries. This value is scoped to the server cluster and does not apply to connection failures or timeouts due to the HTTP plug-in Connection timeout, or to web socket timeouts.
loadBalanceWeightint20This value is dynamically changed during run time. The weight of a server is lowered each time a request is assigned to that server. When all weights for all servers drop to 0 or a lesser value, the web server plug-in readjusts all the weights so that they are greater than 0.
serverRole
  • PRIMARY
  • BACKUP
PRIMARYThe server role identifies a server as primary or backup. When primary servers are available, the web server plug-in uses them for load balance and failover. However, if none of the primary servers are available, the web server plug-in uses only backup servers for load balance and failover.
PRIMARY
Primary
BACKUP
Backup

httpEndpoint

Specify the identifier of the http endpoint to include in the generated plugin-cfg.xml file. The endpoint defines the server in the cluster. The default value is 'defaultHttpEndpoint'.

NameTypeDefaultDescription
onError
  • IGNORE
  • FAIL
  • WARN
WARNAction to take after a failure to start an endpoint.
IGNORE
Server will not issue any warning and error messages when it incurs a configuration error.
FAIL
Server will issue a warning or error message on the first error occurrence and then stop the server.
WARN
Server will issue warning and error messages when it incurs a configuration error.
enabledbooleantrueToggle the availability of an endpoint. When true, this endpoint will be activated by the dispatcher to handle HTTP requests.
hoststringlocalhostIP address, domain name server (DNS) host name with domain name suffix, or just the DNS host name, used by a client to request a resource. Use '*' for all available network interfaces.
httpPortint
Min: -1

Max: 65535
The port used for client HTTP requests. Use -1 to disable this port.
httpsPortint
Min: -1

Max: 65535
The port used for client HTTP requests secured with SSL (https). Use -1 to disable this port.
httpOptionsRefA reference to top level httpOptions element (string).defaultHttpOptionsHTTP protocol options for the endpoint.
sslOptionsRefA reference to top level sslOptions element (string).SSL protocol options for the endpoint.
tcpOptionsRefA reference to top level tcpOptions element (string).defaultTCPOptionsTCP protocol options for the endpoint.
accessLoggingRefA reference to top level httpAccessLogging element (string).HTTP access logging configuration for the endpoint.

httpEndpoint > httpOptions

HTTP protocol options for the endpoint.

NameTypeDefaultDescription
keepAliveEnabledbooleantrueEnables persistent connections (HTTP keepalive). If true, connections are kept alive for reuse by multiple sequential requests and responses. If false, connections are closed after the response is sent.
maxKeepAliveRequestsint
Min: -1
100Maximum number of persistent requests that are allowed on a single HTTP connection if persistent connections are enabled. A value of -1 means unlimited.
persistTimeoutA period of time with second precision30sAmount of time that a socket will be allowed to remain idle between requests. This setting only applies if persistent connections are enabled. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
readTimeoutA period of time with second precision60sAmount of time to wait for a read request to complete on a socket after the first read occurs. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
writeTimeoutA period of time with second precision60sAmount of time to wait on a socket for each portion of the response data to be transmitted. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
removeServerHeaderbooleanfalseRemoves server implementation information from HTTP headers and also disables the default Liberty profile welcome page.

httpEndpoint > sslOptions

SSL protocol options for the endpoint.

NameTypeDefaultDescription
sessionTimeoutA period of time with second precision1dAmount of time to wait for a read or write request to complete on a socket. This value is overridden by protocol-specific timeouts. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
suppressHandshakeErrorsbooleanfalseDisable logging of SSL handshake errors. SSL handshake errors can occur during normal operation, however these messages can be useful when SSL is behaving unexpectedly.
sslRefA reference to top level ssl element (string).The default SSL configuration repertoire. The default value is defaultSSLSettings.
sslSessionTimeoutA period of time with millisecond precision8640msThe timeout limit for an SSL session that is established by the SSL Channel. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

httpEndpoint > tcpOptions

TCP protocol options for the endpoint.

NameTypeDefaultDescription
inactivityTimeoutA period of time with millisecond precision60sAmount of time to wait for a read or write request to complete on a socket. This value is overridden by protocol-specific timeouts. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
soReuseAddrbooleantrueEnables immediate rebind to a port with no active listener.

httpEndpoint > accessLogging

HTTP access logging configuration for the endpoint.

NameTypeDefaultDescription
enabledbooleantrueEnable access logging.
filePathPath to a file${server.output.dir}/logs/http_access.logDirectory path and name of the access log file. Standard variable substitutions, such as ${server.output.dir}, can be used when specifying the directory path.
logFormatstring%h %u %{t}W "%r" %s %bSpecifies the log format that is used when logging client access information.
maxFileSizeint
Min: 0
20Maximum size of a log file, in megabytes, before being rolled over; a value of 0 means no limit.
maxFilesint
Min: 0
2Maximum number of log files that will be kept, before the oldest file is removed; a value of 0 means no limit.

extraConfigProperties

Additional properties to be added to the Config element in the generated plug-in configuration file. These properties can be specified by IBM support to modify behavior of the web server plug-in.