test

N1 Grid Service Provisioning System User's Guide and Release Notes for the WebSphere Plug-In 1.0

Chapter 4 Using the WebSphere 5.1 Plug-In

The WebSphere 5.1 plug-in provides several specific plans and component types and provides easy access to functions that are useful for working with WebSphere 5.1 applications. This chapter describes the following information:

Configuring a WebSphere Application Server Version 5.1 Environment

Plug-In Conventions

The provisioning system enables you to provision and manage applications.

Plans and Component Procedures

The WebSphere 5.1 plug-in provides both plans and component procedures as tools for you to perform tasks. By using plans, you link directly to the functionality you desire. Using component procedures, you have a greater number of tasks that you can perform. Any task that you can perform using a plan included with the WebSphere Plug-In, you can perform by using a component procedure.

Task Names

The WebSphere 5.1 plug-in organizes tasks in four categories: application tasks, infrastructure tasks, configuration tasks, and advanced tasks. These four task categories follow the same convention for describing the task that you must perform.

Table 4–1 Common Task Names

Task Name 

Description  

View All 

Links to all components of a particular type within a specified folder. 

Create 

Links to the component Details page where you can add a new component of this type to the provisioning system. You can create new components by importing them from an existing application server or by browsing the file system. 

Start or Stop 

Links to the component Details page to run the Start or Stop component procedure. 

Install, Uninstall, Remove, Join, Leave 

Links to plans that produce the described functionality. 

Global Prerequisite

All tasks within the provisioning system require that you have specific permissions. To perform tasks with the WebSphere 5.1 plug-in, you must belong to a user group that has the Run Component Procedures permission on the folder that contains the component. You must also have the Allow on Host Set permission for the host set on which you plan to deploy the component.

For more information about permissions, see Chapter 3, Controlling Access Using Permissions, in N1 Grid Service Provisioning System 5.0 System Administration Guide.

For information about how to update your group membership, see How to Change a User’s Group Membership in N1 Grid Service Provisioning System 5.0 System Administration Guide.

Process Overview

    Creating a WebSphere 5.1 environment within the provisioning system is similar to the process of creating the environment without the provisioning system.

  1. Import the WebSphere 5.1 plug-in.

    See Adding the WebSphere Plug-In to the N1 Grid Service Provisioning System.

  2. Configure the provisioning system's Master Server.

    See How to Configure the Master Server for the WebSphere Plug-in.

  3. Set the WebSphere 5.1 session variables: WS_DEFAULT_USER and WS_DEFAULT_PASSWORD.

    These variables are used during standalone application server installation, deployment manager installation, and node federation.

    See Chapter 5, Session Variables, in N1 Grid Service Provisioning System 5.0 Plan and Component Developer’s Guide.

  4. Prepare all hosts.

    The WebSphere 5.1 plug-in contains new system services that must be pushed out to all hosts in the provisioning system. See Preparing a Physical Host in N1 Grid Service Provisioning System 5.0 System Administration Guide.

  5. Create a standalone WebSphere application server.

    See How to Install a Standalone WebSphere Application Server.

  6. Create additional application server instances.

    See How to Create an Application Server Instance.

  7. (Optional) Create the deployment manager.

    See How to Install a Deployment Manager.

  8. If necessary, add each WebSphere application server to the deployment manager.

    See How to Add Nodes to the Deployment Manager.

  9. (Optional) Create a cluster and add cluster members to the cluster.

    See How to Create a WebSphere Cluster and How to Add Cluster Members.

  10. If necessary, configure the application's connection to the database.

    1. Configure the JDBC Provider.

      See How to Create a JDBC Provider Component.

    2. Configure the data source.

      See How to Create a Data Source Component.

  11. Configure the Java Virtual Machine (JVM) component.

    See How to Configure the JVM Component.

  12. Capture the application files.

  13. Deploy applications to target application servers or clusters.

    An application can target either an application server or a cluster.

    See Installing an Enterprise Application.

Creating WebSphere Infrastructure Components

Before you can deploy applications to WebSphere application servers, you must either install the WebSphere components by using the provisioning system or capture the existing WebSphere configuration.

ProcedureHow to Install a Standalone WebSphere Application Server

You must install a standalone application server before you can set up application server instances to service your applications. A standalone application server can hold a set of application server instances. The standalone application server can be managed as a single entity or by a deployment manager. All information about the application server is contained both on the application server and, if used, on the deployment manager.

When you create a new standalone application server by installing the component, you also:

