F Property Files

This appendix documents the property files used by Oracle HTTP Server. The files include:

F.1 ohs_admin.properties File

The ohs_admin.properties file is a per domain file used to configure the Oracle HTTP Server administration server MBeans.

File path: DOMAIN_HOME/config/fmwconfig/components/OHS/ohs_admin.properties

Editable properties in this file are listed here:

Property Description
LogLevel The log level for the OHS plug-in.

Accepted Values:

  • SEVERE (highest value)

  • WARNING

  • INFO

  • CONFIG

  • FINE

  • FINER

  • FINEST (lowest value)

Default: INFO


F.2 ohs_nm.properties File

The ohs_nm.properties file is a per domain file used to configure the Oracle HTTP Server plug-in.

File path: DOMAIN_HOME/config/fmwconfig/components/OHS/ohs_nm.properties

Property Description
LogLevel The log level for the OHS undemanding plug-in.

Accepted values:

  • SEVERE (highest value)

  • WARNING

  • INFO

  • CONFIG

  • FINE

  • FINER

  • FINEST (lowest value)

Default: INFO


F.3 ohs.plugins.nodemanager.properties File

The ohs.plugins.nodemanager.properties file exists for each configured Oracle HTTP Server and contains configured parameters OHS process management.

File path: DOMAIN_HOME/config/fmwconfig/components/OHS/ohs1/ohs.plugins.nodemanager.properties

This section contains the following information:

Note:

Any paths placed in Windows implementations of ohs.plugins.nodemanager.properties that include backslashes must have those backslashes escaped.

You must do this manually after upgrading from Oracle HTTP Server 11g where paths with backslashes were migrated from opmn.xml to ohs.plugins.nodemanager.properties.

For example:

environment.TMP = C:\Users\user\AppData\Local\Temp\1

Must be modified manually to:

environment.TMP = C:\\Users\\user\\AppData\\Local\\Temp\\1 

F.3.1 Cross-platform Properties

The following table lists the cross-platform properties:

Property Description
config-file The base filename of the initial Oracle HTTP Server configuration file.

config-file accepts any valid .conf file in the instance configuration directory.

Caution: The specified .conf file must include admin.conf in the same manner as the default httpd.conf.

Default: httpd.conf

command-line Extra arguments to add to the httpd invocation.

command-line accepts any valid httpd command-line parameters.

Caution: These must not conflict with the usual start, stop, and restart parameters. Using -D and symbol is the expected use of this property.

Default: None

start-timeout The maximum number of seconds to wait for Oracle HTTP Server to start and initialize.

start-timeout accepts any numeric value from 5 to 3600.

Default: 120

stop-timeout The maximum number of seconds to wait for the Oracle HTTP Server to terminate.

stop-timeout accepts any numeric value from 5 to 3600.

Default: 60

restart-timeout The maximum number of seconds to wait for the Oracle HTTP Server to restart.

restart-timeout accepts any numeric value from 5 to 3600.

Default: 180

ping-interval The number of seconds from the completion of one health check ping to the Oracle HTTP Server until the start of the next. A value of 0 disables pings.

ping-interval accepts any numeric value from 0 to 3600.

Default: 30

ping-timeout The maximum number of seconds to wait for an Oracle HTTP Server health check ping to complete.

ping-tmeout accepts any numeric value from 5 to 3600.

Default: 60


Example:

config-file = httpd.conf
command-line = -DSYMBOL
start-timeout = 120
stop-timeout = 60
restart-timeout = 180
ping-interval = 30
ping-timeout = 60

F.3.2 Environment Variable Configuration Properties

Additional environment variables for the OHS server may be specified using environment properties.

The environment property syntax is:

environment[.append][.<order>].<name> = <value>

Where:

  • The optional .append will append the new <value> to any existing value for <name>. If <name> has not yet been defined, then <value> will be the new value.

  • The optional .<order> value sets order for this definition's setting in the environment (the default is 0). The order determines when the configured variable is added to the process' environment (and its value evaluated). Environment properties with lower order values are processed before those with higher order values. The order value must be an integer with a value greater than or equal to 0.

  • <name> is the environment variable name, which must begin with a letter or underscore, and consist of letters, numeric digits or underscores.

  • <value> is the value of environment variable <name>. The value can reference other environment variable names, including its own.

    The following special references may be included in the value:

    • "$:" for the path separator

    • "$/" for the file separator

    • "$$" for '$'

