IBM WebSphere Application Server Network Deployment

https://www.ibm.com/docs/en/was-nd/9.0.5
Admin
IBM WebSphere Application Server Network Deployment is an enterprise Java EE application server...
Tokens:8,507,036
Snippets:125,553
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### Configure Local Installation (Windows Example)

Source: https://www.ibm.com/docs/en/was-nd/9.0.5?topic=files-configuring-sun-java-system-web-server

Example configuration for a local installation on Windows, specifying the DLL and bootstrap properties.

```config
Init fn="load-modules" 
     funcs="as_init,as_handler,as_term" 
     shlib="C:\IBM\WebSphere\Plugins\bin\ns41_http.dll"
Init fn="as_init" 
     bootstrap.properties="C:\IBM\WebSphere\Plugins\config\webserver1\plugin-cfg.xml"

```

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

### Example: Starting an Application Server on z/OS

Source: https://www.ibm.com/docs/en/was-nd/9.0.5?topic=abp-administrative-console-does-not-start-even-though-installation-completes

This is an example of the START command for an application server on z/OS, showing specific values for procedure name, job name, and environment.

```z/OS Console
START BBO6ACR,JOBNAME=BBOS001,ENV=PLEX1.SY1.BBOS001
```

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

### Start Application on Single Server Example

Source: https://www.ibm.com/docs/en/was-nd/9.0.5?topic=cws-application-administration-scripts

Example usage of the startApplicationOnSingleServer script to start an application on a specific server.

```jython
AdminApplication.startApplicationOnSingleServer("myApp", "myNode", "myServer")
```

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

### z/OS Servant Process Start Command Example

Source: https://www.ibm.com/docs/en/was-nd/9.0.5?topic=settings-process-definition

An example of the start command arguments for a z/OS servant process.

```text
JOBNAME=BBOS001S,ENV=SY1.SY1.BBOS001
```

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

### Example File System for Group Mode Installation

Source: https://www.ibm.com/docs/en/was-nd/9.0.5?topic=imo-installing-in-group-mode

This is an example of a file system path where products will be installed in group mode.

```text
/WASProducts
```

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

### Start Job Manager and Proxy Server

Source: https://www.ibm.com/docs/en/was-nd/9.0.5?topic=tools-startserver-command

Examples for starting the job manager and a proxy server.

```bash
startServer jobmgr
```

```bash
startServer proxy1 (for the secure proxy profile)
```

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

### Example Silent Installation Response File

Source: https://www.ibm.com/docs/en/was-nd/9.0.5?topic=systems-installing-product-silently

This is a complete example of a response file for a silent installation. It specifies the installation directory, local repository location, and includes all default features.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<agent-input acceptLicense='true'>
<server>
<repository location='C:\repositories\edge85\local-repositories'/>
</server>
<profile id='Load Balancer for IPV6 v8.5' 
   installLocation='C:\Program Files\IBM\WebSphere\edge\ulb'>
<data key='eclipseLocation' value='C:\Program Files\IBM\WebSphere\edge\ulb'/>
<data key='user.import.profile' value='false'/>
<data key='cic.selector.nl' value='cs,ja,es,zh_HK,en,zh_TW,pt_BR,it'/>
</profile>
<install modify='false'>
<offering id='com.ibm.websphere.EDGELBIPV4IPV6.v85' version='8.5.0.0' 
   profile='IBM WebSphere Edge Components: Load Balancer for IPV4 and IPV6 V8.5' 
   features='Dispatcher,Load Balancer,Metric Server,Content Based Routing,Site Selector'/>
</install>
<preference name='com.ibm.cic.common.core.preferences.eclipseCache' 
    value='C:\Program Files\IBM\IMShared'/>
<preference value='30' name='com.ibm.cic.common.core.preferences.connectTimeout'/>
<preference value='30' name='com.ibm.cic.common.core.preferences.readTimeout'/>
<preference value='0' 
   name='com.ibm.cic.common.core.preferences.downloadAutoRetryCount'/>