You can use this procedure to create a standalone WebSphere application server or you can use this procedure to register an existing standalone application server within the provisioning system.

Note –

This task is performed as root.

Before You Begin

To create a standalone application server, you must belong to a user group that has the Run Component Procedures permission on the folder that contains the component. You must also have the Allow on Host Set permission for the host set on which you plan to deploy the component.

Steps

  1. Ensure that your WebSphere session variables, WS_DEFAULT_USER and WS_DEFAULT_PASSWORD, are set.

    For more information about session variables, see Chapter 5, Session Variables, in N1 Grid Service Provisioning System 5.0 Plan and Component Developer’s Guide.

  2. In the Common Tasks section in the browser interface, click WebSphere 5.1.

  3. Click the WebSphere Application Server for Standalone Systems: Install link.

    The plan's Details page displays.

  4. Click Run.

    The plan's Run page displays.

  5. In the Plan Parameters area, select the variable settings for the StandaloneInstall component that you plan to deploy.

    • If the variable settings have been established for this component, select the appropriate settings from the menu.

    • If the settings are not available from the menu, click Select From List.

      The Select Variable Settings From List window displays.

      • To create a new set of variable settings, select Create Set.

        The following list provides commonly updated variables for the StandaloneInstall component. You can keep the default values for most variables.

        Note –

        If you change the default port values for the standalone application server, ensure that they do not conflict with the deployment manager's port values.

        variable set name

        Required. A name for the new variable set you create.

        installPath

        Required. The location where you plan to install WebSphere 5.1. The default value for installPath is the install path that was used during the most recent installation of a WebSphere component.

        installerHome

        Required. The location of the standalone application server installer.

        Note –

        Do not include extra spaces after the path name.

        name

        Required. The name of the standalone application server virtual host.

    • To use variable components from another component, click Import Set.

      For more information about importing variable sets, see How to Run a Plan in N1 Grid Service Provisioning System 5.0 Operation and Provisioning Guide.

  6. In the Plan Parameters area, select the Default variable set for the AppInstance component that you plan to deploy.

    Note –

    If you decide to create a new variable set, do not change the application server instance name. The name must be server1, otherwise the installation will fail.

  7. Select the target host.

    The standalone application server is installed on the remote agent that you select as target host.

    Note –

    The target host must be a member of the com.sun.was#InstallTargetsHS host set.

  8. Deselect the Target Host Set checkbox.

  9. If you are capturing an existing standalone application server within the provisioning system, select the markOnly Install option.

    This option enables you to create a component that represents an existing WebSphere 5.1 object and then manage the object through the provisioning system.

  10. Click Run Plan (Includes Preflight).

  11. View the Hosts page to verify that the standalone application server and application server instance virtual hosts were created.

ProcedureHow to Create an Application Server Instance

When you create a standalone application server, you automatically create one application server instance, server1. If you must create additional application server instances, use this procedure.

You can use this procedure to create an application server instance or you can use this procedure to capture an existing application server instance within the provisioning system.

Note –

This task is performed as root.

Before You Begin

Before you create an application server instance, you must create a standalone application server. For more information, see How to Install a Standalone WebSphere Application Server.

Steps

  1. In the Common Tasks section in the browser interface, click WebSphere 5.1.

  2. Click the Application Server Instances: Install link.

    The plan's Details page displays.

  3. Click Run.

    The plan's Run page displays.

  4. In the Plan Parameters area, select the variable settings for the AppInstance component that you plan to deploy.

    Each new application server instance needs a unique name. You must create a new variable set to indicate the name for each new application server instance.

    • If the variable settings have been established for this component, select the appropriate settings from the menu.

    • If the settings are not available from the menu, click Select From List.

      The Select Variable Settings From List window displays.

      • To create a new set of variable settings, select Create Set.

        The following list provides commonly-updated variables for the AppInstance component. The AppInstance variable settings rely primarily on the standalone application server's variable setting values. You can keep the default values for most variables.

        variable set name

        Required. A name for the new variable set you create.

        name

        Required. The name of the application server instance.

      • To use variable components from another component, click Import Set.

        For more information about importing variable sets, see How to Run a Plan in N1 Grid Service Provisioning System 5.0 Operation and Provisioning Guide.

  5. Select the target host.

    Install the application server instance on the virtual host of a standalone application server.

  6. Deselect the Target Host Set checkbox.

  7. If you are capturing an existing standalone application server within the provisioning system, select the markOnly Install option.

    This option enables you to create a component that represents an existing WebSphere 5.1 object and then manage the object through the provisioning system.

  8. Click Run Plan (Includes Preflight).

  9. View the Hosts page to verify that the new application server instance virtual host was created.

