sap_swpm: New improved and simplified version

roles/sap_swpm/defaults/main.yml

@@ -5,7 +5,8 @@
 #   SWPM Ansible Role variables
 ########################################
 
-sap_swpm_ansible_role_mode: "default"
+# We do not use role modes any more:
+# sap_swpm_ansible_role_mode: "default"
 # default
 # default_templates
 # advanced
@@ -45,30 +46,29 @@ sap_swpm_files_non_sapcar_group: root
 
 ########################################
 #   SWPM Ansible Role variables
-#   for Inifile Reuse, Advanced, and Defaults/Advanced Templates Mode
+#   for creating the sapinst inifile
 ########################################
 
+# Have the role run the sapinst command with an existing inifile or after creating the inifile:
+sap_swpm_run_sapinst: true
+
 # Inifile Reuse Mode
 sap_swpm_inifile_reuse_source:
 sap_swpm_inifile_reuse_destination:
 
-# Advanced Mode
-#sap_swpm_inifile_custom_values_dictionary:
+#sap_swpm_inifile_parameters_dict:
 #  archives.downloadBasket: /software/download_basket
 #  NW_getFQDN.FQDN: poc.cloud
 ## add.additional.parameters: ''
 
-# Default/Advanced Templates Mode
-#sap_swpm_templates_product_input: ""
-
 
 ########################################
 #   SWPM Ansible Role variables
 #   for Default Mode
 #   - List of inifile parameters to generate
 ########################################
 
-sap_swpm_inifile_list:
+sap_swpm_inifile_sections_list:
   - swpm_installation_media
   - swpm_installation_media_swpm2_hana
 #  - swpm_installation_media_swpm1
@@ -139,7 +139,8 @@ sap_swpm_inifile_list:
 ########################################
 
 # SAP product that will be installed and passed as argument to the sapinst installer, example 'NW_ABAP_OneHost:S4HANA2020.CORE.HDB.ABAP'
-sap_swpm_product_catalog_id:
+# Needs to be defined in the playbook or inventory or can be determined from an existing inifile.params file.
+#sap_swpm_product_catalog_id:
 
 # SAPCAR path and file name, only path is mandatory. The script will automatically get file_name
 sap_swpm_sapcar_path:
@@ -153,10 +154,10 @@ sap_swpm_software_extract_directory: # e.g. /software/sap_swpm_extracted
 # Note:
 # When using SWPM2 (for modern SAP products such as S/4 B/4), using .SAR files is recommended - param value should be false
 # When using SWPM1 (for older SAP products), using CD Media is the only choice - param value should be true
-sap_swpm_software_use_media: 'false'
+sap_swpm_software_use_media: false
 
 # Main path that this role will look for .SAR files
-sap_swpm_software_path:
+#sap_swpm_software_path: /software/sapfiles
 ## This directory path should include these files:
 ##   - igs*sar
 ##   - igshelper*sar
@@ -165,6 +166,10 @@ sap_swpm_software_path:
 ##   - IMDB_CLIENT*SAR
 ##   - SAPHOSTAGENT*SAR
 
+# Directory in which a sapinst inifile which is to be used by the role can be stored:
+sap_swpm_inifile_directory: '/software/sap_swpm/inifiles'
+#sap_swpm_local_inifile_directory: '/tmp/inifiles'
+
 # SWPM1 - paths that this role will look for CD Media software
 sap_swpm_cd_export_pt1_path:
 sap_swpm_cd_export_pt2_path:
@@ -185,12 +190,12 @@ sap_swpm_ibmdb2_unpack_path: "/db2/db2{{ sap_swpm_db_sid | lower }}/db2_software
 sap_swpm_mp_stack_path:
 sap_swpm_mp_stack_file_name:
 # SUM
-sap_swpm_sum_prepare: 'false'
-sap_swpm_sum_start: 'false'
+sap_swpm_sum_prepare: false
+sap_swpm_sum_start: false
 sap_swpm_sum_batch_file:
