Web Server Plugin (pluginConfiguration)

Properties used when generating the web server plugin configuration file

NameTypeDefaultDescription

ESIEnable

boolean

true

ESIEnable property enables Edge Side Include processing to cache the responses. This property provides the option to disable ESI in the web server plugin configuration file.

ESIEnableToPassCookies

boolean

false

ESIEnableToPassCookies allows forwarding of session cookies to WebSphere Application Server. This property provides the option to override the value in the web server plugin configuration file.

ESIInvalidationMonitor

boolean

false

ESIInvalidationMonitor specifies if the ESI processor should receive invalidations from the application server. This property provides the option to override the value in the web server plugin configuration file.

ESIMaxCacheSize

int

1024

ESIMaxCacheSize is the maximum size of the cache which defaults to 1MB. This property provides the option to override the value in the web server plugin configuration file.

connectTimeout

A period of time with second precision

5s

Identifies 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.

httpEndpointRef

A reference to top level httpEndpoint element (string).

defaultHttpEndpoint

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'.

ignoreAffinityRequests

boolean

true

Indicates whether the webserver plug-in ignores affinity requests when it is tracking runtime weight for round-robin load balancing.

ipv6Preferred

boolean

false

Used when resolving an application server host name of {null} or {0}, to prefer the type of address when possible

loadBalanceWeight

int

20

This 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.

logDirLocation

Path to a directory

${pluginInstallRoot}/logs/${webserverName}

Deprecated: Identifies the directory where the http_plugin.log file is located. See Log file name.

logFileName

Path to a file

A 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.

pluginInstallRoot

string

/opt/IBM/WebSphere/Plugins

Web server plugin installation location in file system of web server host

serverIOTimeout

A period of time with second precision

900s

Identifies 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.

serverIOTimeoutRetry

int
Min: -1
Max: 65535

-1

Limits 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.

serverRole

  • BACKUP

  • PRIMARY

PRIMARY

The 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.

sslCertlabel

string

Specifies 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.

sslKeyringLocation

string

${pluginInstallRoot}/config/${webserverName}/plugin-key.kdb

The fully qualified path to the SSL keyring file on the web server host

sslStashfileLocation

string

${pluginInstallRoot}/config/${webserverName}/plugin-key.sth

The fully qualified path to the SSL stashfile on the web server host

trustedProxyEnable

boolean

Enables trusted proxies to be used. When specified, this property overrides the value in the web server plug-in configuration file.

trustedProxyGroup

string

A comma-separated list of trusted proxies. When specified, this property overrides the value in the web server plug-in configuration file.

waitForContinue

boolean

false

If 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.

webserverName

string

webserver1

Name 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.

webserverPort

int
Min: -1
Max: 65535

80

Web server HTTP port

webserverSecurePort

int
Min: -1
Max: 65535

443

Web server HTTPS port

wsServerIOTimeout

A period of time with second precision

Identifies 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.

wsServerIdleTimeout

A period of time with second precision

Identifies 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.

pluginConfiguration > 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. For more information, see https://www.ibm.com/support/knowledgecenter/en/SSAW57_9.0.0/com.ibm.websphere.nd.multiplatform.doc/ae/rwsv_plugin_propstable.html

pluginConfiguration > 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

accessLoggingRef

A reference to top level httpAccessLogging element (string).

HTTP access logging configuration for the endpoint.

compressionRef

A reference to top level compression element (string).

defaultCompression

Compression options for the endpoint.

enabled

boolean

true

Toggle the availability of an endpoint. When true, this endpoint will be activated by the dispatcher to handle HTTP requests.

headersRef

A reference to top level headers element (string).

defaultHeaders

Header options for the endpoint.

host

string

localhost

IP 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.

httpOptionsRef

A reference to top level httpOptions element (string).

defaultHttpOptions

HTTP protocol options for the endpoint.

httpPort

int
Min: -1
Max: 65535

The port used for client HTTP requests. Use -1 to disable this port.

httpsPort

int
Min: -1
Max: 65535

The port used for client HTTP requests secured with SSL (https). Use -1 to disable this port.

onError

  • FAIL

  • IGNORE

  • WARN

WARN

Action to take after a failure to start an endpoint.
FAIL
Server will issue a warning or error message on the first error occurrence and then stop the server.
IGNORE
Server will not issue any warning and error messages when it incurs a configuration error.
WARN
Server will issue warning and error messages when it incurs a configuration error.

protocolVersion

string

When Servlet 4.0 API is enabled as a feature, set this attribute to http/1.1 to disable HTTP/2 processing for the ports that were defined for the httpEndpoint element. When Servlet 3.1 API is enabled as a feature, set this attribute to http/2 to enable HTTP/2 processing for the ports that are defined for the httpEndpoint element.

remoteIpRef

A reference to top level remoteIp element (string).

defaultRemoteIp

Remote IP options for the endpoint.

samesiteRef

A reference to top level samesite element (string).

defaultSameSite

SameSite options for the endpoint.

sslOptionsRef

A reference to top level sslOptions element (string).

SSL protocol options for the endpoint.

tcpOptionsRef

A reference to top level tcpOptions element (string).

defaultTCPOptions

TCP protocol options for the endpoint.

Expand
pluginConfiguration > httpEndpoint > accessLogging

HTTP access logging configuration for the endpoint.

Expand
pluginConfiguration > httpEndpoint > compression

Compression options for the endpoint.

Expand
pluginConfiguration > httpEndpoint > headers

Header options for the endpoint.

Expand
pluginConfiguration > httpEndpoint > httpOptions

HTTP protocol options for the endpoint.

Expand
pluginConfiguration > httpEndpoint > remoteIp

Remote IP options for the endpoint.

Expand
pluginConfiguration > httpEndpoint > samesite

SameSite options for the endpoint.

Expand
pluginConfiguration > httpEndpoint > sslOptions

SSL protocol options for the endpoint.

Expand
pluginConfiguration > httpEndpoint > tcpOptions

TCP protocol options for the endpoint.