Runtime Context Variables

Enabler for WebSphere Application Server Runtime Context Variables

The following table contains a comprehensive list of all runtime context variables used by the enabler for WebSphere Application Server.
Variable Type Description
ARCHIVE_DETECTION_ENABLED

String

Archive detection is enabled if this variable is set to true.

ARCHIVE_DETECTION_FREQUENCY

String

Archive detection frequency in seconds. Default frequency of 30 seconds is used if a value less than 30 is specified.

AS_BOOTSTRAP_ADDRESS

Environment

Application Server Bootstrap Address

AS_DCS_UNICAST_ADDRESSCOMPONENT_NAME Environment Application Server dcs unicast Address
AS_SIB_ENDPOINT_ADDRESS

Environment

Application Server SIB endpoint address

AS_SIB_ENDPOINT_SECURE_ADDRESS

Environment

Application Server SIB endpoint secure address

AS_SIB_MQ_ENDPOINT_ADDRESS

Environment

Application Server SIB MQ endpoint address

AS_SIB_MQ_ENDPOINT_SECURE_ADDRESS

Environment

Application Server SIB MQ endpoint secure address

AS_SIP_DEFAULTHOST

Environment

Application Server SIP default host

AS_SIP_DEFAULTHOST_SECURE

Environment

Application Server SIP default host secure

AS_SOAP_CONNECTOR_ADDRESS

Environment

Application Server soap connector Address

AS_WC_ADMINHOST

Environment

Application Server WC Admin host

AS_WC_ADMINHOST_SECURE

Environment

Application Server WC Admin host secure

AS_WC_DEFAULTHOST

Environment

Application Server WC default host

AS_WC_DEFAULTHOST_SECURE

Environment

Application Server WC default host secure

COMPONENT_NAME Environment WebSphere component name
CONFIG_CHANGE_SAVE_ATTEMPTS

String

Number of attempts to successfully create and save server configuration to deployment manager

COREGROUP_NAME

Environment

WebSphere core group for the cell

DEPLOYMENT_MANAGER_HOST_NAME

Environment

Host where deployment manager is running. This variable is automatically set by the Container at run time based on Clustering Support feature of your component

DEPLOYMENT_MANAGER_SOAP_PORT

Environment

SOAP port on which deployment manager is listening. This variable is automatically set by the Container at run time based on Clustering Support feature of your Component

DISTRIBUTION_NAME

Environment

Name of the distribution.
DISTRIBUTION_VERSION

Environment

Version of the distribution.
DS_CELL

Environment

WebSphere cell name. Do not change this variable; it is automatically set based on the value provided by clustering feature.

DS_NODE

Environment

WebSphere node name. Do not remove DS_NODE_PREFIX.

DS_NODE_PREFIX

Environment

The prefix to use for nodes. It distinguishes nodes dynamically added by Silver Fabric from other nodes that might be existing on Deployment Manager

DUMMY_COREGROUP_NAME

Environment

A dummy WebSphere core group for the cell; is used temporarily while cleanup

GLOBAL_LOCK_ACQUISITION_TIMEOUT

String

The time in seconds for which the container process will keep trying to acquire the global lock; Global Lock ensures atomic configuration changes on the Deployment Manager

GLOBAL_LOCK_EXPIRATION_TIME

String

The time in seconds after which a lock will be expired, if not released, and hence will be available to be acquired by others; Global Lock ensures atomic configuration changes on the Deployment Manager

HOST_NAME

Environment

DEPRECATED: Use LISTEN_ADDRESS variable. Name of the host machine on which this container will be running

IS_PERSISTENCE_ENABLED Environment Variable created when Data Persistence Support feature is selected. Default value is false
JAVA_HOME

Environment

JAVA_HOME set to the proper version of required SDK

JAVA_OPTS

Environment

Additional Java options for WebSphere server process

JDK_NAME

String

The name of the required SDK

JDK_VERSION

String

The version of the required SDK

KEY_STORE_LOCATION

String

The directory containing the key store

KEY_STORE_TYPE

String

The type of key store

LISTEN_ADDRESS_NET_MASK

Environment

A comma delimited list of net masks in CIDR notation. The first IP address found that matches one of the net masks is used as the listen address.

NODEGROUP_NAME

Environment

Node group for this cell

NODE_ACTIVATION_LOCK_TIMEOUT

String

The time in seconds for which the container process will keep trying to acquire the node activation lock. It ensures atomic startup and shutdown of application servers on a local node

NODE_BOOTSTRAP_ADDRESS

String

Node Bootstrap Address

NODE_CSIV2_SSL_MUTUALAUTH_LISTENER_ADDRESS

String