-sap_swpm_spam_update: 'false'
+sap_swpm_spam_update: false
 sap_swpm_spam_update_sar:
-sap_swpm_configure_tms: 'true'
+sap_swpm_configure_tms: true
 sap_swpm_tmsadm_password:
 sap_swpm_tms_tr_files_path:
 # --- Experimental --- #
@@ -205,7 +210,7 @@ sap_swpm_swpm_observer_mode: false
 sap_swpm_swpm_remote_access_user:
 # --- Experimental - SWPM Observer mode --- #
 
-sap_swpm_install_saphostagent: 'true'
+sap_swpm_install_saphostagent: true
 
 
 ########################################
@@ -352,7 +357,7 @@ sap_swpm_backup_prefix:
 sap_swpm_backup_system_password:
 
 # ASCS Install Gateway
-sap_swpm_ascs_install_gateway: "true"
+sap_swpm_ascs_install_gateway: true
 
 
 ########################################
@@ -363,8 +368,8 @@ sap_swpm_ascs_install_gateway: "true"
 
 sap_swpm_wd_instance_nr:
 
-sap_swpm_wd_system_connectivity: 'false'
-sap_swpm_wd_activate_icf: 'false'
+sap_swpm_wd_system_connectivity: false
+sap_swpm_wd_activate_icf: false
 sap_swpm_wd_backend_sid:
 sap_swpm_wd_backend_ms_http_port:
 sap_swpm_wd_backend_ms_host:
@@ -417,18 +422,18 @@ sap_swpm_kernel_independent_file_name:
 sap_swpm_web_dispatcher_path:
 sap_swpm_web_dispatcher_file_name:
 sap_swpm_fqdn:
-sap_swpm_set_fqdn: "true"
+sap_swpm_set_fqdn: true
 
 # If the template to use already has the passwords and they are encrypted the password file must be in the same path as the parameter file
-sap_swpm_use_password_file: "n"
+sap_swpm_use_password_file: false
 sap_swpm_password_file_path:
 
-sap_swpm_use_livecache: "false"
+sap_swpm_use_livecache: false
 sap_swpm_ddic_001_password:
 sap_swpm_load_type: 'SAP'
 
 
-sap_swpm_generic: 'false'
+sap_swpm_generic: false
 
 # SWPM
 sap_swpm_swpm_installation_type: ""
@@ -437,10 +442,10 @@ sap_swpm_swpm_command_virtual_hostname: ""
 sap_swpm_swpm_command_mp_stack: ""
 
 # Firewall setup
-sap_swpm_setup_firewall: 'false'
+sap_swpm_setup_firewall: false
 
 # Update /etc/hosts
-sap_swpm_update_etchosts: 'false'
+sap_swpm_update_etchosts: false
 
 # Display SAP SWPM Unattended Mode output (sapinst stdout)
 sap_swpm_display_unattended_output: false

roles/sap_swpm/tasks/main.yml

@@ -9,8 +9,10 @@
 
 - name: SAP SWPM - run swpm
   ansible.builtin.import_tasks: swpm.yml
+  when: sap_swpm_run_sapinst
   tags:
     - sap_swpm_install
 
 - name: SAP SWPM - run postinstall task
   ansible.builtin.import_tasks: post_install.yml
+  when: sap_swpm_run_sapinst

roles/sap_swpm/tasks/post_install.yml

@@ -17,7 +17,7 @@
 - name: SAP SWPM Post Install - Firewall Setup
   ansible.builtin.include_tasks: post_install/firewall.yml
   when:
-    - "sap_swpm_setup_firewall | bool"
+    - sap_swpm_setup_firewall
 
 ########################################################################################################################
 

roles/sap_swpm/tasks/pre_install.yml

@@ -1,45 +1,148 @@
 # SPDX-License-Identifier: Apache-2.0
 ---
 
