WebSphere Application Server for z/OS Liberty

https://www.ibm.com/docs/en/was-liberty/zos
Admin
This documentation provides comprehensive information on installing, configuring, administering, and...
Tokens:689,989
Snippets:11,014
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Get dynamicRouting setup help

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=collectives-dynamic-routing-command

Command to display help information for the setup action.

```bash
${wlp.install.dir}/bin/dynamicRouting help setup
```

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

### Run dynamicRouting setup command

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=collectives-dynamic-routing-command

Example of executing the setup command with required arguments for a single collective.

```bash
./dynamicRouting setup --port=9444 --host=controller1.acme.com --user=admin --password=password --keystorePassword=keypass --pluginInstallRoot=/opt/HTTPServer_Plugins --webServerNames=webServer1,webServer2
```

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

### Verify feature installation in console.log

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=liberty-deploying-existing-jdbc-application

Example output showing successful feature installation in the server logs.

```text
[AUDIT   ] CWWKF0012I: The server installed the following features: [jdbc-4.0, jndi-1.0].
[AUDIT   ] CWWKF0008I: Feature update completed in 0.326 seconds.
```

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

### Resource adapter installation log output

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=elements-configuring-resource-adapters

Example log messages indicating successful installation of resource adapters.

```text
[AUDIT ] J2CA7001I: Resource adapter MyAdapter installed in 0.495 seconds. 
[AUDIT ] J2CA7001I: Resource adapter MyDropinAdapter installed in 0.311 seconds. 
[AUDIT ] J2CA7001I: Resource adapter app1.MyEmbeddedAdapter installed in 0.247 seconds.
[AUDIT ] J2CA7001I: Resource adapter app2.anotherEmbeddedAdapter installed in 0.518 seconds.
```

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

### Run dynamicRouting setup for multiple collectives

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=collectives-dynamic-routing-command

Executes the setup command with specified collective credentials, keystore password, plugin installation root, and web server names.

```bash
./dynamicRouting setup --collectives=admin:pw@controller1.acme.com:9443,admin:pw@controller2.acme.com:9443 --keystorePassword=keypass --pluginInstallRoot=/opt/HTTPServer_Plugins --webServerNames=webserver1
```

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

### Start the controller server

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=multimedia-video-configuring-auto-scalable-cluster-liberty-elasticity

Navigate to the bin directory and start the controller server instance.

```bash
cd /cygdrive/c/wlp/bin

./server start myController
```

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

### configUtility Command Syntax Examples

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=line-configutility-command

Common command-line patterns for finding and installing configuration snippets. Enclose paths or values containing spaces in double quotation marks.

```bash
configUtility find
configUtility find filter_string
configUtility find "filter string"
configUtility help
configUtility install configSnippet
configUtility install configSnippet --info
configUtility install configSnippet --vvariable=value
configUtility install configSnippet --createConfigFile=C:/wlp/usr/servers/server1/snippet-include.xml
configUtility install configSnippet --encoding=aes --base64Key=base64_key --vvariable=value
configUtility install configSnippet --encoding=aes --aesConfigFile=C:/wlp/usr/servers/server1/myAesKey.xml --vvariable=value
configUtility install --useLocalFile=C:/wlp_temp/mySnippet.xml
```

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

### Launch jConsole with REST Connector

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=applications-configuring-secure-jmx-connection-liberty

Example command to start jConsole with the necessary class path and SSL configuration for Liberty.

```bash
jconsole -J-Djava.class.path=%JAVA_HOME%/lib/jconsole.jar;
                             %JAVA_HOME%/lib/tools.jar;
                             %WLP_HOME%/clients/restConnector.jar
         -J-Djavax.net.ssl.trustStore=key.jks 
         -J-Djavax.net.ssl.trustStorePassword=Liberty 
         -J-Djavax.net.ssl.trustStoreType=jks
```

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

### Start the scaling member

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=multimedia-video-configuring-auto-scalable-cluster-liberty-elasticity

Starts the configured scaling member server.

```bash
./server start myMember
```

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

### Start the Liberty server

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=center-setting-up-admin

Execute the server run command to start the instance and initialize the Admin Center.

```bash
server run myServer
```

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

### Start collective controller and member servers

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=clusters-configuring-liberty-server-cluster

Use the server start command to initialize the collective controller and member server.

```bash
wlp/bin/server start myController

wlp/bin/server start myMember
```

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

### Start Liberty Server

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=manually-administering-liberty-zos

Use the bbgzsrv procedure to start a configured Liberty server instance.

```MVS
start bbgzsrv,parms='defaultServer'
```

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

### Start and stop server commands

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=line-starting-stopping-server-from-command

Standard commands to start or stop a specific server instance.

```text
server start serverName
```

```text
server stop serverName
```

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

### Configure Keystore in server.xml

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=zos-modify-commands

Sample configuration for a default keystore in the server.xml file.

