Open Liberty

https://openliberty.io/docs/
Admin
Open Liberty is an open-source, modular runtime for cloud-native applications, providing support for...
Tokens:741,655
Snippets:13,204
Trust Score:9.8
Update:3 months ago
Show doc for...
Tokens:
Raw
### Example featureUtility install output

Source: https://openliberty.io/docs/26.0.0.6/reference/command/featureUtility-commands.html

Sample output from the featureUtility install command when a custom repository is unreachable.

```text
> featureUtility install mpHealth-2.2
Initializing ...
Using 8 threads to download artifacts.
http://alt.mycomp.com/maven2 cannot be connected
<---------------------> 0.00%
com.ibm.ws.install.InstallException: CWWKF1248E: One of the repositories that is specified in the configuration cannot be reached. Verify that your computer has network access and firewalls are configured correctly, then try the action again. If the connection still fails, the repository server might be temporarily unavailable.
```

--------------------------------

### Server start command syntax

Source: https://openliberty.io/docs/26.0.0.6/reference/command/server-start.html

General syntax for the server start command, executed from the wlp/bin directory.

```bash
server start  _serverName_ [_options_]
```

--------------------------------

### Install server features

Source: https://openliberty.io/docs/26.0.0.6/reference/command/featureUtility-installServerFeatures.html

Basic command to install features for a specific server.

```bash
featureUtility installServerFeatures myserver
```

--------------------------------

### Start a server with variables

Source: https://openliberty.io/docs/26.0.0.6/reference/command/server-start.html

Starts the server while defining a variable, requiring the -- separator before the option.

```bash
server start myserver -- --variable_name=variable_value
```

--------------------------------

### Start Open Liberty server

Source: https://openliberty.io/docs/26.0.0.6/deploy-spring-boot.html

Command to start the Open Liberty server in the foreground.

```bash
server run helloserver
```

--------------------------------

### Start server with variables

Source: https://openliberty.io/docs/26.0.0.6/reference/command/server-run.html

Starts the server while defining a variable, requiring the -- separator before the option.

```bash
server run myserver -- --variable_name=variable_value
```

--------------------------------

### Install feature command syntax

Source: https://openliberty.io/docs/26.0.0.6/reference/command/featureUtility-installFeature.html

Basic syntax for executing the feature installation command from the Liberty bin directory.

```bash
featureUtility installFeature  _featureName_ [_options_]
```

--------------------------------

### Define variables at startup for a runnable JAR

Source: https://openliberty.io/docs/26.0.0.6/runnable-jar-files.html

Use this syntax to pass configuration variables when starting the server. Variables provided here override other sources and cannot be modified after the server starts.

```bash
java -jar myServer.jar --variable1_name=variable1_value --variable2_name=variable2_value
```

--------------------------------

### CWWKZ0013E Application Start Error Message

Source: https://openliberty.io/docs/latest/troubleshooting.html

Example of the error message received when two applications with the same name are detected.

```text
CWWKZ0013E: It is not possible to start two applications called {0}.
```

--------------------------------

### Create a new server

Source: https://openliberty.io/docs/26.0.0.6/reference/command/server-create.html

Initializes a server instance with the specified name.

```bash
server create myserver
```

--------------------------------

### Resource request with custom JWT header

Source: https://openliberty.io/docs/26.0.0.6/reference/feature/openidConnectClient-1.0.html

Example of a HTTP GET request sending a JWT token via a custom header field.

```http
GET /resource HTTP/1.1
Host: server.example.com
jwt: mF_9.B5f-4.1JqM
```

--------------------------------

### Display help for installFeature

Source: https://openliberty.io/docs/26.0.0.6/reference/command/featureUtility-help.html

Shows how to retrieve specific help information for the installFeature action.

```bash
featureUtility help installFeature
```

--------------------------------

### ResourceAdapter Startup Work Submission

Source: https://openliberty.io/docs/26.0.0.6/instanton-limitations.html

Example of a JavaBean resource adapter attempting to schedule work and create a timer during the start method, which is prohibited before a checkpoint.

```java
public class StartupExample implements ResourceAdapter {
    BootstrapContext bootstrapCtx = null;

    @Override
    public void start(BootstrapContext ctx) {
        bootstrapCtx = ctx;
        WorkManager workMgr = bootstrapCtx.getWorkManager();
        ...

        // work submission is not allowed before checkpoint
        try {
            workMgr.scheduleWork(new ExampleWork());  // same for doWork() and startWork()
        } catch (WorkRejectedException wre) {}

        // timer creation is not allowed before checkpoint
        try {
            Timer timer = bootstrapCtx.createTimer();
        } (UnavailableException ue) {}
        ...
     }
```