ProcedureHow to Install a Deployment Manager

When your configuration contains multiple standalone application servers you can manage them with a deployment manager. The deployment manager tracks which applications are being deployed to which application server instance.

You can use this procedure to create a deployment manager or you use this procedure to register an existing deployment manager within the provisioning system.

Note –

This task is performed as root.

Steps

  1. Ensure that your WebSphere session variables, WS_DEFAULT_USER and WS_DEFAULT_PASSWORD, are set.

    For more information about session variables, see Chapter 5, Session Variables, in N1 Grid Service Provisioning System 5.0 Plan and Component Developer’s Guide.

  2. In the Common Tasks section in the browser interface, click WebSphere 5.1.

  3. Click the Network Deployment Manager: Install link.

    The plan's Details page displays.

  4. Click Run.

    The plan's Run page displays.

  5. In the Plan Parameters area, select the variable settings for the NetworkDeploymentInstall component that you plan to deploy.

    • If the variable settings have been established for this component, select the appropriate settings from the menu.

    • If the settings are not available from the menu, click Select From List.

      The Select Variable Settings From List window displays.

      • To create a new set of variable settings, select Create Set.

        The NetworkDeploymentInstall variable settings rely primarily on the standalone application server's variable setting values.

        Note –

        If you change the default port values for the deployment manager, ensure that they do not conflict with the standalone application server's port values.

        variable set name

        Required. A name for the new variable set you create.

        installPath

        Required. The location where you plan to install the WebSphere deployment manager.

        The default value for installPath is /opt/was51nd.

        installerHome

        Required. The location of the deployment manager installer

        Note –

        Do not include extra spaces after the path name.

        name

        Required. The name of the deployment manager's virtual host.

        httpServerPort

        Required for regular web access. The web server port number.

        httpsTrnsprtPort

        Required for secure web access. The secure web server port number.

        bootstrap

        Required. The bootstrap port. You must change the port number if you install a standalone application server and a deployment manager on the same remote agent.

    • To use variable components from another component, click Import Set.

      For more information about importing variable sets, see How to Run a Plan in N1 Grid Service Provisioning System 5.0 Operation and Provisioning Guide.

  6. Select the target host.

    Install the deployment manager on a remote agent.

    Note –

    The target host must be a member of the com.sun.was#InstallTargetHS host set.

  7. Deselect the Target Host Set checkbox.

  8. If you are capturing an existing standalone application server within the provisioning system, select the markOnly Install option.

    This option enables you to create a component that represents an existing WebSphere 5.1object and then manage the object through the provisioning system.

  9. Click Run Plan (Includes Preflight).

  10. Verify that the new deployment manager virtual host was created by viewing the Hosts page.

ProcedureHow to Add Nodes to the Deployment Manager

For a deployment manager to track which applications are deployed to different standalone application servers, you must add the standalone application servers to the deployment manager. The process of adding nodes to the deployment manager is also called federation.

Note –

This task is performed as root.

Before You Begin

Before you can add nodes to a deployment manager, the deployment manager must be installed. For information on installing a deployment manager, see How to Install a Deployment Manager.

Steps

  1. In the Common Tasks section in the browser interface, click WebSphere 5.1.

  2. Click the Network Deployment Manager: Federate link.

    The plan's Details page displays.

  3. Click Run.

    The plan's Run page displays.

  4. Select the target host.

    Select the standalone application server virtual host that you plan to federate.

  5. Deselect the Target Host Set checkbox.

  6. Type the name of the deployment manager virtual host with which you plan to federate the standalone application server.

  7. If you want to copy applications from the federated node to the deployment manager, ensure that the includeApps option is set to true.

  8. If you are creating a representation of an existing, federated standalone application server, select the markOnly Install field.

    This option enables you to represent an existing WebSphere 5.1 object and then manage through the provisioning system.

  9. Click Run Plan (Includes Preflight).

    After federation, the standalone application server virtual host's host type attributes, cellName and dmHost, are updated with the appropriate information.

ProcedureHow to Create a WebSphere Cluster

When you create a WebSphere cluster through the provisioning system, you create an empty container that can hold cluster members. To add cluster members to a cluster, see How to Add Cluster Members.

Note –

This task is performed as root.