```xml
!-- inbound (HTTPS) keystore -->
    <keyStore id=defaultKeyStore password={xor}EjoyPTot
              location=${server.config.dir}/resources/security/key.jks />
```

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

### Override installable configuration in server.xml

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=collectives-configuring-provisionable-clusters-liberty-elasticity

Examples of defining installable elements within a stack group or referencing them via installableRef.

```xml
<stackGroup name="myStackGroup">
   <installable name="wlp.v8555.zip" sourceDir="c:\myStackGroup\installables"/>
</stackGroup>
```

```xml
<stackGroup name="myStackGroup" installDir="/myInstallDir" installableRef="myInstallable1, myInstallable2"/>
<installable name="wlp.v8555.zip" id="myInstallable1" sourceDir="c:\myStackGroup\installablesOne" />
<installable name="jre.v1.6.zip" id="myInstallable2" sourceDir="c:\myStackGroup\installablesTwo"/>
```

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

### Create a Liberty server

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=center-setting-up-admin

Use the server command to initialize a new server instance in the wlp/bin directory.

```bash
server create myServer
```

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

### Example z/OS modify command structure

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=zos-apis-command-processing-support

Example of a command string directed to a started job, where the command portion is matched against the modify.filter.regex property.

```text
"MODIFY <jobname.>identifier,<cmdverb1>,<parm1>,<parm2>,(<moreInfo1>) 
```

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

### Start the Eclipse Help Server

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=overview-viewing-documentation-offline

Command to initialize the Eclipse standalone help server on a specified port.

```batch
java -classpath eclipse\plugins\org.eclipse.help.base_4.2.102.v20171130-0510.jar  org.eclipse.help.standalone.Infocenter -eclipsehome eclipse -port 8680 -command start -noexec -clean
```

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

### Example Metric Values

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=metrics-microprofile-rest-api

A sample JSON object representing metric values returned by a GET request.

```json
{
  "fooVal": 12345,
  "barVal": 42
}
```

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

### Run dynamicRouting setup command

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=collectives-setting-up-dynamic-routing-single-liberty-collective

Execute this command on a controller to generate the required keystore and plug-in configuration files.

```bash
./dynamicRouting setup --port=9444 --host=controller1.acme.com --user=admin --password=passw0rd --keystorePassword=webAS --pluginInstallRoot=/opt/HTTPServer_Plugins/ --webServerNames=webserver1
```

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

### Liberty Server Command Usage Examples

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=line-server-command-options

Common command-line operations for managing Liberty servers, including starting, packaging, and dumping server state.

```bash
server run
server start myserver --clean
server package myserver --archive="archivefile.zip" --include=all
server dump myserver --archive="c:\mybackup\myserver.zip" --include=thread
server javadump myserver
server javadump myserver --include=thread,system
```

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

### Verify customPasswordEncryption installation

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=slia-configuring-custompasswordencryption-provider-command-line-utilities-developer-tools

Use this command to list all installed custom password encryption providers and confirm the installation was successful.

```bash
wlp/bin/securityUtility encode --listCustom
```

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

### Create a Liberty client

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=client-creating-liberty-application-manually

Use the client command to initialize a new client directory structure.

```text
client create client_name
```

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

### Create STARTED profiles for Liberty processes

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=liberty-enabling-zos-authorized-services-zos

Define STARTED profiles to run the angel and Liberty server as z/OS Started Tasks.

```RACF
rdef started bbgzangl.* uacc(none) stdata(user(WLPUSER0) group(wasuser) privileged(no) trusted(no) trace(yes))
```

```RACF
rdef started bbgzsrv.* uacc(none) stdata(user(WLPUSER1) group(wasuser) privileged(no) trusted(no) trace(yes))
```

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

### Create a Liberty server from a custom template

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=liberty-creating-server-manually

Use this command to initialize a new server instance based on a template located in your product extension's templates/servers directory.

```bash
server create --template=<extension-name>:<template-name>
```

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

### Start Collective Controller

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=collective-removing-controller-from-liberty-replica-set

Start the collective controller if it is not currently running.

```bash
wlp/bin/server start myController
```

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

### Start the Liberty server

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=liberty-defining-spring-boot-application-arguments

Command to start the specified Liberty server in the foreground.

```bash
server run helloserver
```

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

### Access genKeystore command help

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=collectives-dynamic-routing-command

Retrieves help documentation for the genKeystore action.

```bash
${wlp.install.dir}/bin/dynamicRouting help genKeystore
```

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

### Start the collective controller

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=collectives-configuring-liberty-collective-replica-sets

Command to start the new collective controller replica.

```bash
wlp/bin/server start myController2
```

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

### Generate plugin configuration files

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=collectives-generating-plugin-cfgxml-route-multiple

Use the dynamicRouting setup command on the controller machine to generate the necessary plugin configuration and key files.

```bash
<Liberty server root>/bin/dynamicRouting setup --port=<controllerport> --host=<controller host> --user=<administrator id> --password=<administrator password> --keystorePassword=<keystore password> --pluginInstallRoot=<root directory of the WebSphere plugin on the WebServer host> --webServerNames=<web server name> --keystoreType=pkcs12
```

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

