Skip to end of metadata
Go to start of metadata



With SWPM ( software provision manager ) we can use different options.These can be used to with sapinst independent of the operating system environment for achieving different purposes.




The wiki aims to provide list of available options that can be used with while running SWPM with "sapinst" option.Along with the standard default used options we will also be providing return codes that can be checked in case of error for troubleshooting purposes.

This wiki does not provide information on which exactly options you should use , but lists out all the available options.


How to achieve this


To get the available options that can be run with SWPM you can simply the run sapinst option with a value 'p'

Example :- ./sapinst -p


Available options

> Sapinst :-


[root@<USERNAME> SWPM]# ./sapinst -p [==============================] / extracting... done!


== This will start the list ==



SAPinst properties: =====================


points to a control(control.xml) or a catalog(product.catalog) file.


directory that SAPinst should use as its working directory (works only if  SAPinst has write permissions in that directory) •GUISERVER_DIALOG_PORT:

the port for communication of the GUI Server with the GUI  default: 21212


trace level console  values: flow_trace, trace, info, phase, warning, error, external(for ACC);  default: error


trace level developer log file  values: flow_trace, trace, info, phase, warning, error  default: flow_trace


switch to activate the JS trace functionality for specific JS classes;  value: comma separated list of JS classes or all  default: empty  if the value contains 'flow_trace' and 'Retry' is pressed then the  framework activates flow trace


switch to enable traces for RFC calls issued by SAPinst  attention: setting this variable to true may cause  passwords to appear in clear text in log files;  default: false •SAPINST_MSLIB_TRACE:

determines trace level of kernel trace library  allowed values: 0-3  default: 1


path and name of CD names and labels file


after each dialog step write user input to keydb file if a dialog was  displayed; default: false


skip all the installation dialogs?; default: false


skip the first step whose status is ERROR; set the step status to OK;  default: false


automatically start the GUI; default: true


automatically start the GUI Server; default: true


name of file which is used to override the top-level components in the control  file


path and name of file which contains F1 help used during the installation


framework will return the value of that property in case of calling the  getHostName() function (value will not be checked)


framework will use that keydb container for reading initial values for the  instance parameters


if the SAPinst is starting using a product.catalog file this value is used to  select the service to be installed (attribute ID at the component tag);  if no product exists with that ID the product selection dialog will be shown


define the handling of the ini file parameter  values:  ignore do not read parameter from file but write them  after dialog phase  default values (default) read parameter from file and use them as defaults  final same as default values, in addition set the parameters to not  changeable and tag them with  GUIENG_USER_INPUT=GUIENG_TRUE, that means if each  parameter on a dialog is tagged with that  property, the dialog isn't shown


values:  true stops the execution after processing all dialog steps  false (default) go on with doing phase after dialog phase


path to directory which contains LABELIDX.ASC or LABEL.ASC file


path and name of file which contains images shown in a slide show during the  doing phase


Property file for the framework JVM usage. Default:


run GUI in accessibility mode, requires additional software/hardware  default: false


This property is obsolete and not supported any more.


name of an OS user which may logon remotely (with name and password). See also SAP Note 1745524.  default: name and password of the SAPinst process owner are needed


enables or disables warning concerning remote access user: this user has to be a trusted user. See also SAP Note 1745524.  default: false •SAPINST_AUTHENTICATION_UNLIMITED

true set user and password field length of the remote dialog to unlimited.  false (default)


points to a text file containing key=value pairs. If the SAPINST_INPUT_PARAMETERS_URL is defined and a component gets processed the first time  SAPInst is checking for each component parameter the existence of attribute defval-for-inifile-generation.  If an attribute is specified SAPinst is using the attribute value as a key for the search within the SAPINST_INPUT_PARAMETERS_URL key/value pairs.  If SAPinst can find a key matching to the attribute value it is setting the component parameter to the corresponding value.


This property is obsolete and not supported any more.


This property is obsolete and not supported any more.


This property is obsolete and not supported any more.


path to external SAP Java Runtime Environment (JRE). E.g. /usr/sap/jvm6138/jre


HTTP port of SAPinst. Used for sending feedback to SAP.


If true, dialog for sending feedback to SAP is shown in the end. Default: true.


Path and name of stack.xml file as described in SAP Note 1680045.


> Return codes


Return codes: ========================

 0 = success  

1 = unknown exception  

2 = user decide to stop  

3 = iSeries specific initialization problem  

4 = framework error ; please inform SAPinst development team  

5 = incomplete service ; please inform installation development team  

6 = stop after dialog phase requested  

7 = unknown exception during step execution  

8 = problems creating support archive  

9 = problems in GUI subsystem; please inform SAPinst development team  

10 = SLC could not be started in server mode because of missing encryption jars within the used JVM  

11 = executed step requested an "abort installation"  

12 = terminated by a signal  

13 = service needs to display a dialog but no GUI is available. Restart SAPinst with GUI.

 14 = executed step stopped service execution  

15 = problems concerning the SDT server's user (default 'sapsdt')  

16 = problems with loading of DLL modules (Only for Windows)  

17 = reserved for framework issues ; not used at the moment  

18 = reserved for framework issues ; not used at the moment  

19 = reserved for framework issues ; not used at the moment  

20 = reserved for framework issues ; not used at the moment  

21 - 110 = error code was defined by a exception thrown by a installation step  

111 = step execution ends with an error without specifying a return code via messages id  112 - 126 error code was defined by a exception thrown by a installation step ,see message.xml.



The list is ever ending and we will be adding different options that we come across.


Related SAP Notes/KBAs



1680045 - Release Note for Software Provisioning Manager 1.0 (recommended: SWPM 1.0 SP 23)

 2230669 - System Provisioning Using a Parameter Input File

950619 - Deprecated: Installation of SAP Systems with Unattended Mode (old inifile.xml)

1928401 - Cannot launch SAPinst STD GUI (old java-based GUI)

2393060 - SAPinst Framework 749 Central Note

2449457 - Inconsistent value of property SAPINST_USE_HOSTNAME

2596237 - Using SAPINST_USE_HOSTNAME in Windows Failover Clusters

1745524 - SAPinst 720-2 / 749 - Using property SAPINST_REMOTE_ACCESS_USER

2600047 - SAPINST_SLP_MODE=false and SAPINST_USE_XML don't work together

2568783 - Release Note for Software Provisioning Manager 2.0 (recommended: SWPM 2.0 SP 00)

2277574 - Central Note for Up-To-Date Installation using Maintenance Planner, Software Provisioning Manager and succeeding update tools



  • No labels