swpm10sp5 diag agent unattended

SAP Solution ManagerEnd-to-End Root Cause Analysis

Diagnostics AgentInstallation in Unattended Modewith SWPM 1.0 SP5for NetWeaver higher than 7.0x

Document Version 5.1 23-May-2014

Copyright 2014 SAP AG. All rights reserved.

No part of this publication may be reproduced or transmittedin any form or for any purpose without the expresspermission of SAP AG. The information contained hereinmay be changed without prior notice.

Some software products marketed by SAP AG and itsdistributors contain proprietary software components of othersoftware vendors.

Microsoft, Windows, Outlook, and PowerPoint are registeredtrademarks of Microsoft Corporation.

IBM, DB2, DB2 Universal Database, OS/2, Parallel Sysplex,MVS/ESA, AIX, S/390, AS/400, OS/390, OS/400, iSeries,pSeries, xSeries, zSeries, z/OS, AFP, Intelligent Miner,WebSphere, Netfinity, Tivoli, and Informix are trademarksor registered trademarks of IBM Corporation in the UnitedStates and/or other countries.

Oracle is a registered trademark of Oracle Corporation.

UNIX, X/Open, OSF/1, and Motif are registered trademarksof the Open Group.

Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame,VideoFrame, and MultiWin are trademarks or registeredtrademarks of Citrix Systems, Inc.

HTML, XML, XHTML and W3C are trademarks orregistered trademarks of W3C, World Wide WebConsortium, Massachusetts Institute of Technology.

Java is a registered trademark of Sun Microsystems, Inc.

JavaScript is a registered trademark of Sun Microsystems,Inc., used under license for technology invented andimplemented by Netscape.

MaxDB is a trademark of MySQL AB, Sweden.

SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAPNetWeaver, and other SAP products and services mentionedherein as well as their respective logos are trademarks orregistered trademarks of SAP AG in Germany and in severalother countries all over the world. All other product andservice names mentioned are the trademarks of theirrespective companies. Data contained in this documentserves informational purposes only. National productspecifications may vary.

These materials are subject to change without notice. Thesematerials are provided by SAP AG and its affiliatedcompanies ("SAP Group") for informational purposesonly, without representation or warranty of any kind, andSAP Group shall not be liable for errors or omissions withrespect to the materials. The only warranties for SAPGroup products and services are those that are set forth in theexpress warranty statements accompanying such productsand services, if any. Nothing herein should be construed asconstituting an additional warranty.

DisclaimerSome components of this product are based on Java. Anycode change in these components may cause unpredictableand severe malfunctions and is therefore expressivelyprohibited, as is any decompilation of these components.

Any Java Source Code delivered with this product is onlyto be used by SAPs Support Services and may not bemodified or altered in any way.

Documentation on SAP Service MarketplaceYou can find this documentation atservice.sap.com/instguides

SAP AG

Neurottstrae 1669190 WalldorfGermanyT +49/18 05/34 34 24F +49/18 05/34 34 20www.sap.com

T yp o g r a p h i c C o n v e n t i o n s

Type Style Represents

ExampleText

Words or charactersquoted from the screen.These include field names,screen titles, pushbuttonslabels, menu names, menupaths, and menu options.Cross-references to otherdocumentation.

Exampletext

Emphasized words orphrases in body text,graphic titles, and tabletitles.

EXAMPLETEXT

Technical names of systemobjects. These includereport names, programnames, transaction codes,table names, and keyconcepts of a programminglanguage when they aresurrounded by body text,for example, SELECT andINCLUDE.

Exampletext

Output on the screen. Thisincludes file and directorynames and their paths,messages, names ofvariables and parameters,source text, and names ofinstallation, upgrade anddatabase tools.

Exampletext

Exact user entry. These arewords or characters thatyou enter in the systemexactly as they appear inthe documentation.

Variable user entry. Anglebrackets indicate that youreplace these words andcharacters with appropriateentries to make entries inthe system.

EXAMPLETEXT

Keys on the keyboard, forexample, F2 or ENTER.

I c o n s

Icon Meaning

Caution

Example

Note

Recommendation

Syntax

