Sun N1 Service Provisioning System User's Guide for SAP Plug-In 1.0

Creating, Managing and Installing SAP Application Servers

The Common Tasks page of the software enables you to create and manage instances of SAP Application Servers.

This section presents the tasks necessary to create SAP Application Servers and to install SAP Application Servers:

Application Server Creation and Management

The following procedures install, uninstall, and manage the SAP Application Server.

ProcedureHow To Create an Application Server

This task creates an SAP Application Server entry in the SPS database.


Note –

This task is a markOnly task.


Steps
  1. In the Common Tasks section of the N1 SPS browser interface, click SAP.

  2. In the Application Server section of the SAP Tasks page, click Create.

  3. Click Run.

  4. In the Plan Parameters table, select the variable settings for the AppServer component.

    • If the variable settings have been created for this component, select the appropriate settings from the drop-down menu.

    • If the variable settings are not available from the drop-down menu:

      1. Click Select From List.

        The Select Variable Settings From List window displays.

        • To create a new variable settings set, click Create Set and type a Set Name.

          The following list provides commonly updated variables for the AppServer component. To create a value for the component variable, click the check box in the component variable's row.


          Note –

          For information about component variables ending in UserExit, see User Exits.


          groupName

          This is a required field.


          Note –

          In the Sun Cluster environment, the groupName must equal the Sun Cluster resource group name.


          groupDescription

          A description of the group.

          resourceName

          Required for the Sun Cluster environment.

          envType

          Identifies whether this component will be deployed to a default, Sun Cluster, or SAP AC environment. Value can be ac, sc, or default.

          createdBy

          Identifies the installer of the component.

          ciLhName

          Required for default install only. This value names the Central Instance logical host.

          asLhName

          Required for the default environment. This value names the Application Server logical host.

          sapSid

          Required for the default environment. The SAP system ID consists of three uppercase alphanumeric characters. The first character must be a letter.

          asSystemInstanceNumber

          Required for the default environment. Application Server instance number. Generate from variable input.

          instanceSize

          Application Server instance size which is generated from variable input. Possible values are small, medium, or big. Default value: medium.

          accServiceID

          Required for the SAP AC environment. The service ID of the SAP Application Server instance (only applicable in the SAP AC environment).

          srmProject

          The Solaris Resource Management (SRM) project name. Default value: default.

          ciInstanceName

          Required for the default environment. The Central Instance name (as in the SAP Central Instance start profile).

          isNewSapVersion

          Required for the default environment. TRUE means the central scripts are used to start and stop the application server. FALSE means instance–specific start and stop scripts from the SAP user home directory will be used to start and stop the application server. Default value: TRUE.

      2. Click Save.

    • To use component variables from another component, click Import Set.

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

  5. Select the target host or target host set.

  6. Click the Run Plan (Includes Preflight) button.

    The Deployment Results page is displayed. If the plan fails, error messages are displayed.

ProcedureHow To Delete an Application Server

This task deletes an SAP Application Server entry from the SPS database.


Note –

This task is a markOnly task.


Steps
  1. In the Common Tasks section of the Sun N1 SPS browser interface, click SAP.

  2. In the Application Server section of the SAP Tasks page, click Delete.

  3. Click Run.

  4. Select the target host or target host set.

  5. Provide the plan variable.

    InstallPath of the AppServer component

    This is a required field. If you do not know the install path, return to the SAP Tasks page and click the View All link.

  6. Click the Run Plan (Includes Preflight) button.

    The Deployment Results page is displayed. If the plan fails, error messages are displayed.

ProcedureHow To Start an Application Server

Prior to starting the SAP Application Server, the plug-in does not check any dependencies. After the startup, the plug-in verifies that the main processes are running. The main processes for the SAP Application Server are:

If the SAP Application Server is installed with the central script to start and stop it, then the plug in starts the application server instance by using the central SAP script like the following:


startsap r3 Dinstance-num_logical-host

If the SAP Application Server is installed without the central script, then the plug–in starts it by using the following script in the home directory of user sidadm:


startsap_Dinstance-num_logical-host
Steps
  1. In the Common Tasks section of the N1 SPS browser interface, click SAP.

  2. In the Application Server section of the SAP Tasks page, click Start.

  3. Click Run.

  4. Select the target host or target host set.

  5. Provide the plan variables.

    InstallPath of the SAP application server component to start

    This is a required field. If you do not know the install path, return to the SAP Tasks page and click the View All link.

    Force start the application server instance on a small server (currently only applicable for the SAP AC environment)

    This option is required when the target host does not meet the SAPS requirement to start the SAP instance. See the SAP Installation Guide for the minimum requirements for starting the SAP instance.


    Note –

    This option is only applicable in the SAP AC environment.


  6. Click the Run Plan (Includes Preflight) button.

    The Deployment Results page is displayed. If the plan fails, error messages are displayed.