With the exception of these special characters, UNIX variable syntax references ("$name" or "${name}") and the Windows variable syntax reference ("%name%") are supported.

Each property name within the same property file must be unique (the behavior is not defined for multiple properties defined with the same name), thus the .<order> field is necessary to keep property names unique when multiple definitions are provided for the same environment variable <name>.

The following environment variables are set by the Oracle HTTP Server plug-in:

  • SHELL: From 's environment, or defaults to /bin/sh, or cmd.exe for Windows

  • ORA_NLS33: Set to $ORACLE_HOME/nls/data

  • NLS_LANG: From 's environment, otherwise default

  • LANG: From 's environment, otherwise default

  • LC_ALL: From 's environment, if set

  • TZ: From 's environment, if set

  • ORACLE_HOME: Full path to the Oracle home

  • ORACLE_INSTANCE: Full path to the domain home

  • INSTANCE_NAME: The name of the domain

  • PRODUCT_HOME: The path to the OHS install: $ORACLE_HOME/ohs

  • PATH: Defaults to

    • On UNIX:

      $PRODUCT_HOME/bin:$ORACLE_HOME/bin:

      $ORACLE_HOME/jdk/bin:/bin:/usr/bin:/usr/local/bin

    • On Windows:

      %PRODUCT_HOME%\bin;%ORACLE_HOME%\bin;

      %ORACLE_HOME%\jdk\bin;%SystemRoot%;%SystemRoot%\system32

These variables apply to UNIX only:

  • TNS_ADMIN: From 's environment, or $ORACLE_HOME/network/admin

  • LD_LIBRARY_PATH: $PRODUCT_HOME/lib:$ORACLE_HOME/lib:$ORACLE_HOME/jdk/lib

  • LIBPATH: Same as LD_LIBARY_PATH

  • X_LD_LIBRARY_PATH_64: Same as LD_LIBRARY_PATH

These variables apply to Windows only:

  • ComSpec: Defaults to %ComSpec% value from the system.

  • SystemRoot: Defaults to %SystemRoot% value from the system.

  • SystemDrive: Defaults to %SystemDrive% value from the system.

Example

On a UNIX like system with the web tier installed as /oracle and the environment variable "MODX_RUNTIME=special" set in the NodeManager's environment, the following definitions:

environment.MODX_RUNTIME = $MODX_RUNTIME
environment.1.MODX_ENV = Value A
environment.1.MODX_PATH = $PATH$:/opt/modx/bin
environment.2.MODX_ENV = ${MODX_ENV}, Value B
environment.append.2.MODX_PATH = /var/modx/bin
MODX_ENV = Value A, Value B
MODX_PATH = /oracle/ohs/bin:/oracle/bin:/oracle/jdk/bin:/bin:/usr/bin: /usr/local/bin:/opt/modx/bin:/var/modx/bin

would result in the following additional environment variables set for Oracle HTTP Server:

MODX_RUNTIME = special

F.3.3 Properties Specific to Oracle HTTP Server Instances Running on Linux and UNIX

These should only be configured for instances running on Linux or other UNIX like systems.

Property Description
restart-mode Determines whether to use graceful or hard restart for the Oracle HTTP Server when configuration changes are activated.

restart-mode accepts these values:

  • restart

  • graceful

Default: graceful

stop-mode Determines whether to use a graceful or hard stop when stopping Oracle HTTP Server.

stop-mode accepts these values:

  • stop

  • graceful-stop

Default: stop

mpm Determines whether to use the prefork, worker, or event MPM for Oracle HTTP Server.

mpm accepts these values:

  • prefork

  • worker

  • event

Default: worker for UNIX, event for Linux

allow-corefiles Determines whether ulimit should be set to allow core files to be written for OHS server crashes.

allow-corefiles accepts these values:

  • yes

  • no

Default: no


Example

restart-mode = graceful
stop-mode = stop
mpm = worker
allow-corefiles = no