Contents May 2014

Diagnostics Agent Installation in Unattended Mode I

Contents

1 INTRODUCTION ............................................................................................................ 11.1 Installation and Installation Strategy .................................................................. 11.2 SAP Solution Manager Diagnostics Agent ......................................................... 11.3 SAP Notes for the Installation ............................................................................. 1

2 PREPARATION.............................................................................................................. 12.1 Preparation Checklist .......................................................................................... 12.2 Prepare the Installation Environment ................................................................. 22.3 Modify the Input Parameters (inifile.xml) ..................................................... 32.4 Create start_dir.cd File .................................................................................. 32.5 Identify Product ID for Installation ...................................................................... 4

3 INSTALLATION ............................................................................................................. 53.1 Process Steps ...................................................................................................... 53.2 Examples .............................................................................................................. 53.3 Installation Parameters ........................................................................................ 5

3.3.1 Diagnostics Agent Parameters .................................................................... 63.3.2 Operating System Users for the Diagnostics Agent ..................................... 63.3.3 Operating System User for the SAP Host Agent .......................................... 73.3.4 Connectivity for the Diagnostics Agent to System Landscape Directory ....... 83.3.5 Connectivity for the Diagnostics Agent to Solution Manager ........................ 8

4 UNINSTALLATION ...................................................................................................... 104.1 Prepare the Installation Environment ............................................................... 104.2 Modify the Input Parameters (inifile.xml) ................................................... 104.3 Create start_dir.cd File ................................................................................ 114.4 Identify Product ID for Uninstallation ................................................................ 114.5 Process Steps .................................................................................................... 11

5 ADDITIONAL INFORMATION ...................................................................................... 125.1 How to Avoid Automatic Logoff by SAPinst (Windows) .................................. 125.2 Troubleshooting with SAPinst .......................................................................... 12

SAP Solution Manager - End-to-End Root Cause Analysis May 2014

Diagnostics Agent Installation in Unattended Mode 1

1 IntroductionIt is possible to install the Diagnostics Agent in an unattended mode. This means you recordall input parameters for an installation scenario, which you can then reuse for furtherinstallations. This guide describes how to perform for such installation or uninstallation.

1.1 Installation and Installation StrategyBefore you continue with the unattended mode installation of Diagnostics Agents, you musthave defined your installation strategy, and you must have made a decision on whether youwant to use the Agents On-the-fly feature or not.

Use the latest installer and read the following sections from the corresponding Installation andSetup Guide, before continuing:

a. Installation Strategy

b. Using Logical Host Names

c. Using Virtual Host Names

1.2 SAP Solution Manager Diagnostics AgentThe Diagnostics Agent is the remote component of the E2E Root Cause Analysis. It enablesyou to establish a connection between SAP Solution Manager as the managing system andthe managed system(s) and then to gather information from the managed systems and passthem to the Solution Manager system.

1.3 SAP Notes for the InstallationBefore planning the installation of the Diagnostics Agents make sure to read SAP Note1858920: Diagnostics Agent installation with SWPM. The corresponding Installation andSetup Guide contains relevant installation and post-installation information.

2 Preparation2.1 Preparation ChecklistThis section includes the preparation steps that you have to perform. Detailed informationabout the steps is available in the respective sections.

Prerequisites

Read SAP Notes for the Installation [page 1]1.

Identify the Installation Strategy (Direct Solution Manager Registration, SLD Registration or2.None)

Check the Hardware Requirements3.

Download the Installation DVDs4.

Read How to Avoid Automatic Logoff by SAPinst (Windows) [page 12]5.

Process Steps

Prepare the Installation [page]1.

Modify the Input Parameters (inifile.xml) according to your needs [page 3]2.



Create start_dir.cd File [page 3]3. Identify Product ID for Installation [page 4]4.

Start the Installation [page 5]5.

2.2 Prepare the Installation EnvironmentDownload the inifile.xml, keydb.dtd and doc.dtd files (attached to this SAP Note)and save them in a common directory ${COMMON_FOLDER}

Windows: c:\unattended\commonUnix/IBM i: /unattended/common

