Role stop_sap 

The role stop_sap is used to stop one or multiple SAP instances, either for a given SAP system ID (tag -t sap_stop_instances) or for all SAP systems that are configured in file /usr/sap/sapservices (tag -t sap_stop_all_systems). If a requested SAP instance is already inactive, the request will be ignored and no error message will be sent. The role stop_sap is using the sapcontrol command of the SAP Host Agent as suggested in SAP Note 1763593. It requires that the SAP start services for the selected instances are active. By default, the SAP start services are started automatically when the subsystem QUSRWRK is started. If the SAP start services are not active, they can be started by using this role with the tag -t sap_start_services.

If the role stop_sap is used with tag -t sap_stop_instances, it needs the SAP system ID as input in variable stopsap_input_sap_sid. An SAP instance number can be provided optionally in variable stopsap_input_sap_instance_nr. If an instance number is provided, only this instance is stopped. If no instance number is provided, stop_sap will stop all configured instances for the given SID, also on remote servers in a distributed landscape. It is recommended that the role stop_sap is executed on the logical partition or server that hosts the central services instance (ASCS, SCS), the primary application server instance, or the central instance.

If the role stop_sap is used with tag -t sap_stop_all_systems, the values in the variables stopsap_input_sap_sid and stopsap_input_sap_instance_nr are ignored. Instead, all SAP systems that are configured in file /usr/sap/sapservices will be stopped with all their instances.

If the role stop_sap is used with tag -t sap_stop_services, you can specify a SAP system ID in variable stopsap_input_sap_sid or the special value "*". If you specify "*", SAP start services will be stopped for all SAP systems that are configured in /usr/sap/sapservices.

Table of contents

Role stop_sap

Requirements 

This role is intended for the operating system IBM i. The target system must be enabled to execute Ansible playbooks. For details, see the prerequisites section in Ansible Content for IBM Power Systems - IBM i with SAP Software.

The SAP start services for the requested SAP system must be configured in file /usr/sap/sapservices. In a standard installation, they are started automatically after an IPL when subsystem QUSRWRK is started (autostart job entry SAPINIT). They can be started manually by calling program R3SAP400/SAPINIT or by executing the role start_sap with tag -t sap_start_services.

Tags 

Specify one of the following tags to specify what parts of an SAP system you want to stop. If you do not specify a tag, -t sap_stop_instances will be assumed as default. If you misspell the tag, an error message will be sent.

Tag	Usage
`sap_stop_instances`	One or all instances for a specific SAP system ID are stopped. The SAP system ID must be specified in variable `stopsap_input_sap_sid`, the instance number can optionally be specified in variable `stopsap_input_sap_instance_nr`.
`sap_stop_all_systems`	All instances are stopped for all SAP systems that are configured in file /usr/sap/sapservices.
`sap_stop_services`	Stop SAP start services for the SAP system ID specified in variable `stopsap_input_sap_sid` or for all SAP systems that are configured in file /usr/sap/sapservices when variable `stopsap_input_sap_sid` is set to `"*"`.

Variables 

Variable	Usage	Required
`stopsap_dir_sapctrl_managednode`	Directory path on the target host where the sapcontrol executable is located	Yes 1
`stopsap_input_sap_sid`	SAP system ID or `"*"`	Yes 2
`stopsap_input_sap_instance_nr`	SAP instance number	No 3
`stopsap_softtimeout`	softtimeout in seconds: -1 = infinite wait, 0 = hard shutdown	No 4
`stopsap_input_waitforstopped`	Timeout in seconds when waiting for instance to be completely stopped	Yes 1

Remarks:

1(1,2): Default provided.
2: The variable is only evaluated when the tags -t sap_stop_instances or -t sap_stop_services are set.
3: The variable is only evaluated when the tag -t sap_stop_instances is set. If the variable is omitted, all instances of the specified SAP system ID will be stopped.
4: When the parameter is omitted, a hard shutdown is executed.

Defaults 

Suggested default values are provided in defaults/main.yml:

Variable	Default
`stopsap_dir_sapctrl_managednode`	`"/usr/sap/hostctrl/exe"`
`stopsap_input_waitforstopped`	`"1200"`
`stopsap_ordered_list_instance_types`	For internal use only
`stopsap_softtimeout`	`""`

Dependencies 

None.

Example Playbook 

The example playbook is used to stop all instances of an SAP system with the SAP system ID (SID) PRD. It is based on the assumption that a configuration file and an inventory file with contents similar to the configuration documentation exist in the current directory. The ASCS instance is installed on host ibmiserver01.mycorp.com, and the SAP start services for SAP system PRD are active on all hosts that have instances for SAP system PRD. The example playbook in the current directory is named stop_sap.yml and has the following contents:

- hosts: ibmiserver01.mycorp.com
  vars:
  - stopsap_input_sap_sid: "PRD"
  roles:
  - role: <ansible_dir>/roles/stop_sap

To execute this playbook, enter the command:

ansible-playbook --verbose stop_sap.yml -t sap_stop_instances

Note: When using the role stop_sap with tag -t sap_stop_instances to stop instances of an SAP system on several hosts, you only need to execute the role on one host, typically the host that holds the central services instance. When using the role stop_sap with tag -t sap_stop_services to stop the SAP start services, you must execute it on all hosts that hold SAP instances for the specified SAP system.