Steps

  1. In the Common Tasks section in the browser interface, click WebSphere 5.1.

  2. Click the Cluster Management: Create link.

    The plan's Details page displays.

  3. Click Run.

    The plan's Run page displays.

  4. In the Plan Parameters area, select the variable settings for the Cluster component that you plan to deploy.

    Each new cluster needs a unique name. You must create a new variable set to indicate the new name for each cluster.

    • If the variable settings have been established for this component, select the appropriate settings from the menu.

    • If the settings are not available from the menu, click Select From List.

      The Select Variable Settings From List window displays.

      • To create a new set of variable settings, select Create Set.

        The following list provides commonly updated variables for the Cluster component. You can keep the default values for most variables.

        variable set name

        Required. A name for the new variable set you create.

        name

        Required. The name of the cluster.

        clusterSPSName

        Required. The name of the cluster virtual host.

    • To use variable components from another component, click Import Set.

      For more information about importing variable sets, see How to Run a Plan in N1 Grid Service Provisioning System 5.0 Operation and Provisioning Guide.

  5. Select the target host.

    Target the virtual host of the deployment manager that will manage the cluster.

  6. Deselect the Target Host Set checkbox.

  7. If you are creating a representation of an existing cluster, select the markOnly Install option.

    This option enables you to represent an existing WebSphere 5.1 object and then manage through the provisioning system.

  8. Click Run Plan (Includes Preflight).

  9. View the Hosts page to verify that the cluster virtual host was created.

ProcedureHow to Add Cluster Members

The procedure creates new cluster members in selected clusters.

Note –

This task is performed as root.

Steps

  1. In the Common Tasks section in the browser interface, click WebSphere 5.1.

  2. Click the Cluster Member Management: Join link.

    The plan's Details page displays.

  3. Click Run.

    The plan's Run page displays.

  4. In the Plan Parameters area, select the variable settings for the ClusterMember component that you plan to deploy.

    Each new cluster member needs a unique name. You must create a new variable set to indicate the name for each new cluster member.

    • If the variable settings have been established for this component, select the appropriate settings from the menu.

    • If the settings are not available from the menu, click Select From List.

      The Select Variable Settings From List window displays.

      • To create a new set of variable settings, select Create Set.

        The following list provides commonly-updated variables for the ClusterMember component. You can keep the default values for most variables.

        variable set name

        Required. A name for the new variable set you create.

        name

        Required. The name of the cluster member.

        cmemberSPSName

        Required. The name of the cluster member virtual host.

    • To use variable components from another component, click Import Set.

      For more information about importing variable sets, see How to Run a Plan in N1 Grid Service Provisioning System 5.0 Operation and Provisioning Guide.

  5. Select the target host.

    You target the cluster virtual host where you plan to add the cluster member.

  6. Deselect the Target Host Set checkbox.

  7. If you are creating a representation of an existing cluster member, select the markOnly Install option.

    This option enables you to represent an existing WebSphere 5.1 object and then manage through the provisioning system.

  8. Click Run Plan (Includes Preflight).

  9. Click the View Cluster Members link on the WebSphere 5.1 Common Tasks page to verify that the cluster members were created.

Configuring the WebSphere 5.1 Environment

The WebSphere 5.1 plug-in enables you to create components that configure various aspects of the WebSphere 5.1 environment. This section describes the following tasks:

ProcedureHow to Create a JDBC Provider Component

You create the JDBC provider component and then install it. See How to Install a JDBC Provider Component.

Steps

  1. In the Common Tasks section in the browser interface, click WebSphere 5.1.

  2. Click the JDBC Provider: Create link.

    The component's Edit page displays.

  3. Type the new JDBC Provider's component name.

  4. (Optional) Type the label and description of the JDBC Provider.

  5. Modify the values of the component variables, then click Check In.

    The following list describes the variables that you must update for the component. You can keep the default values for most variables.

    providerName

    Required. The name for the JDBC Provider that you are creating.

    implementationClassName

    Required. The Java class name of the JDBC driver implementation

    dbClasspath

    Required. The list of paths or JAR file names that form the location for the resource provider classes.

  6. If you do not want to use the default folder, select the folder in which you plan to place the Data Source component by clicking the Change Folder link.

    Select the folder from the Change Folder window and click Change to Selected Folder.

    Note –

    You cannot create a new component in a folder that is owned by a plug-in.

  7. Click Continue to Check In.

    The Components page displays.

ProcedureHow to Install a JDBC Provider Component