<preference value='false' name='offering.service.repositories.areUsed'/>
<preference value='false' name='com.ibm.cic.common.core.preferences.ssl.nonsecureMode'/>
<preference value='false' 
   name='com.ibm.cic.common.core.preferences.http.disablePreemptiveAuthentication'/>
<preference value='true' 
   name='com.ibm.cic.common.core.preferences.preserveDownloadedArtifacts'/>
<preference value='false' name='PassportAdvantageIsEnabled'/>
<preference value='false' 
   name='com.ibm.cic.common.core.preferences.searchForUpdates'/>
</agent-input>
```

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

### Default Web Server Installation Path Example

Source: https://www.ibm.com/docs/en/was-nd/9.0.5?topic=mpdios-manageprofiles-command

Illustrates the default installation path for a web server based on its type.

```text
webServerType=IHS: webServerInstallPath defaulted to "C:\\Program Files\\IBM\\HTTPServer"
webServerType=IIS: webServerInstallPath defaulted to “C:\”
```

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

### Start the administrative agent

Source: https://www.ibm.com/docs/en/was-nd/9.0.5?topic=agent-starting-stopping-administrative

Use the startServer command to initiate the administrative agent. Ensure the product is installed before attempting to start the agent.

```shell
startServer -profileName myProfile -agent adminAgent
```

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

### Install Web Server Plug-ins using imcl command

Source: https://www.ibm.com/docs/en/was-nd/9.0.5?topic=zos-web-server-plug-ins-installation-information

Command-line example for installing the Web Server Plug-ins using IBM Installation Manager (imcl).

```shell
./imcl install com.ibm.websphere.PLG.zOS.v90
  -repositories http://www.ibm.com/software/repositorymanager/com.ibm.websphere.PLG.zOS.v90 
  -installationDirectory /InstallationManager/products/WebSphere/Plugins/V9R0
  -sharedResourcesDirectory /InstallationManager/sharedResources 
  -acceptLicense
  -secureStorageFile  /InstallationManager/im.ssf [-masterPasswordFile /InstallationManager/master.password]
  [-useServiceRepository]
  [-installFixes  <all | recommended | none> ] 

```

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

### Example Local Repository Paths

Source: https://www.ibm.com/docs/en/was-nd/9.0.5?topic=offerings-configuring-product-repositories-in-installation-manager

These are examples of local file paths that can be used to add a repository in Installation Manager.

```text
C:\repositories\product_name\local-repositories
```

```text
/var/repositories/product_name/local-repositories
```

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

### Start Command Arguments Example

Source: https://www.ibm.com/docs/en/was-nd/9.0.5?topic=processes-process-definition-settings

Specifies additional arguments for the start command. Each argument should be on a new line.

```text
<startCommandArgs>8089<startCommandArgs>
<startCommandArgs>/opt/payexpert/conf/PCPILogServer.properties<startCommandArgs>
```

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

### Example MVS Console Command for Starting Server

Source: https://www.ibm.com/docs/en/was-nd/9.0.5?topic=servers-starting-application-server

An example of the MVS console command to start a server, demonstrating the format with specific values for `procname`, `server_shortname`, and the `ENV` parameter.

```mvsconsole
S BBO7ACR,JOBNAME=BBOS001,ENV=BBOBASE.BBONODE.BBOS001
```

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

### Install a Resource Adapter (Windows)

Source: https://www.ibm.com/docs/en/was-nd/9.0.5?topic=application-clientrar-tool

Example of using the clientRAR tool to install a resource adapter archive on a Windows system.

```bash
clientRAR add c:\rars\myrar.rar
```

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

### Start Deployment Manager with Default Values

Source: https://www.ibm.com/docs/en/was-nd/9.0.5?topic=tool-working-your-new-deployment-managers

Example of starting the deployment manager using default values. This command assumes a standard configuration.

```shell
START BBO7DCR,JOBNAME=BBODMGR,ENV=BBOCELL.BBODMGR.BBODMGR
```

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

### Start Job Manager and Proxy Server (Default)

Source: https://www.ibm.com/docs/en/was-nd/9.0.5?topic=tools-startserver-command

Examples for starting the Job Manager and a proxy server, specifying the default server name for a secure proxy profile.

```bash
startServer JobMgr01
```

```bash
startServer proxy1 (default server name for the SecureProxySrv01 profile)
```

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

### z/OS Servant Process Start Command Example

Source: https://www.ibm.com/docs/en/was-nd/9.0.5?topic=processes-process-definition-settings

Example of a procedure name used by Workload Manager (WLM) to start a z/OS servant process. This is used when the WLM dynamic application environment feature is installed.

```text
BBO6ASR
```

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

### Start Server with Options

Source: https://www.ibm.com/docs/en/was-nd/9.0.5?topic=tools-startserver-command

Demonstrates starting a server with options like script generation or trace logging.

```bash
startServer server1
```

```bash
startServer server1 -script (produces the start_server1.sh or .bat files)
```

```bash
startServer server1 -trace (produces the startserver.log file)
```

```bash
startServer adminagent
```

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

### Install Application Example

Source: https://www.ibm.com/docs/en/was-nd/9.0.5?topic=programming-installing-application-through

This Java code demonstrates the complete process of installing an application using WebSphere's application management APIs. It includes preparation of the EAR file, establishing a connection to the server, and initiating the installation. Ensure the `earFile` path is correct and the target server details are accurate.

```Java
import java.lang.*;
import java.io.*;
import java.util.*;
import java.lang.reflect.*;
import com.ibm.websphere.management.application.*;
import com.ibm.websphere.management.application.client.*;
import com.ibm.websphere.management.*;