The keydb.dtd and doc.dtd files are required for parsing inifile.xml.

Create an installation directory on the host on which you want to run SAPinst inunattended mode.

On Unix, make sure that:a) a user group "sapinst" is available.b) "sapinst" is assigned as an additional user group to user root.c) the installation directory is owned by user group "sapinst" and has at leastpermissions 775. To change the group value, proceed as follows:

chgrp R sapinst

On IBM i, make sure that:a) a user group "sapinst" is available.If a user profile "sapinst" already exists, you have nothing to do.If no user profile "sapinst" exists, do the following command:CRTUSRPRF USRPRF(SAPINST) GID(*GEN)b) "sapinst" is assigned as an user group to your installation user:CHGUSRPRF USRPRF() GRPPRF(SAPINST)c) the installation directory is owned by user group "sapinst" and has at leastpermissions 775:CALL PGM(QP2TERM) PARM('/QOpenSys/usr/bin/chmod''-R' '775' '') (press F3 to exit thesession)



To change the group value, proceed as follows:CALL PGM(QP2TERM) PARM('/QOpenSys/usr/bin/chgrp''-R' 'sapinst' '') (press F3 toexit the session)

2.3 Modify the Input Parameters (inifile.xml)The file named inifile.xml is a template document which has to contain all requiredparameters to run SAPinst in unattended mode. Edit inifile.xml and modify theparameters according to your needs.

Only the parameters with value TO_BE_DEFINED are required to be modified.The other ones can be left as they are.

You can enter passwords in plain text. At the first SAPinst execution, yourcurrent inifile.xml will be replaced by a version with the encryptedpassword. For that reason please do not forget to make a copy of your originalinifile.xml if you need it later.

For details refer to chapter Installation Parameters [page 5].

After you have made the required changes, you should check the changes youhave made using a "diff tool". Most problems that occur with this procedure aredue to accidental changes that are made to the inifile.xml file. Doublechecking your changes against the originally distributed template document willprotect you against problems due to accidental changes.

2.4 Create start_dir.cd File Create an installation directory on the host on which you want to run SAPinst in unattended1.

mode: ${EXEC_DIR}

Windows: c:\unattended\install

Unix/IBM i: /unattended/install Create a file named start_dir.cd. It contains the paths to the Installation DVDs (Kernel2.

DVD and Installation Master DVD) required for the unattended installation (To identify anddownload the Installation DVDs see section 1.2).

Save the file start_dir.cd in the installation directory that you created in step 1.3. Edit the file start_dir.cd.4. Enter the paths to the Installation Master and Kernel DVDs. A separate line is required for5.

each DVD path.



For each DVD you have to browse until the main LABEL.ASC file to identify the paths toadd to start_dir.cd.The table below lists the lines to add to start_dir.cd depending on the product and theDVD.

Path

[Installation Master]${DVD_LOCATION}/installation_master[Kernel]${DVD_LOCATION}/kernel_dvd

Save start_dir.cd.6.

2.5 Identify Product ID for Installation You need to identify the Product ID for the installation service that is required for your1.

installation scenario.

Before starting SAPinst you may want to backup/delete/rename an already existing2.sapinst_instdir directory.

Start SAPinst as described in the Installation Guide. See section 1.2.3.

a. On the "Welcome to SAP Installation" screen, choose: SAP Installation MasteroGeneric Installation Optionso Diagnostics in SAP Solution Manager o Install -Diagnostics Agent.

b. Then press "Next".

c. Stop SAPinst as soon as the next screen has appeared.

SAPinst has now created a new sapinst_instdir directory structure. Go to the directory4.and locate and open the sapinst_dev.log file.

In the sapinst_dev.log file search for the string product-id. You should find a line5.like: Running with control file XXX version=XXX changelist=XXXproduct-id=XXXFor SWPM 1.0 SP5 (for NetWeaver higher than 7.0x) the product-id should be:NW_DiagnosticsAgent:GENERIC.IND.PDThis value is required to run the installation in unattended mode. This ID represents theSAP Installation Product ID parameter(SAPINST_EXECUTE_PRODUCT_ID="NW_DiagnosticsAgent:GENERIC.IND.PD")