Before You Begin

The JDBC Provider component that you plan to install must exist within the provisioning system. See How to Create a JDBC Provider Component.

Steps

  1. In the Common Tasks section in the browser interface, click WebSphere 5.1.

  2. Click the JDBC Provider: View All link.

    The component's Edit page displays.

  3. If necessary, find the component by changing to the root folder and selecting the Show Flat View option.

    All JDBC Provider components registered with the provisioning system display in the Component table.

  4. In the row of the JDBC Provider component that you plan to install, click Details.

    The component Details page displays.

  5. In the Component Procedures table, select the Default: Install procedure and click Run.

    The plan Run page displays.

  6. Select the variable set.

  7. Select the target host.

    You can target the data source component to one of the following hosts.

    • Standalone application server virtual host

    • Deployment Manager virtual host

    • Cluster member virtual host

    • Application server instance virtual host

  8. Deselect the Target Host Set checkbox.

  9. Click Run Plan (Includes Preflight).

ProcedureHow to Create a Data Source Component

You create a data source component then install it. See How to Install a Data Source Component.

Before You Begin

Before you create a data source component, you must first create and install the JDBC provider component. See How to Create a JDBC Provider Component.

Steps

  1. In the Common Tasks section in the browser interface, click WebSphere 5.1.

  2. Click the Data Source: Create link.

    The component's Edit page displays.

  3. Type the new data source's component name.

  4. (Optional) Type the label and description of the data source.

  5. If necessary, modify the values of the component variables, then click Check In.

    The following list describes the variables that you must update for the component. You can keep the default values for most variables.

    jdbcProvider

    Required. The name of the JDBC provider under which the Data Source is created.

    jndiName

    Required. The JNDI name for the data source.

    dsHelperClassName

    Required. The name of the datastore helper that is used to perform specific database functions

    authDataAlias

    Required. The alias to use for run time database authentication.

    dbName

    Required. The database name.

  6. Modify the folder in which you plan to place the Data Source component by clicking the Change Folder link.

    Select the folder from the Change Folder window and click Change to Selected Folder.

    Note –

    You cannot create a new component in a folder that is owned by a plug-in.

  7. Click Continue to Check In.

    The Components page displays.

ProcedureHow to Install a Data Source Component

Before You Begin

The Data Source component that you plan to install must exist within the provisioning system. See How to Install a Data Source Component.

Steps

  1. In the Common Tasks section in the browser interface, click WebSphere 5.1.

  2. Click the Data Source: View All link.

    The component's Edit page displays.

  3. If necessary, change to the root folder and select the Show Flat View option to find the component.

    All data source components registered with the provisioning system display in the Component table.

  4. In the row of the Data Source component that you plan to install, click Details.

    The component Details page displays.

  5. In the Component Procedures table, select the Default: Install procedure and click Run.

    The plan Run page displays.

  6. Select the variable set.

  7. Select the target host.

    You can target the data source component to one of the following hosts.

    • Standalone application server virtual host

    • Deployment Manager virtual host

    • Cluster member virtual host

    • Application server instance virtual host

  8. Deselect the Target Host Set checkbox.

  9. Click Run Plan (Includes Preflight).

ProcedureHow to Configure the JVM Component

Steps

  1. In the Common Tasks section in the browser interface, click WebSphere 5.1.

  2. Click the JVM: Configure link.

    The component's Edit page displays.

  3. Type the new JVM component name.

  4. (Optional) Type the label and description of the JVM.

  5. Modify the values of the component variables, then click Check In.

    The following list describes the variables that you can update for this component. You can keep the default values for most variables.

    initHeapSize

    Required. The initial heap size.

    maxHeapSize

    Required. The maximum heap size.

  6. If you do not want to use the default folder, select the folder in which you plan to place the Data Source component by clicking the Change Folder link.

    Select the folder from the Change Folder window and click Change to Selected Folder.

    Note –

    You cannot create a new component in a folder that is owned by a plug-in.

  7. Click Continue to Check In.

    The Components page displays.

ProcedureHow to Install a JVM Component

Before You Begin

The JVM component that you plan to install must exist within the provisioning system. See How to Configure the JVM Component.