Node csiv2 ssl mutualauth listener Address

NODE_CSIV2_SSL_SERVERAUTH_LISTENER_ADDRESS

String

Node csiv2 ssl serverauth listener Address

NODE_DCS_UNICAST_ADDRESS

String

Node dcs unicast Address

NODE_DISCOVERY_ADDRESS

String

Node discovery Address

NODE_IPV6_MULTICAST_DISCOVERY_ADDRESS

String

Node ipv6 multicast discovery Address

NODE_MULTICAST_DISCOVERY_ADDRESS

String

Node multicast discovery Address

NODE_ORB_LISTENER_ADDRESS

String

Node orb listener Address

NODE_PROFILE_NAME

Environment

WebSphere node profile name

NODE_SAS_SSL_SERVERAUTH_LISTENER_ADDRESS

String

Node sas ssl serverauth listener Address

NODE_SOAP_CONNECTOR_ADDRESS

String

Node soap connector Address

PASSWORD

Environment

The password for authentication if security is enabled in the server

PATH

Environment

The executable path

PROFILE_DIR_PATH

Environment

The WebSphere profile directory

SERVER_KEY_STORE_FILE

String

The filename of the server key store file

SERVER_KEY_STORE_PASSWORD

String

The password for the server key store

SERVER_NAME

String

WebSphere application server name

SERVER_RUNTIME_DIR

Environment

The WebSphere server runtime directory

SERVER_TRUST_STORE_FILE

String

The filename of the server trust store file

SERVER_TRUST_STORE_PASSWORD

String

The password for the server trust store

TOTAL_RUNNING_CONDITION_TIMES Environment

Total number of attempts for starting in running condition. Defaut value is 30

TRUST_STORE_TYPE

String

The type of trust store

UNIX_COMMAND_PREFIX

String

Command prefix for UNIX platform to start wsadmin

USERNAME

Environment

The username for authentication if security is enabled in the server

WAS_HOME

Environment

The WebSphere server home directory

WAS_LOCK_DIR Environment Variable used for synchronization. Default value is ${WAS_ROOT_WORK_DIR}${container.getSeparator()}WS_LOCK
WAS_PARENT_WORK_DIR

Environment

Parent directory to be used as container's work directory. Default value is ${WAS_ROOT_WORK_DIR}${container.getSeparator()}WS

WAS_ROOT_WORK_DIR Environment This is used to automatically set a common root for WAS_PARENT_WORK_DIR and WAS_LOCK_DIR directory.

The new definition of these two variables uses value of WAS_ROOT_WORK_DIR. So whenever you want to change the value of these two variabes, just modify the variable WAS_ROOT_WORK_DIR and the changes are reflected for the two vaiables WAS_PARENT_WORK_DIR and WAS_LOCK_DIR .

Default value of the variable is ${ENGINE_WORK_DIR}${container.getSeparator()}
WAS_SERVER

Environment

Name of the top level WebSphere install directory

WIN_COMMAND_PREFIX

String

Command prefix for Windows platform to start wsadmin

WebSphere Deployment Manager Enabler Runtime Context Variables

The following table contains a comprehensive list of all runtime context variables used by the WebSphere Deployment Manager Enabler.
Variable Type Description
ACTIVE_AUTH_MECHANISM

String

The auth mechanism to use; KRB5 or LTPA

ACTIVE_USER_REGISTRY

String

The user registry to use; LocalOSUserRegistry, CustomUserRegistry, LDAPUserRegistry, or WIMUserRegistry

ADMIN_PASSWORD

Environment

Deployment Manager admin password

ADMIN_USER

Environment

Deployment Manager admin user

APP_SECURITY_ENABLED

String

Whether or not to enable application security

AS_DCS_UNICAST_ADDRESSCOMPONENT_NAME Environment Application Server dcs unicast Address
BIND_ON_ALL_LOCAL_ADDRESSES

Environment

Set to true to have WebSphere servers bind to all local IP addresses

BOOTSTRAP_ADDRESS

String

A TCP/IP port the server uses for connections

CAPTURE_EXCLUDES

String

Directories/files excluded from capture. Generally useful to exclude are log file directories, tmp directories, etc.

CAPTURE_INCLUDES

String

Directories that must be captured. Generally these directories contain configuration, applications, and so on.

CELL_DISCOVERY_ADDRESS

String

A TCP/IP port the server uses for connections

CLIENT_KEY_ALIAS

String

Alias of the client key in the keystore

CLUSTER_NAME

Environment

Name of the cluster to be created in Deployment Manager

COMPONENT_NAME Environment WebSphere component name
CSIV2_SSL_MUTUALAUTH_LISTENER_ADDRESS