+- name: SAP SWPM Pre Install - Define 'sap_swpm_inifile_sections_list' from 'sap_swpm_inifile_list' if necessary
+  ansible.builtin.set_fact:
+    sap_swpm_inifile_sections_list: "{{ sap_swpm_inifile_list }}"
+  when:
+    - sap_swpm_inifile_sections_list is undefined
+    - sap_swpm_inifile_list is defined
+  tags: always
+
+- name: SAP SWPM Pre Install - Define 'sap_swpm_inifile_parameters_dict' from 'sap_swpm_inifile_custom_values_dictionary' if necessary
+  ansible.builtin.set_fact:
+    sap_swpm_inifile_parameters_dict: "{{ sap_swpm_inifile_custom_values_dictionary }}"
+  when:
+    - sap_swpm_inifile_parameters_dict is undefined
+    - sap_swpm_inifile_custom_values_dictionary is defined
+  tags: always
+
+# Note: Variable definitions in sap_swpm_templates_install_dictionary will overwrite existing top level definitions.
+- name: SAP SWPM Pre Install - Define variables from 'sap_swpm_templates_install_dictionary' if present
+  when: sap_swpm_templates_install_dictionary is defined
+  tags: always
+  block:
+
+    - name: SAP SWPM Pre Install - Display 'sap_swpm_templates_product_input'
+      ansible.builtin.debug:
+        msg:
+          - "sap_swpm_templates_product_input: >{{ sap_swpm_templates_product_input }}<"
+      ignore_errors: true
+
+    - name: SAP SWPM Pre Install - Fail if 'sap_swpm_inifile_sections_list' and 'sap_swpm_inifile_list' are both defined in the dict
+      ansible.builtin.fail:
+        msg:
+          - "FAIL: In 'sap_swpm_templates_install_dictionary[sap_swpm_templates_product_input]', both"
+          - "'sap_swpm_inifile_sections_list' and 'sap_swpm_inifile_list' are defined!"
+          - "Only one of these variables may be defined in 'sap_swpm_templates_install_dictionary[sap_swpm_templates_product_input]'."
+      when:
+        - sap_swpm_templates_install_dictionary[sap_swpm_templates_product_input]['sap_swpm_inifile_sections_list'] is defined
+        - sap_swpm_templates_install_dictionary[sap_swpm_templates_product_input]['sap_swpm_inifile_list'] is defined
+
+    - name: SAP SWPM Pre Install - Fail if 'sap_swpm_inifile_parameters_dict' and 'sap_swpm_inifile_custom_values_dictionary' are both defined in the dict
+      ansible.builtin.fail:
+        msg:
+          - "FAIL: In 'sap_swpm_templates_install_dictionary[sap_swpm_templates_product_input]', both"
+          - "'sap_swpm_inifile_parameters_dict', and 'sap_swpm_inifile_custom_values_dictionary', are defined!"
+          - "Only one of these variables may be defined in 'sap_swpm_templates_install_dictionary[sap_swpm_templates_product_input]'."
+      when:
+        - sap_swpm_templates_install_dictionary[sap_swpm_templates_product_input]['sap_swpm_inifile_parameters_dict'] is defined
+        - sap_swpm_templates_install_dictionary[sap_swpm_templates_product_input]['sap_swpm_inifile_custom_values_dictionary'] is defined
+
+# Unconditionally define sap_swpm_product_catalog_id from low level member.
+    - name: SAP SWPM Pre Install - Define 'sap_swpm_product_catalog_id' from low level member with the same name
+      ansible.builtin.set_fact:
+#        sap_swpm_product_catalog_id: "{{ sap_swpm_product_catalog_id |
+#          d(sap_swpm_templates_install_dictionary[sap_swpm_templates_product_input]['sap_swpm_product_catalog_id']) }}"
+        sap_swpm_product_catalog_id: "{{ sap_swpm_templates_install_dictionary[sap_swpm_templates_product_input]['sap_swpm_product_catalog_id'] }}"
+      when: sap_swpm_templates_install_dictionary[sap_swpm_templates_product_input]['sap_swpm_product_catalog_id'] is defined
+
+    - name: SAP SWPM Pre Install - Display 'sap_swpm_product_catalog_id'
+      ansible.builtin.debug:
+        msg: "sap_swpm_product_catalog_id: >{{ sap_swpm_product_catalog_id }}<"
+
+# Unconditionally define sap_swpm_inifile_sections_list from low level member.
+    - name: SAP SWPM Pre Install - Define 'sap_swpm_inifile_sections_list' from low level member
+      ansible.builtin.set_fact:
+        sap_swpm_inifile_sections_list: "{{ sap_swpm_templates_install_dictionary[sap_swpm_templates_product_input]['sap_swpm_inifile_list'] |
+          d(sap_swpm_templates_install_dictionary[sap_swpm_templates_product_input]['sap_swpm_inifile_sections_list']) }}"
+      when: sap_swpm_templates_install_dictionary[sap_swpm_templates_product_input]['sap_swpm_inifile_list'] is defined or
+            sap_swpm_templates_install_dictionary[sap_swpm_templates_product_input]['sap_swpm_inifile_sections_list'] is defined
+
+# Define sap_swpm_role_parameters_dict from low level member.
+    - name: SAP SWPM Pre Install - Define 'sap_swpm_role_parameters_dict' from low level member
+      ansible.builtin.set_fact:
+        sap_swpm_role_parameters_dict: "{{ sap_swpm_templates_install_dictionary[sap_swpm_templates_product_input]['sap_swpm_inifile_dictionary'] |
+          d(sap_swpm_templates_install_dictionary[sap_swpm_templates_product_input]['sap_swpm_role_parameters_dict']) }}"
+      when: sap_swpm_templates_install_dictionary[sap_swpm_templates_product_input]['sap_swpm_inifile_dictionary'] is defined or
+            sap_swpm_templates_install_dictionary[sap_swpm_templates_product_input]['sap_swpm_role_parameters_dict'] is defined
+
+    - name: SAP SWPM Pre Install - Display 'sap_swpm_role_parameters_dict'
+      ansible.builtin.debug:
+        msg: "sap_swpm_role_parameters_dict: >{{ sap_swpm_role_parameters_dict }}<"
+      when: sap_swpm_role_parameters_dict is defined and sap_swpm_role_parameters_dict
+      ignore_errors: true
+
+# Define role variables from low level member, looping over 'sap_swpm_role_parameters_dict'.
+# Reason for noqa: We are setting variables from the content of a dict, and the variable names are in the dict keys.
+    - name: SAP SWPM Pre Install - Define role variables from low level member, looping over 'sap_swpm_role_parameters_dict' # noqa var-naming[no-jinja]
+      ansible.builtin.set_fact:
+        "{{ line_item.key }}": "{{ line_item.value }}"
+      loop: "{{ sap_swpm_role_parameters_dict | dict2items if sap_swpm_role_parameters_dict is mapping else [] }}"
+      loop_control:
+        loop_var: line_item
+      when:
+        - sap_swpm_role_parameters_dict is defined and sap_swpm_role_parameters_dict
+
+    - name: SAP SWPM Pre Install - Display all vars and values of 'sap_swpm_role_parameters_dict'
+      ansible.builtin.debug:
+        msg: "{{ line_item.key }}: >{{ lookup('vars', line_item.key) }}<"
+      loop: "{{ sap_swpm_role_parameters_dict | dict2items if sap_swpm_role_parameters_dict is mapping else [] }}"
+      loop_control:
+        loop_var: line_item
+      when: sap_swpm_role_parameters_dict is defined and sap_swpm_role_parameters_dict
+      ignore_errors: true
+
+# Define sap_swpm_inifile_parameters_dict from low level member, or use top level variable if defined. Low level definition has precedence.
+    - name: SAP SWPM Pre Install - Define 'sap_swpm_inifile_parameters_dict' from low level member
+      ansible.builtin.set_fact:
+        sap_swpm_inifile_parameters_dict: "{{ sap_swpm_templates_install_dictionary[sap_swpm_templates_product_input]['sap_swpm_inifile_custom_values_dictionary'] |
+          d(sap_swpm_templates_install_dictionary[sap_swpm_templates_product_input]['sap_swpm_inifile_parameters_dict']) }}"
+      when: sap_swpm_templates_install_dictionary[sap_swpm_templates_product_input]['sap_swpm_inifile_custom_values_dictionary'] is defined or
+            sap_swpm_templates_install_dictionary[sap_swpm_templates_product_input]['sap_swpm_inifile_parameters_dict'] is defined
+
+# The following task ensures that the two main inifile creation parameters are defined.
+# This is necessary when creating the file 'inifile.params'.
+- name: SAP SWPM Pre Install - Define the main inifile creation parameters as empty if necessary
+  ansible.builtin.set_fact:
+    sap_swpm_inifile_sections_list: "{{ sap_swpm_inifile_sections_list | d([]) }}"
+    sap_swpm_inifile_parameters_dict: "{{ sap_swpm_inifile_parameters_dict | d({}) }}"
+  tags: always
+
 ################
 # Run Preinstallation Steps Based on Run Mode
 ################
 
 - name: SAP SWPM Pre Install - Run Preinstallation Steps