For the "Install - Diagnostics Agent with 741 kernel" installation option, theproduct-id you need to identify and use below, should be:NW_DiagnosticsAgent:NW740SR1.IND.PD

Before continuing you may want to backup/delete/rename the just created6.sapinst_instdir directory.



3 Installation3.1 Process StepsOn the host on which you want to run SAPinst in unattended mode, proceed as follows:

Change to the installation directory1.

cd ${EXEC_DIR} Start SAPinst with the following parameters (you get an overview of all SAPinst parameters2.

by execution sapinst -p)x SAPINST_PARAMETER_CONTAINER_URL=${COMMON_FOLDER}/inifile.xmlx SAPINST_EXECUTE_PRODUCT_ID=x SAPINST_SKIP_DIALOGS=trueThe command line to execute is as the following one:${EXEC_DIR} # ${DVD_LOCATION}/installation_master/sapinstSAPINST_PARAMETER_CONTAINER_URL=${COMMON_FOLDER}/inifile.xmlSAPINST_EXECUTE_PRODUCT_ID= SAPINST_SKIP_DIALOGS=true

Result:3.

SAPinst installs your agent in unattended mode. You may check the result of theinstallation by opening the sapinst_dev.log file within the ${EXEC_DIR}.

If you need to start SAPinst with SAPinst GUI, do not specify theSAPINST_SKIP_DIALOGS option.

3.2 ExamplesWindowsC:\unattended\install> c:\installation_master\sapinst.exeSAPINST_PARAMETER_CONTAINER_URL=c:\unattended\common\inifile.xmlSAPINST_EXECUTE_PRODUCT_ID="NW_DiagnosticsAgent:GENERIC.IND.PD"SAPINST_SKIP_DIALOGS=true

Unix / IBM i/unattended/install> /installation_master/sapinstSAPINST_PARAMETER_CONTAINER_URL=/unattended/common/inifile.xmlSAPINST_EXECUTE_PRODUCT_ID="NW_DiagnosticsAgent:GENERIC.IND.PD"SAPINST_SKIP_DIALOGS=true

3.3 Installation ParametersThe following tables list all the mandatory or optional parameters needed for the installation.For parameters that are not mandatory, you can leave their value empty: SAPinst will set thevalue to a default value.

x Diagnostics Agent Parameters [page 6]x Operating System Users for the Diagnostics Agent [page 6]x Operating System User for the SAP Host Agent [page 7]



x Connectivity for the Diagnostics Agent to System Landscape Directory [page 8]x Connectivity for the Diagnostics Agent to Solution Manager [page 8]

For more details, please refer to the Installation Guide (See section 1.2).

3.3.1 Diagnostics Agent ParametersName Description Mandatory

sid System ID of Diagnostics AgentSAPinst sets the system ID of DiagnosticsAgent, , to DAA by default.

NO

instanceNumber Instance Number of the Diagnostics AgentThe instance number is set automatically tothe next free and valid instance number (from98 down to 00) that has not yet beenassigned to the SAP system.

NO

virtualHost Logical Host NameBy default the installer sets the host name tothe physical host name.If you want to install a Diagnostics Agent onthe physical host, you can leave thevirtualHost parameter empty. This is alsothe recommended way to install a DiagnosticsAgent to be used with the Agents On-the-flyfeature.You can set the host name to a logical hostname if you plan to manage systems runningon a logical host.Do not use the FQDN, use the short hostname.

NO

3.3.2 Operating System Users for the Diagnostics AgentThe Diagnostics Agent user adm is used to manage the Diagnostics Agent system.

Before starting to modify the parameters, make sure that you are modifying thecorrect element: the attribute name of its parent element table must notcontain the string NW_SAPHostAgent in its value.

Unix/IBM i

Name Description Mandatory

SIDAdm_Password OS User password for user adm YES if userdoes not exist

SIDAdm_ID User ID for user adm NOSIDAdm_Home Home directory for user adm NOSIDAdm_Shell Login shell for user adm NO



SAPSys_ID Group ID for group sapsys

On IBM i the group sapsys isconverted to the group R3GROUP.

