Show TOC

SAP Host Agent Reference - Command Line Options of the saphostexec ExecutableLocate this document in the navigation structure

Usually SAP Host Agent is automatically started when the operating system is booted. You can also manually control it using the saphostexec program.

Prerequisites

You are logged on as a user with the required authorization:

Windows As a member of the local Administrators group
UNIX As a user with root authorization
IBM i As a user profile with special authorities *SECADM and *ALLOBJ, for example as user profile QSECOFR
Features

You call the program from the command line with the following syntax:

Windows %ProgramFiles%\SAP\hostctrl\exe\saphostexec.exe -[option] [pf=<ProfilePath>]
UNIX, IBM i /usr/sap/hostctrl/exe/saphostexec -[option] [pf=<ProfilePath>]

where <ProfilePath> is path to the profile file ( host_profile) of SAP Host Agent. By default the host_profile file is located in the executable directory.

You can execute saphostexec with the following command line options:

Option

Meaning

-help

Lists all command line options of saphostexec with documentation

-install [-verify]

Installs SAP Host Agent

Recommendation Use the additional parameter -verify to verify the content of the installation package against the SAP digital signature.

-upgrade [-verify][-archive]

Upgrades SAP Host Agent

  • Without further parameters you run this option with the saphostexec executable from the extracted SAPHOSTAGENT<PL-target version>.SAR archive.

  • When you run SAPhostexec -upgrade from the hostctrl directory of the existing SAP Host Agent installation, you use the -archive parameter to provide the direct path to the archive with the required target release version without manually extracting the archive before.

  • -verify

    It is recommended that you use the additional parameter -verify parameter to check the content of the installation package against the SAP digital signature.

-uninstall

Uninstalls SAP Host Agent

-restart

Starts or restarts SAP Host Agent

-stop

Stops a running SAP Host Agent

-status

Returns the status of SAP Host Agent

-version

Returns the version of SAP Host Agent with detailed information