-  ansible.builtin.include_tasks: swpm/swpm_pre_install.yml
+  ansible.builtin.include_tasks: pre_install/swpm_prepare.yml
   tags:
     - sap_swpm_generate_inifile
     - sap_swpm_sapinst_commandline
 
-################
-# Set sapinst command
-################
-
-- name: SAP SWPM Pre Install - Set sapinst command
-  vars:
-    sap_swpm_swpm_command_guiserver: "{{ 'SAPINST_START_GUISERVER=false' if not sap_swpm_swpm_observer_mode else '' }}"
-    sap_swpm_swpm_command_observer: "{{ 'SAPINST_REMOTE_ACCESS_USER=' + sap_swpm_swpm_remote_access_user + ' SAPINST_REMOTE_ACCESS_USER_IS_TRUSTED=true' if sap_swpm_swpm_observer_mode and sap_swpm_swpm_remote_access_user | d('', true) | length > 0 else '' }}"
-  ansible.builtin.set_fact:
-    sap_swpm_swpm_command_inifile: "SAPINST_INPUT_PARAMETERS_URL={{ sap_swpm_tmpdir.path }}/inifile.params"
-    sap_swpm_swpm_command_product_id: "SAPINST_EXECUTE_PRODUCT_ID={{ sap_swpm_product_catalog_id }}"
-    # If SWPM is running a normal install Ansible Variable sap_swpm_swpm_command_virtual_hostname is blank
-    # IF SWPM is running a HA installation, Ansible Variable sap_swpm_swpm_command_virtual_hostname is set and contains "SAPINST_USE_HOSTNAME={{ sap_swpm_virtual_hostname }} IS_HOST_LOCAL_USING_STRING_COMPARE=true"
-    # If SWPM is running a MP Stack XML installation, Ansible Variable sap_swpm_swpm_command_mp_stack is set and contains "SAPINST_STACK_XML={{ sap_swpm_mp_stack_path }} + '/' (if needed) + {{ sap_swpm_mp_stack_file_name }}"
-    sap_swpm_swpm_command_extra_args: "SAPINST_SKIP_DIALOGS=true {{ sap_swpm_swpm_command_guiserver }} {{ sap_swpm_swpm_command_observer }} {{ sap_swpm_swpm_command_virtual_hostname }} {{ sap_swpm_swpm_command_mp_stack }}"
-  tags: sap_swpm_sapinst_commandline
-
 ################
 # Pre Install Optional Tasks
 ################
 
 # Firewall
 