NO

Windows


sapDomain Domain for the Diagnostics Agent OSUsers. SAPinst sets the domain to local bydefault.

NO

sidAdmPassword OS User password for user adm YESsapServiceSIDPassword OS User password for user

SAPServiceYES

sapdrive Base directory for the Diagnostics AgentModifiable only if the saploc share doesnot exist but there are several hard disks onthis machine.

NO butrecommended

3.3.3 Operating System User for the SAP Host AgentIf the SAP Host Agent is already installed on the host, this part is skipped.The SAP Host Agent user sapadm is used for central monitoring services.

Before starting to modify the parameters, make sure that you are modifying thecorrect element: the attribute name of its parent element table must containthe string NW_SAPHostAgent in its value.

Unix/IBM i


SIDAdm_Password OS User password for user sapadm YES if SAP HostAgent notalready installed

SIDAdm_ID User ID for user sapadm NOSIDAdm_Home Home Directory for user sapadm NOSIDAdm_Shell Login Shell for user sapadm NOSAPSys_ID Group ID for group sapsys

On IBM i the group sapsys isconverted to the group R3GROUP.

NO



Windows


sapDomain Domain for the SAP Host Agent OS UserSAPinst set the domain to local by default.

NO

sidAdmPassword OS User password for user sapadm YES if SAP HostAgent notalready installed

3.3.4 Connectivity for the Diagnostics Agent to SystemLandscape Directory

You have identified your Installation Strategy and want to register your Diagnostics Agent inan existing System Landscape Directory (SLD).


connection_sld SLD Registration TypeTo register your Diagnostics Agent in an SLDyou have to set this parameter to: sld

YES put sld orno

host_sld Managing HostHTTP host of the SAP system with the SLD thatis assigned to the managed system on whichthe Diagnostics Agent is being installed

YES ifconnection_sld!= no

port_sld PortHTTP port of the SAP system with the SLD thatis assigned to the managed system on whichthe Diagnostics Agent is being installed


user_sld User YES ifconnection_sld!= no

passwd_sld Password YES ifconnection_sld!= no

needHTTPS_sld x If SSL is used for the SLD connection: truex Otherwise: false


3.3.5 Connectivity for the Diagnostics Agent to SolutionManager

You have identified your Installation Strategy and want to do a direct Solution Managerregistration. You can choose to directly connect to the Solution Manager system even if youregistered it into the SLD during the previous step.


connection_solman Connection of the Diagnostics Agent to SolutionManagerYou can choose between the following options:x solman (Configure connection: the

YES



Diagnostics Agent is connected to theSolution Manager system)

x none (Do not configure connection: theDiagnostics Agent is not connected to theSolution Manager system)

x If you choose this option the values of theparameters below are not taken intoaccount.

connection_ms Solution Manager Connection TypeYou can choose between the following options:x ms (P4 Connection via SCS message

server)

x p4 (Direct P4 Connection via Java EEDispatcher Node)

x ms_ssl (P4 SSL Connection via SCSmessage server)

x p4_ssl (Direct P4 SSL Connection via JavaEE Dispatcher Node)

YES ifconnection_solman != none

host_smd Managing HostThe fully-qualified host name of the SMD Server


port_smd Depending on the connection type you have tospecify either the HTTP SCS Message Port, orthe Dispatcher P4 Port, or the Dispatcher P4SSL Port of the Java stack in your SAP SolutionManager system.


user_smd UserAs of SAP Solution Manager 7.10 SP10 werecommend to use the SMD_AGT user of yourSAP Solution Manager system.For earlier releases the SMD_ADMIN user is stillrecommended.


passwd_smd Password YES ifconnection_solman != none

useSSL_solman Depending on the parameter connection_ms:

x If SSL is used: truex Otherwise: false


route Route string describing the stations of aconnection required between the DiagnosticsAgent and Solution Manager.The route string contains a substring for eachSAProuter without the target server such as:/H/host/S/service/W/passx /H/ indicates the host name

NO



x /S/ is used for specifying the service (port);it is an optional entry, the default value is3299