ProcedureHow To Stop an SAP Application Server

If the SAP component is offline, the plan will complete successfully without any further action. If the SAP component is not offline, the plan stops the SAP component.

If a normal stop fails and the user has selected the Force Stop option, the plan will perform a hard stop by killing the main process. The plan then verifies that the SAP component is offline. If it is, the plan completes successfully. If the SAP component is not offline, the plan fails. The processes used to determine the status follow:

If the SAP Application Server is installed with the central script to start and stop it, then the plug–in stops the application server instance by using the central SAP script, as the following:


stopsap r3 Dinstance-num_logical-host

If the SAP Application Server is installed without the central script, then the plug–in stops it by using the following script in the home directory of user sidadm:


stopsap_Dinstance-num_logical-host
Steps
  1. In the Common Tasks section of the N1 SPS browser interface, click SAP.

  2. In the Application Server section of the SAP Tasks page, click Stop.

  3. Click Run.

  4. Select the target host or target host set.

  5. Provide the plan variables.

    InstallPath of the SAP application server component to stop

    This is a required field. If you do not know the install path, return to the SAP Tasks page and click the View All link.

    Force stop SAP application server after the graceful stop failed in the default environment

    This option is selected by default.

  6. Click the Run Plan (Includes Preflight) button.

    The Deployment Results page is displayed. If the plan fails, error messages are displayed.

ProcedureHow To View All Application Server Instances

When executing this task, the Hosts Where Installed table is displayed with entries for each SAP Application Server installation.

Steps
  1. In the Common Tasks section of the N1 SPS browser interface, click SAP.

  2. In the Application Server section of the SAP Tasks page, click View All.

    The Hosts Where Installed table is displayed.

ProcedureHow To Check the Online Status of an Application Server Instance

If the main processes are present on the system, the resource is considered online. If any of the main processes are not present on the system, the plug-in identifies the resource as offline.


Note –

SAP AC is not supported.


The main processes are:

Steps
  1. In the Common Tasks section of the N1 SPS browser interface, click SAP.

  2. In the Application Server section of the SAP Tasks page, click Online Status.

  3. Click Run.

  4. Select the target host or target host set.

  5. Provide the plan variable.

    InstallPath of the application server component

    This is a required field. If you do not know the install path, return to the SAP Tasks page and click the View All link.

  6. Click the Run Plan (Includes Preflight) button.

    The Deployment Results page is displayed. If the plan fails, error messages are displayed.

ProcedureHow To Check the Offline Status of an Application Server Instance

If the main processes are present on the system, the resource is considered online. If any of the main processes are present on the system, the plug-in identifies the resource as not offline. If none of the main sap processes are present on the system, the plug-in identifies the resource as offline.

The main processes are:


Note –

SAP AC is not supported.


Steps
  1. In the Common Tasks section of the N1 SPS browser interface, click SAP.

  2. In the Application Server section of the SAP Tasks page, click Offline Status.

  3. Click Run.

  4. Select the target host or target host set.

  5. Provide the plan variable.

    InstallPath of the application server component

    This is a required field. If you do not know the install path, return to the SAP Tasks page and click the View All link.

  6. Click the Run Plan (Includes Preflight) button.

    The Deployment Results page is displayed. If the plan fails, error messages are displayed.

Installing Application Servers

The two different installations are:

Installing the Application Server With a Default Exception File

The SAP Plug-In comes with an SAP Application Server default exception file. This default exception file has all the necessary component variables to perform a default installation.

ProcedureHow to Install an SAP Application Server With a Default Exception File

In order for the application server deployment to succeed, the superuser must have read/write privileges for SAP file systems on the machine where the new instance of application server is to be deployed. The SAP file systems must be shared by using one of the following options:

Steps
  1. In the Common Tasks section of the N1 SPS browser interface, click SAP.

  2. In the Application Server With Default Exception File section of the SAP Tasks page, click Install.

  3. Click Run.

  4. In the Plan Parameters table, select the variable settings for the AppServerWithDefaultExceptionFile component.

    • If the variable settings have been created for this component, select the appropriate settings from the drop-down menu.

    • If the variable settings are not available from the drop-down menu,

      1. Click Select From List.

        The Select Variable Settings From List window displays.

        • To create a new variable settings set, click Create Set and type a Set Name.

          The following list provides commonly updated variables for the AppServerWithDefaultExceptionFile component. To create a value for the component variable, click the check box in the component variable's row.


          Note –

          For information about component variables ending in UserExit, see User Exits.


          resourceName

          Required for the Sun Cluster environment.

          groupName

          This is a required field.


          Note –

          In the Sun Cluster environment, the groupName must equal the Sun Cluster resource group name.


          installPath

          Install location. This path can be modified by the user.

          ciLhName

          Required for the default environment installation. This value names the Central Instance logical host.

          asLhName

          Required for the default environment. The value names the Application Server logical host.

          sapSid

          Required for the default environment. The SAP system ID consists of three uppercase alphanumeric characters. The first character must be a letter.

          asSystemInstanceNumber

          Required for the default environment. The Application Server instance number.

          ciInstanceName

          This is a required field. Central Instance number, which is generated from variable input.

          instanceSize

          Application Server instance size. Possible value are small, medium, and large. Default value: medium.

          envType

          Identifies whether this component will be deployed to a default, Sun Cluster, or SAP AC environment. Value can be ac, sc, or default. Default value: default.

          accServiceID

          This SAP AC service ID is required for the SAP AC environment.

          srmProject

          The Solaris Resource Management (SRM) project name. Default value: default.

          isNewSapVersion

          This is a required field. TRUE means the central scripts are used to start and stop the application server. FALSE means instance–specific start and stop scripts from the SAP user home directory will be used to start and stop the application server. Default value: default.

          createdBy

          Identifies the installer of the component.

      2. Click Save.

    • To use component variables from another component, click Import Set.

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

  5. Select the target host or target host set.

  6. Click the Run Plan (Includes Preflight) button.

    The Deployment Results page is displayed. If the plan fails, error messages are displayed.

ProcedureHow to Uninstall an SAP Application Server With a Default Exception File

Plan to uninstall the SAP Application Server along with the default exception file.

Steps
  1. In the Common Tasks section of the N1 SPS browser interface, click SAP.

  2. In the Application Server With Default Exception File section of the SAP Tasks page, click Uninstall.

  3. Click Run.

  4. Select the target host or target host set.

  5. Provide the plan variable.

    Install path for the application server installed with default exception file

    This is a required field. If you do not know the install path, return to the SAP Tasks page and click the View All link.

    markOnly delete

    Selecting the markOnly delete check box deletes the Application Server component from the SPS database. If the markOnly delete check box is selected, the Application Server component is deleted from the SPS database and the Application Server is deleted at the OS level.

  6. Click the Run Plan (Includes Preflight) button.

    The Deployment Results page is displayed. If the plan fails, error messages are displayed.

ProcedureHow to View All SAP Application Server Instances With a Default Exception File

Steps
  1. In the Common Tasks section of the N1 SPS browser interface, click SAP.

  2. In the Application Server With Default Exception File section of the SAP Tasks page, click View All.

    The Host Where Installed table is displayed.

Installing the Application Server With a Custom Exception File

A custom exception file enables you to create a unique set of variables by which to deploy an application server.

This section describes the following tasks:

ProcedureHow to Create Custom Exception File Components

The custom exception file enables you to provide and check in a custom exception file to SPS. You can then use the custom exception file to deploy the application server instead of the default exception file which is provided by the plug–in.

Before You Begin

The custom exception file must be available on the machine where the custom exception file component is created.

Steps
  1. Create the custom exception file.

    For more information, see Exception File Example

  2. In the Common Task ssection of the N1 SPS browser interface, click SAP.

  3. In the Application Server With Custom Exception File section of the SAP Tasks page, click Create Component.

  4. Provide the component information.

    Component

    This is a required field. This is the component name.

    Type

    Leave this value as com.sun.sap#AppServerWithExceptionFile.

    Platform

    Select a specific platform or leave the default value of system#any.

    Label

    Short description of the component.

    Description

    A description of the component.

  5. Import Exception File from host.

    1. Click the Select From List link.

    2. Select a host from the Current Hosts Found list.

    3. Click the Add Host to Main Window button.

    4. Click Refresh.

    5. Navigate to the exception file and click to select it.

  6. Select additional options if desired.

  7. Click the Check In Selected Item button.

    The Check In window is displayed.

  8. Specify the component name.

    You can change the component name if you wish. For example, MyCustomExceptionFileComponent.

  9. Click the Change Folder link.

  10. Change to the /com/sun/n1aa/exceptionfiles directory.

    For more information, see Chapter 6, Setting Up Folders, in Sun N1 Service Provisioning System 5.2 System Administration Guide.

  11. Click the Change To Selected Folder button.

  12. Click the Continue to Check In button.

    The Components table is displayed.