-- name: SAP SWPM Pre Install - Firewall Setup
+- name: SAP SWPM Pre Install - Setup Firewall
   ansible.builtin.include_tasks:
     file: pre_install/firewall.yml
     apply:
       tags: sap_swpm_setup_firewall
-  when: "sap_swpm_setup_firewall | bool"
+  when:
+    - sap_swpm_run_sapinst
+    - sap_swpm_setup_firewall
   tags: sap_swpm_setup_firewall
 
 # /etc/hosts
@@ -49,7 +152,9 @@
     file: pre_install/update_etchosts.yml
     apply:
       tags: sap_swpm_update_etchosts
-  when: "sap_swpm_update_etchosts | bool"
+  when:
+    - sap_swpm_run_sapinst
+    - sap_swpm_update_etchosts
   tags: sap_swpm_update_etchosts
 
 ################
@@ -81,3 +186,32 @@
       - '   The installation can take up to 3 hours. Run the following command as root'
       - '   on {{ ansible_hostname }} to display the installation logs:'
       - '   # tail -f $(cat /tmp/sapinst_instdir/.lastInstallationLocation)/sapinst.log'
+
+################
+# Set sapinst command
+################
+
+- name: SAP SWPM Pre Install - Set the sapinst command parameters
+  vars:
+    sap_swpm_swpm_command_guiserver: "{{ 'SAPINST_START_GUISERVER=false' if not sap_swpm_swpm_observer_mode else '' }}"
+    sap_swpm_swpm_command_observer: "{{ 'SAPINST_REMOTE_ACCESS_USER=' + sap_swpm_swpm_remote_access_user + ' SAPINST_REMOTE_ACCESS_USER_IS_TRUSTED=true' if sap_swpm_swpm_observer_mode and sap_swpm_swpm_remote_access_user | d('', true) | length > 0 else '' }}"
+  ansible.builtin.set_fact:
+    sap_swpm_swpm_command_inifile: "SAPINST_INPUT_PARAMETERS_URL={{ sap_swpm_tmpdir.path }}/inifile.params"
+    sap_swpm_swpm_command_product_id: "SAPINST_EXECUTE_PRODUCT_ID={{ sap_swpm_product_catalog_id }}"
+    # If SWPM is running a normal install Ansible Variable sap_swpm_swpm_command_virtual_hostname is blank
+    # IF SWPM is running a HA installation, Ansible Variable sap_swpm_swpm_command_virtual_hostname is set and contains "SAPINST_USE_HOSTNAME={{ sap_swpm_virtual_hostname }} IS_HOST_LOCAL_USING_STRING_COMPARE=true"
+    # If SWPM is running a MP Stack XML installation, Ansible Variable sap_swpm_swpm_command_mp_stack is set and contains "SAPINST_STACK_XML={{ sap_swpm_mp_stack_path }} + '/' (if needed) + {{ sap_swpm_mp_stack_file_name }}"
+    sap_swpm_swpm_command_extra_args: "SAPINST_SKIP_DIALOGS=true {{ sap_swpm_swpm_command_guiserver }} {{ sap_swpm_swpm_command_observer }} {{ sap_swpm_swpm_command_virtual_hostname }} {{ sap_swpm_swpm_command_mp_stack }}"
+  tags: sap_swpm_sapinst_commandline
+
+- name: Set fact for the sapinst command line
+  ansible.builtin.set_fact:
+    __sap_swpm_sapinst_command: "umask {{ sap_swpm_umask | d('022') }} ; ./sapinst {{ sap_swpm_swpm_command_inifile }}
+    {{ sap_swpm_swpm_command_product_id }}
+    {{ sap_swpm_swpm_command_extra_args }}"
+  tags: sap_swpm_sapinst_commandline
+
+- name: Display the sapinst command line
+  ansible.builtin.debug:
+    msg: "SAP SWPM install command: '{{ __sap_swpm_sapinst_command }}'"
+  tags: sap_swpm_sapinst_commandline