import javax.management.*;

public class Install {

    public static void main (String [] args) {

        try {
  String earFile = "C:/test/test.ear";
  String appName = "MyApp";
             
// Preparation phase: Begin
// Through the preparation phase you populate the enterprise archive (EAR) file with 
// product-specific binding information. For example, you can specify Java Naming
// and Directory Interface (JNDI) names for enterprise beans, or virtual hosts for
// web modules, and so on.

// First, create the controller and populate the EAR file with the appropriate options.
  Hashtable prefs = new Hashtable();
  prefs.put(AppConstants.APPDEPL_LOCALE, Locale.getDefault());

// You can optionally run the default binding generator by using the following options.
// Refer to Java documentation for the AppDeploymentController class to see all the 
// options that you can set.
  Properties defaultBnd = new Properties();
  prefs.put (AppConstants.APPDEPL_DFLTBNDG, defaultBnd);
  defaultBnd.put (AppConstants.APPDEPL_DFLTBNDG_VHOST, "default_host");
  
// Create the controller.
  AppDeploymentController controller = AppDeploymentController
    .readArchive(earFile, prefs);
  AppDeploymentTask task = controller.getFirstTask();
  while (task != null)
  {
// Populate the task data.
   String[][] data = task.getTaskData();
// Manipulate task data which is a table of stringtask.
   task.setTaskData(data);
   task = controller.getNextTask();
  }
  controller.saveAndClose();
  
  Hashtable options = controller.getAppDeploymentSavedResults();
// The previous options table contains the module-to-server relationship if it was set by
// using tasks.
//Preparation phase: End

// Get a connection to the product.
  String host = "localhost";
  String port = "8880";
  String target = "WebSphere:cell=cellName,node=nodeName,server=server1";

  Properties config = new Properties();
  config.put (AdminClient.CONNECTOR_HOST,  host);
  config.put (AdminClient.CONNECTOR_PORT,  port);
  config.put (AdminClient.CONNECTOR_TYPE, AdminClient.CONNECTOR_TYPE_SOAP);
  System.out.println ("Config: " + config);
     AdminClient _soapClient = AdminClientFactory.createAdminClient(config);

// Create the application management proxy, AppManagement. 
  AppManagement proxy = AppManagementProxy. getJMXProxyForClient (_soapClient);

// If code for the preparation phase has been run, then you already have the options table.
// If not, create a new table and add the module-to-server relationship to it by uncommenting
// the next statement.
//Hashtable options = new Hashtable();
  options.put (AppConstants.APPDEPL_LOCALE, Locale.getDefault());

// Uncomment the following statements to add the module to the server relationship table if 
//  the preparation phase does not collect it.
//Hashtable module2server = new Hashtable();
//module2server.put ("*", target);
//options.put (AppConstants.APPDEPL_MODULE_TO_SERVER, module2server);

//Create the notification filter for listening to installation events.
  NotificationFilterSupport myFilter = new NotificationFilterSupport();
  myFilter.enableType (AppConstants.NotificationType);


//Add the listener.
  NotificationListener listener = new AListener(_soapClient, 
myFilter, "Install: " + appName, AppNotification.INSTALL);

// Install the application.
  proxy.installApplication (earFile, appName, options, null);
  System.out.println ("After install App is called..");

// Wait for some timeout. The installation application programming interface (API) is 
//  asynchronous and so returns immediately.
// If the program does not wait here, the program ends.
  Thread.sleep(300000); // Wait so that the program does not end.

        }
        catch (Exception e) {
            e.printStackTrace();
        }
    }
}