Steps

  1. In the Common Tasks section in the browser interface, click WebSphere 5.1.

  2. Click the JVM: View Configurations link.

    The component's Edit page displays.

  3. If necessary, find the component by changing to the root folder and selecting the Show Flat View option.

    All JVM components registered with the provisioning system display in the Component table.

  4. In the row of the JVM component that you plan to install, click Details.

    The component Details page displays.

  5. In the Component Procedures table, select the Default: Install procedure and click Run.

    The plan Run page displays.

  6. Select the variable set.

  7. Select the target host.

    The target host is either an application server or a cluster member.

  8. Deselect the Target Host Set checkbox.

  9. Click Run Plan (Includes Preflight).

Managing the WebSphere 5.1 Infrastructure Components

In addition to installing WebSphere 5.1 infrastructure components, you can use the provisioning system to start, stop, and uninstall these components. This section describes the following tasks:

ProcedureHow to Start or Stop an Application Server for Standalone Systems

Steps

  1. In the Common Tasks section in the browser interface, click WebSphere 5.1.

  2. Click the WebSphere Application Server for Standalone Systems: Start or Stop link.

    The component's Details page displays.

  3. In the Component Procedures table, select the startServer or stopServer procedure and click Run.

    The plan's Run page displays hosts that have the standalone application server installed.

  4. Select the host that you plan to start or stop.

    You select the host and its installation path from the list of current installations.

  5. Click Run Selected Installations.

  6. Verify that the plan details are correct and click Run Plan (Includes Preflight).

ProcedureHow to Uninstall an Application Server for Standalone Systems

Steps

  1. In the Common Tasks section in the browser interface, click WebSphere 5.1.

  2. Click the WebSphere Application Server for Standalone Systems: Uninstall link.

    The plan's Details page displays.

  3. Click Run.

    The plan's Run page displays the remote agents that have the standalone application servers installed.

  4. Select the target host.

    You target the remote agent on which the standalone application server is installed.

  5. Deselect the Target Host Set checkbox.

  6. To specify the version of the application server that you plan to uninstall, type the application server's install path.

    If this value is omitted, the most recently installed component in any path is used. The value is converted to universal format prior to component resolution. This attribute can reference simple substitution variables.

  7. If you want to remove the standalone application server from the provisioning system but want to keep the application server running in the WebSphere environment, select the markOnly option

  8. Click Run Plan (Includes Preflight).

ProcedureHow to Start or Stop an Application Server Instance

Steps

  1. In the Common Tasks section in the browser interface, click WebSphere 5.1.

  2. Click the Application Server Instances: Start or Stop link.

    The component's Details page displays.

  3. In the Component Procedures table, select the startAppInstance or stopAppInstance procedure and click Run.

    The plan's Run page displays.

  4. Select the standalone application server virtual host on which the application server instance is installed.

  5. Click Run Selected Installations.

  6. Verify that the plan details are correct and click Run Plan (Includes Preflight).

ProcedureHow to Uninstall an Application Server Instance

Steps

  1. In the Common Tasks section in the browser interface, click WebSphere 5.1.

  2. Click the Application Server Instances: Uninstall link.

    The plan's Details page displays.

  3. Click Run.

    The plan's Run page displays.

  4. Select the target host.

    You target the standalone application server virtual host that you plan to uninstall.

  5. Deselect the Target Host Set checkbox.

  6. Type the install path of the application instance that you plan to uninstall.

    If this value is omitted, the most recently installed component in any path is used. The value is converted to universal format prior to component resolution. This attribute can reference simple substitution variables.

  7. If you want to remove the application server instance from the provisioning system but want to keep the application server instance running in the WebSphere environment, select the markOnly option.

  8. Click Run Plan (Includes Preflight).

ProcedureHow to Start or Stop a Deployment Manager

Steps

  1. In the Common Tasks section in the browser interface, click WebSphere 5.1.

  2. Click the Network Deployment Manager: Start or Stop link.

    The component's Details page displays.

  3. In the Component Procedures table, select the startServer or stopServer procedure and click Run.

    The plan's Run page displays.

  4. Select the virtual host on which the deployment manager is installed.

  5. Click Run Selected Installations.

  6. Verify that the plan details are correct and click Run Plan (Includes Preflight).

ProcedureHow to Uninstall a Deployment Manager

Steps

  1. In the Common Tasks section in the browser interface, click WebSphere 5.1.

  2. Click the Network Deployment Manager: Uninstall link.

    The plan's Details page displays.

  3. Click Run.

    The plan's Run page displays.

  4. Select the remote agent on which you installed the deployment manager.

  5. Type the install path of the deployment manager that you plan to uninstall.

    If this value is omitted, the most recently installed component in any path is used. The value is converted to universal format prior to component resolution. This attribute can reference simple substitution variables.

  6. If you want to remove the deployment manager from the provisioning system but want to keep the deployment manager running in the WebSphere environment, select the markOnly option.

  7. Click Run Plan (Includes Preflight).

