Open Liberty Server Run Engine commands

Use the following Run Engine commands to configure Open Liberty Servers - ts-app, crs-app, search-app, search-ingest-app, search-query-app, xc-app.

The following table contains the default Run Engine commands. To view the scripts, start with /SETUP/bin/entrypoint.sh. If you want to implement custom logic or override existing configurations, ensure that the necessary parameters can be resolved by the commands during startup.

Run Engine commands for (Open Liberty Server)
Description Command
Set the connection to the Transaction server run set-transaction-server hostName securedPort
hostName
Transaction server host name.
Port
Transaction server port.
The SPI username and password is used for inter-component server API invocation only. The spiuser is configured in the Store server, Search server and Customization server, and used in the API invocation from those servers to the Transaction server. The images need to be configured with the spiuser password, otherwise the component servers cannot connect to the Transaction server.

Sets JVM property: spi.username, spi.password

 run set-spi-user userName ASCII_encrypted_password
userName
SPI username. The default user name is spiuser.
password
The ASCII encrypted password. You can encrypt the password by using utilities_root/wcs_encrypt.sh utility.
For development or authoring environment, set Search server name binding. run set-search-server search_host search_port
search_host
Search host name.
search_port
Search port.
For live environments, set the Search server name binding for the Search repeater. run set-search-server search_host search_port search_repeater_host search_repeater_port
search_host
Search host name.
search_port
Search port.
search_repeater_host
Search Repeater hostname, for live environments.
search_repeater_port
Search Repeater port, for live environments (for example, 3738).
Based on cloudAccout name, user name, password, userType, accoutAlias to create JNDI entry for this Cloudant account. run add-cloudant-account cloudantAccount userName password accountAlias
cloudantAccount
The Cloudant account name. For example, if the account URI is https://account.cloudant.com, the parameter value must be account.
userName
The name of the user.
password
The plain text password.
accountAlias
The alias for the account.
Update Cloudant account information. run update-cloudant-account cloudantAccount userName password accountAlias
cloudantAccount
The Cloudant account name. For example, if the account URI is https://account.cloudant.com, the parameter value must be account.
userName
The name of the user.
password
The plain text password.
accountAlias
The alias for the account.
Add a database connection datasource. run add-datasource jndi database dbtype dbHost dbPort dbUser dbPass xa sslConnect
jndi
The name of the JNDI.
For example, the default value for the Search server is jdbc/wcdb.
database
The name of the database.
dbType
The database type.
For example, db2.
dbHost
The host name of the database server.
dbPort
The database server port.
dbUser
The database user name.
dbPass
The database password.
xa
(Boolean) Determines whether it is an XA data source. Set this value to true if you are using the default datasource.
sslConnect
(Boolean) Enable SSL connection.
Add JNDI entry. run add-jndi-entry name value
name
JNDI name.
value
JNDI value.
Update userregistry.xml to create a new user registry. run add-spi-registry registryId username password
registryId
The basic registry unique name.
username
The user name for the SPI integration user.
password
The password for the SPI integration user.
Update jvm.options to add new JVM properties. run add-system-property name value
name
JVM System property name.
value
JVM System property value.
Update wlp Liberty home and server name for Run Engine configuration properties. run generate-config-properties LibertyHome ServerName
LibertyServerHome
Location of wlp Liberty is installed.
ServerName
Name of the wlp Liberty server.
Retrieve the start state of an application in the Liberty server. If the application is not started within 3 minutes, error code 1 is returned. run get-status application_name
application_name
The name of the application EAR.
Remove SPI registry form userregistry.xml. run remove-spi-registry-user registryId username [group]
registryId
The basic registry unique name.
username
The user name.
group
(Optional) The group from which to remove the user. If not specified, user is removed from the default 'spiIntegration' group.
Copy trace setting file (logging.xml) to wlp Liberty server home. Default location is /SETUP/server/root/logging.xml run reset-trace-specification
Update initHeapSize and maxHeapSize in jvm.option file. run set-heap-size initHeapSize maxHeapSize
initHeapSize
Minimum Heap size.
maxHeapSize
Maximum Heap size.
Update jndi.xml to create or update a JNDI entry. run set-jndi-entry name value
name
JNDI name.
value
JNDI value.
Set JNDI entry.

com.ibm.commerce.foundation.server.services.commerce.integration.sessionkey

 run set-session-key sessionKey
