Operations for Custom Hooks
This section describes the operations that are available for custom hooks in SAP Landscape Management.
|
Operation |
Description |
|---|---|
|
start |
Starts the instance. |
|
stop |
Stops the instance. |
|
prepare |
Binds virtual host names of the instance to network interfaces and mounts remote memory locations to the local file system.
|
|
unprepare |
Unmounts remote memory locations from the local file system and unbinds virtual host names from the network interfaces.
|
|
registerIA |
Registers and starts the instance agent of an SAP instance. |
|
restartIA |
Unregisters and registers the instance agent of an SAP instance. |
|
restartJ2EE |
Restarts only the Java processes of a dual stack application server. |
For all operations on system level, such as update DNS, clone volumes, or software provisioning manager, SAP Landscape Management generates hooks for all instances of that system, if the hook constraints are applicable.
|
Operation |
Operation Description |
Parameter |
Parameter Description |
System Operation |
|---|---|---|---|---|
| ABAP post copy automation |
Executes a task list for ABAP PCA. Do not use this operation for export and import tasks or task lists. |
PSCA_SCENARIO_ID | Selected scenario ID. | Yes |
| ABAP post copy automation |
Executes a task list for ABAP PCA. Do not use this operation for export and import tasks or task lists. |
PSCA_TEMPLATE_ID | Selected template ID. | Yes |
| ABAP post copy automation |
Executes a task list for ABAP PCA. Do not use this operation for export and import tasks or task lists. |
PSCA_RFC_DESTINATION | Destination name. | Yes |
| ABAP post copy automation export | Executes export tasks for ABAP PCA. | PSCA_SCENARIO_ID | Selected scenario ID. | Yes |
| ABAP post copy automation export | Executes export tasks for ABAP PCA. | PSCA_TEMPLATE_ID | Selected template ID. | Yes |
| ABAP post copy automation export | Executes export tasks for ABAP PCA. | PSCA_RFC_DESTINATION | Destination name. | Yes |
| ABAP post copy automation import | Executes import tasks for ABAP PCA. | PSCA_SCENARIO_ID | Selected scenario ID. | Yes |
| ABAP post copy automation import | Executes import tasks for ABAP PCA. | PSCA_TEMPLATE_ID | Selected template ID. | Yes |
| ABAP post copy automation import | Executes import tasks for ABAP PCA. | PSCA_RFC_DESTINATION | Destination name. | Yes |
| Activate IP Address | Activates hostnames during a takeover of a replicated database. | Not applicable | Not applicable | None |
| Add and Configure Host | Configures a newly provisioned host. | Not applicable | Not applicable | None |
| Application Server Installation |
Installs an SAP application server using the software provisioning manager. All parameters to the software provisioning manager (as shown in the SAP Landscape Management log) are available using the SAPINST_ prefix. The available parameters depend on the system or database type. |
SAPINST_SOURCE_INST_PATH | Local path to the software provisioning manager executable. | None |
| Application Server Installation |
Installs an SAP application server using the software provisioning manager. All parameters to the software provisioning manager (as shown in the SAP Landscape Management log) are available using the SAPINST_ prefix. The available parameters depend on the system or database type. |
SAPINST_SYSTEM_DB_TYPE | Type of the system database. | None |
| Application Server Installation |
Installs an SAP application server using the software provisioning manager. All parameters to the software provisioning manager (as shown in the SAP Landscape Management log) are available using the SAPINST_ prefix. The available parameters depend on the system or database type. |
SAPINST_RELEASE | Release of the system. | None |
| Application Server Installation |
Installs an SAP application server using the software provisioning manager. All parameters to the software provisioning manager (as shown in the SAP Landscape Management log) are available using the SAPINST_ prefix. The available parameters depend on the system or database type. |
SAPINST_PROD_ID | Production ID which will be executed. | None |
| Application Server Installation |
Installs an SAP application server using the software provisioning manager. All parameters to the software provisioning manager (as shown in the SAP Landscape Management log) are available using the SAPINST_ prefix. The available parameters depend on the system or database type. |
SAPINST_VIRT_HOSTNAME | Virtual host name, for which the software provisioning manager is started. | None |
| Application Server Installation |
Installs an SAP application server using the software provisioning manager. All parameters to the software provisioning manager (as shown in the SAP Landscape Management log) are available using the SAPINST_ prefix. The available parameters depend on the system or database type. |
SAPINST_EXPORT_PATH | Remote path the root of the installation DVD. | None |
| Application Server Installation |
Installs an SAP application server using the software provisioning manager. All parameters to the software provisioning manager (as shown in the SAP Landscape Management log) are available using the SAPINST_ prefix. The available parameters depend on the system or database type. |
SAPINST_PWD |
Windows only: Password of the user starting the software provisioning manager. |
None |
| Application Server Installation |
Installs an SAP application server using the software provisioning manager. All parameters to the software provisioning manager (as shown in the SAP Landscape Management log) are available using the SAPINST_ prefix. The available parameters depend on the system or database type. |
SAPINST_USER |
Windows only: User starting the software provisioning manager. |
None |
| Application Server Uninstallation |
Uninstalls an SAP application server using the software provisioning manager. All parameters to software provisioning manager (as shown in the SAP Landscape Management log) are available using the SAPINST_ prefix. The available parameters depend on the system or database type. |
SAPINST_SOURCE_INST_PATH | Local path to the software provisioning manager executable. | None |
| Application Server Uninstallation |
Uninstalls an SAP application server using the software provisioning manager. All parameters to software provisioning manager (as shown in the SAP Landscape Management log) are available using the SAPINST_ prefix. The available parameters depend on the system or database type. |
SAPINST_SYSTEM_DB_TYPE | Type of the system database. | None |
| Application Server Uninstallation |
Uninstalls an SAP application server using the software provisioning manager. All parameters to software provisioning manager (as shown in the SAP Landscape Management log) are available using the SAPINST_ prefix. The available parameters depend on the system or database type. |
SAPINST_RELEASE | Release of the system. | None |
| Application Server Uninstallation |
Uninstalls an SAP application server using the software provisioning manager. All parameters to software provisioning manager (as shown in the SAP Landscape Management log) are available using the SAPINST_ prefix. The available parameters depend on the system or database type. |
SAPINST_PROD_ID | Production ID which will be executed. | None |
| Application Server Uninstallation |
Uninstalls an SAP application server using the software provisioning manager. All parameters to software provisioning manager (as shown in the SAP Landscape Management log) are available using the SAPINST_ prefix. The available parameters depend on the system or database type. |
SAPINST_VIRT_HOSTNAME | Virtual host name, for which the software provisioning manager is started. | None |
| Application Server Uninstallation |
Uninstalls an SAP application server using the software provisioning manager. All parameters to software provisioning manager (as shown in the SAP Landscape Management log) are available using the SAPINST_ prefix. The available parameters depend on the system or database type. |
SAPINST_EXPORT_PATH | Remote path the root of the installation DVD. | None |
| Application Server Uninstallation |
Uninstalls an SAP application server using the software provisioning manager. All parameters to software provisioning manager (as shown in the SAP Landscape Management log) are available using the SAPINST_ prefix. The available parameters depend on the system or database type. |
SAPINST_PWD |
Windows only: Password of the user starting the software provisioning manager. |
None |
| Application Server Uninstallation |
Uninstalls an SAP application server using the software provisioning manager. All parameters to software provisioning manager (as shown in the SAP Landscape Management log) are available using the SAPINST_ prefix. The available parameters depend on the system or database type. |
SAPINST_USER |
Windows only: User starting the software provisioning manager. |
None |
| Change Instance Profile | Changes the start, instance, or default profile of an SAP instance or system. | CH_PF_PROFILE | Path to profile. | Yes |
| Change Instance Profile | Changes the start, instance, or default profile of an SAP instance or system. | CH_PF_PARAMS | New parameter <key>=<value>pairs, separated by ;. | Yes |
| Change Instance Profile | Changes the start, instance, or default profile of an SAP instance or system. | CH_PF_NEW_SID | New system ID (SID). | Yes |
| Change Instance Profile | Changes the start, instance, or default profile of an SAP instance or system. | CH_PF_SRC_SID | New system ID (SID). | Yes |
| Change Instance Profile | Changes the start, instance, or default profile of an SAP instance or system. | CH_PF_SRC_SID | Old SID. | Yes |
| Change Instance Profile | Changes the start, instance, or default profile of an SAP instance or system. | CH_PF_USER | On UNIX, the user, which will be used to change the profile. | Yes |
| Change Local Host Name Lookup | Changes the resolution of host name lookup for all installation hosts of a cloned system. | HN_CHANGES | Host name changes <source host name>=<ip address of new host name> separated by HN_CHANGES_SEP. | Executed for one instance of the system per host. |
| Change Local Host Name Lookup | Changes the resolution of host name lookup for all installation hosts of a cloned system. | HN_CHANGES_SEP | Separator. | Executed for one instance of the system per host. |
| Change Mode | Changes the system replication mode. | Not applicable | Not applicable | None |
| Change RFC Credentials | Changes the credentials used for an RFC connection. | Not applicable | Not applicable | None |
| Check Mount Points | Checks that no SID-specific mount points are shared between target and source host. | Not applicable | Not applicable | None |
| Cleanup | Cleans up system replication. | Not applicable | Not applicable | None |
| Clean Up Provisioning Changes | Removes unnecessary firewall or hostname changes on a host, for example, because of a failed or aborted system provisioning. | Not applicable | Not applicable | None |
| Clear local cache | Clears the local host name, user, and group caches. | CLEAR_CACHE_HOSTS | Should the host name change be clear. Value is true or false. | Yes |
| Clear local cache | Clears the local host name, user, and group caches. | CLEAR_CACHE_GROUPS | Should the group change be clear. Value is true or false. | Yes |
| Clear local cache | Clears the local host name, user, and group caches. | CLEAR_CACHE_USERS | Should the user name change be clear. | Yes |
| Clear Mount Configuration | During a custom provisioning process for system refresh, clears the mount configuration for each service, which is not handled by the restore backup operation. | Not applicable | Not applicable | None |
| Clone VM and Ensure DB Consistency | Clones a virtual machine and ensures database consistency. | Not applicable | Not applicable | None |
| Clone Volumes | Clones storage volumes. | Not applicable | Not applicable | Yes |
| Clone volumes (source system) | Clones storage volumes without online database consistency. The hook is executed on all instances of the source system. | Not applicable | Not applicable | Yes |
| Clone volumes (target system) | Clones storage volumes without online database consistency. The hook is executed on all instances of the target system. | Not applicable | Not applicable | Yes |
| Clone volumes and ensure database consistency (sources system) | Clones volumes of an online database which will be set to suspend IO or backup mode. The hook is executed on all instances of the source system. | Not applicable | Not applicable | Yes |
| Clone volumes and ensure database consistency (target system) | Clones storage volumes of an online database which will be set suspend IO or backup mode. The hook is executed on all instances of the target system. | Not applicable | Not applicable | Yes |
| Create directory | Creates a directory. | MK_DIR | Path of the directory which will be created recursively. | Yes |
| Create directory | Creates a directory. | MK_DIR_USER | Owner of the directory. | Yes |
| Create directory | Creates a directory. | MK_DIR_PERM | Permissions (binary, for example 744). | Yes |
| Create directory | Creates a directory. | MK_DIR_GROUP | Group of the directory. | Yes |
| Create Firewall Rules | Configures the outgoing firewall rules for an instance on a host for a fenced instance. | FW_ALLOWED_HOSTS_SEP | Separator character separating the allowed host names. | Executed for one instance of the system per host. |
| Create Firewall Rules | Configures the outgoing firewall rules for an instance on a host for a fenced instance. | FW_ALLOWED_HOSTS | Allowed host names separated by FW_ALLOWD_HOST_SEP. | Executed for one instance of the system per host. |
| Create Firewall Rules | Configures the outgoing firewall rules for an instance on a host for a fenced instance. | FW_CON_TIMEOUT | Time-out for the connection check. | Executed for one instance of the system per host. |
| Create Firewall Rules | Configures the outgoing firewall rules for an instance on a host for a fenced instance. | FW_DENY_CONS | Connections <host name>:<port> which are not allowed, separated by ;. | Executed for one instance of the system per host. |
| Create Firewall Rules | Configures the outgoing firewall rules for an instance on a host for a fenced instance. | FW_ALLOWED_PORTS | Allowed services or ports separated by FW_ALLOWED_PORTS_SEP | Executed for one instance of the system per host. |
| Create Firewall Rules | Configures the outgoing firewall rules for an instance on a host for a fenced instance. | FW_RULENAME | Name identifying the firewall rule set for one system. | Executed for one instance of the system per host. |
| Create Firewall Rules | Configures the outgoing firewall rules for an instance on a host for a fenced instance. | FW_ALLOWED_PORTS_SEP | Separator character separating the allowed instances and ports. | Executed for one instance of the system per host. |
| Deactivate IP Address | Deactivates IP addresses on the primary database during system replication takeover. | UNBIND.[INDEX].HOSTNAME |
For each hostname to unbind. Information about the unbound IP addresses. |
None |
| Deactivate IP Address | Deactivates IP addresses on the primary database during system replication takeover. | UNBIND.[INDEX].NIC |
For each hostname to unbind. Information about the unbound IP addresses. |
None |
| Deactivate IP Address | Deactivates IP addresses on the primary database during system replication takeover. | UNBIND.LENGTH |
Once only Number of entries or indexes. Index starts with 0 and ends with UNBIND.LENGTH -1 |
None |
| Deactivate IP Address | Deactivates IP addresses on the primary database during system replication takeover. | NO_UPDATE_OF_MOUNT_POINTS | Information about the unbound IP addresses. | None |
| Deactivate IP Address | Deactivates IP addresses on the primary database during system replication takeover. | CREATE_MOUNT_POINTS | Information about the unbound IP addresses. | None |
| Deactivate IP Address | Deactivates IP addresses on the primary database during system replication takeover. | DELETE_MOUNT_POINTS | Information about the unbound IP addresses. | None |
| Deactivate IP Address | Deactivates IP addresses on the primary database during system replication takeover. | USER_EXIT | Information about the unbound IP addresses. | None |
| Deactivate IP Address | Deactivates IP addresses on the primary database during system replication takeover. | FORCED | Information about the unbound IP addresses. | None |
| Deactivate IP Address | Deactivates IP addresses on the primary database during system replication takeover. | SYNC | Information about the unbound IP addresses. | None |
| Deactivate IP Address | Deactivates IP addresses on the primary database during system replication takeover. | DO_MODIFY_SERVICES | Information about the unbound IP addresses. | None |
| Delete Host Names (DNS) | During a system destroy, deletes the hostname from the DNS server. | DNS_SERVER | DNS server to update. | None |
| Delete Host Names (DNS) | During a system destroy, deletes the hostname from the DNS server. | DNS_ENTRIES_SEP | Entries separator char. | None |
| Delete Host Names (DNS) | During a system destroy, deletes the hostname from the DNS server. | DNS_REV_ZONE |
Optional: Reverse DNS zone. |
None |
| Delete Host Names (DNS) | During a system destroy, deletes the hostname from the DNS server. | DNS_TTL | Time to live for the new entries. | None |
| Delete Host Names (DNS) | During a system destroy, deletes the hostname from the DNS server. | DNS_ENTRIES | <host name>=<ip-address>pairs, separated by ;. | None |
| Delete operating system users | Deletes operating system users. Only supported for LDAP. | Not applicable | Not applicable | Yes |
| Delete Volumes | Deletes storage volumes. | Not applicable | Not applicable | Yes |
| Diagnostics Agent Installation | Installs the Diagnostics Agent using the software provisioning manager. All parameters to the software provisioning manager (as shown in the SAP Landscape Management log) are available using the SAPINST_ prefix. The available parameters depend on the system or database type. | SAPINST_SOURCE_INST_PATH | Local path to the software provisioning manager executable. | None |
| Diagnostics Agent Installation | Installs the Diagnostics Agent using the software provisioning manager. All parameters to the software provisioning manager (as shown in the SAP Landscape Management log) are available using the SAPINST_ prefix. The available parameters depend on the system or database type. | SAPINST_SYSTEM_DB_TYPE | Type of the system database. | None |
| Diagnostics Agent Installation | Installs the Diagnostics Agent using the software provisioning manager. All parameters to the software provisioning manager (as shown in the SAP Landscape Management log) are available using the SAPINST_ prefix. The available parameters depend on the system or database type. | SAPINST_RELEASE | Release of the system. | None |
| Diagnostics Agent Installation | Installs the Diagnostics Agent using the software provisioning manager. All parameters to the software provisioning manager (as shown in the SAP Landscape Management log) are available using the SAPINST_ prefix. The available parameters depend on the system or database type. | SAPINST_PROD_ID | Production ID which will be executed. | None |
| Diagnostics Agent Installation | Installs the Diagnostics Agent using the software provisioning manager. All parameters to the software provisioning manager (as shown in the SAP Landscape Management log) are available using the SAPINST_ prefix. The available parameters depend on the system or database type. | SAPINST_VIRT_HOSTNAME | Virtual host name, for which the software provisioning manager is started. | None |
| Diagnostics Agent Installation | Installs the Diagnostics Agent using the software provisioning manager. All parameters to the software provisioning manager (as shown in the SAP Landscape Management log) are available using the SAPINST_ prefix. The available parameters depend on the system or database type. | SAPINST_EXPORT_PATH | Remote path the root of the installation DVD. | None |
| Diagnostics Agent Installation | Installs the Diagnostics Agent using the software provisioning manager. All parameters to the software provisioning manager (as shown in the SAP Landscape Management log) are available using the SAPINST_ prefix. The available parameters depend on the system or database type. | SAPINST_PWD |
Windows only: Password of the user starting the software provisioning manager. |
None |
| Diagnostics Agent Installation | Installs the Diagnostics Agent using the software provisioning manager. All parameters to the software provisioning manager (as shown in the SAP Landscape Management log) are available using the SAPINST_ prefix. The available parameters depend on the system or database type. | SAPINST_USER |
Windows only: User starting the software provisioning manager. |
None |
| Diagnostics Agent Uninstallation | Uninstalls the Diagnostics Agent using the software provisioning manager. All parameters to software provisioning manager (as shown in the SAP Landscape Management log) are available using the SAPINST_ prefix. The available parameters depend on the system or database type | SAPINST_SOURCE_INST_PATH | Local path to the software provisioning manager executable. | None |
| Diagnostics Agent Uninstallation | Uninstalls the Diagnostics Agent using the software provisioning manager. All parameters to software provisioning manager (as shown in the SAP Landscape Management log) are available using the SAPINST_ prefix. The available parameters depend on the system or database type. | SAPINST_SYSTEM_DB_TYPE | Type of the system database. | None |
| Diagnostics Agent Uninstallation | Uninstalls the Diagnostics Agent using the software provisioning manager. All parameters to software provisioning manager (as shown in the SAP Landscape Management log) are available using the SAPINST_ prefix. The available parameters depend on the system or database type. | SAPINST_RELEASE | Release of the system. | None |
| Diagnostics Agent Uninstallation | Uninstalls the Diagnostics Agent using the software provisioning manager. All parameters to software provisioning manager (as shown in the SAP Landscape Management log) are available using the SAPINST_ prefix. The available parameters depend on the system or database type. | SAPINST_PROD_ID | Production ID which will be executed. | None |
| Diagnostics Agent Uninstallation | Uninstalls the Diagnostics Agent using the software provisioning manager. All parameters to software provisioning manager (as shown in the SAP Landscape Management log) are available using the SAPINST_ prefix. The available parameters depend on the system or database type. | SAPINST_VIRT_HOSTNAME | Virtual host name, for which the software provisioning manager is started. | None |
| Diagnostics Agent Uninstallation | Uninstalls the Diagnostics Agent using the software provisioning manager. All parameters to software provisioning manager (as shown in the SAP Landscape Management log) are available using the SAPINST_ prefix. The available parameters depend on the system or database type. | SAPINST_EXPORT_PATH | Remote path the root of the installation DVD. | None |
| Diagnostics Agent Uninstallation | Uninstalls the Diagnostics Agent using the software provisioning manager. All parameters to software provisioning manager (as shown in the SAP Landscape Management log) are available using the SAPINST_ prefix. The available parameters depend on the system or database type. | SAPINST_PWD |
Windows only: Password of the user starting the software provisioning manager. |
None |
| Diagnostics Agent Uninstallation | Uninstalls the Diagnostics Agent using the software provisioning manager. All parameters to software provisioning manager (as shown in the SAP Landscape Management log) are available using the SAPINST_ prefix. The available parameters depend on the system or database type. | SAPINST_USER |
Windows only: User starting the software provisioning manager. |
None |
| Disable | Disables system replication. | Not applicable | Not applicable | None |
| Disable Post Copy Automation in Profile | Disables the PCA profile parameters in the default profile. | CH_PF_PROFILE | Path to profile. | Yes |
| Disable Post Copy Automation in Profile | Disables the PCA profile parameters in the default profile. | CH_PF_PARAMS | New parameter <key>=<value>, separated by ;. | Yes |
| Disable Post Copy Automation in Profile | Disables the PCA profile parameters in the default profile. | CH_PF_NEW_SID | New SID. | Yes |
| Disable Post Copy Automation in Profile | Disables the PCA profile parameters in the default profile. | CH_PF_SRC_SID | Old SID. | Yes |
| Disable Post Copy Automation in Profile | Disables the PCA profile parameters in the default profile. | CH_PF_USER | On UNIX, the user, which will be used to change the profile. | Yes |
| DNS Update | Creates the host names in the configured DNS or LDAP. It automatically selects free IP addresses in the given range. | DNS_SERVER | DNS server to update. | Yes |
| DNS Update | Creates the host names in the configured DNS or LDAP. It automatically selects free IP addresses in the given range. | DNS_ENTRIES_SEP | Entries separator char. | Yes |
| DNS Update | Creates the host names in the configured DNS or LDAP. It automatically selects free IP addresses in the given range. | DNS_REV_ZONE |
Optional: Reverse DNS zone. |
Yes |
| DNS Update | Creates the host names in the configured DNS or LDAP. It automatically selects free IP addresses in the given range. | DNS_TTL | Time to live for the new entries. | Yes |
| DNS Update | Creates the host names in the configured DNS or LDAP. It automatically selects free IP addresses in the given range. | DNS_ENTRIES | <host name>=<ip-address>pairs, separated by ;. | Yes |
| DNS Update | Creates the host names in the configured DNS or LDAP. It automatically selects free IP addresses in the given range. | DNS_ADD |
Optional: Value is true if entries should be added. Value is false if entries should be removed. |
Yes |
| Enable | Enables system replication. | Not applicable | Not applicable | None |
| Enable Post Copy Automation Changes in Profile | Enables the post-copy automation (PCA) profile parameters in the default profile. | CH_PF_PROFILE | Path to profile. | Yes |
| Enable Post Copy Automation Changes in Profile | Enables the post-copy automation (PCA) profile parameters in the default profile. | CH_PF_PARAMS | New parameter <key>=<value>, separated by ;. | Yes |
| Enable Post Copy Automation Changes in Profile | Enables the post-copy automation (PCA) profile parameters in the default profile. | CH_PF_NEW_SID | New SID. | Yes |
| Enable Post Copy Automation Changes in Profile | Enables the post-copy automation (PCA) profile parameters in the default profile. | CH_PF_SRC_SID | Old SID. | Yes |
| Enable Post Copy Automation Changes in Profile | Enables the post-copy automation (PCA) profile parameters in the default profile. | CH_PF_USER | On UNIX, the user, which will be used to change the profile. | Yes |
| Enable Startup Protection for Clone | Inserts a check in the start profile of a cloned SAP instance to avoid the startup of the SAP instance if the communication to the source system is possible. | CH_PF_PROFILE | Path to profile. | None |
| Enable Startup Protection for Clone | Inserts a check in the start profile of a cloned SAP instance to avoid the startup of the SAP instance if the communication to the source system is possible. | CH_PF_NEW_PARAM | Name of the new start profile parameter for clone startup protection. | None |
| Enable Startup Protection for Clone | Inserts a check in the start profile of a cloned SAP instance to avoid the startup of the SAP instance if the communication to the source system is possible. | CH_PF_NEW_SID | New SID. | None |
| Enable Startup Protection for Clone | Inserts a check in the start profile of a cloned SAP instance to avoid the startup of the SAP instance if the communication to the source system is possible. | CH_PF_SRC_SID | Old SID. | None |
| Enable Startup Protection for Clone | Inserts a check in the start profile of a cloned SAP instance to avoid the startup of the SAP instance if the communication to the source system is possible. | CH_PF_USER | On UNIX, the user, which will be used to change the profile. | None |
| Enable system | Enables the target system of a provisioning process for operational use within SAP Landscape Management. | Not applicable | Not applicable | Yes |
| Finalize Clone Volumes | Finalizes clone volumes. Is executed in background. | Not applicable | Not applicable | Yes |
| Finalize clone volumes (source system) | Executes storage-related background tasks. For example splitting a snapshot. The hook is executed on all instances of the source system. | Not applicable | Not applicable | Yes |
| Finalize clone volumes (target system) | Executes storage-related background tasks. For example splitting a snapshot. The hook is executed on all instances of the target system. | Not applicable | Not applicable | Yes |
| Finalize Source DB | Reverts any changes done by prepare database for copy. | Not applicable | Not applicable | None |
| Finalize VM Clone | Finalize VM clone, is executed in background. Available only for phased VM clone operations. | Not applicable | Not applicable | None |
| Forced Register and Start Instance Agent | Registers and starts the instance agent. | Not applicable | Not applicable | None |
| Forced Restart and Reregister Instance Agent | Unregisters and registers the instance agent. | Not applicable | Not applicable | None |
| Fullsync | Complete synchronization for system replication. | Not applicable | Not applicable | None |
| HANA Lifecycle Management | Calls hdblcm to rename SAP HANA instances. | SAPINST_SOURCE_INST_PATH | Local path to the software provisioning manager executable. | None |
| HANA Lifecycle Management | Calls hdblcm to rename SAP HANA instances. | SAPINST_SYSTEM_DB_TYPE | Type of the system database. | None |
| HANA Lifecycle Management | Calls hdblcm to rename SAP HANA instances. | SAPINST_RELEASE | Release of the system. | None |
| HANA Lifecycle Management | Calls hdblcm to rename SAP HANA instances. | SAPINST_PROD_ID | Production ID which will be executed. | None |
| HANA Lifecycle Management | Calls hdblcm to rename SAP HANA instances. | SAPINST_VIRT_HOSTNAME | Virtual host name, for which the software provisioning manager is started. | None |
| HANA Lifecycle Management | Calls hdblcm to rename SAP HANA instances. | SAPINST_EXPORT_PATH | Remote path the root of the installation DVD. | None |
| HANA Lifecycle Management | Calls hdblcm to rename SAP HANA instances. | SAPINST_PWD |
Windows only: Password of the user starting the software provisioning manager. |
None |
| HANA Lifecycle Management | Calls hdblcm to rename SAP HANA instances. | SAPINST_USER |
Windows only: User starting the software provisioning manager. |
None |
| Java Post Copy Automation | Executes task lists for Java PCA on a copied system. | JPCA_SCENARIO | Selected scenario. | Yes |
| Java Post Copy Automation | Executes task lists for Java PCA on a copied system. | JPCA_CONFIG | Name of the Java PCA configuration in SAP Landscape Management. | Yes |
| Java Post Copy Automation | Executes task lists for Java PCA on a copied system. | JPCA_PORT | Port of the target instance. | Yes |
| Java Post Copy Automation | Executes task lists for Java PCA on a copied system. | JPCA_HOSTNAME | Host name of the target instance | Yes |
| Java Post Copy Automation | Executes task lists for Java PCA on a copied system. | JPCA_PROTOCOL | Protocol used to access the target instance either http or https. | Yes |
| Java Post Copy Automation | Executes task lists for Java PCA on a copied system. | JCA_EXPORT_PATH | Local path where the Java PCA export is stored. | Yes |
| Java post copy automation export | Executes export task lists for Java PCA. | JPCA_SCENARIO | Selected scenario. | Yes |
| Java post copy automation export | Executes export task lists for Java PCA. | JPCA_CONFIG | Name of the Java PCA configuration in SAP Landscape Management. | Yes |
| Java post copy automation export | Executes export task lists for Java PCA. | JPCA_PORT | Port of the target instance. | Yes |
| Java post copy automation export | Executes export task lists for Java PCA. | JPCA_HOSTNAME | Host name of the target instance. | Yes |
| Java post copy automation export | Executes export task lists for Java PCA. | JPCA_PROTOCOL | Protocol used to access the target instance either http or https. | Yes |
| Java post copy automation export | Executes export task lists for Java PCA. | JCA_EXPORT_PATH | Local path where the Java PCA export is stored. | Yes |
| Java Post Copy Automation Import | Imports the Java post-copy automation export. | JPCA_SCENARIO | Selected scenario. | Yes |
| Java Post Copy Automation Import | Imports the Java post-copy automation export. | JPCA_CONFIG | Name of the Java PCA configuration in SAP Landscape Management. | Yes |
| Java Post Copy Automation Import | Imports the Java post-copy automation export. | JPCA_PORT | Port of the target instance. | Yes |
| Java Post Copy Automation Import | Imports the Java post-copy automation export. | JPCA_HOSTNAME | Host name of the target instance. | Yes |
| Java Post Copy Automation Import | Imports the Java post-copy automation export. | JPCA_PROTOCOL | Protocol used to access the target instance either http or https. | Yes |
| Java Post Copy Automation Import | Imports the Java post-copy automation export. | JCA_EXPORT_PATH | Local path where the Java PCA export is stored. | Yes |
| Kernel Update (Rolling Kernel Switch) | Executes the rolling kernel switch. | Not applicable | Not applicable | Yes |
| Modify Fstab/Export | Changes the SID specific mount points on the target host during VM-based provisioning. | OPTIONS | Options | Yes |
| Modify Fstab/Export | Changes the SID specific mount points on the target host during VM-based provisioning. | SID_MAPPINGS | SID mappings | Yes |
| Modify Fstab/Export | Changes the SID specific mount points on the target host during VM-based provisioning. | HOST_MAPPINGS | Host mappings | Yes |
| Modify Fstab/Export | Changes the SID specific mount points on the target host during VM-based provisioning. | ADDITIONAL_PARAMS | Additional parameters | Yes |
| Mount Oracle redo logs | Mounts the configured file system for the oracle redo logs. | MNT_LOCAL | Mount point | None |
| Mount Oracle redo logs | Mounts the configured file system for the oracle redo logs. | MNT_REMOTE | Remote path | None |
| Mount Oracle redo logs | Mounts the configured file system for the oracle redo logs. | MNT_OPTIONS | Mount options | None |
| Mount Oracle redo logs | Mounts the configured file system for the oracle redo logs. | MNT_TYPE | Storage type, DFS, NETFS, or SRID. | None |
| Mount Oracle redo logs | Mounts the configured file system for the oracle redo logs. | MNT_FSTYPE | File system type. | None |
| Mount Oracle redo logs | Mounts the configured file system for the oracle redo logs. | MNT_VENDOR | Partner ID for DFS and SRID. | None |
| Mount Oracle redo logs | Mounts the configured file system for the oracle redo logs. | Not applicable | Not applicable | None |
| Mount PCA Export | Mounts the configured file system for the PCA export. | Not applicable | Not applicable | None |
| Post Clone Volumes | Storage dependent post-clone operation. | Not applicable | Not applicable | Yes |
| Post clone volumes (source system) | Executed directly after cloning the storage volumes. The hook is executed on all instances of the source system. | Not applicable | Not applicable | Yes |
| Post clone volumes (target system) | Executed directly after cloning the storage volumes. The hook is executed on all instances of the target system. | Not applicable | Not applicable | Yes |
| Post-Process for Snapshot | Storage dependent post-snapshot operation. | Not applicable | Not applicable | None |
| Post VM Clone | Vendor specifc post VM clone step. Not possible for operations which need to be executed on the host directly, as it will not be available yet. | Not applicable | Not applicable | None |
| Post VM Clone (Source) | Vendor specifc post VM clone step, executed on and with the parameters of the source host. | Not applicable | Not applicable | None |
| Prepare Clone Volumes | Storage dependent preparation of the volume clone operation. | Not applicable | Not applicable | Yes |
| Prepare clone volumes (source system) | Prepares the clones of storage volumes. The hook is executed on all instances of the source system. | Not applicable | Not applicable | Yes |
| Prepare clone volumes (target system) | Prepares the clones of storage volumes. The hook is executed on all instances of the target system. | Not applicable | Not applicable | Yes |
| Prepare database for copy | Exports the database-related information used by the software provisioning manager. | Not applicable | Not applicable | None |
| Prepare DB copy | Calls prepareCopy on source database. | Not applicable | Not applicable | None |
| Prepare for Snapshot | Storage dependent preparation of a snapshot operation. | Not applicable | Not applicable | None |
| Prepare VM Clone | Vendor specific prepare VM clone step. Not possible for operations which need to be executed on the host directly, as it will not be available yet. Available only for phased VM clone operations. | Not applicable | Not applicable | None |
| Prepare VM Clone source | Vendor specific prepare VM clone step. Will be executed on and with the parameters of the source host. Available only for phased VM clone operations. | Not applicable | Not applicable | None |
| Provision Virtual Machine | Provisions a virtual machine. Not possible for operations which need to be executed on the host directly, as it will might not be available yet, to access host directly, use the post Add and Configure Host hook. Applicable for none phased VM clone operations. | Not applicable | Not applicable | Suspend |
| Provision Virtual Machine Source | Provisions a virtual machine. Will be executed with the parameters of the source host. Applicable for none phased VM clone operations. | Not applicable | Not applicable | Suspend |
| Register | Registration of the system replication. | Not applicable | Not applicable | None |
| Register and Start Instance Agent and Diagnostic Agent | Registers the instance agent and the corresponding Diagnostics Agent, if configured. | Not applicable | Not applicable | None |
| Remove directory |
Removes the previously created directory. |
SAPInstWorkDir | Directory, which will be deleted. | Depends on preceding step. |
| Remove firewall rules | Removes the outgoing firewall rules for an instance on a host for a fenced instance. Only called if the last instance of a fenced system is unprepared on a host. | FW_RULENAME | Name identifying the firewall rule set for one system. | Executed for one instance of the system per host. |
| Remove Host Configuration | Removes host configuration from SAP Landscape Management after system destroy. | Not applicable | Not applicable | None |
| Remove Instance | Removes system configuration from SAP Landscape Management after system destroy. | Not applicable | Not applicable | Yes |
| Restart Instance Agent | Triggers an instance restart. | Not applicable | Not applicable | Yes |
| Revert host name lookup | Reverts the resolution of host name lookup for all installation hosts of a cloned system. | HN_CHANGES | Host name changes <source host name>=<ip address of new host name>separated by HN_CHANGES_SEP. | Executed for one instance of the system per host. |
| Revert host name lookup | Reverts the resolution of host name lookup for all installation hosts of a cloned system. | HN_CHANGES_SEP | Separator. | Executed for one instance of the system per host. |
| Revert startup protection | Disables the startup protection in the start profile that was added during system clone. | CH_PF_PROFILE | Path to profile. | None |
| Revert startup protection | Disables the startup protection in the start profile that was added during system clone. | CH_PF_PARAMS | New parameter <key>=<value>pairs, separated by ;. | None |
| Revert startup protection | Disables the startup protection in the start profile that was added during system clone. | CH_PF_NEW_SID | New system ID (SID). | None |
| Revert startup protection | Disables the startup protection in the start profile that was added during system clone. | CH_PF_SRC_SID | New system ID (SID). | None |
| Revert startup protection | Disables the startup protection in the start profile that was added during system clone. | CH_PF_SRC_SID | Old SID. | None |
| Revert startup protection | Disables the startup protection in the start profile that was added during system clone. | CH_PF_USER | On UNIX, the user, which will be used to change the profile. | None |
| Set Post Copy Automation Export Path in Profile | Sets the location for the PCA export in the default profile. | CH_PF_PROFILE | Path to profile. | Yes |
| Set Post Copy Automation Export Path in Profile | Sets the location for the PCA export in the default profile. | CH_PF_PARAMS | New parameter <key>=<value>, separated by ;. | Yes |
| Set Post Copy Automation Export Path in Profile | Sets the location for the PCA export in the default profile. | CH_PF_NEW_SID | New SID. | Yes |
| Set Post Copy Automation Export Path in Profile | Sets the location for the PCA export in the default profile. | CH_PF_SRC_SID | Old SID. | Yes |
| Set Post Copy Automation Export Path in Profile | Sets the location for the PCA export in the default profile. | CH_PF_USER | On UNIX, the user, which will be used to change the profile. | Yes |
| Shut Down | Shuts down the virtual machine. | Not applicable | Not applicable | None |
| Software Provisioning Manager |
Starts the storage based system rename feature in the software provisioning manager. All parameters to the software provisioning manager (as shown in the SAP Landscape Management log) are available using the SAPINST_ prefix. The available parameters depend on the system or database type. |
SAPINST_SOURCE_INST_PATH | Local path to the software provisioning manager executable. | Yes, for central system |
| Software Provisioning Manager |
Starts the storage based system rename feature in the software provisioning manager. All parameters to the software provisioning manager (as shown in the SAP Landscape Management log) are available using the SAPINST_ prefix. The available parameters depend on the system or database type. |
SAPINST_SYSTEM_DB_TYPE | Type of the system database. | Yes, for central system |
| Software Provisioning Manager |
Starts the storage based system rename feature in the software provisioning manager. All parameters to the software provisioning manager (as shown in the SAP Landscape Management log) are available using the SAPINST_ prefix. The available parameters depend on the system or database type. |
SAPINST_RELEASE | Release of the system. | Yes, for central system |
| Software Provisioning Manager |
Starts the storage based system rename feature in the software provisioning manager. All parameters to the software provisioning manager (as shown in the SAP Landscape Management log) are available using the SAPINST_ prefix. The available parameters depend on the system or database type. |
SAPINST_PROD_ID | Production ID which will be executed. | Yes, for central system |
| Software Provisioning Manager |
Starts the storage based system rename feature in the software provisioning manager. All parameters to the software provisioning manager (as shown in the SAP Landscape Management log) are available using the SAPINST_ prefix. The available parameters depend on the system or database type. |
SAPINST_VIRT_HOSTNAME | Virtual host name, for which software provisioning manager is started. | Yes, for central system |
| Software Provisioning Manager |
Starts the storage based system rename feature in the software provisioning manager. All parameters to the software provisioning manager (as shown in the SAP Landscape Management log) are available using the SAPINST_ prefix. The available parameters depend on the system or database type. |
SAPINST_EXPORT_PATH | Remote path to the root of the installation DVD. | Yes, for central system |
| Software Provisioning Manager |
Starts the storage based system rename feature in the software provisioning manager. All parameters to the software provisioning manager (as shown in the SAP Landscape Management log) are available using the SAPINST_ prefix. The available parameters depend on the system or database type. |
SAPINST_PWD |
Windows only: Password of the user starting the software provisioning manager. |
Yes, for central system |
| Software Provisioning Manager |
Starts the storage based system rename feature in the software provisioning manager. All parameters to the software provisioning manager (as shown in the SAP Landscape Management log) are available using the SAPINST_ prefix. The available parameters depend on the system or database type. |
SAPINST_USER |
Windows only: User starting the software provisioning manager. |
Yes, for central system |
| Software Provisioning Manager Prerequisite Checker | Prerequisite checker of the software provisioning manager. | SAPINST_SOURCE_INST_PATH | Local path to the software provisioning manager executable. | Yes, for central system |
| Software Provisioning Manager Prerequisite Checker | Prerequisite checker of the software provisioning manager. | SAPINST_SYSTEM_DB_TYPE | Type of the system database. | Yes, for central system |
| Software Provisioning Manager Prerequisite Checker | Prerequisite checker of the software provisioning manager. | SAPINST_RELEASE | Release of the system. | Yes, for central system |
| Software Provisioning Manager Prerequisite Checker | Prerequisite checker of the software provisioning manager. | SAPINST_PROD_ID | Production ID which will be executed. | Yes, for central system |
| Software Provisioning Manager Prerequisite Checker | Prerequisite checker of the software provisioning manager. | SAPINST_VIRT_HOSTNAME | Virtual host name, for which software provisioning manager is started. | Yes, for central system |
| Software Provisioning Manager Prerequisite Checker | Prerequisite checker of the software provisioning manager. | SAPINST_EXPORT_PATH | Remote path to the root of the installation DVD. | Yes, for central system |
| Software Provisioning Manager Prerequisite Checker | Prerequisite checker of the software provisioning manager. | SAPINST_PWD |
Windows only: Password of the user starting the software provisioning manager. |
Yes, for central system |
| Software Provisioning Manager Prerequisite Checker | Prerequisite checker of the software provisioning manager. | SAPINST_USER |
Windows only: User starting the software provisioning manager. |
Yes, for central system |
| Stop and Unregister Instance Agent and Diagnostic Agent | Stops and unregisters instance agent and Diagnostics Agent. | Not applicable | Not applicable | Yes |
| Suspend | Suspends virtual machine. | Not applicable | Not applicable | None |
| Takeover | Starts a takeover of the SAP HANA replication. | Not applicable | Not applicable | None |
| Take snapshot | Creates a storage clone. | Not applicable | Not applicable | None |
| Take Snapshot and Ensure DB Consistency | Creates a storage clone and ensures database consistency afterwards. | Not applicable | Not applicable | None |
| Unmount Fstab Mounts | Unmounts SID-specific mount points in the fstab. | UMOUNT.[INDEX].MNT_PATH | Mount path | Yes |
| Unmount Fstab Mounts | Unmounts SID-specific mount points in the fstab. | UMOUNT.[INDEX].MNT_OPTIONS | Mount options | Yes |
| Unmount Fstab Mounts | Unmounts SID-specific mount points in the fstab. | UMOUNT.[INDEX].MNT_TYPE | Mount type | Yes |
| Unmount Fstab Mounts | Unmounts SID-specific mount points in the fstab. | UMOUNT.[INDEX].MNT_FSTYPE | Filesystem type | Yes |
| Unmount Fstab Mounts | Unmounts SID-specific mount points in the fstab. | UMOUNT.[INDEX].MNT_VENDOR | Vendor | Yes |
| Unmount Fstab Mounts | Unmounts SID-specific mount points in the fstab. | UMOUNT.LENGTH |
Once only. Number of entries or indexes. Index starts with 0 and ends with UMOUNT.LENGTH -1. |
Yes |
| Unmount Fstab Mounts | Unmounts SID-specific mount points in the fstab. | USER_EXIT | User exit | Yes |
| Unmount Fstab Mounts | Unmounts SID-specific mount points in the fstab. | FORCED | Forced | Yes |
| Unmount Fstab Mounts | Unmounts SID-specific mount points in the fstab. | SYNC | Sync | Yes |
| Unmount Fstab Mounts | Unmounts SID-specific mount points in the fstab. | DO_MODIFY_SERVICES | Do modify services | Yes |
| Unmount Oracle redo logs | Unmounts the configured file system for the oracle redo logs. | MNT_LOCAL | Mount point | None |
| Unmount Oracle redo logs | Unmounts the configured file system for the oracle redo logs. | MNT_REMOTE | Remote path | None |
| Unmount Oracle redo logs | Unmounts the configured file system for the oracle redo logs. | MNT_OPTIONS | Mount options | None |
| Unmount Oracle redo logs | Unmounts the configured file system for the oracle redo logs. | MNT_TYPE | Storage type, DFS, NETFS, or SRID. | None |
| Unmount Oracle redo logs | Unmounts the configured file system for the oracle redo logs. | MNT_FSTYPE | File system type. | None |
| Unmount Oracle redo logs | Unmounts the configured file system for the oracle redo logs. | MNT_VENDOR | Partner ID for DFS and SRID. | None |
| Unmount PCA Export | Unmounts the configured file system for PCA exports. | MNT_LOCAL | Mount point | None |
| Unmount PCA Export | Unmounts the configured file system for PCA exports. | MNT_REMOTE | Remote path | None |
| Unmount PCA Export | Unmounts the configured file system for PCA exports. | MNT_OPTIONS | Mount options | None |
| Unmount PCA Export | Unmounts the configured file system for PCA exports. | MNT_TYPE | Storage type, DFS, NETFS, or SRID. | None |
| Unmount PCA Export | Unmounts the configured file system for PCA exports. | MNT_FSTYPE | File system type. | None |
| Unmount PCA Export | Unmounts the configured file system for PCA exports. | MNT_VENDOR | Partner ID for DFS and SRID. | None |
| Unprepare | Detaches database, unregisters instance agent, unmounts file systems, and deactivates virtual hostnames. | Not applicable | Not applicable | None |
| Unregister | Unregisters system replication. | Not applicable | Not applicable | Yes |
| Update Firewall Rules | Update firewall rules for a system. | Not applicable | Not applicable | None |
| Update mount configuration | Update mount configuration of the target system with new volume information. | Not applicable | Not applicable | Yes |
| Update SAP kernel versions in LVM configuration. | Checks current SAP kernel version of service and updates service if newer version is available. | Not applicable | Not applicable | None |
| User management |
Creates the operating system users for an SAP system. The hooks will be executed for all applicable instances of the system for all users. |
USER_USERID | ID of the user. | Yes |
| User management |
Creates the operating system users for an SAP system. The hooks will be executed for all applicable instances of the system for all users. |
USER_NAME | User name | Yes |
| User management |
Creates the operating system users for an SAP system. The hooks will be executed for all applicable instances of the system for all users. |
USER_GROUP_MEMBER | A list of groups, the user is part of, separated by USER_GOUP_MEMBER_SEP | Yes |
| User management |
Creates the operating system users for an SAP system. The hooks will be executed for all applicable instances of the system for all users. |
USER_LOGIN_SHELL |
UNIX only: Logon shell of the user. |
Yes |
| User management |
Creates the operating system users for an SAP system. The hooks will be executed for all applicable instances of the system for all users. |
USER_HOME_DIR |
UNIX only: Home directory of the user. |
Yes |
| User management |
Creates the operating system users for an SAP system. The hooks will be executed for all applicable instances of the system for all users. |
USER_UID_NUMBER |
UNIX only: UID of the user. |
Yes |
| User management |
Creates the operating system users for an SAP system. The hooks will be executed for all applicable instances of the system for all users. |
USER_GID_NUMBER |
UNIX only: GID of the primary group. |
Yes |
| User management |
Creates the operating system users for an SAP system. The hooks will be executed for all applicable instances of the system for all users. |
USER_PRIMARAY_GROUP |
UNIX only: Name of the primary group. |
Yes |
| User management |
Creates the operating system users for an SAP system. The hooks will be executed for all applicable instances of the system for all users. |
USER_PASSWORD | Assigned password for the user. | Yes |
| User management |
Creates the operating system users for an SAP system. The hooks will be executed for all applicable instances of the system for all users. |
USER_EXISTS | Does the user already exist. | Yes |
| User management |
Creates the operating system users for an SAP system. The hooks will be executed for all applicable instances of the system for all users. |
USER_DOMAIN |
Windows only: Domain of the user. |
Yes |
| VM Clone | Clones a virtual machine. Not possible for operations which need to be executed on the host directly, as it will might not be available yet, to access host directly, use the post Add and Configure Host hook Available only for phased VM clone operations. | Not applicable | Not applicable | None |
| VM Clone Source | Clones a virtual machine. Will be executed on and with the parameters of the source host. Available only for phased VM clone operations. | Not applicable | Not applicable | None |