ProcedureHow to Start or Stop a Cluster

Steps

  1. In the Common Tasks section in the browser interface, click WebSphere 5.1.

  2. Click the Cluster Management: Start or Stop link.

    The component's Details page displays.

  3. In the Component Procedures table, select the startCluster or stopCluster procedure and click Run.

    The plan's Run page displays.

  4. Select the cluster that you plan to start or stop.

    You select the deployment manager and the cluster name from the list of current installations.

  5. Click Run Selected Installations.

  6. Verify that the plan details are correct and click Run Plan (Includes Preflight).

ProcedureHow to Uninstall a Cluster

Steps

  1. In the Common Tasks section in the browser interface, click WebSphere 5.1.

  2. Click the Cluster Management: Remove link.

    The plan's Details page displays.

  3. Click Run.

    The plan's Run page displays.

  4. Select the target host.

    You target the deployment manager virtual host.

  5. Deselect the Target Host Set checkbox.

  6. Type the install path of the cluster that you plan to uninstall.

    If this value is omitted, the most recently installed component in any path is used. The value is converted to universal format prior to component resolution. This attribute can reference simple substitution variables.

  7. If you want to remove the cluster from the provisioning system but want to keep the cluster running in the WebSphere environment, select the markOnly option

  8. Click Run Plan (Includes Preflight).

ProcedureHow to Remove Cluster Members

Steps

  1. In the Common Tasks section in the browser interface, click WebSphere 5.1.

  2. Click the Cluster Member Management: Leave link.

    The plan's Details page displays.

  3. Click Run.

    The plan's Run page displays.

  4. Select the cluster virtual host as the target host.

  5. Deselect the Target Host Set checkbox.

  6. If you want to remove the cluster member from the provisioning system but want to keep the cluster member running in the WebSphere environment, select the markOnly option.

  7. Click Run Plan (Includes Preflight).

Using the Command-Line Interface to Work with WebSphere 5.1

Using the N1 Grid Service Provisioning System Command-Line Interface

By default, the provisioning system's command-line interface is located in the following directory: /opt/SUNWn1sps/N1_Grid_Service_Provisioning_system_5.0/cli/bin/cr_cli

WebSphere 5.1 plug-in objects are located in the /com/sun/was/5.1 folder.

You can interact with plug-in components and plans much like any other custom component or plan. However, if you want to make changes to the components or plans, you must save the component or plan to a new folder and make your changes there. For more information about using the provisioning system's command-line interface, see Chapter 1, Using the Command-Line Interface, in N1 Grid Service Provisioning System 5.0 Command-Line Interface Reference Manual

Using the WebSphere 5.1 wsadmin Script

You can run the WebSphere 5.1scripting program, wsadmin, through the N1 Grid Service Provisioning System. For more information about how to use the scripting program, see IBM's WebSphere 5.1 documentation.

ProcedureHow to Run the wsadmin Script

Steps

  1. In the Common Tasks section in the browser interface, click WebSphere 5.1.

  2. Click the Command Line Interface: Run Command link.

    The plan's Details page displays.

  3. Click Run.

  4. Select the target host.

    You can target the virtual host of the standalone application server or deployment manager.

  5. Type the arguments for the wsadmin script in the Plan Variables field.

  6. Click Run Plan (Includes Preflight).

Example 4–1 Creating a Cluster Using the wsadmin Script

This example illustrates input for the wsadmin script.

If you wanted to create a cluster using the command line, you could type the following string in the Enter the Arguments to wsadmin Script field.


-c 'set cell [$AdminConfig getid /Cell:cellname/]' 
-c '$AdminConfig create ServerCluster $cell {{name clustername}}' 
-c '$AdminConfig save'

In this example, cellname is the name of the existing cell and clustername is the cluster that you plan to create.

Using a Component Type to Deploy WebSphere Applications

The WebSphere Plug-In includes several WebSphere-specific component types. These component types enable you to quickly model many of the most common WebSphere application components and to automatically associate install, uninstall, export, and snapshot behavior with a particular resource. Many of the component types are used by the software when you create and manage servers and clusters. As a result, there is only one component type that you will work with on a regular basis, as described in the following section:

Note –