--------------------------------

### Run the server package command

Source: https://openliberty.io/docs/26.0.0.6/reference/command/server-package.html

Execute this command from the installation bin directory to package a specified server.

```bash
server package  _serverName_ [_options_]
```

--------------------------------

### SIMPLE Log Format Example

Source: https://openliberty.io/docs/latest/log-trace-configuration.html

Example output of a message in SIMPLE format.

```text
[18/10/21 14:49:26:246 EDT] 0000003e com.ibm.ws.kernel.feature.internal.FeatureManager            A CWWKF0011I: The defaultServer server is ready to run a smarter planet. The defaultServer server started in 7.844 seconds
```

--------------------------------

### Create a Liberty server

Source: https://openliberty.io/docs/26.0.0.6/deploy-spring-boot.html

Initializes a new server instance named helloserver in the wlp/bin directory.

```bash
server create helloserver
```

--------------------------------

### Server create syntax

Source: https://openliberty.io/docs/26.0.0.6/reference/command/server-create.html

General command structure for creating a server.

```bash
server create  _serverName_ [_options_]
```

--------------------------------

### DEV Log Format Example

Source: https://openliberty.io/docs/latest/log-trace-configuration.html

Example output of a message in DEV format.

```text
[AUDIT] CWWKF0011I: The defaultServer server is ready to run a smarter planet. The defaultServer server started in 7.967 seconds.
```

--------------------------------

### Maven coordinates example

Source: https://openliberty.io/docs/26.0.0.6/reference/command/featureUtility-installFeature.html

Example of specifying a feature using Maven coordinates.

```text
io.openliberty.features:mpHealth-2.2
```

--------------------------------

### Syntax for server help

Source: https://openliberty.io/docs/26.0.0.6/reference/command/server-help.html

General syntax for the server help command, executed from the wlp/bin directory.

```bash
server help  _actionName_
```

--------------------------------

### Install Logstash Collector feature

Source: https://openliberty.io/docs/26.0.0.6/forwarding-logs-logstash.html

Install the logstashCollector-1.0 feature using the featureUtility command.

```bash
d:\wlp\bin\featureUtility installFeature logstashCollector-1.0
```

--------------------------------

### Kerberos Configuration File Example

Source: https://openliberty.io/docs/26.0.0.6/configuring-spnego-authentication.html

A sample krb5.conf or krb5.ini file defining realms and domain mappings.

```ini
[libdefaults]
    default_realm = MYDOMAIN.EXAMPLE.COM
    default_keytab_name = FILE:c:\windows\krb5.keytab
    default_tkt_enctypes = rc4-hmac aes256-cts-hmac-sha1-96
    default_tgs_enctypes = rc4-hmac aes256-cts-hmac-sha1-96
[realms]
    MYDOMAIN.EXAMPLE.COM= {
        kdc = host1.example.com:88
        default_domain = example.com
}
[domain_realm]
    .example.com = MYDOMAIN.EXAMPLE.COM
```

--------------------------------

### Configure Admin Center in server.xml

Source: https://openliberty.io/docs/26.0.0.6/admin-center.html

Example server.xml configuration enabling the Admin Center feature, defining management roles, and setting up an HTTPS endpoint with a keystore.

```xml
<server description="Admin Center example server">
   <featureManager>
      <feature>adminCenter-1.0</feature>
   </featureManager>
   <basicRegistry id="basic">
      <user name="admin" password="adminpwd" />
      <user name="reader" password="readerpwd" />
   </basicRegistry>
   <administrator-role>
      <user>admin</user>
   </administrator-role>
   <reader-role>
      <user>reader</user>
   </reader-role>
   <keyStore id="defaultKeyStore" password="Liberty" />
   <httpEndpoint id="defaultHttpEndpoint"
                 host="*"
                 httpPort="9080"
                 httpsPort="9443" />
</server>
```

--------------------------------

### Command syntax

Source: https://openliberty.io/docs/26.0.0.6/reference/command/featureUtility-installServerFeatures.html

General syntax for executing the installServerFeatures command.

```bash
featureUtility installServerFeatures  _serverName_ [_options_]
```

--------------------------------

### Install a feature without caching

Source: https://openliberty.io/docs/26.0.0.6/reference/command/featureUtility-installFeature.html