String

A TCP/IP port the server uses for connections

CSIV2_SSL_SERVERAUTH_LISTENER_ADDRESS

String

A TCP/IP port the server uses for connections

CUPRIMARY_ID

String

Primary ID when using CustomUserRegistry

CUSERVER_ID

String

Server ID when using CustomUserRegistry

CUSERVER_PASSWORD

String

Server password when using CustomUserRegistry

CUSERVER_CLASS

String

Class containing implementation for CustomUserRegistry

DCS_UNICAST_ADDRESS

String

A TCP/IP port the server uses for connections

DEFAULT_HOST_BASE_PORT

Environment

Default host base port for managed application servers

DEFAULT_HOST_SECURE_BASE_PORT

Environment

Default host secure base port for managed application servers

DISTRIBUTION_NAME

Environment

Name of the distribution.
DISTRIBUTION_VERSION

Environment

Version of the distribution.
DM_PROFILE_NAME

Environment

WebSphere Deployment Manager profile name

HTTPS_PORT

Environment

HTTPS listen port used by VirtualRouter to forward requests to Engines

HTTP_PORT

Environment

HTTP listen port used by VirtualRouter to forward requests to Engines

IS_PERSISTENCE_ENABLED Environment Variable created when Data Persistence Support feature is selected. Default value is false. This RCV is configured by the feature, and manual configuration if done, is ignored.
IPC_CONNECTOR_ADDRESS_PORT Environment The inter-process communications (IPC) port for JMX connections.
JAVA_HOME

Environment

JAVA_HOME set to the proper version of required JDK

JAVA2_SECURITY_ENABLED

String

Whether or not to enable Java 2 security

JAVA_OPTS

Environment

Additional Java options for WebSphere server process

JDK_NAME

String

The name of the required JDK

JDK_VERSION

String

The version of the required JDK

KEY_STORE_NAME

String

The logical name of the keystore

KEY_STORE_TYPE

String

The type of key store

LISTEN_ADDRESS_NET_MASK

Environment

A comma delimited list of net masks in CIDR notation. The first IP address found that matches one of the net masks is used as the listen address

MAX_INSTANCES_PER_HOST

Environment

Maximum number of WebSphere managed servers or Deployment Manager servers allowed per host

NODE_PROFILE_NAME

Environment

WebSphere node profile name that is used internally

ORB_LISTENER_ADDRESS

String

A TCP/IP port the server uses for connections

OVERLAY_TCP_LISTENER_ADDRESS_PORT Environment Administration Overlay TCP Port
OVERLAY_UDP_LISTENER_ADDRESS_PORT Environment Administration Overlay UDP Port
SAS_SSL_SERVERAUTH_LISTENER_ADDRESS

String

A TCP/IP port the server uses for connections

SERVER_KEY_ALIAS

String

Alias of the server key in the keystore

SERVER_KEY_STORE_FILE

String

The filename of the server key store file

SERVER_KEY_STORE_PASSWORD

String

The password for the server key store

SERVER_RUNTIME_DIR

Environment

WebSphere server runtime directory

SERVER_TRUST_STORE_FILE

String

The filename of the server trust store file

SERVER_TRUST_STORE_PASSWORD

String

The password for the server trust store

SOAP_CONNECTOR_ADDRESS

Environment

A TCP/IP port the server uses for connections

STATUS_LISTENER_ADDRESS_PORT Environment The status listener port
TOTAL_RUNNING_CONDITION_TIMES Environment Total number of attempts for starting in running condition. Defaut value is 30
TRUST_STORE_NAME

String

The logical name of the truststore

TRUST_STORE_TYPE

String

The type of trust store

WAS_CELL_CONFIG

String

WebSphere Deployment Manager cell config directory

WAS_CELL_MANAGER

Environment

Name of WebSphere Deployment Manager cell manager node

WAS_CELL_NAME

Environment

WebSphere Deployment Manager cell name

WAS_HOME

Environment

WebSphere server home

WAS_NODE_NAME

Environment

Name of the first node created in the WebSphere Deployment Manager cell on the same host as the Deployment Manager; This is not the name of the Deployment Manager cell manager node

WAS_PROFILE_DIR

Environment

WebSphere profiles directory

WAS_SECURITY_ENABLED

Environment

Indicates if security is enabled for WebSphere Deployment Manager

WAS_SERVER

Environment

Name of the top level WebSphere install directory

WC_ADMINHOST_PORT

Environment

A TCP/IP port the server uses for administration

WC_ADMINHOST_SECURE_PORT

Environment

A TCP/IP port the server uses for administration

XDAGENT_PORT Environment The XDAgent (middleware agent) port