Merge pull request sap-linuxlab#1172 from berndfinger/issue-1150-swpm-vars-v4

swpm: Rename all vars which contain '_swpm_swpm'

Author: berndfinger

roles/sap_swpm/README.md

@@ -22,7 +22,7 @@ Managed nodes:
 ### Prepare SAP installation media
 Place a valid SAPCAR executable file in a directory specified by variable `sap_swpm_sapcar_path` (e.g. /software/sapcar). Example: `SAPCAR_1300-70007716.EXE`
 
-Place a valid SWPM SAR file in a directory specified by variable `sap_swpm_swpm_path` (e.g. /software/sap_swpm). Example: `SWPM20SP18_3-80003424.SAR`
+Place a valid SWPM SAR file in a directory specified by variable `sap_swpm_path` (e.g. /software/sap_swpm). Example: `SWPM20SP23_0-80003424
 
 Place the following files in a directory specified by variable `sap_swpm_software_path` (e.g. /software/sap_swpm_download_basket):
 
@@ -70,7 +70,7 @@ It is recommended to execute this role together with other roles in this collect
 
 - Get SAPCAR executable filename from `sap_swpm_sapcar_path`
 
-- Get SWPM executable filename from `sap_swpm_swpm_path`
+- Get SWPM executable filename from `sap_swpm_path`
 
 - Get all .SAR filenames  from `sap_swpm_software_path`
 
@@ -322,12 +322,12 @@ Define path to directory with SAPCAR file.
 
 (Optional) Define name of SAPCAR file, or leave for auto-detection.
 
-#### sap_swpm_swpm_path
+#### sap_swpm_path
 - _Type:_ `string`
 
 Define path to directory with SWPM.
 
-#### sap_swpm_swpm_sar_file_name
+#### sap_swpm_sar_file_name
 - _Type:_ `string`
 
 (Optional) Define name of SWPM file, or leave for auto-detection.
@@ -350,6 +350,11 @@ Set to `true` to use SAP Media files instead of SAR files.</br>
 
 Define directory where sapinst inifile will be stored.
 
+#### sap_swpm_command_extra_args
+- _Type:_ `string`
+
+(Optional) Define extra sapinst arguments to be added to the sapinst command line.
+
 #### sap_swpm_install_saphostagent
 - _Type:_ `bool`
 - _Default:_ `true`
@@ -737,18 +742,12 @@ Define load type parameter `loadType`.
 
 Set to `true` to execute `sap_swpm` role in generic auto-detection mode, ignoring steps for individual detection.
 
-#### sap_swpm_swpm_installation_type
-- _Type:_ `string`
-
-Define installation type method. Available types: `restore`, `ha`, `maint_plan_stack`, `ha_maint_plan_stack`.</br>
-Installation type is auto-detected from `sap_swpm_product_catalog_id`.
-
-#### sap_swpm_swpm_command_virtual_hostname
+#### sap_swpm_command_virtual_hostname
 - _Type:_ `string`
 
 Define to override default virtual hostname `sap_swpm_virtual_hostname` sapinst command used for HA installation.
 
-#### sap_swpm_swpm_command_mp_stack
+#### sap_swpm_command_mp_stack
 - _Type:_ `string`
 
 Define to override default sapinst command parameter for Maintenance Plan stack file.
@@ -875,17 +874,17 @@ Set group ownership for SAPCAR file in `sap_swpm_sapcar_path`.
 - _Type:_ `string`
 - _Default:_ `0644`
 
-Set permissions for all non-SAPCAR files in `sap_swpm_software_path` and for SWPM*.SAR files in `sap_swpm_swpm_path`.
+Set permissions for all non-SAPCAR files in `sap_swpm_software_path` and for SWPM*.SAR files in `sap_swpm_path`.
 
 #### sap_swpm_files_non_sapcar_owner
 - _Type:_ `string`
 - _Default:_ `root`
 
-Set owner for all non-SAPCAR files in `sap_swpm_software_path` and for SWPM*.SAR files in `sap_swpm_swpm_path`.
+Set owner for all non-SAPCAR files in `sap_swpm_software_path` and for SWPM*.SAR files in `sap_swpm_path`.
 
 #### sap_swpm_files_non_sapcar_group
 - _Type:_ `string`
 - _Default:_ `root`
 
-Set group ownership for all non-SAPCAR files in `sap_swpm_software_path` and for SWPM*.SAR files in `sap_swpm_swpm_path`.
+Set group ownership for all non-SAPCAR files in `sap_swpm_software_path` and for SWPM*.SAR files in `sap_swpm_path`.
 <!-- END Role Variables -->

roles/sap_swpm/defaults/main.yml

@@ -28,7 +28,7 @@ sap_swpm_set_file_permissions: true
 # The guide mentions 755 as the minimum permission for the SPWM download directory and a umask setting of 022 for the user
 # which downloads the SAP software.
 #
-# Access permissions and ownership for all directories in sap_swpm_software_path, for sap_swpm_sapcar_path, and for sap_swpm_swpm_path:
+# Access permissions and ownership for all directories in sap_swpm_software_path, for sap_swpm_sapcar_path, and for sap_swpm_path:
 sap_swpm_software_directory_mode: '0755'
 sap_swpm_software_directory_owner: root
 sap_swpm_software_directory_group: root
@@ -38,7 +38,7 @@ sap_swpm_files_sapcar_mode: '0755'
 sap_swpm_files_sapcar_owner: root
 sap_swpm_files_sapcar_group: root
 #
-# Access permissions and ownership for all non-SAPCAR*EXE files in sap_swpm_software_path and for SWPM*.SAR in sap_swpm_swpm_path:
+# Access permissions and ownership for all non-SAPCAR*EXE files in sap_swpm_software_path and for SWPM*.SAR in sap_swpm_path:
 sap_swpm_files_non_sapcar_mode: '0644'
 sap_swpm_files_non_sapcar_owner: root
 sap_swpm_files_non_sapcar_group: root
@@ -149,15 +149,16 @@ sap_swpm_software_path: '/software/sapfiles'
 ##   - SAPHOSTAGENT*SAR
 
 # Directory and file name of SAPCAR*EXE. Only path is mandatory. The role will automatically determine file_name
-sap_swpm_sapcar_path: "{{ sap_swpm_software_path }}"
+sap_swpm_sapcar_path: ''
 # sap_swpm_sapcar_file_name:
 
 # Directory and file name of SWPM. Only path is mandatory. The role will automatically determine file_name
-sap_swpm_swpm_path: "{{ sap_swpm_software_path }}"
-# sap_swpm_swpm_sar_file_name:
+sap_swpm_path: ''
+sap_swpm_file_name: ''
+
 #
 # Define your own software extraction directory. If undefined, the role will use './extracted' as a subdirectory
-# of sap_swpm_swpm_path.
+# of sap_swpm_path.
 # sap_swpm_software_extract_directory: # e.g. /software/sap_swpm_extracted
 
 # Note:
@@ -173,6 +174,9 @@ sap_swpm_env_vars: {}
 # 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'
 
+# extra sapinst arguments to be added to the sapinst command line:
+sap_swpm_command_extra_args: ''
+
 # SWPM1 - paths that this role will look for CD Media software
 sap_swpm_cd_export_pt1_path: ''
 sap_swpm_cd_export_pt2_path: ''
@@ -208,12 +212,12 @@ sap_swpm_tms_tr_files_path: ''
 # This allows user to watch the installation progress from a browser (on standard port 4237) and possibly interact with it
 # Note: Interaction can impact the automated installation and may result in the need for further manual actions
 # in order to complete the installation
-sap_swpm_swpm_observer_mode: false
+sap_swpm_observer_mode: false
 # Allows to specify a different remote access user (e.g. when root's password is unknown).
 # Default SWPM behaviour is to use root. This may not be desirable as the password of the root user
 # may not be available for security reasons. The remote access user must exist before SWPM is executed
 # (i.e. <sid>adm can't be used if it doesn't exist yet).
-sap_swpm_swpm_remote_access_user: ''
+sap_swpm_remote_access_user: ''
 # --- Experimental - SWPM Observer mode --- #
 
 sap_swpm_install_saphostagent: true

roles/sap_swpm/tasks/main.yml

@@ -32,18 +32,25 @@
   tags: always
 
 
-- name: SAP SWPM - run pre_install tasks
+- name: SAP SWPM - Include task file to prepare variables
+  ansible.builtin.include_tasks:
+    file: pre_tasks/prepare_variables.yml
+    apply:
+      tags: always
+  tags: always
+
+- name: SAP SWPM - Run pre_install tasks
   ansible.builtin.import_tasks: pre_install.yml
   tags:
     - sap_swpm_pre_install
     - sap_swpm_install
 
-- name: SAP SWPM - run swpm
+- 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
+- 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

@@ -19,17 +19,17 @@
 
 - name: SAP SWPM Deployment - Finished
   ansible.builtin.debug:
-    msg:
-      - '   SAP SWPM deployment successfully completed '
-      - ' '
-      - '   SAP Product        -       {{ sap_swpm_product_catalog_id }}  '
-      - '   SID                -       {{ sap_swpm_sid | d("") }} '
-      - '   Primary Instance   -       {{ sap_swpm_pas_instance_nr | d("") }} '
-      - '   Host               -       {{ ansible_hostname }} '
-      - '   FQDN               -       {{ ansible_fqdn }}  '
-      - '   IP                 -       {{ ansible_default_ipv4.address | d(ansible_all_ipv4_addresses[0]) }}  '
-#      - '   Master Password    -       {{ sap_swpm_master_password }} '
-#      - '   DDIC 000 Password  -       {{ sap_swpm_ddic_000_password }} '
+    msg: |
+      "   SAP SWPM deployment successfully completed "
+      " "
+      "   SAP Product        -       {{ sap_swpm_product_catalog_id }}  "
+      "   SID                -       {{ sap_swpm_sid | d('') }} "
+      "   Primary Instance   -       {{ sap_swpm_pas_instance_nr | d('') }} "
+      "   Host               -       {{ ansible_facts['hostname'] }} "
+      "   FQDN               -       {{ ansible_facts['fqdn'] }}  "
+      "   IP                 -       {{ ansible_facts['default_ipv4'].address | d(ansible_facts['all_ipv4_addresses'][0]) }}  "
+#      "   Master Password    -       {{ sap_swpm_master_password }} "
+#      "   DDIC 000 Password  -       {{ sap_swpm_ddic_000_password }} "
 
 # SAP HANA Client will not be installed for any installation with SAP AnyDB
 # and will only be installed alongside SAP NWAS PAS or AAS (not NWAS ASCS)
@@ -62,6 +62,6 @@
   ansible.builtin.include_tasks: post_install/sum_push_to_finish.yml
   when:
     - sap_swpm_sum_start
-    - not sap_swpm_swpm_observer_mode
+    - not __sap_swpm_fact_observer_mode
     - "'NW_ABAP_CI:' in sap_swpm_product_catalog_id | string or
        'NW_ABAP_OneHost:' in sap_swpm_product_catalog_id | string"

roles/sap_swpm/tasks/post_install/sum_push_to_finish.yml

@@ -16,12 +16,12 @@
 
 - name: Print SUM monitoring and action URLs
   ansible.builtin.debug:
-    msg:
-      - "Check the following URLs for SAP Software Update Manager (SUM) monitoring or actions:"
-      - "Note: If these URLs don't work, check the sapinst.log file for the correct URLs."
-      - "SUM Monitor - https://{{ ansible_fqdn }}:1129/lmsl/sumobserver/{{ sap_swpm_sid | upper }}/monitor/index.html"
-      - "SUM Admin - https://{{ ansible_fqdn }}:1129/lmsl/sumabap/{{ sap_swpm_sid | upper }}/slui/"
-      - "SUM Admin Utilities - https://{{ ansible_fqdn }}:1129/lmsl/sumabap/{{ sap_swpm_sid | upper }}/slui_ext/"
+    msg: |
+      "Check the following URLs for SAP Software Update Manager (SUM) monitoring or actions:"
+      "Note: If these URLs don't work, check the sapinst.log file for the correct URLs."
+      "SUM Monitor - https://{{ ansible_facts['fqdn'] }}:1129/lmsl/sumobserver/{{ sap_swpm_sid | upper }}/monitor/index.html"
+      "SUM Admin - https://{{ ansible_facts['fqdn'] }}:1129/lmsl/sumabap/{{ sap_swpm_sid | upper }}/slui/"
+      "SUM Admin Utilities - https://{{ ansible_facts['fqdn'] }}:1129/lmsl/sumabap/{{ sap_swpm_sid | upper }}/slui_ext/"
 
 # Check the SUM status via SUMOBSEVER.XML, wait for 60 minutes until we are in BIND_PATCH phase
 - name: Checking the status of SUM (BIND_PATCH)

roles/sap_swpm/tasks/pre_install.yml

@@ -31,7 +31,7 @@
 
 - name: SAP SWPM Pre Install - Define the temporary directory for SWPM
   ansible.builtin.set_fact:
-    __sap_swpm_fact_tempdir_from_env: "{{ ansible_env.TEMP | d('/tmp') }}"
+    __sap_swpm_fact_tempdir_from_env: "{{ ansible_facts['env'].TEMP | d('/tmp') }}"
   tags:
     - sap_swpm_generate_inifile
     - sap_swpm_sapinst_commandline
@@ -171,7 +171,6 @@
         FAIL: The variable '{{ __sap_swpm_var_name }}' is empty.
       {% endif %}
   loop:
-    - sap_swpm_software_path
     - sap_swpm_product_catalog_id
     - sap_swpm_sid
     - sap_swpm_fqdn
@@ -332,18 +331,18 @@
 - name: SAP SWPM - Display Software
   ansible.builtin.debug:
     msg: |
-      SAPCAR:     {{ sap_swpm_sapcar_path }}: {{ __sap_swpm_fact_sapcar_file_name }}
-      SWPM:       {{ sap_swpm_swpm_path }}: {{ __sap_swpm_fact_swpm_sar_file_name }}
+      SAPCAR:     {{ __sap_swpm_fact_sapcar_path }}: {{ __sap_swpm_fact_sapcar_file_name }}
+      SWPM:       {{ __sap_swpm_fact_swpm_path }}: {{ __sap_swpm_fact_swpm_file_name }}
       {% if not sap_swpm_generic %}
-      SAPEXEDB:   {{ sap_swpm_software_path }}: {{ __sap_swpm_register_sapexedb_files.files | map(attribute='path') | map('basename') | join(', ') | d('') }}
-      SAPEXE:     {{ sap_swpm_software_path }}: {{ __sap_swpm_register_sapexe_files.files | map(attribute='path') | map('basename') | join(', ') | d('') }}
-      IGS:        {{ sap_swpm_software_path }}: {{ __sap_swpm_register_igs_exe_files.files | map(attribute='path') | map('basename') | join(', ') | d('') }}
-      IGS Helper: {{ sap_swpm_software_path }}: {{ __sap_swpm_register_igs_helper_files.files | map(attribute='path') | map('basename') | join(', ') | d('') }}
+      SAPEXEDB:   {{ __sap_swpm_fact_software_path }}: {{ __sap_swpm_register_sapexedb_files.files | map(attribute='path') | map('basename') | join(', ') | d('') }}
+      SAPEXE:     {{ __sap_swpm_fact_software_path }}: {{ __sap_swpm_register_sapexe_files.files | map(attribute='path') | map('basename') | join(', ') | d('') }}
+      IGS:        {{ __sap_swpm_fact_software_path }}: {{ __sap_swpm_register_igs_exe_files.files | map(attribute='path') | map('basename') | join(', ') | d('') }}
+      IGS Helper: {{ __sap_swpm_fact_software_path }}: {{ __sap_swpm_register_igs_helper_files.files | map(attribute='path') | map('basename') | join(', ') | d('') }}
       {% if 'Webdispatcher' in sap_swpm_product_catalog_id | string %}
-      WEBDISP:    {{ sap_swpm_software_path }}: {{ __sap_swpm_register_sapwebdisp_files.files | map(attribute='path') | map('basename') | join(', ') | d('') }}
+      WEBDISP:    {{ __sap_swpm_fact_software_path }}: {{ __sap_swpm_register_sapwebdisp_files.files | map(attribute='path') | map('basename') | join(', ') | d('') }}
       {% endif %}
       {% endif %}
-      {% if sap_swpm_swpm_installation_type in ['maint_plan_stack', 'ha_maint_plan_stack'] %}
+      {% if __sap_swpm_fact_installation_type in ['maint_plan_stack', 'ha_maint_plan_stack'] %}
       MP Stack:   {{ (sap_swpm_mp_stack_path | d('', true) + '/' + sap_swpm_mp_stack_file_name | d('', true)) | regex_replace('//*', '/') }}"
       {% endif %}
       {% if sap_swpm_backup_location is defined and sap_swpm_backup_location | string | trim | length > 0 %}
@@ -354,39 +353,39 @@
 - name: SAP SWPM - Installation Process
   ansible.builtin.debug:
     msg:
-      - '   Ready to run SWPM for SAP Software Installation  '
-      - ' '
-      - '   SAP Product        -       {{ sap_swpm_product_catalog_id }}  '
-      - '   SID                -       {{ sap_swpm_sid }} '
-      - '   Host               -       {{ ansible_hostname }} '
-      - ' '
-      - '   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 {{ __sap_swpm_fact_tempdir_from_env }}/sapinst_instdir/.lastInstallationLocation)/sapinst.log'
+      - "   Ready to run SWPM for SAP Software Installation  "
+      - " "
+      - "   SAP Product        -       {{ sap_swpm_product_catalog_id }}  "
+      - "   SID                -       {{ sap_swpm_sid }} "
+      - "   Host               -       {{ ansible_facts['hostname'] }} "
+      - " "
+      - "   The installation can take up to 3 hours. Run the following command as root"
+      - "   on {{ ansible_facts['hostname'] }} to display the installation logs:"
+      - "   # tail -f $(cat {{ __sap_swpm_fact_tempdir_from_env }}/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 '' }}"
+    sap_swpm_command_guiserver: "{{ 'SAPINST_START_GUISERVER=false' if not __sap_swpm_fact_observer_mode else '' }}"
+    sap_swpm_command_observer: "{{ 'SAPINST_REMOTE_ACCESS_USER=' + __sap_swpm_fact_remote_access_user + ' SAPINST_REMOTE_ACCESS_USER_IS_TRUSTED=true' if __sap_swpm_fact_observer_mode and __sap_swpm_fact_remote_access_user | d('', true) | length > 0 else '' }}"
   ansible.builtin.set_fact:
-    sap_swpm_swpm_command_inifile: "SAPINST_INPUT_PARAMETERS_URL={{ __sap_swpm_register_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 | d('') }} {{ sap_swpm_swpm_command_mp_stack | d('') }}"
+    __sap_swpm_fact_command_inifile: "SAPINST_INPUT_PARAMETERS_URL={{ __sap_swpm_register_tmpdir.path }}/inifile.params"
+    __sap_swpm_fact_command_product_id: "SAPINST_EXECUTE_PRODUCT_ID={{ sap_swpm_product_catalog_id }}"
+    # If SWPM is running a normal install Ansible Variable __sap_swpm_fact_command_virtual_hostname is blank
+    # IF SWPM is running a HA installation, Ansible Variable __sap_swpm_fact_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_fact_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_fact_command_extra_args: "SAPINST_SKIP_DIALOGS=true {{ sap_swpm_command_guiserver }} {{ sap_swpm_command_observer }} {{ __sap_swpm_fact_command_virtual_hostname | d('') }} {{ __sap_swpm_fact_command_mp_stack | d('') }} {{ sap_swpm_command_extra_args | d('') }}"
   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 }}
+      umask {{ sap_swpm_umask | d('022') }} ; ./sapinst {{ __sap_swpm_fact_command_inifile }}
+      {{ __sap_swpm_fact_command_product_id }}
+      {{ __sap_swpm_fact_command_extra_args }}
   tags: sap_swpm_sapinst_commandline
 
 - name: Display the sapinst command line

roles/sap_swpm/tasks/pre_install/assert_hostname_resolution_for_ha.yml

@@ -42,8 +42,8 @@
     fail_msg: "FAIL: 'sap_swpm_virtual_hostname' is not defined, cannot be resolved, or has multiple entries in /etc/hosts!"
     success_msg: "PASS: {{ sap_swpm_virtual_hostname }} can be resolved."
 
-- name: SAP SWPM Pre Install - HA settings - Assert that sap_swpm_fact_virtual_ip is part of ansible_all_ipv4_addresses
+- name: SAP SWPM Pre Install - HA settings - Assert that sap_swpm_fact_virtual_ip is part of ansible_facts['all_ipv4_addresses']
   ansible.builtin.assert:
-    that: __sap_swpm_fact_virtual_ip in ansible_all_ipv4_addresses
-    fail_msg: "FAIL: {{ __sap_swpm_fact_virtual_ip }} is not part of ansible_all_ipv4_addresses!"
-    success_msg: "PASS: {{ __sap_swpm_fact_virtual_ip }} is part of ansible_all_ipv4_addresses."
+    that: __sap_swpm_fact_virtual_ip in ansible_facts['all_ipv4_addresses']
+    fail_msg: "FAIL: {{ __sap_swpm_fact_virtual_ip }} is not part of ansible_facts['all_ipv4_addresses']!"
+    success_msg: "PASS: {{ __sap_swpm_fact_virtual_ip }} is part of ansible_facts['all_ipv4_addresses']."