Installs a feature while bypassing the local Maven repository cache.

```bash
featureUtility installFeature mpHealth-2.2 --noCache
```

--------------------------------

### Display help for a specific action

Source: https://openliberty.io/docs/26.0.0.6/reference/command/securityUtility-help.html

Use this command to view help information for the createSSLCertificate action.

```bash
securityUtility help createSSLCertificate
```

--------------------------------

### Install a feature from Maven Central

Source: https://openliberty.io/docs/26.0.0.6/reference/command/featureUtility-installFeature.html

Installs a specific feature by name from the default Maven Central repository.

```bash
featureUtility installFeature mpHealth-2.2
```

--------------------------------

### Configure QuickStart security

Source: https://openliberty.io/docs/26.0.0.6/reference/feature/appSecurity-2.0.html

Configures a basic user registry for testing purposes by granting the administrator role to a specified user.

```xml
<quickStartSecurity userName="Bob" userPassword="bobpwd" />
```

--------------------------------

### JNDI entry literal examples

Source: https://openliberty.io/docs/26.0.0.6/reference/feature/jndi-1.0.html

Examples of various Java literal types supported by the jndiEntry element.

```xml
<jndiEntry jndiName="a" value='"Hello, world.\n"' />
```

```xml
<jndiEntry jndiName="b" value="0b1010101" />
```

```xml
<jndiEntry jndiName="c" value="'X'" />
```

```xml
<jndiEntry jndiName="d" value="1.0D" />
```

--------------------------------

### Using multiple extInfo options

Source: https://openliberty.io/docs/26.0.0.6/reference/command/securityUtility-createSSLCertificate.html

Example of providing multiple X.509 certificate extension information values to the command.

```bash
--extInfo="san=dns:laptop" --extInfo="ExtendedKeyUsage=serverAuth,clientAuth"
```

--------------------------------

### HTTP endpoint configuration examples

Source: https://openliberty.io/docs/26.0.0.6/reference/command/server-pause.html

Example XML configuration for HTTP endpoints that can be targeted by the pause command.

```xml
<httpEndpoint id="defaultHttpEndpoint" host="*" httpPort="8800" httpsPort="8810"/>
<httpEndpoint id="db1HttpEndpoint" host="*" httpPort="8801" httpsPort="8811"/>
<httpEndpoint id="db2HttpEndpoint" host="*" httpPort="8802" httpsPort="8812"/>
```

--------------------------------

### Display help information

Source: https://openliberty.io/docs/26.0.0.6/reference/command/serverSchemaGen.html

Displays help documentation for the serverSchemaGen command.

```bash
serverSchemaGen  _serverName_ --help
```

--------------------------------

### Build InstantOn image with Podman

Source: https://openliberty.io/docs/26.0.0.6/instanton.html

Execute the build command with required Linux capabilities and security options to enable CRIU checkpointing.

```bash
podman build \
   -t dev.local/liberty-app-instanton \
   --cap-add=CHECKPOINT_RESTORE \
   --cap-add=SYS_PTRACE\
   --cap-add=SETPCAP \
   --security-opt seccomp=unconfined .
```

--------------------------------

### Install Admin Center feature

Source: https://openliberty.io/docs/26.0.0.6/admin-center.html

Use the featureUtility command to install the adminCenter-1.0 feature into the Open Liberty runtime.

```bash
featureUtility installFeature adminCenter-1.0
```

--------------------------------

### Configure quickStartSecurity for development

Source: https://openliberty.io/docs/26.0.0.6/reference/feature/restConnector-2.0.html

Minimal configuration to enable the restConnector-2.0 feature and a single administrator user for testing.

```xml
<featureManager>
    <feature>restConnector-2.0</feature>
</featureManager>
<quickStartSecurity userName="bob" userPassword="bobpassword" />
<keyStore id="defaultKeyStore" password="keystorePassword"/>
```

--------------------------------

### ENHANCED trace log examples

Source: https://openliberty.io/docs/latest/log-trace-configuration.html

Examples of ENHANCED formatted messages, including one with an empty object ID.

```text
[2025-05-21, 16:04:36:874 EDT] 0000004c id=f430e04e cs.internal.monitor.computed.internal.ComputedMonitorMetrics > getMonitorMetricID Entry
```

```text
[2025-05-21, 15:48:16:213 EDT] 00000001 id=00000000 com.ibm.ws.kernel.launch.internal.FrameworkManager           I CWWKE0002I: The kernel started after 1.954 seconds
```
Tokens:
Raw