// Specify the Java Management Extensions (JMX) notification listener for JMX events.
class AListener implements NotificationListener
{
    AdminClient _soapClient;
    NotificationFilterSupport  myFilter;
    Object handback;
    ObjectName on;
    String eventTypeToCheck;

    public AListener(AdminClient cl, NotificationFilterSupport fl, 
Object h, String eType) throws Exception
    {
        _soapClient = cl;
        myFilter = fl;
        handback = h;
        eventTypeToCheck = eType;

        Iterator iter = _soapClient.queryNames (new ObjectName(
"WebSphere:type=AppManagement,*"), null).iterator();
        on = (ObjectName)iter.next();
        System.out.println ("ObjectName: " + on);
        _soapClient.addNotificationListener (on, this, myFilter, handback);
    }

```

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

### Example Error Message for Ownership Issues

Source: https://www.ibm.com/docs/en/was-nd/9.0.5?topic=mpnru-changing-ownership-profile-maintenance

This error message indicates that a non-root user cannot start the product because the ownership of profile files was not correctly updated after a maintenance package installation.

```text
ADMR0104E: 
The system is unable to read document 
cells/express1Cell/nodes/express1/node-metadata.properties: 
java.io.IOException: No such file or directory
```

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

### ServerInit Directive - Linux/UNIX Example

Source: https://www.ibm.com/docs/en/was-nd/9.0.5?topic=security-using-pac-ldap-authorization-module

Example of the ServerInit directive for Linux and UNIX systems. Ensure the paths to the shared library and configuration file are correct for your installation.

```config
ServerInit /usr/lib/libpacwte.so:pacwte_auth_init /etc/pac.conf
```

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

### Install Web Server Plug-ins (OS400 Command Line)

Source: https://www.ibm.com/docs/en/was-nd/9.0.5?topic=systems-web-server-plug-ins-installation-information

Use this command to install Web Server Plug-ins on an OS400 system. This example specifies a custom repository and installation paths relevant to OS400 environments.

```bash
./imcl install com.ibm.websphere.PLG.v90
  -repositories https://downloads.mycorp.com:8080/WAS_90_repository
  -installationDirectory /QIBM/ProdData/WebSphere/Plugins/V9/webserver
  -properties was.install.os400.profile.location=/QIBM/UserData/WebSphere/Plugins/V9/webserver
  -sharedResourcesDirectory /QIBM/UserData/InstallationManager/IMShared
  -secureStorageFile $HOME/WASFiles/temp/credential.store
  -acceptLicense
  -showProgress
```

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

### Start Application on Cluster Example

Source: https://www.ibm.com/docs/en/was-nd/9.0.5?topic=cws-application-administration-scripts

Example usage of the startApplicationOnCluster script to start an application on a cluster. This script requires the cluster to be fully started.

```jython
AdminApplication.startApplicationOnCluster("myApp", "myCluster")
```

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

### Start Standalone Application Server and Run IVT

Source: https://www.ibm.com/docs/en/was-nd/9.0.5?topic=zos-building-practice-websphere-application-server-cells

This step involves starting the newly created standalone application server and then running the Install Verification Test (IVT) to ensure it is functioning correctly.

```Shell
# Start the standalone application server
/path/to/your/server/bin/startServer.sh server_name

# Run the Install Verification Test (IVT)
/path/to/your/server/bin/runIVT.sh

```

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

### Start a server, generate script, or enable trace

Source: https://www.ibm.com/docs/en/was-nd/9.0.5?topic=utilities-startserver-command

Demonstrates basic server startup, generating startup scripts, and enabling trace logging for a server.

```bash
startServer server1
```

```bash
startServer server1 -script (produces the start_server1.sh or .bat files)
```

```bash
startServer server1 -trace (produces the startserver.log file)
```

```bash
startServer adminagent
```

```bash
startServer.sh server1 -trace -username MyUserName -password MyUserPassword
 -profileName MyProfileName     (starts the server1 server using the 
         MyProfileName profile. The server runs under the user name MyUserName,
         and produces trace files under the profile_root/logs directory)
```

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

### Start Application on All Deployed Targets Example

Source: https://www.ibm.com/docs/en/was-nd/9.0.5?topic=cws-application-administration-scripts

Example usage of the startApplicationOnAllDeployedTargets script to start an application on all nodes.

```jython
AdminApplication.startApplicationOnAllDeployedTargets("myApp", "myNode")
```

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

### Get Service Instructions Example

Source: https://www.ibm.com/docs/en/was-nd/9.0.5?topic=library-bluemixutility-scripts

Example of calling the showInstructions script to get instructions for the dashDB1 service.

```python
BluemixUtility.showInstructions("serviceName=dashDB1")
```

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

### Example installed.xml entry (Linux/macOS path)

Source: https://www.ibm.com/docs/en/was-nd/9.0.5?topic=offerings-verifying-installation

This example shows a snippet from the installed.xml file, indicating the product's installation location on a Linux or macOS system.

```xml
<location id="IBM WebSphere Application Server V9.0" kind="product" 
path="program_data_dir/IBM/WebSphere/AppServer"> ..... </location>
```

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

### Comprehensive Server Start Examples

Source: https://www.ibm.com/docs/en/was-nd/9.0.5?topic=tools-startserver-command

A consolidated list of various startServer command usages, including different server types and options.

```bash
startServer server1
```

```bash
startServer server1 -script (produces the start_server1.sh file)
```

```bash
startServer server1 -trace (produces the startserver.log file)
```

```bash
startServer adminagent
```

```bash
startServer jobmgr
```

```bash
startServer proxy1 (for the secure proxy profile)
```

```bash
startServer.sh server1 -trace -username MyUserName -password MyUserPassword
 -profileName MyProfileName     (starts the server1 server using the 
         MyProfileName profile. The server runs under the user name MyUserName,
         and produces trace files under the profile_root/logs directory)
```

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

### Setup Blog Sample Data Sources (Windows)

Source: https://www.ibm.com/docs/en/was-nd/9.0.5?topic=applications-osgi-blog-sample-application

This script configures the data sources for the blog sample application on Windows systems. This is part of a manual installation process using the administrative console.

```shell
app_server_root\profiles\profileName\bin\wsadmin.bat 
     -f scripts\blogSampleInstall.py setupOnly serverName nodeName 
```

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

### Example installed.xml entry (Windows path)

Source: https://www.ibm.com/docs/en/was-nd/9.0.5?topic=offerings-verifying-installation

This example shows a snippet from the installed.xml file, indicating the product's installation location on a Windows system.

```xml
<location id="IBM WebSphere Application Server V9.0" kind="product" 
path="C:\\Program Files\\IBM\\WebSphere\\AppServer"> ..... </location>
```

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

### Install a Resource Adapter

Source: https://www.ibm.com/docs/en/was-nd/9.0.5?topic=drajeca-clientrar-tool

Example of how to install a resource adapter using the 'add' task. Specify the fully qualified path to the resource adapter archive file.

```bash
clientRAR add c:\rars\myrar.rar
```

```bash
./clientRAR add /usr/rars/myrar.rar
```

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

### Installation Manager Response File Example

Source: https://www.ibm.com/docs/en/was-nd/9.0.5?topic=scimjd-installing-version-90-product-using-job-manager-command-line-deprecated

An XML example of an Installation Manager response file for installing WebSphere Application Server Network Deployment on Windows. This file specifies repository location and accepts licenses.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<agent-input acceptLicense='true' clean='true' temporary='true'>
<server>
<repository location='<MY REPOSITORY LOCATION>'/>
</server>

```

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

### Setup Blog Sample Data Sources (UNIX)

Source: https://www.ibm.com/docs/en/was-nd/9.0.5?topic=applications-osgi-blog-sample-application

This script configures the data sources for the blog sample application on UNIX systems. This is part of a manual installation process using the administrative console.

```shell
app_server_root/profiles/profileName/bin/wsadmin.sh 
     -f scripts/blogSampleInstall.py setupOnly serverName nodeName
```

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

### Configure Local Distributed Installation (HP-UX Example)

Source: https://www.ibm.com/docs/en/was-nd/9.0.5?topic=files-configuring-sun-java-system-web-server

Example configuration for a local distributed installation on HP-UX, specifying the shared library and bootstrap properties.

```config
Init fn="load-modules" 
     funcs="as_init,as_handler,as_term" 
     shlib="/opt/IBM/WebSphere/Plugins/bin/libns61_http.so"
Init fn="as_init" 
     bootstrap.properties="profile_root/config/
        cells/dmgrcell/nodes/managed_node/servers/webserver1/plugin-cfg.xml"

```

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

### Install Offering with Interim Fixes

Source: https://www.ibm.com/docs/en/was-nd/9.0.5?topic=offerings-installing-product-by-using-command-line

Demonstrates how to install an offering and specify which interim fixes to include. Options include 'all', 'recommended', or 'none'. The default behavior depends on whether an offering version is specified.

```bash
imcl install com.ibm.websphere.ND.v90 -repositories /path/to/repository -installationDirectory /opt/IBM/WebSphere/AppServer -installFixes all
```

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

### Install Blog Sample Application (Windows)

Source: https://www.ibm.com/docs/en/was-nd/9.0.5?topic=applications-osgi-blog-sample-application

This script installs the blog sample application, including creating data sources and the business-level application, on Windows systems. The target application server must be running before execution.

```shell
app_server_root\profiles\profileName\bin\wsadmin.bat 
     -f scripts\blogSampleInstall.py fullInstall serverName nodeName 
     blogSample.eba_Location 
     com.ibm.samples.websphere.osgi.logging.api.jar_Location
     com.ibm.samples.websphere.osgi.logging.impl.jar_Location
```

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

### ODR Server Metric Example: From Server Start

Source: https://www.ibm.com/docs/en/was-nd/9.0.5?topic=settings-custom-health-condition-subexpression-builder

An example of a subexpression for ODR errors, checking if the count exceeds 100L since the server started.

```text
ODRServerMetric_FromServerStart$errors  > 100L
```

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

### Default Application Installation Directory Example

Source: https://www.ibm.com/docs/en/was-nd/9.0.5?topic=o-migration-considerations-1

This example shows the default location where applications are installed during migration if not otherwise specified. It highlights the use of the USER_INSTALL_ROOT variable.

```text
${USER_INSTALL_ROOT}/installedApps
```

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

### Example of Contracted Application Install Directory with APP_INSTALL_ROOT

Source: https://www.ibm.com/docs/en/was-nd/9.0.5?topic=umt-waspostupgrade-command

Shows an example of an application install directory being contracted using the APP_INSTALL_ROOT variable, including cell name.

```text
MIGR0341W: Application install directory has been updated to ${APP_INSTALL_ROOT}
cellName\customAppDirectory\.
```
Tokens:
Raw