x /W/ indicates the password for theconnection between the predecessor andsuccessor on the route and is also optional(default is "", no password)

The route between the Diagnostics Agent andSolution Manager can be such as:/H/hostname.sap.com/S/3199

passwd_route Password NO

4 UninstallationOn the host on which you want to run SAPinst in unattended mode, proceed as follows:

Prepare the Installation [page 10]1.

Modify the Input Parameters (inifile.xml) according to your needs [page 10]2. Create start_dir.cd [page 11]3. Identify Product ID for Uninstallation [page 11]4.

Execute the Process Steps [page 11]5.

4.1 Prepare the Installation EnvironmentFor the uninstallation the inifile.xml is not provided. You need to create it as follows: Start SAPinst as described in the Installation Guide. See section 1.2.1.

a. On the "Welcome to SAP Installation" screen, choose: Generic Installation Optionso Diagnostics in SAP Solution Manager o Uninstall - Diagnostics Agent

b. On the screen "General SAP System Parameters", select the profile directory of theDiagnostics Agent that you want to uninstall:

/usr/sap//SYS/profilec. Follow the instructions in the SAPinst input dialogs.

Stop SAPinst after the "Parameter Summary" screen has appeared.2.

SAPinst creates the inifile.xml in the installation directory.Copy the inifile.xml, keydb.dtd and doc.dtd files from the installation directory of the"original" installation and save them in ${COMMON_FOLDER}.

4.2 Modify the Input Parameters (inifile.xml)Edit inifile.xml and modify the parameters according to your needs.

Note that you can only modify the parameters which were covered by the inputdialogs you went through in step 4.1.



4.3 Create start_dir.cd File Create an installation directory on the host on which you want to run SAPinst in unattended1.

mode: ${EXEC_DIR}

Windows: c:\unattended\uninstall

Unix/IBM i: /unattended/uninstall

Create a file named start_dir.cd. It contains the path to the Installation Master DVD2. Save the file start_dir.cd in the installation directory that you created in step 1:3.${EXEC_DIR}.

Edit the file start_dir.cd.4. Enter the path to the Installation Master DVD.5.

The table below lists the line to add to start_dir.cd.6.Path

[Installation Master]${DVD_LOCATION}/installation_master

Save start_dir.cd.7.

4.4 Identify Product ID for UninstallationYou need to identify the Product ID for the installation service that is required for youruninstallation.

Open the file sapinst_dev.log which is available in the installation directory where you1.created the file inifile.xml in step 4.1.

Get the value of the Product ID which is named: product-id=2.

4.5 Process StepsOn the host on which you want to run SAPinst in unattended mode, proceed as follows:

Change to the installation directory1.cd ${EXEC_DIR}

For Unix and IBM i systems these directories need to belong to the sapinstgroup and have at least permissions 775.

Start SAPinst with the following parameters2.

x SAPINST_PARAMETER_CONTAINER_URL=${COMMON_FOLDER}/inifile.xmlx SAPINST_EXECUTE_PRODUCT_ID=x SAPINST_SKIP_DIALOGS=true

The command line to execute is as the following one:3.



${EXEC_DIR}# ${DVD_LOCATION}/installation_master/sapinstSAPINST_PARAMETER_CONTAINER_URL=${COMMON_FOLDER}/inifile.xmlSAPINST_EXECUTE_PRODUCT_ID= SAPINST_SKIP_DIALOGS=true

Result:4.

SAPinst uninstalls your agent in unattended mode. You may check the result of theuninstallation by opening the sapinst_dev.log file within the ${EXEC_DIR} directory.

5 Additional Information5.1 How to Avoid Automatic Logoff by SAPinst

(Windows)Please refer to the respective section in the Diagnostics Agent Setup Guide for matchingSoftware Provisioning Manager 1.0 Service Pack.

5.2 Troubleshooting with SAPinstThis section tells you how to proceed when errors occur during the installation with SAPinst.

If an error occurs, SAPinst:

x Stops the installationx Displays a dialog informing you about the error

Procedure

Check the log files of SAPinst in the installation directory ${EXEC_DIR}.

swpm10sp5 diag agent unattended

Documents