### SSL Default Configuration Example

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=collectives-liberty-collective-troubleshooting

Example of an sslDefault configuration element in server.xml.

```xml
<sslDefault sslRef="LDAPSSLSettings"></sslDefault>
```

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

### Configure quickStartSecurity

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=collectives-configuring-liberty-collective-replica-sets

Ensure security configuration matches the original controller.

```xml
<quickStartSecurity userName="adminUser" userPassword="adminPassword" />
```

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

### Configure targetPath options

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=collectives-dynamic-routing-command

Examples of valid --targetPath configurations for specifying output directories and file naming patterns.

```text
--targetPath='config/'
```

```text
--targetPath='config/${webServerName}.xml'
```

```text
--targetPath='config/${webServerName}/'
```

```text
--targetPath='config/${webServerName}/plugin-cfg.xml'
```

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

### Succinct Method Print Format Example

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=liberty-troubleshooting-sip-container-session-repository

Example output format for the dumpAllSASIds method.

```text
 local.1347524282775_8 
```

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

### Configure server environment variables

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=multimedia-video-configuring-auto-scalable-cluster-liberty-elasticity

Example content for a server.env file to define the JAVA_HOME path on Windows hosts.

```text
JAVA_HOME=C:\wlp.jre\jre.17.zip\jre
```

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

### Example Servlet MXBean ObjectNames

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=10-web-application-monitoring

Concrete examples of ObjectNames for identifying servlet MXBeans.

```text
WebSphere:type=ServletStats,name=snoop.Alpine Snoop Servlet
WebSphere:type=ServletStats,name=MyApp.MyServlet
```

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

### Install logstashcollector-1.0 feature

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=collector-using-logstash-version-10

Run the installUtility command to add the logstashcollector-1.0 feature to the Liberty installation.

```bash
d:\wlp\bin\installUtility install logstashcollector-1.0
```

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

### Sample Kerberos Configuration File

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=liberty-configuring-spnego-authentication-in

A sample krb5.conf file for AIX, z/OS, HP-UX, or Solaris platforms.

```text
[libdefaults]
          default_realm = MYDOMAIN.EXAMPLE.COM
          default_keytab_name = FILE:/etc/krb5/krb5.keytab
          default_tkt_enctypes = rc4-hmac 
          default_tgs_enctypes = rc4-hmac 
          forwardable  = true
          renewable  = true
          noaddresses = true
          clockskew  = 300
          udp_preference_limit = 1
[realms]
          MYDOMAIN.EXAMPLE.COM = {
                kdc = myAdMachine.example.com:88
                default_domain = example.com
			}
[domain_realm]
        .example.com = MYDOMAIN.EXAMPLE.COM
```

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

### Start the ARM policy

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=sul-enabling-automatic-restart-management-arm-feature-server-instance

Issue these operator commands to start the ARM policy if it is not already running.

```text
SETXCF COUPLE,TYPE=ARM,PCOUPLE=(dsname,vvvvvv) SETXCF START,POLICY,TYPE=ARM
```

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

### Create a Liberty server

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=multimedia-video-configuring-auto-scalable-cluster-liberty-elasticity

Command to initialize a new Liberty server instance.

```bash
server create cluster1
```

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

### Create and start a Liberty server

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=applications-getting-started-security-in-liberty

Commands to initialize and launch a new Liberty server instance on non-Windows systems.

```bash
server create MyNewServer 
server start MyNewServer
```

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

### Example endpoint MXBean ObjectNames

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=10-jax-ws-monitoring

Concrete examples of ObjectName strings for a specific JAX-WS service.

```text
org.apache.cxf:bus.id=JaxWsLibertyDemo-Server-Bus,type=Performance.Counter.Server,
    service="{http://jaxws.samples/}SimpleEchoService",port="SimpleEchoPort"
org.apache.cxf:bus.id=JaxWsLibertyDemo-Server-Bus,type=Performance.Counter.Client,
    service="{http://jaxws.samples/}SimpleEchoService",port="SimpleEchoPort"
```

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

### Example server.xml include file for shared configuration

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=sets-automatically-sharing-configurations-among-replicas

A sample XML configuration snippet used as the 'config' parameter for the addSharedConfig operation.

```xml
<?xml version="1.0" encoding="UTF-8" ?>
<server>
  <logging traceSpecification="com.ibm.ws.collective.repository.internal.SharedConfigManager=all"/>
</server>
```

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

### Sample SAML keystore configuration

Source: https://www.ibm.com/docs/en/was-liberty/zos?topic=liberty-configuring-saml-web-browser-sso-in

Example XML configuration for a keystore used by the SAML SP.

```xml
<keyStore id="samlKeyStore" password="<password>"
              location="${server.config.dir}/resources/security/<samlKey.jks>" />
```
Tokens:
Raw