ProcedureHow to View All Exception File Components

Steps
  1. In the Common Tasks section of the N1 SPS browser interface, click SAP.

  2. In the Application Server With Custom Exception File section of the SAP Tasks page, click View All Components.

  3. Click the View Current Component Check-Ins button.

    The Default Exception File and any previously checked in Custom Exception files are displayed.

    If you do not see the components you checked in, click on the Change Folder link and change the folder to the one in which you created the components.

ProcedureHow to Create Application Server Components

This task creates an SAP Application Server component in the SPS database. This SAP Application Server is used by the Sun N1 Advanced Architecture for SAP Solutions to deploy and create a new SAP Application Server at the OS level.

Steps
  1. In the Common Tasks section of the N1 SPS browser interface, click SAP.

  2. In the Application Server With Custom Exception File section of the SAP Tasks page, click Create Component.

  3. Populate the component information.


    Note –

    For information about component variables ending in UserExit, see User Exits.


    Component

    This is a required field. This is the component name. The format of the component name is ASWithcustom-exception-filename, where custom-exception-filename is the previously created component.

    For example, ASWithMyCustomExceptionFile. This component needs to be in the /com/sun/n1aa/exceptionfiles directory.

    Type

    Leave this value as com.sun.sap#AppServerWithExceptionFile.

    Platform

    Select a specific platform or leave the default value of system#any.

    Label

    A short description.

    Description

    An description of the component.

    Referenced Components
    1. Click the Reference Existing link for the Exception File component.

    2. Select the exception file.

    3. Click the Reference Checked Components button.

      The Add Component Variables table appears.


      Note –

      This table will be empty if there are no component variables


    4. Click the Continue to Reference Components button.

  4. Populate the Component Variables.

    resourceName

    Required for the Sun Cluster environment.

    groupName

    This is a required field.


    Note –

    In the Sun Cluster environment, the groupName must equal the Sun Cluster resource group name.


    installPath

    Install location.

    ciLhName

    Required for the default environment installation. Central instance logical host.

    asLhName

    Required for the default environment. Application server logical host.

    sapSid

    Required for the default environment. SAP system ID (3 upper case alphanumeric.) The first character must be an alphabetic letter.

    asSystemInstanceNumber

    Required for the default environment. Application Server instance number.

    ciInstanceName

    This is a required field. Central Instance number. Generated from variable input.

    instanceSize

    Application Server instance size. Default value: medium.

    envType

    Identifies if this component will be deployed to a Default, Sun Cluster, or SAP AC environment. Value can be ac, sc, or default. Default value: default.

    accServiceID

    Required for the SAP AC environment. SAP AC service ID.

    srmProject

    The Solaris Resource Management (SRM) project name. Default value: default.

    isNewSAPVersion

    This is a required field. TRUE means the central scripts are user to start and stop the application server. FALSE means instance specific start and stop scripts from the SAP user home directory will be used to start and stop the application server. Default value: TRUE

    createdBy

    Identifies the installer of the component.

  5. Click Check In.

  6. Click Continue to Check In.

    You have completed the creation of the application server with custom exception file component.

ProcedureHow to View All Application Server Components

Steps
  1. In the Common Tasks section of the N1 SPS browser interface, click SAP.

  2. In the Application Server With Custom Exception File section of the SAP Tasks page, click View All Components.

    The components table is displayed.

ProcedureHow to Create an Application Server With Custom Exception File Install Plan

Steps
  1. Select the Application Server with Custom Exception File component.

    Perform one of the following options to begin the plan creation task:

    • If you are in the Components Details window.

      1. Select default: install

    • If you enter from the Common Tasks page.

      1. In the Common Tasks section of the N1 SPS browser interface, click SAP.

      2. In the Application Server With Custom Exception File section of the SAP Tasks page, click View All Components.

      3. Select the appropriate application server with custom exception file component.

      4. Select the default:install procedure from the component procedures table.

  2. Click Generate Plan With Checked Procedures.

    The plans details advanced edit page appears.

  3. Type the plan name

    The format of the plan name is Installcomponent-namePlan. For example, InstallASWithMyCustomExceptionFilePlan.

  4. Edit the plan definition.

    1. Delete <paramList> through </paramList>

    2. Delete <argList> through </argList>

  5. Click the Check In button.

    The Plans Details Edit Check In window appears.


    Note –

    The following warning might appear and can be ignored.


    warning – plan names and/or paths differ

  6. Click the Continue To Check In button.

    The Plans Details window appears.

  7. Click Done.

    The Plans table is displayed.