sessionKey
An encrypted session key.
Add JVM property. run set-system-property name value
name
JVM System property name value.
Change trace log directory. run set-trace-log-directory directory
directory
The location to write the logs.
Change trace level. run set-trace-specification spec
spec
The new logging trace specification.
Update JNDI entry. run update-jndi-entry name value
name
JNDI name.
value
JNDI value.
Update isClientSideRedirectSupported attribute. run update-oidc-client-side-redirect-supported clientSideRedirectSupported
clientSideRedirectSupported
The value to support client-side redirect or not, true or false.
Update context path for OIDC configuration. run add-oidc-context-root contextRoot
contextRoot
The context root of the Liberty application.
Update OIDC redirect server host name. run update-oidc-redirect-server-host serverHost
serverHost
The server host name with HTTP/HTTPS protocol. The port number is optional.
Create an Oracle datasource to a server configuration. run add-datasource-oracle jndi database dbHost dbPort dbUser dbPass xa optional:sslConnect
jndi
Datasource JNDI name
database
-- Database name
dbHost
-- Database hostname
dbPort
-- Database port number
dbUser
-- Database user name
dbPass
-- Database user's password
xa
-- XA datasource (true or false)
sslConnect
-- Database sslConnection, set to true by default.
Create a PostgreSQL datasource to a server configuration. run add-datasource-postgres jndi database dbHost dbPort dbUser dbPass xa optional:sslConnect
jndi
Datasource JNDI name
database
-- Database name
dbHost
-- Database hostname
dbPort
-- Database port number
dbUser
-- Database user name
dbPass
-- Database user's password
xa
-- XA datasource (true or false)
sslConnect
-- Database sslConnection, set to true by default.
Adds a new db2 datasource to a server configuration if it does not already exist. run add-datasource jndi database dbHost dbPort dbUser dbPass xa optional:sslConnect
jndi
Datasource JNDI name
database
-- Database name
dbHost
-- Database hostname
dbPort
-- Database port number
dbUser
-- Database user name
dbPass
-- Database user's password
xa
-- XA datasource (true or false)
sslConnect
-- Database sslConnection, set to true by default.
Adds a new JNDI entry to a server configuration if it does not already exist. run add-jndi-entry name value
name
-- JNDI name
value
-- JNDI value
Adds a new object cache instance if it does not already exist. run add-objectcache jndiName cacheSize [sizeMB]
jndiName
-- JNDI Name of the object cache
cacheSize
-- Size of the object cache
cacheSize
-- (Optional) size in MB for the cache entry added.
Adds a new SPI registry for integration. run add-spi-registry registryId username password
registryId
-- The basic registry unique name.
username
-- The username for the SPI integration user.
password
-- The password for the SPI integration user.
Adds a new JVM System property to jvm.options if it does not already exist. run add-system-property name value
name
-- JVM System property name
value
-- JVM System property value
Enables JSON logging on the Liberty Server. run enable-json-logging
Creates configuration properties file for Run Engine Command. run generate-config-properties LibertyHome ServerName
LibertyHome
-- Location of Liberty Home
ServerName
-- Name of the Liberty server
Gets the status of an application. run get-status application name
application name
-- The name of the EAR to get status of.
Resets trace specification and clears any trace level set. run reset-trace-specification
Sets the heap size on jvm.options. run set-heap-size initHeapSize maxHeapSize
initHeapSize
-- Minimum Heap size
maxHeapSize
-- Maximum Heap size
Creates or updates a JNDI entry to a server configuration. run set-jndi-entry name value
name
-- JNDI name
value
-- JNDI value
Sets the session key for the application, optionally including the file path for wc-server.xml. run set-session-key sessionKey [filePath]
sessionKey
-- The encrypted session key
filePath
-- (Optional) Path of wc-server.xml file.
Configures SPI user by setting the username and password for SPI integration. run set-spi-user userName password
userName
-- SPI Username
password
-- SPI Password
Sets a JVM System property on jvm.options. run set-system-property name value
name
-- JVM System property name
value
-- JVM System property value
Sets the maximum number of trace files to retain. run set-trace-file-maximum-number numberOfHistoricalFiles
numberOfHistoricalFiles
-- The maximum number of historical files, default value is 10. Range: 1-50 (0 means no limit).
Sets the maximum size of trace log files run set-trace-file-maximum-size size
size
-- The size of the trace log file (in MB). Default value is 20. Range: 1-200 (0 means no limit).
Sets the trace format for the log. run set-trace-format traceformatType
traceformatType
-- The format type. Acceptable values: "ADVANCED", "BASIC", "ENHANCED", "TBASIC". Default is "BASIC".
Sets the directory for trace logs. run set-trace-log-directory directory
directory
-- The location to write the logs.
Sets the trace specification. run set-trace-specification spec
spec
-- The new logging trace specification.
Configures transaction server by setting the transaction host name and ports. run set-transaction-server hostName securedPort [nonsecuredPort]
hostName
-- Transaction Server Host Name
securedPort
-- Transaction Server Secured Port
nonsecuredPort
-- (Optional) Transaction Server Nonsecured Port
Updates database credentials (user and password) for the specified JNDI. run update-datasource-cred jndi dbUser dbPass
jndi
Datasource JNDI name
dbUser
-- The database username
dbPass
-- The password for the database user
Updates database connection details for the specified JNDI. run update-datasource-db jndi database dbHost dbPort sslConnect
jndi
Datasource JNDI name
database
-- Database name
dbHost
-- Database hostname
dbPort
-- Database port number
sslConnect
-- (Optional) Enable or disable SSL
Updates an existing JNDI entry to a server configuration. run update-jndi-entry name value
name
-- JNDI name
value
-- JNDI value
Updates the size of an object cache if it exists. run update-objectcache-size jndi cacheSize [sizeMB]
jndi
-- JNDI Name of the object cache
cacheSize
-- New size of the object cache
sizeMB
-- (Optional) Size in MB for the cache entry added.
Updates the SPI registry user password. run update-spi-registry-user-password registryId username password
registryId
-- The basic registry unique name.
userName
-- The username for the SPI integration user whose password to update.
password
-- The new password for the SPI integration user
Updates an existing JVM System property on jvm.options. run update-system-property name value
name
-- JVM System property name
value
-- JVM System property value