The WebSphere Plug-In can only install EAR files that were assembled using the IBM assemble tool. These files contain configuration settings that the plug-in requires.

Enterprise Application (EAR) Component Type

A component of this type models an enterprise application. The component can contain either an enterprise application archive (EAR) or the expanded version of an EAR as a package.

Browsing for an Enterprise Application

You can use one of the following browsers to select your enterprise application for this component type:

Note –

The WebSphere Plug-In can only install EAR files that were assembled using the IBM assemble tool. These files contain configuration settings that the plug-in requires.

Installing an Enterprise Application

To install an enterprise application component, you must use a WebSphere application server instance or cluster as the target host. The installation process performs three main tasks:

  1. Installs the EAR file on the target.

  2. Registers the EAR with the WebSphere Application Server.

You can install the enterprise application by navigating to the application's component Details page and running the Install component procedure.

Uninstalling an Enterprise Application

When you uninstall an enterprise application component, the enterprise application no longer targets the virtual host. If the enterprise application is not targeted elsewhere, the registration component is removed from the application server .

You can uninstall the enterprise application by navigating to the application's component Details page and running the Uninstall component procedure.

Starting and Stopping an Enterprise Application

You can start and stop enterprise applications that have been installed with the provisioning system.

ProcedureHow to Start or Stop an Enterprise Application

Steps

  1. In the Common Tasks section in the browser interface, click WebSphere 5.1.

  2. Click the Enterprise Applications (EAR): View All link.

    The Components page displays.

  3. Select the enterprise application that you plan to start or stop, and click Details.

    The component Details page displays.

  4. In the Component Procedures table, select the Start or Stop procedure and click Run.

    The plan's Run page displays.

  5. Select the virtual host of the application server that hosts the enterprise application that you plan to start or stop.

  6. Click Run Selected Installations.

    The plan Run page displays.

  7. Click Run Plan (Includes Preflight).

Installing Web Application (WAR) and Java Archive (JAR) File

WebSphere does not support WAR and JAR files. If you need to install a WAR or JAR file through the provisioning system, use the WebSphere Assemble tool to convert the file to the EAR format. After you export the file, you can use the provisioning system to deploy it.

Plans

The WebSphere Plug-In relies on plans to perform many of the tasks associated with installing and removing application servers, deployment managers, and clusters.

WebSphere 5.1 plug-in plans are located in the /com/sun/was/5.1 folder.

Troubleshooting

If you are experiencing problems managing WebSphere through the provisioning software, messages will likely appear on the screen to tell you that a problem exists.


Problems encountered during plan run or preflight

The plan (or preflight) "/com/sun/was/5.1/DeleteCluster" finished 
with 1 failed host(s). (017034)

Cannot perform operation on component component 
/com/sun/was/5.1/Cluster because it was not installed on host sun-1 (017057)
Unable to resolve installed component for component 
/com/sun/was/5.1/Cluster. (602021)

Although the message in this example is easily deciphered, not all messages are this straightforward. To find out more information about a specific problem, follow the Run History Details links. Drill down to the final error block and view the output of stderr and stdout on the error condition.

Uninstalling the WebSphere 5.1 Plug-in

ProcedureHow to Uninstall the WebSphere 5.1 Plug-in.

Before You Begin

You cannot uninstall a plug-in if any object owned by the plug-in is being used by the provisioning system.

To uninstall a plug-in, you must be a member of the admin user group.

Steps

  1. Ensure that all objects owned by the plug-in are not in use.

    The following components must be uninstalled from the hosts on which they were installed.

    • WebSphere applications

    • WebSphere application servers

    • Deployment Managers

    • Clusters

    • Cluster Members

    You cannot delete a plug-in if any object owned by the plug-in is being used by the provisioning system.

  2. In the Application Deployment section of the browser interface, click Plans.

  3. If necessary, navigate to the /com/sun/was/5.1 folder.

  4. Select UninstallSystemServicesPlan and click Details.

    The plan's Details page is displayed.

  5. Click Run.

  6. Verify that the com.sun.was#InstallTargetHS target host set is selected.

  7. Click Run Plan (Includes Preflight).

    The WebSphere system services are deleted.

  8. In the Administrative section of the browser interface, click Plug-ins.

  9. Select the plug-in that you want to uninstall and click Details.

    The plug-in Details page displays.

  10. At the bottom of the Details page, click Delete.

    You are asked to verify that you want to delete the plug-in.

  11. Click Continue to Delete.

    After the plug-in is deleted, the Plug-in page is updated.