diff --git a/docs/share/zos_core/configuration_guide.md b/docs/share/zos_core/configuration_guide.md index 403c87a0c..8f8893d4d 100644 --- a/docs/share/zos_core/configuration_guide.md +++ b/docs/share/zos_core/configuration_guide.md @@ -121,13 +121,15 @@ execution. `group_vars` environment variables: - Property `BPXK_AUTOCVT` must be configured to `"ON"`; e.g., `_BPXK_AUTOCVT: "ON"` -- Property `ZOAU_HOME` is the **ZOA Utilities** install root path; e.g., `ZOAU_HOME: "/usr/lpp/IBM/zoautil"` -- Property `PYTHONPATH` is the **ZOA Utilities** Python library path; e.g., `PYTHONPATH: "/usr/lpp/IBM/zoautil/lib"` +- Property `ZOAU_HOME` is the **Z Open Automation Utilities (ZOAU)** install root path; + e.g., `ZOAU_HOME: "/usr/lpp/IBM/zoautil"` +- Property `PYTHONPATH` is the **Z Open Automation Utilities (ZOAU)** Python library path; + e.g., `PYTHONPATH: "/usr/zoau-wheel/"` - Property `LIBPATH` is **both** the path to the **Python libraries** on the target - and the **ZOA Utilities Python library path** separated by semi-colons; e.g., - `LIBPATH: "/usr/lpp/IBM/zoautil/lib/:/usr/lpp/IBM/cyp/v3r8/pyz/lib:/usr/lib:/lib:."` + and the **Z Open Automation Utilities (ZOAU) Python library path** separated by semi-colons; e.g., + `LIBPATH: "/usr/lpp/IBM/zoautil/lib/:/usr/lpp/IBM/cyp/v3r12/pyz/lib:/usr/lib:/lib:."` - Property `PATH` is the ZOA utilities **BIN** path and **Python interpreter** path, e.g., - `PATH: "/usr/lpp/IBM/zoautil/bin:/usr/lpp/IBM/cyp/v3r8/pyz/bin:/bin"` + `PATH: "/usr/lpp/IBM/zoautil/bin:/usr/lpp/IBM/cyp/v3r12/pyz/bin:/bin"` - Property `_CEE_RUNOPTS` is the invocation Language Environment® runtime options for programs and used by Python. e.g., `_CEE_RUNOPTS: "FILETAG(AUTOCVT,AUTOTAG) POSIX(ON)"` @@ -154,7 +156,7 @@ A complete example of `all.yml` is: environment_vars: _BPXK_AUTOCVT: "ON" ZOAU_HOME: "{{ ZOAU }}" - PYTHONPATH: "{{ ZOAU }}/lib" + PYTHONPATH: "{{ ZOAU_PYTHON_LIBRARY_PATH }}" LIBPATH: "{{ ZOAU }}/lib:{{ PYZ }}/lib:/lib:/usr/lib:." PATH: "{{ ZOAU }}/bin:{{ PYZ }}/bin:/bin:/var/bin:/usr/sbin" _CEE_RUNOPTS: "FILETAG(AUTOCVT,AUTOTAG) POSIX(ON)" @@ -183,7 +185,7 @@ complete the configuration. `host_vars` environment variables: - Property `PYZ` is the python installation home path on the z/OS managed node - (target), e.g, `pyz: "/usr/lpp/IBM/cyp/v3r8/pyz"` + (target), e.g, `pyz: "/usr/lpp/IBM/cyp/v3r12/pyz"` - Property `ZOAU` is the ZOAU installation home on the z/OS managed node (target), e.g, `zoau: "/usr/lpp/IBM/zoautil"` - Property `ansible_python_interpreter` is the z/OS managed node (target) Python @@ -194,8 +196,10 @@ complete the configuration. A complete example of `zos_host.yml` is: ``` {.yaml} -PYZ: "/usr/lpp/IBM/cyp/v3r8/pyz" +PYZ: "/usr/lpp/IBM/cyp/v3r12/pyz" ZOAU: "/usr/lpp/IBM/zoautil" +ZOAU_PYTHON_LIBRARY_PATH: "{{ path_to_wheel_installation_directory }}" + ansible_python_interpreter: "{{ PYZ }}/bin/python3" ``` diff --git a/docs/share/zos_core/configure_host_vars.md b/docs/share/zos_core/configure_host_vars.md index f00966e3e..c04f24669 100644 --- a/docs/share/zos_core/configure_host_vars.md +++ b/docs/share/zos_core/configure_host_vars.md @@ -6,7 +6,7 @@ established. ## Description of the environment variables used in this configuration * Environment variable `PYZ` is the Python home installation path on the - z/OS managed node (target), e.g, `pyz: "/usr/lpp/IBM/cyp/v3r8/pyz"` + z/OS managed node (target), e.g, `pyz: "/usr/lpp/IBM/cyp/v3r12/pyz"` * Environment variable `ZOAU` is the ZOAU installation home on the z/OS managed node (target), e.g, `zoau: "/usr/lpp/IBM/zoautil"` * Environment variable `ansible_python_interpreter` is the Python binary @@ -18,8 +18,10 @@ Configure `PYZ` and `ZOAU` in the included **group_vars** configuration. For example: ```yaml -PYZ: "/u/oeusr01/python/pyz_3_8_2/usr/lpp/IBM/cyp/v3r8/pyz" +PYZ: "/usr/lpp/IBM/cyp/v3r12/pyz" ZOAU: "/usr/lpp/IBM/zoautil" +ZOAU_PYTHON_LIBRARY_PATH: "{{ path_to_wheel_installation_directory }}" + ansible_python_interpreter: "{{ PYZ }}/bin/python3" ``` diff --git a/docs/share/zos_core/configure_inventory.md b/docs/share/zos_core/configure_inventory.md index c060ca185..90c1068ce 100644 --- a/docs/share/zos_core/configure_inventory.md +++ b/docs/share/zos_core/configure_inventory.md @@ -4,8 +4,8 @@ will connect. Also part of the inventory is the user that Ansible should connect to over SSH to the managed host. ## Description of the properties used in this configuration -* Property `ansible_host` is the z/OS managed node (target), e.g, `ansible_host: "zvm1.vmec.svl.ibm.com"` -* Property `ansible_user` is the z/OS managed user to connect and run as over SSH, e.g, `ansible_user: "zosadm"` +* Property `ansible_host` is the z/OS managed node (target), e.g, `ansible_host: "zos-system.ibm.com"` +* Property `ansible_user` is the z/OS managed user to connect and run as over SSH, e.g, `ansible_user: "zosusr"` Configure `ansible_host` and `ansible_user` in the included inventory. @@ -15,8 +15,8 @@ For example: source_system: hosts: zos_host: - ansible_host: "zvm1.vmec.svl.ibm.com" - ansible_user: "zosadm" + ansible_host: "zos-system.ibm.com" + ansible_user: "zosusr" ``` If you are unfamiliar with playbook configuration practices and would like to diff --git a/zos_basics/constructs/inventories/group_vars/all.yml b/zos_basics/constructs/inventories/group_vars/all.yml index a32cce2a3..767d93cc4 100644 --- a/zos_basics/constructs/inventories/group_vars/all.yml +++ b/zos_basics/constructs/inventories/group_vars/all.yml @@ -1,5 +1,5 @@ ################################################################################ -# Copyright (c) IBM Corporation 2020 +# Copyright (c) IBM Corporation 2020, 2024 ################################################################################ ################################################################################ @@ -9,7 +9,7 @@ environment_vars: _BPXK_AUTOCVT: "ON" ZOAU_HOME: "{{ ZOAU }}" - PYTHONPATH: "{{ ZOAU }}/lib" + PYTHONPATH: "{{ ZOAU_PYTHON_LIBRARY_PATH }}" LIBPATH: "{{ ZOAU }}/lib:{{ PYZ }}/lib:/lib:/usr/lib:." PATH: "{{ ZOAU }}/bin:{{ PYZ }}/bin:/bin:/var/bin" _CEE_RUNOPTS: "FILETAG(AUTOCVT,AUTOTAG) POSIX(ON)" @@ -23,10 +23,12 @@ environment_vars: # Description of the properties used in this configuration: ################################################################################ # - Property BPXK_AUTOCVT must be configured to "ON"; e.g., _BPXK_AUTOCVT: "ON" -# - Property ZOAU_HOME is the ZOA Utilities install root path; e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" -# - Property PYTHONPATH is the ZOA Utilities Python library path; e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" +# - Property ZOAU_HOME is the Z Open Automation Utilities (ZOAU) install root path; +# e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" +# - Property PYTHONPATH is the Z Open Automation Utilities (ZOAU) Python library path; +# e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" # - Property LIBPATH is both the path to the Python libraries on the target -# and the ZOA Utilities Python library path separated by semi-colons; e.g., +# and the Z Open Automation Utilities (ZOAU) Python library path separated by semi-colons; e.g., # LIBPATH: "/usr/lpp/IBM/zoautil/lib/:/usr/lpp/IBM/cyp/v3r8/pyz/lib:/usr/lib:/lib:." # - Property PATH is the ZOA utilities BIN path and Python interpreter path, e.g., # PATH: "/usr/lpp/IBM/zoautil/bin:/usr/lpp/IBM/cyp/v3r8/pyz/bin:/bin" diff --git a/zos_basics/constructs/inventories/host_vars/zos_host.yml b/zos_basics/constructs/inventories/host_vars/zos_host.yml index cbf8614f2..d385e9ed8 100644 --- a/zos_basics/constructs/inventories/host_vars/zos_host.yml +++ b/zos_basics/constructs/inventories/host_vars/zos_host.yml @@ -1,25 +1,64 @@ --- ################################################################################ -# Copyright (c) IBM Corporation 2021 +# Copyright (c) IBM Corporation 2021, 2024 ################################################################################ ################################################################################ # Description of the properties used in this configuration: -# - Property `PYZ` is the python installation home path on the z/OS managed node (target), -# e.g, pyz: "/usr/lpp/IBM/cyp/v3r8/pyz" -# - Property `ZOAU` is the ZOAU installation home on the z/OS managed node (target), -# e.g, zoau: "/usr/lpp/IBM/zoautil" -# - property `ansible_python_interpreter` is the z/OS managed node (target) Python +# - Property `PYZ` is the python installation home path on the z/OS managed +# (target) node e.g, PYZ: "/usr/lpp/IBM/cyp/v3r12/pyz" +# - Property `PYZ_VERSION` is the version of python on the z/OS managed +# (target) node e.g, PYZ_VERSION: "3.12". +# - Property `ZOAU` is the ZOAU installation home on the z/OS managed (target) +# node, e.g, ZOAU: "/usr/lpp/IBM/zoautil". +# - Property `ZOAU_PYTHON_LIBRARY_PATH` is the path to the Z Open Automation +# Utilities (ZOAU) python library. Specifically, the path points to the +# directory containing 'zoautil_py'. Packages installed using 'pip' generally +# default to the 'site-packages' directory within the python installation, +# eg "/usr/lpp/IBM/cyp/v3r12/pyz/lib/python3.12/site-packages/". +# If the installation uses options such as '--user' or '--target', the module +# is installed to a non-default location which must be configured in +# `ZOAU_PYTHON_LIBRARY_PATH`. +# If the wheel installation method is used with the '--target' or '--user' +# option, `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory the wheel +# file was installed to. e.g ZOAU_PYTHON_LIBRARY_PATH: "/usr/zoau-wheel/". +# Else 'ZOAU_PYTHON_LIBRARY_PATH' should point to the directory containing +# the pre-compiled binary. +# For ZOAU v1.2.x, the pre-compiled binary is located in the 'lib' directory. +# e.g "/usr/lpp/IBM/zoautil/lib" or "{{ ZOAU }}/lib". +# For ZOAU v1.3.x, the pre-compiled binary is located in a sub-directory +# corresponding to the `PYZ_VERSION` inside the 'lib' directory, +# e.g "/usr/lpp/IBM/zoautil/lib/3.12" or "{{ ZOAU }}/lib/{{ PYZ_VERSION }}". +# - Property `ansible_python_interpreter` is the z/OS managed node (target) Python # binary installation path, e.g, ansible_python_interpreter: "{{PYZ}}/bin/python3" # -# Note, PYZ and ZOAU environment variables must be configured. +# Note, PYZ, PYZ_VERSION, and ZOAU environment variables must be configured. ################################################################################ PYZ: "path_to_python_installation_on_zos_target" +PYZ_VERSION: "3.xx" + ZOAU: "path_to_zoau_installation_on_zos_target" +# Configuring the `ZOAU_PYTHON_LIBRARY_PATH` property is required. + +# If the ZOAU python package, zoautil_py, has been installed as a wheel (*.whl) +# with the '--target' or '--user' option, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ path_to_wheel_installation_directory }}" + +# If the ZOAU python zoautil_py package has been installed in the default location +# that is part of Python's search path, the `ZOAU_PYTHON_LIBRARY_PATH` environment +# variable must be set as an empty string. Uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "" + +# If using pre-compiled binaries for ZOAU v1.3.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib/{{ PYZ_VERSION }}" + +# If using pre-compiled binaries for ZOAU v1.2.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib" + ################################################################################ -# Do not configure, variable substituion will correctly set the -# variable`ansible_python_interpreter` +# Do not configure, variable substitution will correctly set the +# variable `ansible_python_interpreter` ################################################################################ ansible_python_interpreter: "{{ PYZ }}/bin/python3" diff --git a/zos_basics/factgathering/inventories/group_vars/all.yml b/zos_basics/factgathering/inventories/group_vars/all.yml index ee6e8d53c..83293e844 100644 --- a/zos_basics/factgathering/inventories/group_vars/all.yml +++ b/zos_basics/factgathering/inventories/group_vars/all.yml @@ -1,5 +1,5 @@ ################################################################################ -# Copyright (c) IBM Corporation 2023 +# Copyright (c) IBM Corporation 2023, 2024 ################################################################################ ################################################################################ @@ -10,7 +10,7 @@ environment_vars: _BPXK_AUTOCVT: "ON" ZOAU_HOME: "{{ ZOAU }}" - PYTHONPATH: "{{ ZOAU }}/lib" + PYTHONPATH: "{{ ZOAU_PYTHON_LIBRARY_PATH }}" LIBPATH: "{{ ZOAU }}/lib:{{ PYZ }}/lib:/lib:/usr/lib:." PATH: "{{ ZOAU }}/bin:{{ PYZ }}/bin:/bin:/var/bin" _CEE_RUNOPTS: "FILETAG(AUTOCVT,AUTOTAG) POSIX(ON)" @@ -24,10 +24,12 @@ environment_vars: # Description of the properties used in this configuration: ################################################################################ # - Property BPXK_AUTOCVT must be configured to "ON"; e.g., _BPXK_AUTOCVT: "ON" -# - Property ZOAU_HOME is the ZOA Utilities install root path; e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" -# - Property PYTHONPATH is the ZOA Utilities Python library path; e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" +# - Property ZOAU_HOME is the Z Open Automation Utilities (ZOAU) install root path; +# e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" +# - Property PYTHONPATH is the Z Open Automation Utilities (ZOAU) Python library path; +# e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" # - Property LIBPATH is both the path to the Python libraries on the target -# and the ZOA Utilities Python library path separated by semi-colons; e.g., +# and the Z Open Automation Utilities (ZOAU) Python library path separated by semi-colons; e.g., # LIBPATH: "/usr/lpp/IBM/zoautil/lib/:/usr/lpp/IBM/cyp/v3r8/pyz/lib:/usr/lib:/lib:." # - Property PATH is the ZOA utilities BIN path and Python interpreter path, e.g., # PATH: "/usr/lpp/IBM/zoautil/bin:/usr/lpp/IBM/cyp/v3r8/pyz/bin:/bin" diff --git a/zos_basics/factgathering/inventories/host_vars/zos_host.yml b/zos_basics/factgathering/inventories/host_vars/zos_host.yml index 6500d1850..0f5715762 100644 --- a/zos_basics/factgathering/inventories/host_vars/zos_host.yml +++ b/zos_basics/factgathering/inventories/host_vars/zos_host.yml @@ -1,25 +1,64 @@ --- ################################################################################ -# Copyright (c) IBM Corporation 2023 +# Copyright (c) IBM Corporation 2023, 2024 ################################################################################ ################################################################################ # Description of the properties used in this configuration: -# - Property `PYZ` is the python installation home path on the z/OS managed node (target), -# e.g, pyz: "/usr/lpp/IBM/cyp/v3r8/pyz" -# - Property `ZOAU` is the ZOAU installation home on the z/OS managed node (target), -# e.g, zoau: "/usr/lpp/IBM/zoautil" -# - property `ansible_python_interpreter` is the z/OS managed node (target) Python +# - Property `PYZ` is the python installation home path on the z/OS managed +# (target) node e.g, PYZ: "/usr/lpp/IBM/cyp/v3r12/pyz" +# - Property `PYZ_VERSION` is the version of python on the z/OS managed +# (target) node e.g, PYZ_VERSION: "3.12". +# - Property `ZOAU` is the ZOAU installation home on the z/OS managed (target) +# node, e.g, ZOAU: "/usr/lpp/IBM/zoautil". +# - Property `ZOAU_PYTHON_LIBRARY_PATH` is the path to the Z Open Automation +# Utilities (ZOAU) python library. Specifically, the path points to the +# directory containing 'zoautil_py'. Packages installed using 'pip' generally +# default to the 'site-packages' directory within the python installation, +# eg "/usr/lpp/IBM/cyp/v3r12/pyz/lib/python3.12/site-packages/". +# If the installation uses options such as '--user' or '--target', the module +# is installed to a non-default location which must be configured in +# `ZOAU_PYTHON_LIBRARY_PATH`. +# If the wheel installation method is used with the '--target' or '--user' +# option, `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory the wheel +# file was installed to. e.g ZOAU_PYTHON_LIBRARY_PATH: "/usr/zoau-wheel/". +# Else 'ZOAU_PYTHON_LIBRARY_PATH' should point to the directory containing +# the pre-compiled binary. +# For ZOAU v1.2.x, the pre-compiled binary is located in the 'lib' directory. +# e.g "/usr/lpp/IBM/zoautil/lib" or "{{ ZOAU }}/lib". +# For ZOAU v1.3.x, the pre-compiled binary is located in a sub-directory +# corresponding to the `PYZ_VERSION` inside the 'lib' directory, +# e.g "/usr/lpp/IBM/zoautil/lib/3.12" or "{{ ZOAU }}/lib/{{ PYZ_VERSION }}". +# - Property `ansible_python_interpreter` is the z/OS managed node (target) Python # binary installation path, e.g, ansible_python_interpreter: "{{PYZ}}/bin/python3" # -# Note, PYZ and ZOAU environment variables must be configured. +# Note, PYZ, PYZ_VERSION, and ZOAU environment variables must be configured. ################################################################################ -# PYZ: "path_to_python_installation_on_zos_target" -# ZOAU: "path_to_zoau_installation_on_zos_target" +PYZ: "path_to_python_installation_on_zos_target" +PYZ_VERSION: "3.xx" + +ZOAU: "path_to_zoau_installation_on_zos_target" + +# Configuring the `ZOAU_PYTHON_LIBRARY_PATH` property is required. + +# If the ZOAU python package, zoautil_py, has been installed as a wheel (*.whl) +# with the '--target' or '--user' option, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ path_to_wheel_installation_directory }}" + +# If the ZOAU python zoautil_py package has been installed in the default location +# that is part of Python's search path, the `ZOAU_PYTHON_LIBRARY_PATH` environment +# variable must be set as an empty string. Uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "" + +# If using pre-compiled binaries for ZOAU v1.3.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib/{{ PYZ_VERSION }}" + +# If using pre-compiled binaries for ZOAU v1.2.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib" ################################################################################ -# Do not configure, variable substituion will correctly set the -# variable`ansible_python_interpreter` +# Do not configure, variable substitution will correctly set the +# variable `ansible_python_interpreter` ################################################################################ ansible_python_interpreter: "{{ PYZ }}/bin/python3" diff --git a/zos_concepts/certificate_management/inventories/group_vars/all.yml b/zos_concepts/certificate_management/inventories/group_vars/all.yml new file mode 100644 index 000000000..767d93cc4 --- /dev/null +++ b/zos_concepts/certificate_management/inventories/group_vars/all.yml @@ -0,0 +1,52 @@ +################################################################################ +# Copyright (c) IBM Corporation 2020, 2024 +################################################################################ + +################################################################################ +# Enviroment variables for all z/OS managed nodes (target) that do not need +# further configuration. +################################################################################ +environment_vars: + _BPXK_AUTOCVT: "ON" + ZOAU_HOME: "{{ ZOAU }}" + PYTHONPATH: "{{ ZOAU_PYTHON_LIBRARY_PATH }}" + LIBPATH: "{{ ZOAU }}/lib:{{ PYZ }}/lib:/lib:/usr/lib:." + PATH: "{{ ZOAU }}/bin:{{ PYZ }}/bin:/bin:/var/bin" + _CEE_RUNOPTS: "FILETAG(AUTOCVT,AUTOTAG) POSIX(ON)" + _TAG_REDIR_ERR: "txt" + _TAG_REDIR_IN: "txt" + _TAG_REDIR_OUT: "txt" + LANG: "C" + PYTHONSTDINENCODING: "cp1047" + +################################################################################ +# Description of the properties used in this configuration: +################################################################################ +# - Property BPXK_AUTOCVT must be configured to "ON"; e.g., _BPXK_AUTOCVT: "ON" +# - Property ZOAU_HOME is the Z Open Automation Utilities (ZOAU) install root path; +# e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" +# - Property PYTHONPATH is the Z Open Automation Utilities (ZOAU) Python library path; +# e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" +# - Property LIBPATH is both the path to the Python libraries on the target +# and the Z Open Automation Utilities (ZOAU) Python library path separated by semi-colons; e.g., +# LIBPATH: "/usr/lpp/IBM/zoautil/lib/:/usr/lpp/IBM/cyp/v3r8/pyz/lib:/usr/lib:/lib:." +# - Property PATH is the ZOA utilities BIN path and Python interpreter path, e.g., +# PATH: "/usr/lpp/IBM/zoautil/bin:/usr/lpp/IBM/cyp/v3r8/pyz/bin:/bin" +# - Property _CEE_RUNOPTS is the invocation Language Environment® runtime +# options for programs and used by Python. e.g., +# _CEE_RUNOPTS: "FILETAG(AUTOCVT,AUTOTAG) POSIX(ON)" +# - Properties __TAG_REDIR_ERR, _TAG_REDIR_IN, _TAG_REDIR_OUT are txt and used +# by the shell; e.g., +# _TAG_REDIR_ERR: "txt" +# _TAG_REDIR_IN: "txt" +# _TAG_REDIR_OUT: "txt" +# - Property LANG is the name of the default locale; value +# C specifies the POSIX locale; for example: ``LANG: "C"``. +# - Property `PYTHONSTDINENCODING` should be set to the encoding Unix System Services +# is configured as, supported encodings are ASCII or EBCDIC. This environment +# variable is used to instruct Ansible which encoding it will *pipe* content to +# Python's STDIN (standard in) when `pipelining=true` is set in `ansible.cfg` . +# This environment variable will only apply when using IBM Enterprise Python +# 3.10 or later, otherwise, it is ignored. +# For example:`PYTHONSTDINENCODING: "cp1047"`. +################################################################################ diff --git a/zos_concepts/certificate_management/inventories/host_vars/zos_host.yml b/zos_concepts/certificate_management/inventories/host_vars/zos_host.yml new file mode 100644 index 000000000..d385e9ed8 --- /dev/null +++ b/zos_concepts/certificate_management/inventories/host_vars/zos_host.yml @@ -0,0 +1,64 @@ +--- +################################################################################ +# Copyright (c) IBM Corporation 2021, 2024 +################################################################################ + +################################################################################ +# Description of the properties used in this configuration: +# - Property `PYZ` is the python installation home path on the z/OS managed +# (target) node e.g, PYZ: "/usr/lpp/IBM/cyp/v3r12/pyz" +# - Property `PYZ_VERSION` is the version of python on the z/OS managed +# (target) node e.g, PYZ_VERSION: "3.12". +# - Property `ZOAU` is the ZOAU installation home on the z/OS managed (target) +# node, e.g, ZOAU: "/usr/lpp/IBM/zoautil". +# - Property `ZOAU_PYTHON_LIBRARY_PATH` is the path to the Z Open Automation +# Utilities (ZOAU) python library. Specifically, the path points to the +# directory containing 'zoautil_py'. Packages installed using 'pip' generally +# default to the 'site-packages' directory within the python installation, +# eg "/usr/lpp/IBM/cyp/v3r12/pyz/lib/python3.12/site-packages/". +# If the installation uses options such as '--user' or '--target', the module +# is installed to a non-default location which must be configured in +# `ZOAU_PYTHON_LIBRARY_PATH`. +# If the wheel installation method is used with the '--target' or '--user' +# option, `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory the wheel +# file was installed to. e.g ZOAU_PYTHON_LIBRARY_PATH: "/usr/zoau-wheel/". +# Else 'ZOAU_PYTHON_LIBRARY_PATH' should point to the directory containing +# the pre-compiled binary. +# For ZOAU v1.2.x, the pre-compiled binary is located in the 'lib' directory. +# e.g "/usr/lpp/IBM/zoautil/lib" or "{{ ZOAU }}/lib". +# For ZOAU v1.3.x, the pre-compiled binary is located in a sub-directory +# corresponding to the `PYZ_VERSION` inside the 'lib' directory, +# e.g "/usr/lpp/IBM/zoautil/lib/3.12" or "{{ ZOAU }}/lib/{{ PYZ_VERSION }}". +# - Property `ansible_python_interpreter` is the z/OS managed node (target) Python +# binary installation path, e.g, ansible_python_interpreter: "{{PYZ}}/bin/python3" +# +# Note, PYZ, PYZ_VERSION, and ZOAU environment variables must be configured. +################################################################################ + +PYZ: "path_to_python_installation_on_zos_target" +PYZ_VERSION: "3.xx" + +ZOAU: "path_to_zoau_installation_on_zos_target" + +# Configuring the `ZOAU_PYTHON_LIBRARY_PATH` property is required. + +# If the ZOAU python package, zoautil_py, has been installed as a wheel (*.whl) +# with the '--target' or '--user' option, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ path_to_wheel_installation_directory }}" + +# If the ZOAU python zoautil_py package has been installed in the default location +# that is part of Python's search path, the `ZOAU_PYTHON_LIBRARY_PATH` environment +# variable must be set as an empty string. Uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "" + +# If using pre-compiled binaries for ZOAU v1.3.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib/{{ PYZ_VERSION }}" + +# If using pre-compiled binaries for ZOAU v1.2.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib" + +################################################################################ +# Do not configure, variable substitution will correctly set the +# variable `ansible_python_interpreter` +################################################################################ +ansible_python_interpreter: "{{ PYZ }}/bin/python3" diff --git a/zos_concepts/certificate_management/inventories/inventory.yml b/zos_concepts/certificate_management/inventories/inventory.yml new file mode 100644 index 000000000..0d6df6fe1 --- /dev/null +++ b/zos_concepts/certificate_management/inventories/inventory.yml @@ -0,0 +1,17 @@ +################################################################################ +# © Copyright IBM Corporation 2020, 2024 +################################################################################ + +################################################################################ +# Description of the properties used in this configuration: +# - Property `ansible_host` is the z/OS managed node (target), +# e.g, ansible_host: "zvm1.vmec.svl.ibm.com" +# - Property `ansible_user` is the z/OS managed user to connect and run as over SSH, +# e.g, ansible_user: "zosadm" +################################################################################ + +source_system: + hosts: + zos_host: + ansible_host: zos_target_address + ansible_user: zos_target_username diff --git a/zos_concepts/data_sets/copy_edit_submit/inventories/group_vars/all.yml b/zos_concepts/data_sets/copy_edit_submit/inventories/group_vars/all.yml index a32cce2a3..767d93cc4 100644 --- a/zos_concepts/data_sets/copy_edit_submit/inventories/group_vars/all.yml +++ b/zos_concepts/data_sets/copy_edit_submit/inventories/group_vars/all.yml @@ -1,5 +1,5 @@ ################################################################################ -# Copyright (c) IBM Corporation 2020 +# Copyright (c) IBM Corporation 2020, 2024 ################################################################################ ################################################################################ @@ -9,7 +9,7 @@ environment_vars: _BPXK_AUTOCVT: "ON" ZOAU_HOME: "{{ ZOAU }}" - PYTHONPATH: "{{ ZOAU }}/lib" + PYTHONPATH: "{{ ZOAU_PYTHON_LIBRARY_PATH }}" LIBPATH: "{{ ZOAU }}/lib:{{ PYZ }}/lib:/lib:/usr/lib:." PATH: "{{ ZOAU }}/bin:{{ PYZ }}/bin:/bin:/var/bin" _CEE_RUNOPTS: "FILETAG(AUTOCVT,AUTOTAG) POSIX(ON)" @@ -23,10 +23,12 @@ environment_vars: # Description of the properties used in this configuration: ################################################################################ # - Property BPXK_AUTOCVT must be configured to "ON"; e.g., _BPXK_AUTOCVT: "ON" -# - Property ZOAU_HOME is the ZOA Utilities install root path; e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" -# - Property PYTHONPATH is the ZOA Utilities Python library path; e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" +# - Property ZOAU_HOME is the Z Open Automation Utilities (ZOAU) install root path; +# e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" +# - Property PYTHONPATH is the Z Open Automation Utilities (ZOAU) Python library path; +# e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" # - Property LIBPATH is both the path to the Python libraries on the target -# and the ZOA Utilities Python library path separated by semi-colons; e.g., +# and the Z Open Automation Utilities (ZOAU) Python library path separated by semi-colons; e.g., # LIBPATH: "/usr/lpp/IBM/zoautil/lib/:/usr/lpp/IBM/cyp/v3r8/pyz/lib:/usr/lib:/lib:." # - Property PATH is the ZOA utilities BIN path and Python interpreter path, e.g., # PATH: "/usr/lpp/IBM/zoautil/bin:/usr/lpp/IBM/cyp/v3r8/pyz/bin:/bin" diff --git a/zos_concepts/data_sets/copy_edit_submit/inventories/host_vars/zos_host.yml b/zos_concepts/data_sets/copy_edit_submit/inventories/host_vars/zos_host.yml index cbf8614f2..d385e9ed8 100644 --- a/zos_concepts/data_sets/copy_edit_submit/inventories/host_vars/zos_host.yml +++ b/zos_concepts/data_sets/copy_edit_submit/inventories/host_vars/zos_host.yml @@ -1,25 +1,64 @@ --- ################################################################################ -# Copyright (c) IBM Corporation 2021 +# Copyright (c) IBM Corporation 2021, 2024 ################################################################################ ################################################################################ # Description of the properties used in this configuration: -# - Property `PYZ` is the python installation home path on the z/OS managed node (target), -# e.g, pyz: "/usr/lpp/IBM/cyp/v3r8/pyz" -# - Property `ZOAU` is the ZOAU installation home on the z/OS managed node (target), -# e.g, zoau: "/usr/lpp/IBM/zoautil" -# - property `ansible_python_interpreter` is the z/OS managed node (target) Python +# - Property `PYZ` is the python installation home path on the z/OS managed +# (target) node e.g, PYZ: "/usr/lpp/IBM/cyp/v3r12/pyz" +# - Property `PYZ_VERSION` is the version of python on the z/OS managed +# (target) node e.g, PYZ_VERSION: "3.12". +# - Property `ZOAU` is the ZOAU installation home on the z/OS managed (target) +# node, e.g, ZOAU: "/usr/lpp/IBM/zoautil". +# - Property `ZOAU_PYTHON_LIBRARY_PATH` is the path to the Z Open Automation +# Utilities (ZOAU) python library. Specifically, the path points to the +# directory containing 'zoautil_py'. Packages installed using 'pip' generally +# default to the 'site-packages' directory within the python installation, +# eg "/usr/lpp/IBM/cyp/v3r12/pyz/lib/python3.12/site-packages/". +# If the installation uses options such as '--user' or '--target', the module +# is installed to a non-default location which must be configured in +# `ZOAU_PYTHON_LIBRARY_PATH`. +# If the wheel installation method is used with the '--target' or '--user' +# option, `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory the wheel +# file was installed to. e.g ZOAU_PYTHON_LIBRARY_PATH: "/usr/zoau-wheel/". +# Else 'ZOAU_PYTHON_LIBRARY_PATH' should point to the directory containing +# the pre-compiled binary. +# For ZOAU v1.2.x, the pre-compiled binary is located in the 'lib' directory. +# e.g "/usr/lpp/IBM/zoautil/lib" or "{{ ZOAU }}/lib". +# For ZOAU v1.3.x, the pre-compiled binary is located in a sub-directory +# corresponding to the `PYZ_VERSION` inside the 'lib' directory, +# e.g "/usr/lpp/IBM/zoautil/lib/3.12" or "{{ ZOAU }}/lib/{{ PYZ_VERSION }}". +# - Property `ansible_python_interpreter` is the z/OS managed node (target) Python # binary installation path, e.g, ansible_python_interpreter: "{{PYZ}}/bin/python3" # -# Note, PYZ and ZOAU environment variables must be configured. +# Note, PYZ, PYZ_VERSION, and ZOAU environment variables must be configured. ################################################################################ PYZ: "path_to_python_installation_on_zos_target" +PYZ_VERSION: "3.xx" + ZOAU: "path_to_zoau_installation_on_zos_target" +# Configuring the `ZOAU_PYTHON_LIBRARY_PATH` property is required. + +# If the ZOAU python package, zoautil_py, has been installed as a wheel (*.whl) +# with the '--target' or '--user' option, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ path_to_wheel_installation_directory }}" + +# If the ZOAU python zoautil_py package has been installed in the default location +# that is part of Python's search path, the `ZOAU_PYTHON_LIBRARY_PATH` environment +# variable must be set as an empty string. Uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "" + +# If using pre-compiled binaries for ZOAU v1.3.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib/{{ PYZ_VERSION }}" + +# If using pre-compiled binaries for ZOAU v1.2.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib" + ################################################################################ -# Do not configure, variable substituion will correctly set the -# variable`ansible_python_interpreter` +# Do not configure, variable substitution will correctly set the +# variable `ansible_python_interpreter` ################################################################################ ansible_python_interpreter: "{{ PYZ }}/bin/python3" diff --git a/zos_concepts/data_sets/data_set_basics/inventories/group_vars/all.yml b/zos_concepts/data_sets/data_set_basics/inventories/group_vars/all.yml index a32cce2a3..767d93cc4 100644 --- a/zos_concepts/data_sets/data_set_basics/inventories/group_vars/all.yml +++ b/zos_concepts/data_sets/data_set_basics/inventories/group_vars/all.yml @@ -1,5 +1,5 @@ ################################################################################ -# Copyright (c) IBM Corporation 2020 +# Copyright (c) IBM Corporation 2020, 2024 ################################################################################ ################################################################################ @@ -9,7 +9,7 @@ environment_vars: _BPXK_AUTOCVT: "ON" ZOAU_HOME: "{{ ZOAU }}" - PYTHONPATH: "{{ ZOAU }}/lib" + PYTHONPATH: "{{ ZOAU_PYTHON_LIBRARY_PATH }}" LIBPATH: "{{ ZOAU }}/lib:{{ PYZ }}/lib:/lib:/usr/lib:." PATH: "{{ ZOAU }}/bin:{{ PYZ }}/bin:/bin:/var/bin" _CEE_RUNOPTS: "FILETAG(AUTOCVT,AUTOTAG) POSIX(ON)" @@ -23,10 +23,12 @@ environment_vars: # Description of the properties used in this configuration: ################################################################################ # - Property BPXK_AUTOCVT must be configured to "ON"; e.g., _BPXK_AUTOCVT: "ON" -# - Property ZOAU_HOME is the ZOA Utilities install root path; e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" -# - Property PYTHONPATH is the ZOA Utilities Python library path; e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" +# - Property ZOAU_HOME is the Z Open Automation Utilities (ZOAU) install root path; +# e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" +# - Property PYTHONPATH is the Z Open Automation Utilities (ZOAU) Python library path; +# e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" # - Property LIBPATH is both the path to the Python libraries on the target -# and the ZOA Utilities Python library path separated by semi-colons; e.g., +# and the Z Open Automation Utilities (ZOAU) Python library path separated by semi-colons; e.g., # LIBPATH: "/usr/lpp/IBM/zoautil/lib/:/usr/lpp/IBM/cyp/v3r8/pyz/lib:/usr/lib:/lib:." # - Property PATH is the ZOA utilities BIN path and Python interpreter path, e.g., # PATH: "/usr/lpp/IBM/zoautil/bin:/usr/lpp/IBM/cyp/v3r8/pyz/bin:/bin" diff --git a/zos_concepts/data_sets/data_set_basics/inventories/host_vars/zos_host.yml b/zos_concepts/data_sets/data_set_basics/inventories/host_vars/zos_host.yml index cbf8614f2..d385e9ed8 100644 --- a/zos_concepts/data_sets/data_set_basics/inventories/host_vars/zos_host.yml +++ b/zos_concepts/data_sets/data_set_basics/inventories/host_vars/zos_host.yml @@ -1,25 +1,64 @@ --- ################################################################################ -# Copyright (c) IBM Corporation 2021 +# Copyright (c) IBM Corporation 2021, 2024 ################################################################################ ################################################################################ # Description of the properties used in this configuration: -# - Property `PYZ` is the python installation home path on the z/OS managed node (target), -# e.g, pyz: "/usr/lpp/IBM/cyp/v3r8/pyz" -# - Property `ZOAU` is the ZOAU installation home on the z/OS managed node (target), -# e.g, zoau: "/usr/lpp/IBM/zoautil" -# - property `ansible_python_interpreter` is the z/OS managed node (target) Python +# - Property `PYZ` is the python installation home path on the z/OS managed +# (target) node e.g, PYZ: "/usr/lpp/IBM/cyp/v3r12/pyz" +# - Property `PYZ_VERSION` is the version of python on the z/OS managed +# (target) node e.g, PYZ_VERSION: "3.12". +# - Property `ZOAU` is the ZOAU installation home on the z/OS managed (target) +# node, e.g, ZOAU: "/usr/lpp/IBM/zoautil". +# - Property `ZOAU_PYTHON_LIBRARY_PATH` is the path to the Z Open Automation +# Utilities (ZOAU) python library. Specifically, the path points to the +# directory containing 'zoautil_py'. Packages installed using 'pip' generally +# default to the 'site-packages' directory within the python installation, +# eg "/usr/lpp/IBM/cyp/v3r12/pyz/lib/python3.12/site-packages/". +# If the installation uses options such as '--user' or '--target', the module +# is installed to a non-default location which must be configured in +# `ZOAU_PYTHON_LIBRARY_PATH`. +# If the wheel installation method is used with the '--target' or '--user' +# option, `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory the wheel +# file was installed to. e.g ZOAU_PYTHON_LIBRARY_PATH: "/usr/zoau-wheel/". +# Else 'ZOAU_PYTHON_LIBRARY_PATH' should point to the directory containing +# the pre-compiled binary. +# For ZOAU v1.2.x, the pre-compiled binary is located in the 'lib' directory. +# e.g "/usr/lpp/IBM/zoautil/lib" or "{{ ZOAU }}/lib". +# For ZOAU v1.3.x, the pre-compiled binary is located in a sub-directory +# corresponding to the `PYZ_VERSION` inside the 'lib' directory, +# e.g "/usr/lpp/IBM/zoautil/lib/3.12" or "{{ ZOAU }}/lib/{{ PYZ_VERSION }}". +# - Property `ansible_python_interpreter` is the z/OS managed node (target) Python # binary installation path, e.g, ansible_python_interpreter: "{{PYZ}}/bin/python3" # -# Note, PYZ and ZOAU environment variables must be configured. +# Note, PYZ, PYZ_VERSION, and ZOAU environment variables must be configured. ################################################################################ PYZ: "path_to_python_installation_on_zos_target" +PYZ_VERSION: "3.xx" + ZOAU: "path_to_zoau_installation_on_zos_target" +# Configuring the `ZOAU_PYTHON_LIBRARY_PATH` property is required. + +# If the ZOAU python package, zoautil_py, has been installed as a wheel (*.whl) +# with the '--target' or '--user' option, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ path_to_wheel_installation_directory }}" + +# If the ZOAU python zoautil_py package has been installed in the default location +# that is part of Python's search path, the `ZOAU_PYTHON_LIBRARY_PATH` environment +# variable must be set as an empty string. Uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "" + +# If using pre-compiled binaries for ZOAU v1.3.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib/{{ PYZ_VERSION }}" + +# If using pre-compiled binaries for ZOAU v1.2.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib" + ################################################################################ -# Do not configure, variable substituion will correctly set the -# variable`ansible_python_interpreter` +# Do not configure, variable substitution will correctly set the +# variable `ansible_python_interpreter` ################################################################################ ansible_python_interpreter: "{{ PYZ }}/bin/python3" diff --git a/zos_concepts/data_transfer/archive_copy_unarchive_restore/inventories/group_vars/all.yml b/zos_concepts/data_transfer/archive_copy_unarchive_restore/inventories/group_vars/all.yml index 6bd7f828b..18f174c63 100644 --- a/zos_concepts/data_transfer/archive_copy_unarchive_restore/inventories/group_vars/all.yml +++ b/zos_concepts/data_transfer/archive_copy_unarchive_restore/inventories/group_vars/all.yml @@ -1,5 +1,5 @@ ################################################################################ -# Copyright (c) IBM Corporation 2023 +# Copyright (c) IBM Corporation 2023, 2024 ################################################################################ ################################################################################ @@ -9,7 +9,7 @@ environment_vars: _BPXK_AUTOCVT: "ON" ZOAU_HOME: "{{ ZOAU }}" - PYTHONPATH: "{{ ZOAU }}/lib" + PYTHONPATH: "{{ ZOAU_PYTHON_LIBRARY_PATH }}" LIBPATH: "{{ ZOAU }}/lib:{{ PYZ }}/lib:/lib:/usr/lib:." PATH: "{{ ZOAU }}/bin:{{ PYZ }}/bin:/bin:/var/bin" _CEE_RUNOPTS: "FILETAG(AUTOCVT,AUTOTAG) POSIX(ON)" @@ -23,10 +23,12 @@ environment_vars: # Description of the properties used in this configuration: ################################################################################ # - Property BPXK_AUTOCVT must be configured to "ON"; e.g., _BPXK_AUTOCVT: "ON" -# - Property ZOAU_HOME is the ZOA Utilities install root path; e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" -# - Property PYTHONPATH is the ZOA Utilities Python library path; e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" +# - Property ZOAU_HOME is the Z Open Automation Utilities (ZOAU) install root path; +# e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" +# - Property PYTHONPATH is the Z Open Automation Utilities (ZOAU) Python library path; +# e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" # - Property LIBPATH is both the path to the Python libraries on the target -# and the ZOA Utilities Python library path separated by semi-colons; e.g., +# and the Z Open Automation Utilities (ZOAU) Python library path separated by semi-colons; e.g., # LIBPATH: "/usr/lpp/IBM/zoautil/lib/:/usr/lpp/IBM/cyp/v3r8/pyz/lib:/usr/lib:/lib:." # - Property PATH is the ZOA utilities BIN path and Python interpreter path, e.g., # PATH: "/usr/lpp/IBM/zoautil/bin:/usr/lpp/IBM/cyp/v3r8/pyz/bin:/bin" diff --git a/zos_concepts/data_transfer/archive_copy_unarchive_restore/inventories/host_vars/destination.yml b/zos_concepts/data_transfer/archive_copy_unarchive_restore/inventories/host_vars/destination.yml index 445e66d6f..38e974e4f 100644 --- a/zos_concepts/data_transfer/archive_copy_unarchive_restore/inventories/host_vars/destination.yml +++ b/zos_concepts/data_transfer/archive_copy_unarchive_restore/inventories/host_vars/destination.yml @@ -1,24 +1,63 @@ ################################################################################ -# Copyright (c) IBM Corporation 2023 +# Copyright (c) IBM Corporation 2023, 2024 ################################################################################ ################################################################################ # Description of the properties used in this configuration: -# - Property `PYZ` is the python installation home path on the z/OS managed node (target), -# e.g, pyz: "/usr/lpp/IBM/cyp/v3r11/pyz" -# - Property `ZOAU` is the ZOAU installation home on the z/OS managed node (target), -# e.g, zoau: "/usr/lpp/IBM/zoautil" -# - property `ansible_python_interpreter` is the z/OS managed node (target) Python +# - Property `PYZ` is the python installation home path on the z/OS managed +# (target) node e.g, PYZ: "/usr/lpp/IBM/cyp/v3r12/pyz" +# - Property `PYZ_VERSION` is the version of python on the z/OS managed +# (target) node e.g, PYZ_VERSION: "3.12". +# - Property `ZOAU` is the ZOAU installation home on the z/OS managed (target) +# node, e.g, ZOAU: "/usr/lpp/IBM/zoautil". +# - Property `ZOAU_PYTHON_LIBRARY_PATH` is the path to the Z Open Automation +# Utilities (ZOAU) python library. Specifically, the path points to the +# directory containing 'zoautil_py'. Packages installed using 'pip' generally +# default to the 'site-packages' directory within the python installation, +# eg "/usr/lpp/IBM/cyp/v3r12/pyz/lib/python3.12/site-packages/". +# If the installation uses options such as '--user' or '--target', the module +# is installed to a non-default location which must be configured in +# `ZOAU_PYTHON_LIBRARY_PATH`. +# If the wheel installation method is used with the '--target' or '--user' +# option, `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory the wheel +# file was installed to. e.g ZOAU_PYTHON_LIBRARY_PATH: "/usr/zoau-wheel/". +# Else 'ZOAU_PYTHON_LIBRARY_PATH' should point to the directory containing +# the pre-compiled binary. +# For ZOAU v1.2.x, the pre-compiled binary is located in the 'lib' directory. +# e.g "/usr/lpp/IBM/zoautil/lib" or "{{ ZOAU }}/lib". +# For ZOAU v1.3.x, the pre-compiled binary is located in a sub-directory +# corresponding to the `PYZ_VERSION` inside the 'lib' directory, +# e.g "/usr/lpp/IBM/zoautil/lib/3.12" or "{{ ZOAU }}/lib/{{ PYZ_VERSION }}". +# - Property `ansible_python_interpreter` is the z/OS managed node (target) Python # binary installation path, e.g, ansible_python_interpreter: "{{PYZ}}/bin/python3" # -# Note, PYZ and ZOAU environment variables must be configured. +# Note, PYZ, PYZ_VERSION, and ZOAU environment variables must be configured. ################################################################################ PYZ: "path_to_python_installation_on_zos_target" +PYZ_VERSION: "3.xx" + ZOAU: "path_to_zoau_installation_on_zos_target" +# Configuring the `ZOAU_PYTHON_LIBRARY_PATH` property is required. + +# If the ZOAU python package, zoautil_py, has been installed as a wheel (*.whl) +# with the '--target' or '--user' option, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ path_to_wheel_installation_directory }}" + +# If the ZOAU python zoautil_py package has been installed in the default location +# that is part of Python's search path, the `ZOAU_PYTHON_LIBRARY_PATH` environment +# variable must be set as an empty string. Uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "" + +# If using pre-compiled binaries for ZOAU v1.3.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib/{{ PYZ_VERSION }}" + +# If using pre-compiled binaries for ZOAU v1.2.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib" + ################################################################################ -# Do not configure, variable substituion will correctly set the -# variable`ansible_python_interpreter` +# Do not configure, variable substitution will correctly set the +# variable `ansible_python_interpreter` ################################################################################ -ansible_python_interpreter: "{{ PYZ }}/bin/python3" \ No newline at end of file +ansible_python_interpreter: "{{ PYZ }}/bin/python3" diff --git a/zos_concepts/data_transfer/archive_copy_unarchive_restore/inventories/host_vars/source.yml b/zos_concepts/data_transfer/archive_copy_unarchive_restore/inventories/host_vars/source.yml index ee6a0e7d8..38e974e4f 100644 --- a/zos_concepts/data_transfer/archive_copy_unarchive_restore/inventories/host_vars/source.yml +++ b/zos_concepts/data_transfer/archive_copy_unarchive_restore/inventories/host_vars/source.yml @@ -1,24 +1,63 @@ ################################################################################ -# Copyright (c) IBM Corporation 2024 +# Copyright (c) IBM Corporation 2023, 2024 ################################################################################ ################################################################################ # Description of the properties used in this configuration: -# - Property `PYZ` is the python installation home path on the z/OS managed node (target), -# e.g, pyz: "/usr/lpp/IBM/cyp/v3r11/pyz" -# - Property `ZOAU` is the ZOAU installation home on the z/OS managed node (target), -# e.g, zoau: "/usr/lpp/IBM/zoautil" -# - property `ansible_python_interpreter` is the z/OS managed node (target) Python +# - Property `PYZ` is the python installation home path on the z/OS managed +# (target) node e.g, PYZ: "/usr/lpp/IBM/cyp/v3r12/pyz" +# - Property `PYZ_VERSION` is the version of python on the z/OS managed +# (target) node e.g, PYZ_VERSION: "3.12". +# - Property `ZOAU` is the ZOAU installation home on the z/OS managed (target) +# node, e.g, ZOAU: "/usr/lpp/IBM/zoautil". +# - Property `ZOAU_PYTHON_LIBRARY_PATH` is the path to the Z Open Automation +# Utilities (ZOAU) python library. Specifically, the path points to the +# directory containing 'zoautil_py'. Packages installed using 'pip' generally +# default to the 'site-packages' directory within the python installation, +# eg "/usr/lpp/IBM/cyp/v3r12/pyz/lib/python3.12/site-packages/". +# If the installation uses options such as '--user' or '--target', the module +# is installed to a non-default location which must be configured in +# `ZOAU_PYTHON_LIBRARY_PATH`. +# If the wheel installation method is used with the '--target' or '--user' +# option, `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory the wheel +# file was installed to. e.g ZOAU_PYTHON_LIBRARY_PATH: "/usr/zoau-wheel/". +# Else 'ZOAU_PYTHON_LIBRARY_PATH' should point to the directory containing +# the pre-compiled binary. +# For ZOAU v1.2.x, the pre-compiled binary is located in the 'lib' directory. +# e.g "/usr/lpp/IBM/zoautil/lib" or "{{ ZOAU }}/lib". +# For ZOAU v1.3.x, the pre-compiled binary is located in a sub-directory +# corresponding to the `PYZ_VERSION` inside the 'lib' directory, +# e.g "/usr/lpp/IBM/zoautil/lib/3.12" or "{{ ZOAU }}/lib/{{ PYZ_VERSION }}". +# - Property `ansible_python_interpreter` is the z/OS managed node (target) Python # binary installation path, e.g, ansible_python_interpreter: "{{PYZ}}/bin/python3" # -# Note, PYZ and ZOAU environment variables must be configured. +# Note, PYZ, PYZ_VERSION, and ZOAU environment variables must be configured. ################################################################################ PYZ: "path_to_python_installation_on_zos_target" +PYZ_VERSION: "3.xx" + ZOAU: "path_to_zoau_installation_on_zos_target" +# Configuring the `ZOAU_PYTHON_LIBRARY_PATH` property is required. + +# If the ZOAU python package, zoautil_py, has been installed as a wheel (*.whl) +# with the '--target' or '--user' option, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ path_to_wheel_installation_directory }}" + +# If the ZOAU python zoautil_py package has been installed in the default location +# that is part of Python's search path, the `ZOAU_PYTHON_LIBRARY_PATH` environment +# variable must be set as an empty string. Uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "" + +# If using pre-compiled binaries for ZOAU v1.3.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib/{{ PYZ_VERSION }}" + +# If using pre-compiled binaries for ZOAU v1.2.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib" + ################################################################################ -# Do not configure, variable substituion will correctly set the -# variable`ansible_python_interpreter` +# Do not configure, variable substitution will correctly set the +# variable `ansible_python_interpreter` ################################################################################ -ansible_python_interpreter: "{{ PYZ }}/bin/python3" \ No newline at end of file +ansible_python_interpreter: "{{ PYZ }}/bin/python3" diff --git a/zos_concepts/data_transfer/copy_fetch_data_set/inventories/group_vars/all.yml b/zos_concepts/data_transfer/copy_fetch_data_set/inventories/group_vars/all.yml index a32cce2a3..767d93cc4 100644 --- a/zos_concepts/data_transfer/copy_fetch_data_set/inventories/group_vars/all.yml +++ b/zos_concepts/data_transfer/copy_fetch_data_set/inventories/group_vars/all.yml @@ -1,5 +1,5 @@ ################################################################################ -# Copyright (c) IBM Corporation 2020 +# Copyright (c) IBM Corporation 2020, 2024 ################################################################################ ################################################################################ @@ -9,7 +9,7 @@ environment_vars: _BPXK_AUTOCVT: "ON" ZOAU_HOME: "{{ ZOAU }}" - PYTHONPATH: "{{ ZOAU }}/lib" + PYTHONPATH: "{{ ZOAU_PYTHON_LIBRARY_PATH }}" LIBPATH: "{{ ZOAU }}/lib:{{ PYZ }}/lib:/lib:/usr/lib:." PATH: "{{ ZOAU }}/bin:{{ PYZ }}/bin:/bin:/var/bin" _CEE_RUNOPTS: "FILETAG(AUTOCVT,AUTOTAG) POSIX(ON)" @@ -23,10 +23,12 @@ environment_vars: # Description of the properties used in this configuration: ################################################################################ # - Property BPXK_AUTOCVT must be configured to "ON"; e.g., _BPXK_AUTOCVT: "ON" -# - Property ZOAU_HOME is the ZOA Utilities install root path; e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" -# - Property PYTHONPATH is the ZOA Utilities Python library path; e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" +# - Property ZOAU_HOME is the Z Open Automation Utilities (ZOAU) install root path; +# e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" +# - Property PYTHONPATH is the Z Open Automation Utilities (ZOAU) Python library path; +# e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" # - Property LIBPATH is both the path to the Python libraries on the target -# and the ZOA Utilities Python library path separated by semi-colons; e.g., +# and the Z Open Automation Utilities (ZOAU) Python library path separated by semi-colons; e.g., # LIBPATH: "/usr/lpp/IBM/zoautil/lib/:/usr/lpp/IBM/cyp/v3r8/pyz/lib:/usr/lib:/lib:." # - Property PATH is the ZOA utilities BIN path and Python interpreter path, e.g., # PATH: "/usr/lpp/IBM/zoautil/bin:/usr/lpp/IBM/cyp/v3r8/pyz/bin:/bin" diff --git a/zos_concepts/data_transfer/copy_fetch_data_set/inventories/host_vars/zos_host.yml b/zos_concepts/data_transfer/copy_fetch_data_set/inventories/host_vars/zos_host.yml index cbf8614f2..d385e9ed8 100644 --- a/zos_concepts/data_transfer/copy_fetch_data_set/inventories/host_vars/zos_host.yml +++ b/zos_concepts/data_transfer/copy_fetch_data_set/inventories/host_vars/zos_host.yml @@ -1,25 +1,64 @@ --- ################################################################################ -# Copyright (c) IBM Corporation 2021 +# Copyright (c) IBM Corporation 2021, 2024 ################################################################################ ################################################################################ # Description of the properties used in this configuration: -# - Property `PYZ` is the python installation home path on the z/OS managed node (target), -# e.g, pyz: "/usr/lpp/IBM/cyp/v3r8/pyz" -# - Property `ZOAU` is the ZOAU installation home on the z/OS managed node (target), -# e.g, zoau: "/usr/lpp/IBM/zoautil" -# - property `ansible_python_interpreter` is the z/OS managed node (target) Python +# - Property `PYZ` is the python installation home path on the z/OS managed +# (target) node e.g, PYZ: "/usr/lpp/IBM/cyp/v3r12/pyz" +# - Property `PYZ_VERSION` is the version of python on the z/OS managed +# (target) node e.g, PYZ_VERSION: "3.12". +# - Property `ZOAU` is the ZOAU installation home on the z/OS managed (target) +# node, e.g, ZOAU: "/usr/lpp/IBM/zoautil". +# - Property `ZOAU_PYTHON_LIBRARY_PATH` is the path to the Z Open Automation +# Utilities (ZOAU) python library. Specifically, the path points to the +# directory containing 'zoautil_py'. Packages installed using 'pip' generally +# default to the 'site-packages' directory within the python installation, +# eg "/usr/lpp/IBM/cyp/v3r12/pyz/lib/python3.12/site-packages/". +# If the installation uses options such as '--user' or '--target', the module +# is installed to a non-default location which must be configured in +# `ZOAU_PYTHON_LIBRARY_PATH`. +# If the wheel installation method is used with the '--target' or '--user' +# option, `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory the wheel +# file was installed to. e.g ZOAU_PYTHON_LIBRARY_PATH: "/usr/zoau-wheel/". +# Else 'ZOAU_PYTHON_LIBRARY_PATH' should point to the directory containing +# the pre-compiled binary. +# For ZOAU v1.2.x, the pre-compiled binary is located in the 'lib' directory. +# e.g "/usr/lpp/IBM/zoautil/lib" or "{{ ZOAU }}/lib". +# For ZOAU v1.3.x, the pre-compiled binary is located in a sub-directory +# corresponding to the `PYZ_VERSION` inside the 'lib' directory, +# e.g "/usr/lpp/IBM/zoautil/lib/3.12" or "{{ ZOAU }}/lib/{{ PYZ_VERSION }}". +# - Property `ansible_python_interpreter` is the z/OS managed node (target) Python # binary installation path, e.g, ansible_python_interpreter: "{{PYZ}}/bin/python3" # -# Note, PYZ and ZOAU environment variables must be configured. +# Note, PYZ, PYZ_VERSION, and ZOAU environment variables must be configured. ################################################################################ PYZ: "path_to_python_installation_on_zos_target" +PYZ_VERSION: "3.xx" + ZOAU: "path_to_zoau_installation_on_zos_target" +# Configuring the `ZOAU_PYTHON_LIBRARY_PATH` property is required. + +# If the ZOAU python package, zoautil_py, has been installed as a wheel (*.whl) +# with the '--target' or '--user' option, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ path_to_wheel_installation_directory }}" + +# If the ZOAU python zoautil_py package has been installed in the default location +# that is part of Python's search path, the `ZOAU_PYTHON_LIBRARY_PATH` environment +# variable must be set as an empty string. Uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "" + +# If using pre-compiled binaries for ZOAU v1.3.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib/{{ PYZ_VERSION }}" + +# If using pre-compiled binaries for ZOAU v1.2.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib" + ################################################################################ -# Do not configure, variable substituion will correctly set the -# variable`ansible_python_interpreter` +# Do not configure, variable substitution will correctly set the +# variable `ansible_python_interpreter` ################################################################################ ansible_python_interpreter: "{{ PYZ }}/bin/python3" diff --git a/zos_concepts/data_transfer/copy_sort_fetch/inventories/group_vars/all.yml b/zos_concepts/data_transfer/copy_sort_fetch/inventories/group_vars/all.yml index a32cce2a3..767d93cc4 100644 --- a/zos_concepts/data_transfer/copy_sort_fetch/inventories/group_vars/all.yml +++ b/zos_concepts/data_transfer/copy_sort_fetch/inventories/group_vars/all.yml @@ -1,5 +1,5 @@ ################################################################################ -# Copyright (c) IBM Corporation 2020 +# Copyright (c) IBM Corporation 2020, 2024 ################################################################################ ################################################################################ @@ -9,7 +9,7 @@ environment_vars: _BPXK_AUTOCVT: "ON" ZOAU_HOME: "{{ ZOAU }}" - PYTHONPATH: "{{ ZOAU }}/lib" + PYTHONPATH: "{{ ZOAU_PYTHON_LIBRARY_PATH }}" LIBPATH: "{{ ZOAU }}/lib:{{ PYZ }}/lib:/lib:/usr/lib:." PATH: "{{ ZOAU }}/bin:{{ PYZ }}/bin:/bin:/var/bin" _CEE_RUNOPTS: "FILETAG(AUTOCVT,AUTOTAG) POSIX(ON)" @@ -23,10 +23,12 @@ environment_vars: # Description of the properties used in this configuration: ################################################################################ # - Property BPXK_AUTOCVT must be configured to "ON"; e.g., _BPXK_AUTOCVT: "ON" -# - Property ZOAU_HOME is the ZOA Utilities install root path; e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" -# - Property PYTHONPATH is the ZOA Utilities Python library path; e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" +# - Property ZOAU_HOME is the Z Open Automation Utilities (ZOAU) install root path; +# e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" +# - Property PYTHONPATH is the Z Open Automation Utilities (ZOAU) Python library path; +# e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" # - Property LIBPATH is both the path to the Python libraries on the target -# and the ZOA Utilities Python library path separated by semi-colons; e.g., +# and the Z Open Automation Utilities (ZOAU) Python library path separated by semi-colons; e.g., # LIBPATH: "/usr/lpp/IBM/zoautil/lib/:/usr/lpp/IBM/cyp/v3r8/pyz/lib:/usr/lib:/lib:." # - Property PATH is the ZOA utilities BIN path and Python interpreter path, e.g., # PATH: "/usr/lpp/IBM/zoautil/bin:/usr/lpp/IBM/cyp/v3r8/pyz/bin:/bin" diff --git a/zos_concepts/data_transfer/copy_sort_fetch/inventories/host_vars/zos_host.yml b/zos_concepts/data_transfer/copy_sort_fetch/inventories/host_vars/zos_host.yml index cbf8614f2..d385e9ed8 100644 --- a/zos_concepts/data_transfer/copy_sort_fetch/inventories/host_vars/zos_host.yml +++ b/zos_concepts/data_transfer/copy_sort_fetch/inventories/host_vars/zos_host.yml @@ -1,25 +1,64 @@ --- ################################################################################ -# Copyright (c) IBM Corporation 2021 +# Copyright (c) IBM Corporation 2021, 2024 ################################################################################ ################################################################################ # Description of the properties used in this configuration: -# - Property `PYZ` is the python installation home path on the z/OS managed node (target), -# e.g, pyz: "/usr/lpp/IBM/cyp/v3r8/pyz" -# - Property `ZOAU` is the ZOAU installation home on the z/OS managed node (target), -# e.g, zoau: "/usr/lpp/IBM/zoautil" -# - property `ansible_python_interpreter` is the z/OS managed node (target) Python +# - Property `PYZ` is the python installation home path on the z/OS managed +# (target) node e.g, PYZ: "/usr/lpp/IBM/cyp/v3r12/pyz" +# - Property `PYZ_VERSION` is the version of python on the z/OS managed +# (target) node e.g, PYZ_VERSION: "3.12". +# - Property `ZOAU` is the ZOAU installation home on the z/OS managed (target) +# node, e.g, ZOAU: "/usr/lpp/IBM/zoautil". +# - Property `ZOAU_PYTHON_LIBRARY_PATH` is the path to the Z Open Automation +# Utilities (ZOAU) python library. Specifically, the path points to the +# directory containing 'zoautil_py'. Packages installed using 'pip' generally +# default to the 'site-packages' directory within the python installation, +# eg "/usr/lpp/IBM/cyp/v3r12/pyz/lib/python3.12/site-packages/". +# If the installation uses options such as '--user' or '--target', the module +# is installed to a non-default location which must be configured in +# `ZOAU_PYTHON_LIBRARY_PATH`. +# If the wheel installation method is used with the '--target' or '--user' +# option, `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory the wheel +# file was installed to. e.g ZOAU_PYTHON_LIBRARY_PATH: "/usr/zoau-wheel/". +# Else 'ZOAU_PYTHON_LIBRARY_PATH' should point to the directory containing +# the pre-compiled binary. +# For ZOAU v1.2.x, the pre-compiled binary is located in the 'lib' directory. +# e.g "/usr/lpp/IBM/zoautil/lib" or "{{ ZOAU }}/lib". +# For ZOAU v1.3.x, the pre-compiled binary is located in a sub-directory +# corresponding to the `PYZ_VERSION` inside the 'lib' directory, +# e.g "/usr/lpp/IBM/zoautil/lib/3.12" or "{{ ZOAU }}/lib/{{ PYZ_VERSION }}". +# - Property `ansible_python_interpreter` is the z/OS managed node (target) Python # binary installation path, e.g, ansible_python_interpreter: "{{PYZ}}/bin/python3" # -# Note, PYZ and ZOAU environment variables must be configured. +# Note, PYZ, PYZ_VERSION, and ZOAU environment variables must be configured. ################################################################################ PYZ: "path_to_python_installation_on_zos_target" +PYZ_VERSION: "3.xx" + ZOAU: "path_to_zoau_installation_on_zos_target" +# Configuring the `ZOAU_PYTHON_LIBRARY_PATH` property is required. + +# If the ZOAU python package, zoautil_py, has been installed as a wheel (*.whl) +# with the '--target' or '--user' option, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ path_to_wheel_installation_directory }}" + +# If the ZOAU python zoautil_py package has been installed in the default location +# that is part of Python's search path, the `ZOAU_PYTHON_LIBRARY_PATH` environment +# variable must be set as an empty string. Uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "" + +# If using pre-compiled binaries for ZOAU v1.3.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib/{{ PYZ_VERSION }}" + +# If using pre-compiled binaries for ZOAU v1.2.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib" + ################################################################################ -# Do not configure, variable substituion will correctly set the -# variable`ansible_python_interpreter` +# Do not configure, variable substitution will correctly set the +# variable `ansible_python_interpreter` ################################################################################ ansible_python_interpreter: "{{ PYZ }}/bin/python3" diff --git a/zos_concepts/data_transfer/dump_pack_ftp_unpack_restore/inventories/group_vars/all.yml b/zos_concepts/data_transfer/dump_pack_ftp_unpack_restore/inventories/group_vars/all.yml index a32cce2a3..767d93cc4 100644 --- a/zos_concepts/data_transfer/dump_pack_ftp_unpack_restore/inventories/group_vars/all.yml +++ b/zos_concepts/data_transfer/dump_pack_ftp_unpack_restore/inventories/group_vars/all.yml @@ -1,5 +1,5 @@ ################################################################################ -# Copyright (c) IBM Corporation 2020 +# Copyright (c) IBM Corporation 2020, 2024 ################################################################################ ################################################################################ @@ -9,7 +9,7 @@ environment_vars: _BPXK_AUTOCVT: "ON" ZOAU_HOME: "{{ ZOAU }}" - PYTHONPATH: "{{ ZOAU }}/lib" + PYTHONPATH: "{{ ZOAU_PYTHON_LIBRARY_PATH }}" LIBPATH: "{{ ZOAU }}/lib:{{ PYZ }}/lib:/lib:/usr/lib:." PATH: "{{ ZOAU }}/bin:{{ PYZ }}/bin:/bin:/var/bin" _CEE_RUNOPTS: "FILETAG(AUTOCVT,AUTOTAG) POSIX(ON)" @@ -23,10 +23,12 @@ environment_vars: # Description of the properties used in this configuration: ################################################################################ # - Property BPXK_AUTOCVT must be configured to "ON"; e.g., _BPXK_AUTOCVT: "ON" -# - Property ZOAU_HOME is the ZOA Utilities install root path; e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" -# - Property PYTHONPATH is the ZOA Utilities Python library path; e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" +# - Property ZOAU_HOME is the Z Open Automation Utilities (ZOAU) install root path; +# e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" +# - Property PYTHONPATH is the Z Open Automation Utilities (ZOAU) Python library path; +# e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" # - Property LIBPATH is both the path to the Python libraries on the target -# and the ZOA Utilities Python library path separated by semi-colons; e.g., +# and the Z Open Automation Utilities (ZOAU) Python library path separated by semi-colons; e.g., # LIBPATH: "/usr/lpp/IBM/zoautil/lib/:/usr/lpp/IBM/cyp/v3r8/pyz/lib:/usr/lib:/lib:." # - Property PATH is the ZOA utilities BIN path and Python interpreter path, e.g., # PATH: "/usr/lpp/IBM/zoautil/bin:/usr/lpp/IBM/cyp/v3r8/pyz/bin:/bin" diff --git a/zos_concepts/data_transfer/dump_pack_ftp_unpack_restore/inventories/host_vars/destination.yml b/zos_concepts/data_transfer/dump_pack_ftp_unpack_restore/inventories/host_vars/destination.yml index 3c1369d50..c939afd47 100644 --- a/zos_concepts/data_transfer/dump_pack_ftp_unpack_restore/inventories/host_vars/destination.yml +++ b/zos_concepts/data_transfer/dump_pack_ftp_unpack_restore/inventories/host_vars/destination.yml @@ -1,9 +1,9 @@ ################################################################################ -# Copyright (c) IBM Corporation 2021 +# Copyright (c) IBM Corporation 2021, 2024 ################################################################################ ################################################################################ -# Variables used and needing confirugation for this playbook +# Variables used and needing configuration for this playbook ################################################################################ # A list of data sets contained in an archive you wish to restore @@ -32,16 +32,66 @@ delete: true # Indicates if existing data sets should be overwritten during restore replace: true -# The python installation home path on the z/OS managed node (target), -# e.g, pyz: "/usr/lpp/IBM/cyp/v3r8/pyz" +################################################################################ +# Environment Variables +################################################################################ + +################################################################################ +# Description of the properties used in this configuration: +# - Property `PYZ` is the python installation home path on the z/OS managed +# (target) node e.g, PYZ: "/usr/lpp/IBM/cyp/v3r12/pyz" +# - Property `PYZ_VERSION` is the version of python on the z/OS managed +# (target) node e.g, PYZ_VERSION: "3.12". +# - Property `ZOAU` is the ZOAU installation home on the z/OS managed (target) +# node, e.g, ZOAU: "/usr/lpp/IBM/zoautil". +# - Property `ZOAU_PYTHON_LIBRARY_PATH` is the path to the Z Open Automation +# Utilities (ZOAU) python library. Specifically, the path points to the +# directory containing 'zoautil_py'. Packages installed using 'pip' generally +# default to the 'site-packages' directory within the python installation, +# eg "/usr/lpp/IBM/cyp/v3r12/pyz/lib/python3.12/site-packages/". +# If the installation uses options such as '--user' or '--target', the module +# is installed to a non-default location which must be configured in +# `ZOAU_PYTHON_LIBRARY_PATH`. +# If the wheel installation method is used with the '--target' or '--user' +# option, `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory the wheel +# file was installed to. e.g ZOAU_PYTHON_LIBRARY_PATH: "/usr/zoau-wheel/". +# Else 'ZOAU_PYTHON_LIBRARY_PATH' should point to the directory containing +# the pre-compiled binary. +# For ZOAU v1.2.x, the pre-compiled binary is located in the 'lib' directory. +# e.g "/usr/lpp/IBM/zoautil/lib" or "{{ ZOAU }}/lib". +# For ZOAU v1.3.x, the pre-compiled binary is located in a sub-directory +# corresponding to the `PYZ_VERSION` inside the 'lib' directory, +# e.g "/usr/lpp/IBM/zoautil/lib/3.12" or "{{ ZOAU }}/lib/{{ PYZ_VERSION }}". +# - Property `ansible_python_interpreter` is the z/OS managed node (target) Python +# binary installation path, e.g, ansible_python_interpreter: "{{PYZ}}/bin/python3" +# +# Note, PYZ, PYZ_VERSION, and ZOAU environment variables must be configured. +################################################################################ + PYZ: "path_to_python_installation_on_zos_target" +PYZ_VERSION: "3.xx" -# The ZOAU installation home on the z/OS managed node (target), -# e.g, zoau: "/usr/lpp/IBM/zoautil" ZOAU: "path_to_zoau_installation_on_zos_target" -# The z/OS managed node (target) Python binary installation path, -# e.g, ansible_python_interpreter: "{{PYZ}}/bin/python3" -# NOTE: This needs not configuration because it uses variable substituion to -# correctly set the variable`ansible_python_interpreter` +# Configuring the `ZOAU_PYTHON_LIBRARY_PATH` property is required. + +# If the ZOAU python package, zoautil_py, has been installed as a wheel (*.whl) +# with the '--target' or '--user' option, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ path_to_wheel_installation_directory }}" + +# If the ZOAU python zoautil_py package has been installed in the default location +# that is part of Python's search path, the `ZOAU_PYTHON_LIBRARY_PATH` environment +# variable must be set as an empty string. Uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "" + +# If using pre-compiled binaries for ZOAU v1.3.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib/{{ PYZ_VERSION }}" + +# If using pre-compiled binaries for ZOAU v1.2.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib" + +################################################################################ +# Do not configure, variable substitution will correctly set the +# variable `ansible_python_interpreter` +################################################################################ ansible_python_interpreter: "{{ PYZ }}/bin/python3" diff --git a/zos_concepts/data_transfer/dump_pack_ftp_unpack_restore/inventories/host_vars/source.yml b/zos_concepts/data_transfer/dump_pack_ftp_unpack_restore/inventories/host_vars/source.yml index 1cee21424..dbd9759bc 100644 --- a/zos_concepts/data_transfer/dump_pack_ftp_unpack_restore/inventories/host_vars/source.yml +++ b/zos_concepts/data_transfer/dump_pack_ftp_unpack_restore/inventories/host_vars/source.yml @@ -1,5 +1,5 @@ ################################################################################ -# Copyright (c) IBM Corporation 2021 +# Copyright (c) IBM Corporation 2021, 2024 ################################################################################ ################################################################################ @@ -38,16 +38,66 @@ target_password: "" # Indicates if terse and archive data sets should be deleted upon successful transfer? delete: true -# The python installation home path on the z/OS managed node (target), -# e.g, pyz: "/usr/lpp/IBM/cyp/v3r8/pyz" +################################################################################ +# Environment Variables +################################################################################ + +################################################################################ +# Description of the properties used in this configuration: +# - Property `PYZ` is the python installation home path on the z/OS managed +# (target) node e.g, PYZ: "/usr/lpp/IBM/cyp/v3r12/pyz" +# - Property `PYZ_VERSION` is the version of python on the z/OS managed +# (target) node e.g, PYZ_VERSION: "3.12". +# - Property `ZOAU` is the ZOAU installation home on the z/OS managed (target) +# node, e.g, ZOAU: "/usr/lpp/IBM/zoautil". +# - Property `ZOAU_PYTHON_LIBRARY_PATH` is the path to the Z Open Automation +# Utilities (ZOAU) python library. Specifically, the path points to the +# directory containing 'zoautil_py'. Packages installed using 'pip' generally +# default to the 'site-packages' directory within the python installation, +# eg "/usr/lpp/IBM/cyp/v3r12/pyz/lib/python3.12/site-packages/". +# If the installation uses options such as '--user' or '--target', the module +# is installed to a non-default location which must be configured in +# `ZOAU_PYTHON_LIBRARY_PATH`. +# If the wheel installation method is used with the '--target' or '--user' +# option, `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory the wheel +# file was installed to. e.g ZOAU_PYTHON_LIBRARY_PATH: "/usr/zoau-wheel/". +# Else 'ZOAU_PYTHON_LIBRARY_PATH' should point to the directory containing +# the pre-compiled binary. +# For ZOAU v1.2.x, the pre-compiled binary is located in the 'lib' directory. +# e.g "/usr/lpp/IBM/zoautil/lib" or "{{ ZOAU }}/lib". +# For ZOAU v1.3.x, the pre-compiled binary is located in a sub-directory +# corresponding to the `PYZ_VERSION` inside the 'lib' directory, +# e.g "/usr/lpp/IBM/zoautil/lib/3.12" or "{{ ZOAU }}/lib/{{ PYZ_VERSION }}". +# - Property `ansible_python_interpreter` is the z/OS managed node (target) Python +# binary installation path, e.g, ansible_python_interpreter: "{{PYZ}}/bin/python3" +# +# Note, PYZ, PYZ_VERSION, and ZOAU environment variables must be configured. +################################################################################ + PYZ: "path_to_python_installation_on_zos_target" +PYZ_VERSION: "3.xx" -# The ZOAU installation home on the z/OS managed node (target), -# e.g, zoau: "/usr/lpp/IBM/zoautil" ZOAU: "path_to_zoau_installation_on_zos_target" -# The z/OS managed node (target) Python binary installation path, -# e.g, ansible_python_interpreter: "{{PYZ}}/bin/python3" -# NOTE: This needs not configuration because it uses variable substituion to -# correctly set the variable`ansible_python_interpreter` +# Configuring the `ZOAU_PYTHON_LIBRARY_PATH` property is required. + +# If the ZOAU python package, zoautil_py, has been installed as a wheel (*.whl) +# with the '--target' or '--user' option, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ path_to_wheel_installation_directory }}" + +# If the ZOAU python zoautil_py package has been installed in the default location +# that is part of Python's search path, the `ZOAU_PYTHON_LIBRARY_PATH` environment +# variable must be set as an empty string. Uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "" + +# If using pre-compiled binaries for ZOAU v1.3.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib/{{ PYZ_VERSION }}" + +# If using pre-compiled binaries for ZOAU v1.2.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib" + +################################################################################ +# Do not configure, variable substitution will correctly set the +# variable `ansible_python_interpreter` +################################################################################ ansible_python_interpreter: "{{ PYZ }}/bin/python3" diff --git a/zos_concepts/data_transfer/terse_fetch_data_set/inventories/group_vars/all.yml b/zos_concepts/data_transfer/terse_fetch_data_set/inventories/group_vars/all.yml index a32cce2a3..767d93cc4 100644 --- a/zos_concepts/data_transfer/terse_fetch_data_set/inventories/group_vars/all.yml +++ b/zos_concepts/data_transfer/terse_fetch_data_set/inventories/group_vars/all.yml @@ -1,5 +1,5 @@ ################################################################################ -# Copyright (c) IBM Corporation 2020 +# Copyright (c) IBM Corporation 2020, 2024 ################################################################################ ################################################################################ @@ -9,7 +9,7 @@ environment_vars: _BPXK_AUTOCVT: "ON" ZOAU_HOME: "{{ ZOAU }}" - PYTHONPATH: "{{ ZOAU }}/lib" + PYTHONPATH: "{{ ZOAU_PYTHON_LIBRARY_PATH }}" LIBPATH: "{{ ZOAU }}/lib:{{ PYZ }}/lib:/lib:/usr/lib:." PATH: "{{ ZOAU }}/bin:{{ PYZ }}/bin:/bin:/var/bin" _CEE_RUNOPTS: "FILETAG(AUTOCVT,AUTOTAG) POSIX(ON)" @@ -23,10 +23,12 @@ environment_vars: # Description of the properties used in this configuration: ################################################################################ # - Property BPXK_AUTOCVT must be configured to "ON"; e.g., _BPXK_AUTOCVT: "ON" -# - Property ZOAU_HOME is the ZOA Utilities install root path; e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" -# - Property PYTHONPATH is the ZOA Utilities Python library path; e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" +# - Property ZOAU_HOME is the Z Open Automation Utilities (ZOAU) install root path; +# e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" +# - Property PYTHONPATH is the Z Open Automation Utilities (ZOAU) Python library path; +# e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" # - Property LIBPATH is both the path to the Python libraries on the target -# and the ZOA Utilities Python library path separated by semi-colons; e.g., +# and the Z Open Automation Utilities (ZOAU) Python library path separated by semi-colons; e.g., # LIBPATH: "/usr/lpp/IBM/zoautil/lib/:/usr/lpp/IBM/cyp/v3r8/pyz/lib:/usr/lib:/lib:." # - Property PATH is the ZOA utilities BIN path and Python interpreter path, e.g., # PATH: "/usr/lpp/IBM/zoautil/bin:/usr/lpp/IBM/cyp/v3r8/pyz/bin:/bin" diff --git a/zos_concepts/data_transfer/terse_fetch_data_set/inventories/host_vars/zos_host.yml b/zos_concepts/data_transfer/terse_fetch_data_set/inventories/host_vars/zos_host.yml index 6d396850b..042504b0d 100644 --- a/zos_concepts/data_transfer/terse_fetch_data_set/inventories/host_vars/zos_host.yml +++ b/zos_concepts/data_transfer/terse_fetch_data_set/inventories/host_vars/zos_host.yml @@ -1,6 +1,6 @@ --- ################################################################################ -# Copyright (c) IBM Corporation 2021 +# Copyright (c) IBM Corporation 2021, 2024 ################################################################################ ################################################################################ @@ -13,21 +13,60 @@ archive_data_set: "" ################################################################################ # Description of the properties used in this configuration: -# - Property `PYZ` is the python installation home path on the z/OS managed node (target), -# e.g, pyz: "/usr/lpp/IBM/cyp/v3r8/pyz" -# - Property `ZOAU` is the ZOAU installation home on the z/OS managed node (target), -# e.g, zoau: "/usr/lpp/IBM/zoautil" -# - property `ansible_python_interpreter` is the z/OS managed node (target) Python +# - Property `PYZ` is the python installation home path on the z/OS managed +# (target) node e.g, PYZ: "/usr/lpp/IBM/cyp/v3r12/pyz" +# - Property `PYZ_VERSION` is the version of python on the z/OS managed +# (target) node e.g, PYZ_VERSION: "3.12". +# - Property `ZOAU` is the ZOAU installation home on the z/OS managed (target) +# node, e.g, ZOAU: "/usr/lpp/IBM/zoautil". +# - Property `ZOAU_PYTHON_LIBRARY_PATH` is the path to the Z Open Automation +# Utilities (ZOAU) python library. Specifically, the path points to the +# directory containing 'zoautil_py'. Packages installed using 'pip' generally +# default to the 'site-packages' directory within the python installation, +# eg "/usr/lpp/IBM/cyp/v3r12/pyz/lib/python3.12/site-packages/". +# If the installation uses options such as '--user' or '--target', the module +# is installed to a non-default location which must be configured in +# `ZOAU_PYTHON_LIBRARY_PATH`. +# If the wheel installation method is used with the '--target' or '--user' +# option, `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory the wheel +# file was installed to. e.g ZOAU_PYTHON_LIBRARY_PATH: "/usr/zoau-wheel/". +# Else 'ZOAU_PYTHON_LIBRARY_PATH' should point to the directory containing +# the pre-compiled binary. +# For ZOAU v1.2.x, the pre-compiled binary is located in the 'lib' directory. +# e.g "/usr/lpp/IBM/zoautil/lib" or "{{ ZOAU }}/lib". +# For ZOAU v1.3.x, the pre-compiled binary is located in a sub-directory +# corresponding to the `PYZ_VERSION` inside the 'lib' directory, +# e.g "/usr/lpp/IBM/zoautil/lib/3.12" or "{{ ZOAU }}/lib/{{ PYZ_VERSION }}". +# - Property `ansible_python_interpreter` is the z/OS managed node (target) Python # binary installation path, e.g, ansible_python_interpreter: "{{PYZ}}/bin/python3" # -# Note, PYZ and ZOAU environment variables must be configured. +# Note, PYZ, PYZ_VERSION, and ZOAU environment variables must be configured. ################################################################################ PYZ: "path_to_python_installation_on_zos_target" +PYZ_VERSION: "3.xx" + ZOAU: "path_to_zoau_installation_on_zos_target" +# Configuring the `ZOAU_PYTHON_LIBRARY_PATH` property is required. + +# If the ZOAU python package, zoautil_py, has been installed as a wheel (*.whl) +# with the '--target' or '--user' option, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ path_to_wheel_installation_directory }}" + +# If the ZOAU python zoautil_py package has been installed in the default location +# that is part of Python's search path, the `ZOAU_PYTHON_LIBRARY_PATH` environment +# variable must be set as an empty string. Uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "" + +# If using pre-compiled binaries for ZOAU v1.3.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib/{{ PYZ_VERSION }}" + +# If using pre-compiled binaries for ZOAU v1.2.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib" + ################################################################################ -# Do not configure, variable substituion will correctly set the -# variable`ansible_python_interpreter` +# Do not configure, variable substitution will correctly set the +# variable `ansible_python_interpreter` ################################################################################ ansible_python_interpreter: "{{ PYZ }}/bin/python3" diff --git a/zos_concepts/encoding/convert_encoding/inventories/group_vars/all.yml b/zos_concepts/encoding/convert_encoding/inventories/group_vars/all.yml index a32cce2a3..767d93cc4 100644 --- a/zos_concepts/encoding/convert_encoding/inventories/group_vars/all.yml +++ b/zos_concepts/encoding/convert_encoding/inventories/group_vars/all.yml @@ -1,5 +1,5 @@ ################################################################################ -# Copyright (c) IBM Corporation 2020 +# Copyright (c) IBM Corporation 2020, 2024 ################################################################################ ################################################################################ @@ -9,7 +9,7 @@ environment_vars: _BPXK_AUTOCVT: "ON" ZOAU_HOME: "{{ ZOAU }}" - PYTHONPATH: "{{ ZOAU }}/lib" + PYTHONPATH: "{{ ZOAU_PYTHON_LIBRARY_PATH }}" LIBPATH: "{{ ZOAU }}/lib:{{ PYZ }}/lib:/lib:/usr/lib:." PATH: "{{ ZOAU }}/bin:{{ PYZ }}/bin:/bin:/var/bin" _CEE_RUNOPTS: "FILETAG(AUTOCVT,AUTOTAG) POSIX(ON)" @@ -23,10 +23,12 @@ environment_vars: # Description of the properties used in this configuration: ################################################################################ # - Property BPXK_AUTOCVT must be configured to "ON"; e.g., _BPXK_AUTOCVT: "ON" -# - Property ZOAU_HOME is the ZOA Utilities install root path; e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" -# - Property PYTHONPATH is the ZOA Utilities Python library path; e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" +# - Property ZOAU_HOME is the Z Open Automation Utilities (ZOAU) install root path; +# e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" +# - Property PYTHONPATH is the Z Open Automation Utilities (ZOAU) Python library path; +# e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" # - Property LIBPATH is both the path to the Python libraries on the target -# and the ZOA Utilities Python library path separated by semi-colons; e.g., +# and the Z Open Automation Utilities (ZOAU) Python library path separated by semi-colons; e.g., # LIBPATH: "/usr/lpp/IBM/zoautil/lib/:/usr/lpp/IBM/cyp/v3r8/pyz/lib:/usr/lib:/lib:." # - Property PATH is the ZOA utilities BIN path and Python interpreter path, e.g., # PATH: "/usr/lpp/IBM/zoautil/bin:/usr/lpp/IBM/cyp/v3r8/pyz/bin:/bin" diff --git a/zos_concepts/encoding/convert_encoding/inventories/host_vars/zos_host.yml b/zos_concepts/encoding/convert_encoding/inventories/host_vars/zos_host.yml index cbf8614f2..d385e9ed8 100644 --- a/zos_concepts/encoding/convert_encoding/inventories/host_vars/zos_host.yml +++ b/zos_concepts/encoding/convert_encoding/inventories/host_vars/zos_host.yml @@ -1,25 +1,64 @@ --- ################################################################################ -# Copyright (c) IBM Corporation 2021 +# Copyright (c) IBM Corporation 2021, 2024 ################################################################################ ################################################################################ # Description of the properties used in this configuration: -# - Property `PYZ` is the python installation home path on the z/OS managed node (target), -# e.g, pyz: "/usr/lpp/IBM/cyp/v3r8/pyz" -# - Property `ZOAU` is the ZOAU installation home on the z/OS managed node (target), -# e.g, zoau: "/usr/lpp/IBM/zoautil" -# - property `ansible_python_interpreter` is the z/OS managed node (target) Python +# - Property `PYZ` is the python installation home path on the z/OS managed +# (target) node e.g, PYZ: "/usr/lpp/IBM/cyp/v3r12/pyz" +# - Property `PYZ_VERSION` is the version of python on the z/OS managed +# (target) node e.g, PYZ_VERSION: "3.12". +# - Property `ZOAU` is the ZOAU installation home on the z/OS managed (target) +# node, e.g, ZOAU: "/usr/lpp/IBM/zoautil". +# - Property `ZOAU_PYTHON_LIBRARY_PATH` is the path to the Z Open Automation +# Utilities (ZOAU) python library. Specifically, the path points to the +# directory containing 'zoautil_py'. Packages installed using 'pip' generally +# default to the 'site-packages' directory within the python installation, +# eg "/usr/lpp/IBM/cyp/v3r12/pyz/lib/python3.12/site-packages/". +# If the installation uses options such as '--user' or '--target', the module +# is installed to a non-default location which must be configured in +# `ZOAU_PYTHON_LIBRARY_PATH`. +# If the wheel installation method is used with the '--target' or '--user' +# option, `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory the wheel +# file was installed to. e.g ZOAU_PYTHON_LIBRARY_PATH: "/usr/zoau-wheel/". +# Else 'ZOAU_PYTHON_LIBRARY_PATH' should point to the directory containing +# the pre-compiled binary. +# For ZOAU v1.2.x, the pre-compiled binary is located in the 'lib' directory. +# e.g "/usr/lpp/IBM/zoautil/lib" or "{{ ZOAU }}/lib". +# For ZOAU v1.3.x, the pre-compiled binary is located in a sub-directory +# corresponding to the `PYZ_VERSION` inside the 'lib' directory, +# e.g "/usr/lpp/IBM/zoautil/lib/3.12" or "{{ ZOAU }}/lib/{{ PYZ_VERSION }}". +# - Property `ansible_python_interpreter` is the z/OS managed node (target) Python # binary installation path, e.g, ansible_python_interpreter: "{{PYZ}}/bin/python3" # -# Note, PYZ and ZOAU environment variables must be configured. +# Note, PYZ, PYZ_VERSION, and ZOAU environment variables must be configured. ################################################################################ PYZ: "path_to_python_installation_on_zos_target" +PYZ_VERSION: "3.xx" + ZOAU: "path_to_zoau_installation_on_zos_target" +# Configuring the `ZOAU_PYTHON_LIBRARY_PATH` property is required. + +# If the ZOAU python package, zoautil_py, has been installed as a wheel (*.whl) +# with the '--target' or '--user' option, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ path_to_wheel_installation_directory }}" + +# If the ZOAU python zoautil_py package has been installed in the default location +# that is part of Python's search path, the `ZOAU_PYTHON_LIBRARY_PATH` environment +# variable must be set as an empty string. Uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "" + +# If using pre-compiled binaries for ZOAU v1.3.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib/{{ PYZ_VERSION }}" + +# If using pre-compiled binaries for ZOAU v1.2.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib" + ################################################################################ -# Do not configure, variable substituion will correctly set the -# variable`ansible_python_interpreter` +# Do not configure, variable substitution will correctly set the +# variable `ansible_python_interpreter` ################################################################################ ansible_python_interpreter: "{{ PYZ }}/bin/python3" diff --git a/zos_concepts/jobs/submit_query_retrieve/inventories/group_vars/all.yml b/zos_concepts/jobs/submit_query_retrieve/inventories/group_vars/all.yml index a32cce2a3..767d93cc4 100644 --- a/zos_concepts/jobs/submit_query_retrieve/inventories/group_vars/all.yml +++ b/zos_concepts/jobs/submit_query_retrieve/inventories/group_vars/all.yml @@ -1,5 +1,5 @@ ################################################################################ -# Copyright (c) IBM Corporation 2020 +# Copyright (c) IBM Corporation 2020, 2024 ################################################################################ ################################################################################ @@ -9,7 +9,7 @@ environment_vars: _BPXK_AUTOCVT: "ON" ZOAU_HOME: "{{ ZOAU }}" - PYTHONPATH: "{{ ZOAU }}/lib" + PYTHONPATH: "{{ ZOAU_PYTHON_LIBRARY_PATH }}" LIBPATH: "{{ ZOAU }}/lib:{{ PYZ }}/lib:/lib:/usr/lib:." PATH: "{{ ZOAU }}/bin:{{ PYZ }}/bin:/bin:/var/bin" _CEE_RUNOPTS: "FILETAG(AUTOCVT,AUTOTAG) POSIX(ON)" @@ -23,10 +23,12 @@ environment_vars: # Description of the properties used in this configuration: ################################################################################ # - Property BPXK_AUTOCVT must be configured to "ON"; e.g., _BPXK_AUTOCVT: "ON" -# - Property ZOAU_HOME is the ZOA Utilities install root path; e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" -# - Property PYTHONPATH is the ZOA Utilities Python library path; e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" +# - Property ZOAU_HOME is the Z Open Automation Utilities (ZOAU) install root path; +# e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" +# - Property PYTHONPATH is the Z Open Automation Utilities (ZOAU) Python library path; +# e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" # - Property LIBPATH is both the path to the Python libraries on the target -# and the ZOA Utilities Python library path separated by semi-colons; e.g., +# and the Z Open Automation Utilities (ZOAU) Python library path separated by semi-colons; e.g., # LIBPATH: "/usr/lpp/IBM/zoautil/lib/:/usr/lpp/IBM/cyp/v3r8/pyz/lib:/usr/lib:/lib:." # - Property PATH is the ZOA utilities BIN path and Python interpreter path, e.g., # PATH: "/usr/lpp/IBM/zoautil/bin:/usr/lpp/IBM/cyp/v3r8/pyz/bin:/bin" diff --git a/zos_concepts/jobs/submit_query_retrieve/inventories/host_vars/zos_host.yml b/zos_concepts/jobs/submit_query_retrieve/inventories/host_vars/zos_host.yml index cbf8614f2..d385e9ed8 100644 --- a/zos_concepts/jobs/submit_query_retrieve/inventories/host_vars/zos_host.yml +++ b/zos_concepts/jobs/submit_query_retrieve/inventories/host_vars/zos_host.yml @@ -1,25 +1,64 @@ --- ################################################################################ -# Copyright (c) IBM Corporation 2021 +# Copyright (c) IBM Corporation 2021, 2024 ################################################################################ ################################################################################ # Description of the properties used in this configuration: -# - Property `PYZ` is the python installation home path on the z/OS managed node (target), -# e.g, pyz: "/usr/lpp/IBM/cyp/v3r8/pyz" -# - Property `ZOAU` is the ZOAU installation home on the z/OS managed node (target), -# e.g, zoau: "/usr/lpp/IBM/zoautil" -# - property `ansible_python_interpreter` is the z/OS managed node (target) Python +# - Property `PYZ` is the python installation home path on the z/OS managed +# (target) node e.g, PYZ: "/usr/lpp/IBM/cyp/v3r12/pyz" +# - Property `PYZ_VERSION` is the version of python on the z/OS managed +# (target) node e.g, PYZ_VERSION: "3.12". +# - Property `ZOAU` is the ZOAU installation home on the z/OS managed (target) +# node, e.g, ZOAU: "/usr/lpp/IBM/zoautil". +# - Property `ZOAU_PYTHON_LIBRARY_PATH` is the path to the Z Open Automation +# Utilities (ZOAU) python library. Specifically, the path points to the +# directory containing 'zoautil_py'. Packages installed using 'pip' generally +# default to the 'site-packages' directory within the python installation, +# eg "/usr/lpp/IBM/cyp/v3r12/pyz/lib/python3.12/site-packages/". +# If the installation uses options such as '--user' or '--target', the module +# is installed to a non-default location which must be configured in +# `ZOAU_PYTHON_LIBRARY_PATH`. +# If the wheel installation method is used with the '--target' or '--user' +# option, `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory the wheel +# file was installed to. e.g ZOAU_PYTHON_LIBRARY_PATH: "/usr/zoau-wheel/". +# Else 'ZOAU_PYTHON_LIBRARY_PATH' should point to the directory containing +# the pre-compiled binary. +# For ZOAU v1.2.x, the pre-compiled binary is located in the 'lib' directory. +# e.g "/usr/lpp/IBM/zoautil/lib" or "{{ ZOAU }}/lib". +# For ZOAU v1.3.x, the pre-compiled binary is located in a sub-directory +# corresponding to the `PYZ_VERSION` inside the 'lib' directory, +# e.g "/usr/lpp/IBM/zoautil/lib/3.12" or "{{ ZOAU }}/lib/{{ PYZ_VERSION }}". +# - Property `ansible_python_interpreter` is the z/OS managed node (target) Python # binary installation path, e.g, ansible_python_interpreter: "{{PYZ}}/bin/python3" # -# Note, PYZ and ZOAU environment variables must be configured. +# Note, PYZ, PYZ_VERSION, and ZOAU environment variables must be configured. ################################################################################ PYZ: "path_to_python_installation_on_zos_target" +PYZ_VERSION: "3.xx" + ZOAU: "path_to_zoau_installation_on_zos_target" +# Configuring the `ZOAU_PYTHON_LIBRARY_PATH` property is required. + +# If the ZOAU python package, zoautil_py, has been installed as a wheel (*.whl) +# with the '--target' or '--user' option, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ path_to_wheel_installation_directory }}" + +# If the ZOAU python zoautil_py package has been installed in the default location +# that is part of Python's search path, the `ZOAU_PYTHON_LIBRARY_PATH` environment +# variable must be set as an empty string. Uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "" + +# If using pre-compiled binaries for ZOAU v1.3.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib/{{ PYZ_VERSION }}" + +# If using pre-compiled binaries for ZOAU v1.2.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib" + ################################################################################ -# Do not configure, variable substituion will correctly set the -# variable`ansible_python_interpreter` +# Do not configure, variable substitution will correctly set the +# variable `ansible_python_interpreter` ################################################################################ ansible_python_interpreter: "{{ PYZ }}/bin/python3" diff --git a/zos_concepts/program_authorization/git_apf/inventories/group_vars/all.yml b/zos_concepts/program_authorization/git_apf/inventories/group_vars/all.yml index a32cce2a3..767d93cc4 100644 --- a/zos_concepts/program_authorization/git_apf/inventories/group_vars/all.yml +++ b/zos_concepts/program_authorization/git_apf/inventories/group_vars/all.yml @@ -1,5 +1,5 @@ ################################################################################ -# Copyright (c) IBM Corporation 2020 +# Copyright (c) IBM Corporation 2020, 2024 ################################################################################ ################################################################################ @@ -9,7 +9,7 @@ environment_vars: _BPXK_AUTOCVT: "ON" ZOAU_HOME: "{{ ZOAU }}" - PYTHONPATH: "{{ ZOAU }}/lib" + PYTHONPATH: "{{ ZOAU_PYTHON_LIBRARY_PATH }}" LIBPATH: "{{ ZOAU }}/lib:{{ PYZ }}/lib:/lib:/usr/lib:." PATH: "{{ ZOAU }}/bin:{{ PYZ }}/bin:/bin:/var/bin" _CEE_RUNOPTS: "FILETAG(AUTOCVT,AUTOTAG) POSIX(ON)" @@ -23,10 +23,12 @@ environment_vars: # Description of the properties used in this configuration: ################################################################################ # - Property BPXK_AUTOCVT must be configured to "ON"; e.g., _BPXK_AUTOCVT: "ON" -# - Property ZOAU_HOME is the ZOA Utilities install root path; e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" -# - Property PYTHONPATH is the ZOA Utilities Python library path; e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" +# - Property ZOAU_HOME is the Z Open Automation Utilities (ZOAU) install root path; +# e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" +# - Property PYTHONPATH is the Z Open Automation Utilities (ZOAU) Python library path; +# e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" # - Property LIBPATH is both the path to the Python libraries on the target -# and the ZOA Utilities Python library path separated by semi-colons; e.g., +# and the Z Open Automation Utilities (ZOAU) Python library path separated by semi-colons; e.g., # LIBPATH: "/usr/lpp/IBM/zoautil/lib/:/usr/lpp/IBM/cyp/v3r8/pyz/lib:/usr/lib:/lib:." # - Property PATH is the ZOA utilities BIN path and Python interpreter path, e.g., # PATH: "/usr/lpp/IBM/zoautil/bin:/usr/lpp/IBM/cyp/v3r8/pyz/bin:/bin" diff --git a/zos_concepts/program_authorization/git_apf/inventories/host_vars/zos_host.yml b/zos_concepts/program_authorization/git_apf/inventories/host_vars/zos_host.yml index cbf8614f2..d52645747 100644 --- a/zos_concepts/program_authorization/git_apf/inventories/host_vars/zos_host.yml +++ b/zos_concepts/program_authorization/git_apf/inventories/host_vars/zos_host.yml @@ -1,25 +1,65 @@ --- ################################################################################ -# Copyright (c) IBM Corporation 2021 +# Copyright (c) IBM Corporation 2021, 2024 ################################################################################ ################################################################################ # Description of the properties used in this configuration: -# - Property `PYZ` is the python installation home path on the z/OS managed node (target), -# e.g, pyz: "/usr/lpp/IBM/cyp/v3r8/pyz" -# - Property `ZOAU` is the ZOAU installation home on the z/OS managed node (target), -# e.g, zoau: "/usr/lpp/IBM/zoautil" -# - property `ansible_python_interpreter` is the z/OS managed node (target) Python +# - Property `PYZ` is the python installation home path on the z/OS managed +# (target) node e.g, PYZ: "/usr/lpp/IBM/cyp/v3r12/pyz" +# - Property `PYZ_VERSION` is the version of python on the z/OS managed +# (target) node e.g, PYZ_VERSION: "3.12". +# - Property `ZOAU` is the ZOAU installation home on the z/OS managed (target) +# node, e.g, ZOAU: "/usr/lpp/IBM/zoautil". +# - Property `ZOAU_PYTHON_LIBRARY_PATH` is the path to the Z Open Automation +# Utilities (ZOAU) python library. Specifically, the path points to the +# directory containing 'zoautil_py'. Packages installed using 'pip' generally +# default to the 'site-packages' directory within the python installation, +# eg "/usr/lpp/IBM/cyp/v3r12/pyz/lib/python3.12/site-packages/". +# If the installation uses options such as '--user' or '--target', the module +# is installed to a non-default location which must be configured in +# `ZOAU_PYTHON_LIBRARY_PATH`. +# If the wheel installation method is used with the '--target' or '--user' +# option, `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory the wheel +# file was installed to. e.g ZOAU_PYTHON_LIBRARY_PATH: "/usr/zoau-wheel/". +# Else 'ZOAU_PYTHON_LIBRARY_PATH' should point to the directory containing +# the pre-compiled binary. +# For ZOAU v1.2.x, the pre-compiled binary is located in the 'lib' directory. +# e.g "/usr/lpp/IBM/zoautil/lib" or "{{ ZOAU }}/lib". +# For ZOAU v1.3.x, the pre-compiled binary is located in a sub-directory +# corresponding to the `PYZ_VERSION` inside the 'lib' directory, +# e.g "/usr/lpp/IBM/zoautil/lib/3.12" or "{{ ZOAU }}/lib/{{ PYZ_VERSION }}". +# - Property `ansible_python_interpreter` is the z/OS managed node (target) Python # binary installation path, e.g, ansible_python_interpreter: "{{PYZ}}/bin/python3" # -# Note, PYZ and ZOAU environment variables must be configured. +# Note, PYZ, PYZ_VERSION, and ZOAU environment variables must be configured. ################################################################################ PYZ: "path_to_python_installation_on_zos_target" +PYZ_VERSION: "3.xx" + ZOAU: "path_to_zoau_installation_on_zos_target" +# Configuring the `ZOAU_PYTHON_LIBRARY_PATH` property is required. + +# If the ZOAU python package, zoautil_py, has been installed as a wheel (*.whl) +# with the '--target' or '--user' option, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ path_to_wheel_installation_directory }}" + +# If the ZOAU python zoautil_py package has been installed in the default location +# that is part of Python's search path, the `ZOAU_PYTHON_LIBRARY_PATH` environment +# variable must be set as an empty string. Uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "" + +# If using pre-compiled binaries for ZOAU v1.3.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib/{{ PYZ_VERSION }}" + +# If using pre-compiled binaries for ZOAU v1.2.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib" + ################################################################################ -# Do not configure, variable substituion will correctly set the -# variable`ansible_python_interpreter` +# Do not configure, variable substitution will correctly set the +# variable `ansible_python_interpreter` ################################################################################ ansible_python_interpreter: "{{ PYZ }}/bin/python3" + diff --git a/zos_concepts/rest_apis/inventories/group_vars/all.yml b/zos_concepts/rest_apis/inventories/group_vars/all.yml index a32cce2a3..767d93cc4 100644 --- a/zos_concepts/rest_apis/inventories/group_vars/all.yml +++ b/zos_concepts/rest_apis/inventories/group_vars/all.yml @@ -1,5 +1,5 @@ ################################################################################ -# Copyright (c) IBM Corporation 2020 +# Copyright (c) IBM Corporation 2020, 2024 ################################################################################ ################################################################################ @@ -9,7 +9,7 @@ environment_vars: _BPXK_AUTOCVT: "ON" ZOAU_HOME: "{{ ZOAU }}" - PYTHONPATH: "{{ ZOAU }}/lib" + PYTHONPATH: "{{ ZOAU_PYTHON_LIBRARY_PATH }}" LIBPATH: "{{ ZOAU }}/lib:{{ PYZ }}/lib:/lib:/usr/lib:." PATH: "{{ ZOAU }}/bin:{{ PYZ }}/bin:/bin:/var/bin" _CEE_RUNOPTS: "FILETAG(AUTOCVT,AUTOTAG) POSIX(ON)" @@ -23,10 +23,12 @@ environment_vars: # Description of the properties used in this configuration: ################################################################################ # - Property BPXK_AUTOCVT must be configured to "ON"; e.g., _BPXK_AUTOCVT: "ON" -# - Property ZOAU_HOME is the ZOA Utilities install root path; e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" -# - Property PYTHONPATH is the ZOA Utilities Python library path; e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" +# - Property ZOAU_HOME is the Z Open Automation Utilities (ZOAU) install root path; +# e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" +# - Property PYTHONPATH is the Z Open Automation Utilities (ZOAU) Python library path; +# e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" # - Property LIBPATH is both the path to the Python libraries on the target -# and the ZOA Utilities Python library path separated by semi-colons; e.g., +# and the Z Open Automation Utilities (ZOAU) Python library path separated by semi-colons; e.g., # LIBPATH: "/usr/lpp/IBM/zoautil/lib/:/usr/lpp/IBM/cyp/v3r8/pyz/lib:/usr/lib:/lib:." # - Property PATH is the ZOA utilities BIN path and Python interpreter path, e.g., # PATH: "/usr/lpp/IBM/zoautil/bin:/usr/lpp/IBM/cyp/v3r8/pyz/bin:/bin" diff --git a/zos_concepts/rest_apis/inventories/host_vars/zos_host.yml b/zos_concepts/rest_apis/inventories/host_vars/zos_host.yml index cd76e4e35..8dbf722e4 100644 --- a/zos_concepts/rest_apis/inventories/host_vars/zos_host.yml +++ b/zos_concepts/rest_apis/inventories/host_vars/zos_host.yml @@ -1,6 +1,6 @@ --- ################################################################################ -# Copyright (c) IBM Corporation 2021 +# Copyright (c) IBM Corporation 2021, 2024 ################################################################################ ################################################################################ @@ -37,16 +37,62 @@ ZOSMF_SYSTEM: zosmf_system # Environment varibles ################################################################################ -# The python installation home path on the z/OS managed node (target), -# e.g, pyz: "/usr/lpp/IBM/cyp/v3r8/pyz" +################################################################################ +# Description of the properties used in this configuration: +# - Property `PYZ` is the python installation home path on the z/OS managed +# (target) node e.g, PYZ: "/usr/lpp/IBM/cyp/v3r12/pyz" +# - Property `PYZ_VERSION` is the version of python on the z/OS managed +# (target) node e.g, PYZ_VERSION: "3.12". +# - Property `ZOAU` is the ZOAU installation home on the z/OS managed (target) +# node, e.g, ZOAU: "/usr/lpp/IBM/zoautil". +# - Property `ZOAU_PYTHON_LIBRARY_PATH` is the path to the Z Open Automation +# Utilities (ZOAU) python library. Specifically, the path points to the +# directory containing 'zoautil_py'. Packages installed using 'pip' generally +# default to the 'site-packages' directory within the python installation, +# eg "/usr/lpp/IBM/cyp/v3r12/pyz/lib/python3.12/site-packages/". +# If the installation uses options such as '--user' or '--target', the module +# is installed to a non-default location which must be configured in +# `ZOAU_PYTHON_LIBRARY_PATH`. +# If the wheel installation method is used with the '--target' or '--user' +# option, `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory the wheel +# file was installed to. e.g ZOAU_PYTHON_LIBRARY_PATH: "/usr/zoau-wheel/". +# Else 'ZOAU_PYTHON_LIBRARY_PATH' should point to the directory containing +# the pre-compiled binary. +# For ZOAU v1.2.x, the pre-compiled binary is located in the 'lib' directory. +# e.g "/usr/lpp/IBM/zoautil/lib" or "{{ ZOAU }}/lib". +# For ZOAU v1.3.x, the pre-compiled binary is located in a sub-directory +# corresponding to the `PYZ_VERSION` inside the 'lib' directory, +# e.g "/usr/lpp/IBM/zoautil/lib/3.12" or "{{ ZOAU }}/lib/{{ PYZ_VERSION }}". +# - Property `ansible_python_interpreter` is the z/OS managed node (target) Python +# binary installation path, e.g, ansible_python_interpreter: "{{PYZ}}/bin/python3" +# +# Note, PYZ, PYZ_VERSION, and ZOAU environment variables must be configured. +################################################################################ + PYZ: "path_to_python_installation_on_zos_target" +PYZ_VERSION: "3.xx" -# The ZOAU installation home on the z/OS managed node (target), -# e.g, zoau: "/usr/lpp/IBM/zoautil" ZOAU: "path_to_zoau_installation_on_zos_target" -# The z/OS managed node (target) Python binary installation path, -# e.g, ansible_python_interpreter: "{{PYZ}}/bin/python3" -# NOTE: This needs not configuration because it uses variable substituion to -# correctly set the variable`ansible_python_interpreter` +# Configuring the `ZOAU_PYTHON_LIBRARY_PATH` property is required. + +# If the ZOAU python package, zoautil_py, has been installed as a wheel (*.whl) +# with the '--target' or '--user' option, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ path_to_wheel_installation_directory }}" + +# If the ZOAU python zoautil_py package has been installed in the default location +# that is part of Python's search path, the `ZOAU_PYTHON_LIBRARY_PATH` environment +# variable must be set as an empty string. Uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "" + +# If using pre-compiled binaries for ZOAU v1.3.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib/{{ PYZ_VERSION }}" + +# If using pre-compiled binaries for ZOAU v1.2.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib" + +################################################################################ +# Do not configure, variable substitution will correctly set the +# variable `ansible_python_interpreter` +################################################################################ ansible_python_interpreter: "{{ PYZ }}/bin/python3" diff --git a/zos_concepts/software_management/inventories/group_vars/all.yml b/zos_concepts/software_management/inventories/group_vars/all.yml index a32cce2a3..767d93cc4 100644 --- a/zos_concepts/software_management/inventories/group_vars/all.yml +++ b/zos_concepts/software_management/inventories/group_vars/all.yml @@ -1,5 +1,5 @@ ################################################################################ -# Copyright (c) IBM Corporation 2020 +# Copyright (c) IBM Corporation 2020, 2024 ################################################################################ ################################################################################ @@ -9,7 +9,7 @@ environment_vars: _BPXK_AUTOCVT: "ON" ZOAU_HOME: "{{ ZOAU }}" - PYTHONPATH: "{{ ZOAU }}/lib" + PYTHONPATH: "{{ ZOAU_PYTHON_LIBRARY_PATH }}" LIBPATH: "{{ ZOAU }}/lib:{{ PYZ }}/lib:/lib:/usr/lib:." PATH: "{{ ZOAU }}/bin:{{ PYZ }}/bin:/bin:/var/bin" _CEE_RUNOPTS: "FILETAG(AUTOCVT,AUTOTAG) POSIX(ON)" @@ -23,10 +23,12 @@ environment_vars: # Description of the properties used in this configuration: ################################################################################ # - Property BPXK_AUTOCVT must be configured to "ON"; e.g., _BPXK_AUTOCVT: "ON" -# - Property ZOAU_HOME is the ZOA Utilities install root path; e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" -# - Property PYTHONPATH is the ZOA Utilities Python library path; e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" +# - Property ZOAU_HOME is the Z Open Automation Utilities (ZOAU) install root path; +# e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" +# - Property PYTHONPATH is the Z Open Automation Utilities (ZOAU) Python library path; +# e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" # - Property LIBPATH is both the path to the Python libraries on the target -# and the ZOA Utilities Python library path separated by semi-colons; e.g., +# and the Z Open Automation Utilities (ZOAU) Python library path separated by semi-colons; e.g., # LIBPATH: "/usr/lpp/IBM/zoautil/lib/:/usr/lpp/IBM/cyp/v3r8/pyz/lib:/usr/lib:/lib:." # - Property PATH is the ZOA utilities BIN path and Python interpreter path, e.g., # PATH: "/usr/lpp/IBM/zoautil/bin:/usr/lpp/IBM/cyp/v3r8/pyz/bin:/bin" diff --git a/zos_concepts/software_management/inventories/host_vars/zos_host.yml b/zos_concepts/software_management/inventories/host_vars/zos_host.yml index cbf8614f2..d385e9ed8 100644 --- a/zos_concepts/software_management/inventories/host_vars/zos_host.yml +++ b/zos_concepts/software_management/inventories/host_vars/zos_host.yml @@ -1,25 +1,64 @@ --- ################################################################################ -# Copyright (c) IBM Corporation 2021 +# Copyright (c) IBM Corporation 2021, 2024 ################################################################################ ################################################################################ # Description of the properties used in this configuration: -# - Property `PYZ` is the python installation home path on the z/OS managed node (target), -# e.g, pyz: "/usr/lpp/IBM/cyp/v3r8/pyz" -# - Property `ZOAU` is the ZOAU installation home on the z/OS managed node (target), -# e.g, zoau: "/usr/lpp/IBM/zoautil" -# - property `ansible_python_interpreter` is the z/OS managed node (target) Python +# - Property `PYZ` is the python installation home path on the z/OS managed +# (target) node e.g, PYZ: "/usr/lpp/IBM/cyp/v3r12/pyz" +# - Property `PYZ_VERSION` is the version of python on the z/OS managed +# (target) node e.g, PYZ_VERSION: "3.12". +# - Property `ZOAU` is the ZOAU installation home on the z/OS managed (target) +# node, e.g, ZOAU: "/usr/lpp/IBM/zoautil". +# - Property `ZOAU_PYTHON_LIBRARY_PATH` is the path to the Z Open Automation +# Utilities (ZOAU) python library. Specifically, the path points to the +# directory containing 'zoautil_py'. Packages installed using 'pip' generally +# default to the 'site-packages' directory within the python installation, +# eg "/usr/lpp/IBM/cyp/v3r12/pyz/lib/python3.12/site-packages/". +# If the installation uses options such as '--user' or '--target', the module +# is installed to a non-default location which must be configured in +# `ZOAU_PYTHON_LIBRARY_PATH`. +# If the wheel installation method is used with the '--target' or '--user' +# option, `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory the wheel +# file was installed to. e.g ZOAU_PYTHON_LIBRARY_PATH: "/usr/zoau-wheel/". +# Else 'ZOAU_PYTHON_LIBRARY_PATH' should point to the directory containing +# the pre-compiled binary. +# For ZOAU v1.2.x, the pre-compiled binary is located in the 'lib' directory. +# e.g "/usr/lpp/IBM/zoautil/lib" or "{{ ZOAU }}/lib". +# For ZOAU v1.3.x, the pre-compiled binary is located in a sub-directory +# corresponding to the `PYZ_VERSION` inside the 'lib' directory, +# e.g "/usr/lpp/IBM/zoautil/lib/3.12" or "{{ ZOAU }}/lib/{{ PYZ_VERSION }}". +# - Property `ansible_python_interpreter` is the z/OS managed node (target) Python # binary installation path, e.g, ansible_python_interpreter: "{{PYZ}}/bin/python3" # -# Note, PYZ and ZOAU environment variables must be configured. +# Note, PYZ, PYZ_VERSION, and ZOAU environment variables must be configured. ################################################################################ PYZ: "path_to_python_installation_on_zos_target" +PYZ_VERSION: "3.xx" + ZOAU: "path_to_zoau_installation_on_zos_target" +# Configuring the `ZOAU_PYTHON_LIBRARY_PATH` property is required. + +# If the ZOAU python package, zoautil_py, has been installed as a wheel (*.whl) +# with the '--target' or '--user' option, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ path_to_wheel_installation_directory }}" + +# If the ZOAU python zoautil_py package has been installed in the default location +# that is part of Python's search path, the `ZOAU_PYTHON_LIBRARY_PATH` environment +# variable must be set as an empty string. Uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "" + +# If using pre-compiled binaries for ZOAU v1.3.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib/{{ PYZ_VERSION }}" + +# If using pre-compiled binaries for ZOAU v1.2.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib" + ################################################################################ -# Do not configure, variable substituion will correctly set the -# variable`ansible_python_interpreter` +# Do not configure, variable substitution will correctly set the +# variable `ansible_python_interpreter` ################################################################################ ansible_python_interpreter: "{{ PYZ }}/bin/python3" diff --git a/zos_concepts/templates/copy_template/inventories/group_vars/all.yml b/zos_concepts/templates/copy_template/inventories/group_vars/all.yml index af7a65f6c..fee532210 100644 --- a/zos_concepts/templates/copy_template/inventories/group_vars/all.yml +++ b/zos_concepts/templates/copy_template/inventories/group_vars/all.yml @@ -1,5 +1,5 @@ ################################################################################ -# Copyright (c) IBM Corporation 2023 +# Copyright (c) IBM Corporation 2023, 2024 ################################################################################ ################################################################################ @@ -9,7 +9,7 @@ environment_vars: _BPXK_AUTOCVT: "ON" ZOAU_HOME: "{{ ZOAU }}" - PYTHONPATH: "{{ ZOAU }}/lib" + PYTHONPATH: "{{ ZOAU_PYTHON_LIBRARY_PATH }}" LIBPATH: "{{ ZOAU }}/lib:{{ PYZ }}/lib:/lib:/usr/lib:." PATH: "{{ ZOAU }}/bin:{{ PYZ }}/bin:/bin:/var/bin" _CEE_RUNOPTS: "FILETAG(AUTOCVT,AUTOTAG) POSIX(ON)" @@ -23,10 +23,12 @@ environment_vars: # Description of the properties used in this configuration: ################################################################################ # - Property BPXK_AUTOCVT must be configured to "ON"; e.g., _BPXK_AUTOCVT: "ON" -# - Property ZOAU_HOME is the ZOA Utilities install root path; e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" -# - Property PYTHONPATH is the ZOA Utilities Python library path; e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" +# - Property ZOAU_HOME is the Z Open Automation Utilities (ZOAU) install root path; +# e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" +# - Property PYTHONPATH is the Z Open Automation Utilities (ZOAU) Python library path; +# e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" # - Property LIBPATH is both the path to the Python libraries on the target -# and the ZOA Utilities Python library path separated by semi-colons; e.g., +# and the Z Open Automation Utilities (ZOAU) Python library path separated by semi-colons; e.g., # LIBPATH: "/usr/lpp/IBM/zoautil/lib/:/usr/lpp/IBM/cyp/v3r8/pyz/lib:/usr/lib:/lib:." # - Property PATH is the ZOA utilities BIN path and Python interpreter path, e.g., # PATH: "/usr/lpp/IBM/zoautil/bin:/usr/lpp/IBM/cyp/v3r8/pyz/bin:/bin" diff --git a/zos_concepts/templates/copy_template/inventories/host_vars/zos_host.yml b/zos_concepts/templates/copy_template/inventories/host_vars/zos_host.yml index f9d4e5f81..0f5715762 100644 --- a/zos_concepts/templates/copy_template/inventories/host_vars/zos_host.yml +++ b/zos_concepts/templates/copy_template/inventories/host_vars/zos_host.yml @@ -1,25 +1,64 @@ --- ################################################################################ -# Copyright (c) IBM Corporation 2023 +# Copyright (c) IBM Corporation 2023, 2024 ################################################################################ ################################################################################ # Description of the properties used in this configuration: -# - Property `PYZ` is the python installation home path on the z/OS managed node (target), -# e.g, pyz: "/usr/lpp/IBM/cyp/v3r8/pyz" -# - Property `ZOAU` is the ZOAU installation home on the z/OS managed node (target), -# e.g, zoau: "/usr/lpp/IBM/zoautil" -# - property `ansible_python_interpreter` is the z/OS managed node (target) Python +# - Property `PYZ` is the python installation home path on the z/OS managed +# (target) node e.g, PYZ: "/usr/lpp/IBM/cyp/v3r12/pyz" +# - Property `PYZ_VERSION` is the version of python on the z/OS managed +# (target) node e.g, PYZ_VERSION: "3.12". +# - Property `ZOAU` is the ZOAU installation home on the z/OS managed (target) +# node, e.g, ZOAU: "/usr/lpp/IBM/zoautil". +# - Property `ZOAU_PYTHON_LIBRARY_PATH` is the path to the Z Open Automation +# Utilities (ZOAU) python library. Specifically, the path points to the +# directory containing 'zoautil_py'. Packages installed using 'pip' generally +# default to the 'site-packages' directory within the python installation, +# eg "/usr/lpp/IBM/cyp/v3r12/pyz/lib/python3.12/site-packages/". +# If the installation uses options such as '--user' or '--target', the module +# is installed to a non-default location which must be configured in +# `ZOAU_PYTHON_LIBRARY_PATH`. +# If the wheel installation method is used with the '--target' or '--user' +# option, `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory the wheel +# file was installed to. e.g ZOAU_PYTHON_LIBRARY_PATH: "/usr/zoau-wheel/". +# Else 'ZOAU_PYTHON_LIBRARY_PATH' should point to the directory containing +# the pre-compiled binary. +# For ZOAU v1.2.x, the pre-compiled binary is located in the 'lib' directory. +# e.g "/usr/lpp/IBM/zoautil/lib" or "{{ ZOAU }}/lib". +# For ZOAU v1.3.x, the pre-compiled binary is located in a sub-directory +# corresponding to the `PYZ_VERSION` inside the 'lib' directory, +# e.g "/usr/lpp/IBM/zoautil/lib/3.12" or "{{ ZOAU }}/lib/{{ PYZ_VERSION }}". +# - Property `ansible_python_interpreter` is the z/OS managed node (target) Python # binary installation path, e.g, ansible_python_interpreter: "{{PYZ}}/bin/python3" # -# Note, PYZ and ZOAU environment variables must be configured. +# Note, PYZ, PYZ_VERSION, and ZOAU environment variables must be configured. ################################################################################ PYZ: "path_to_python_installation_on_zos_target" +PYZ_VERSION: "3.xx" + ZOAU: "path_to_zoau_installation_on_zos_target" +# Configuring the `ZOAU_PYTHON_LIBRARY_PATH` property is required. + +# If the ZOAU python package, zoautil_py, has been installed as a wheel (*.whl) +# with the '--target' or '--user' option, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ path_to_wheel_installation_directory }}" + +# If the ZOAU python zoautil_py package has been installed in the default location +# that is part of Python's search path, the `ZOAU_PYTHON_LIBRARY_PATH` environment +# variable must be set as an empty string. Uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "" + +# If using pre-compiled binaries for ZOAU v1.3.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib/{{ PYZ_VERSION }}" + +# If using pre-compiled binaries for ZOAU v1.2.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib" + ################################################################################ # Do not configure, variable substitution will correctly set the -# variable`ansible_python_interpreter` +# variable `ansible_python_interpreter` ################################################################################ ansible_python_interpreter: "{{ PYZ }}/bin/python3" diff --git a/zos_concepts/templates/loadlib/inventories/group_vars/all.yml b/zos_concepts/templates/loadlib/inventories/group_vars/all.yml index af7a65f6c..fee532210 100644 --- a/zos_concepts/templates/loadlib/inventories/group_vars/all.yml +++ b/zos_concepts/templates/loadlib/inventories/group_vars/all.yml @@ -1,5 +1,5 @@ ################################################################################ -# Copyright (c) IBM Corporation 2023 +# Copyright (c) IBM Corporation 2023, 2024 ################################################################################ ################################################################################ @@ -9,7 +9,7 @@ environment_vars: _BPXK_AUTOCVT: "ON" ZOAU_HOME: "{{ ZOAU }}" - PYTHONPATH: "{{ ZOAU }}/lib" + PYTHONPATH: "{{ ZOAU_PYTHON_LIBRARY_PATH }}" LIBPATH: "{{ ZOAU }}/lib:{{ PYZ }}/lib:/lib:/usr/lib:." PATH: "{{ ZOAU }}/bin:{{ PYZ }}/bin:/bin:/var/bin" _CEE_RUNOPTS: "FILETAG(AUTOCVT,AUTOTAG) POSIX(ON)" @@ -23,10 +23,12 @@ environment_vars: # Description of the properties used in this configuration: ################################################################################ # - Property BPXK_AUTOCVT must be configured to "ON"; e.g., _BPXK_AUTOCVT: "ON" -# - Property ZOAU_HOME is the ZOA Utilities install root path; e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" -# - Property PYTHONPATH is the ZOA Utilities Python library path; e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" +# - Property ZOAU_HOME is the Z Open Automation Utilities (ZOAU) install root path; +# e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" +# - Property PYTHONPATH is the Z Open Automation Utilities (ZOAU) Python library path; +# e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" # - Property LIBPATH is both the path to the Python libraries on the target -# and the ZOA Utilities Python library path separated by semi-colons; e.g., +# and the Z Open Automation Utilities (ZOAU) Python library path separated by semi-colons; e.g., # LIBPATH: "/usr/lpp/IBM/zoautil/lib/:/usr/lpp/IBM/cyp/v3r8/pyz/lib:/usr/lib:/lib:." # - Property PATH is the ZOA utilities BIN path and Python interpreter path, e.g., # PATH: "/usr/lpp/IBM/zoautil/bin:/usr/lpp/IBM/cyp/v3r8/pyz/bin:/bin" diff --git a/zos_concepts/templates/loadlib/inventories/host_vars/zos_host.yml b/zos_concepts/templates/loadlib/inventories/host_vars/zos_host.yml index f9d4e5f81..b53850f3f 100644 --- a/zos_concepts/templates/loadlib/inventories/host_vars/zos_host.yml +++ b/zos_concepts/templates/loadlib/inventories/host_vars/zos_host.yml @@ -1,25 +1,65 @@ --- ################################################################################ -# Copyright (c) IBM Corporation 2023 +# Copyright (c) IBM Corporation 2023, 2024 ################################################################################ ################################################################################ # Description of the properties used in this configuration: -# - Property `PYZ` is the python installation home path on the z/OS managed node (target), -# e.g, pyz: "/usr/lpp/IBM/cyp/v3r8/pyz" -# - Property `ZOAU` is the ZOAU installation home on the z/OS managed node (target), -# e.g, zoau: "/usr/lpp/IBM/zoautil" -# - property `ansible_python_interpreter` is the z/OS managed node (target) Python +# - Property `PYZ` is the python installation home path on the z/OS managed +# (target) node e.g, PYZ: "/usr/lpp/IBM/cyp/v3r12/pyz" +# - Property `PYZ_VERSION` is the version of python on the z/OS managed +# (target) node e.g, PYZ_VERSION: "3.12". +# - Property `ZOAU` is the ZOAU installation home on the z/OS managed (target) +# node, e.g, ZOAU: "/usr/lpp/IBM/zoautil". +# - Property `ZOAU_PYTHON_LIBRARY_PATH` is the path to the Z Open Automation +# Utilities (ZOAU) python library. Specifically, the path points to the +# directory containing 'zoautil_py'. Packages installed using 'pip' generally +# default to the 'site-packages' directory within the python installation, +# eg "/usr/lpp/IBM/cyp/v3r12/pyz/lib/python3.12/site-packages/". +# If the installation uses options such as '--user' or '--target', the module +# is installed to a non-default location which must be configured in +# `ZOAU_PYTHON_LIBRARY_PATH`. +# If the wheel installation method is used with the '--target' or '--user' +# option, `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory the wheel +# file was installed to. e.g ZOAU_PYTHON_LIBRARY_PATH: "/usr/zoau-wheel/". +# Else 'ZOAU_PYTHON_LIBRARY_PATH' should point to the directory containing +# the pre-compiled binary. +# For ZOAU v1.2.x, the pre-compiled binary is located in the 'lib' directory. +# e.g "/usr/lpp/IBM/zoautil/lib" or "{{ ZOAU }}/lib". +# For ZOAU v1.3.x, the pre-compiled binary is located in a sub-directory +# corresponding to the `PYZ_VERSION` inside the 'lib' directory, +# e.g "/usr/lpp/IBM/zoautil/lib/3.12" or "{{ ZOAU }}/lib/{{ PYZ_VERSION }}". +# - Property `ansible_python_interpreter` is the z/OS managed node (target) Python # binary installation path, e.g, ansible_python_interpreter: "{{PYZ}}/bin/python3" # -# Note, PYZ and ZOAU environment variables must be configured. +# Note, PYZ, PYZ_VERSION, and ZOAU environment variables must be configured. ################################################################################ PYZ: "path_to_python_installation_on_zos_target" +PYZ_VERSION: "3.xx" + ZOAU: "path_to_zoau_installation_on_zos_target" +# Configuring the `ZOAU_PYTHON_LIBRARY_PATH` property is required. + +# If the ZOAU python package, zoautil_py, has been installed as a wheel (*.whl) +# with the '--target' or '--user' option, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ path_to_wheel_installation_directory }}" + +# If the ZOAU python zoautil_py package has been installed in the default location +# that is part of Python's search path, the `ZOAU_PYTHON_LIBRARY_PATH` environment +# variable must be set as an empty string. Uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "" + +# If using pre-compiled binaries for ZOAU v1.3.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib/{{ PYZ_VERSION }}" + +# If using pre-compiled binaries for ZOAU v1.2.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib" + ################################################################################ # Do not configure, variable substitution will correctly set the -# variable`ansible_python_interpreter` +# variable `ansible_python_interpreter` ################################################################################ ansible_python_interpreter: "{{ PYZ }}/bin/python3" + diff --git a/zos_concepts/templates/submit_job_template/inventories/group_vars/all.yml b/zos_concepts/templates/submit_job_template/inventories/group_vars/all.yml index af7a65f6c..fee532210 100644 --- a/zos_concepts/templates/submit_job_template/inventories/group_vars/all.yml +++ b/zos_concepts/templates/submit_job_template/inventories/group_vars/all.yml @@ -1,5 +1,5 @@ ################################################################################ -# Copyright (c) IBM Corporation 2023 +# Copyright (c) IBM Corporation 2023, 2024 ################################################################################ ################################################################################ @@ -9,7 +9,7 @@ environment_vars: _BPXK_AUTOCVT: "ON" ZOAU_HOME: "{{ ZOAU }}" - PYTHONPATH: "{{ ZOAU }}/lib" + PYTHONPATH: "{{ ZOAU_PYTHON_LIBRARY_PATH }}" LIBPATH: "{{ ZOAU }}/lib:{{ PYZ }}/lib:/lib:/usr/lib:." PATH: "{{ ZOAU }}/bin:{{ PYZ }}/bin:/bin:/var/bin" _CEE_RUNOPTS: "FILETAG(AUTOCVT,AUTOTAG) POSIX(ON)" @@ -23,10 +23,12 @@ environment_vars: # Description of the properties used in this configuration: ################################################################################ # - Property BPXK_AUTOCVT must be configured to "ON"; e.g., _BPXK_AUTOCVT: "ON" -# - Property ZOAU_HOME is the ZOA Utilities install root path; e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" -# - Property PYTHONPATH is the ZOA Utilities Python library path; e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" +# - Property ZOAU_HOME is the Z Open Automation Utilities (ZOAU) install root path; +# e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" +# - Property PYTHONPATH is the Z Open Automation Utilities (ZOAU) Python library path; +# e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" # - Property LIBPATH is both the path to the Python libraries on the target -# and the ZOA Utilities Python library path separated by semi-colons; e.g., +# and the Z Open Automation Utilities (ZOAU) Python library path separated by semi-colons; e.g., # LIBPATH: "/usr/lpp/IBM/zoautil/lib/:/usr/lpp/IBM/cyp/v3r8/pyz/lib:/usr/lib:/lib:." # - Property PATH is the ZOA utilities BIN path and Python interpreter path, e.g., # PATH: "/usr/lpp/IBM/zoautil/bin:/usr/lpp/IBM/cyp/v3r8/pyz/bin:/bin" diff --git a/zos_concepts/templates/submit_job_template/inventories/host_vars/zos_host.yml b/zos_concepts/templates/submit_job_template/inventories/host_vars/zos_host.yml index f9d4e5f81..0f5715762 100644 --- a/zos_concepts/templates/submit_job_template/inventories/host_vars/zos_host.yml +++ b/zos_concepts/templates/submit_job_template/inventories/host_vars/zos_host.yml @@ -1,25 +1,64 @@ --- ################################################################################ -# Copyright (c) IBM Corporation 2023 +# Copyright (c) IBM Corporation 2023, 2024 ################################################################################ ################################################################################ # Description of the properties used in this configuration: -# - Property `PYZ` is the python installation home path on the z/OS managed node (target), -# e.g, pyz: "/usr/lpp/IBM/cyp/v3r8/pyz" -# - Property `ZOAU` is the ZOAU installation home on the z/OS managed node (target), -# e.g, zoau: "/usr/lpp/IBM/zoautil" -# - property `ansible_python_interpreter` is the z/OS managed node (target) Python +# - Property `PYZ` is the python installation home path on the z/OS managed +# (target) node e.g, PYZ: "/usr/lpp/IBM/cyp/v3r12/pyz" +# - Property `PYZ_VERSION` is the version of python on the z/OS managed +# (target) node e.g, PYZ_VERSION: "3.12". +# - Property `ZOAU` is the ZOAU installation home on the z/OS managed (target) +# node, e.g, ZOAU: "/usr/lpp/IBM/zoautil". +# - Property `ZOAU_PYTHON_LIBRARY_PATH` is the path to the Z Open Automation +# Utilities (ZOAU) python library. Specifically, the path points to the +# directory containing 'zoautil_py'. Packages installed using 'pip' generally +# default to the 'site-packages' directory within the python installation, +# eg "/usr/lpp/IBM/cyp/v3r12/pyz/lib/python3.12/site-packages/". +# If the installation uses options such as '--user' or '--target', the module +# is installed to a non-default location which must be configured in +# `ZOAU_PYTHON_LIBRARY_PATH`. +# If the wheel installation method is used with the '--target' or '--user' +# option, `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory the wheel +# file was installed to. e.g ZOAU_PYTHON_LIBRARY_PATH: "/usr/zoau-wheel/". +# Else 'ZOAU_PYTHON_LIBRARY_PATH' should point to the directory containing +# the pre-compiled binary. +# For ZOAU v1.2.x, the pre-compiled binary is located in the 'lib' directory. +# e.g "/usr/lpp/IBM/zoautil/lib" or "{{ ZOAU }}/lib". +# For ZOAU v1.3.x, the pre-compiled binary is located in a sub-directory +# corresponding to the `PYZ_VERSION` inside the 'lib' directory, +# e.g "/usr/lpp/IBM/zoautil/lib/3.12" or "{{ ZOAU }}/lib/{{ PYZ_VERSION }}". +# - Property `ansible_python_interpreter` is the z/OS managed node (target) Python # binary installation path, e.g, ansible_python_interpreter: "{{PYZ}}/bin/python3" # -# Note, PYZ and ZOAU environment variables must be configured. +# Note, PYZ, PYZ_VERSION, and ZOAU environment variables must be configured. ################################################################################ PYZ: "path_to_python_installation_on_zos_target" +PYZ_VERSION: "3.xx" + ZOAU: "path_to_zoau_installation_on_zos_target" +# Configuring the `ZOAU_PYTHON_LIBRARY_PATH` property is required. + +# If the ZOAU python package, zoautil_py, has been installed as a wheel (*.whl) +# with the '--target' or '--user' option, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ path_to_wheel_installation_directory }}" + +# If the ZOAU python zoautil_py package has been installed in the default location +# that is part of Python's search path, the `ZOAU_PYTHON_LIBRARY_PATH` environment +# variable must be set as an empty string. Uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "" + +# If using pre-compiled binaries for ZOAU v1.3.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib/{{ PYZ_VERSION }}" + +# If using pre-compiled binaries for ZOAU v1.2.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib" + ################################################################################ # Do not configure, variable substitution will correctly set the -# variable`ansible_python_interpreter` +# variable `ansible_python_interpreter` ################################################################################ ansible_python_interpreter: "{{ PYZ }}/bin/python3" diff --git a/zos_concepts/tso_commands/scripts/inventories/group_vars/all.yml b/zos_concepts/tso_commands/scripts/inventories/group_vars/all.yml index af7a65f6c..fee532210 100644 --- a/zos_concepts/tso_commands/scripts/inventories/group_vars/all.yml +++ b/zos_concepts/tso_commands/scripts/inventories/group_vars/all.yml @@ -1,5 +1,5 @@ ################################################################################ -# Copyright (c) IBM Corporation 2023 +# Copyright (c) IBM Corporation 2023, 2024 ################################################################################ ################################################################################ @@ -9,7 +9,7 @@ environment_vars: _BPXK_AUTOCVT: "ON" ZOAU_HOME: "{{ ZOAU }}" - PYTHONPATH: "{{ ZOAU }}/lib" + PYTHONPATH: "{{ ZOAU_PYTHON_LIBRARY_PATH }}" LIBPATH: "{{ ZOAU }}/lib:{{ PYZ }}/lib:/lib:/usr/lib:." PATH: "{{ ZOAU }}/bin:{{ PYZ }}/bin:/bin:/var/bin" _CEE_RUNOPTS: "FILETAG(AUTOCVT,AUTOTAG) POSIX(ON)" @@ -23,10 +23,12 @@ environment_vars: # Description of the properties used in this configuration: ################################################################################ # - Property BPXK_AUTOCVT must be configured to "ON"; e.g., _BPXK_AUTOCVT: "ON" -# - Property ZOAU_HOME is the ZOA Utilities install root path; e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" -# - Property PYTHONPATH is the ZOA Utilities Python library path; e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" +# - Property ZOAU_HOME is the Z Open Automation Utilities (ZOAU) install root path; +# e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" +# - Property PYTHONPATH is the Z Open Automation Utilities (ZOAU) Python library path; +# e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" # - Property LIBPATH is both the path to the Python libraries on the target -# and the ZOA Utilities Python library path separated by semi-colons; e.g., +# and the Z Open Automation Utilities (ZOAU) Python library path separated by semi-colons; e.g., # LIBPATH: "/usr/lpp/IBM/zoautil/lib/:/usr/lpp/IBM/cyp/v3r8/pyz/lib:/usr/lib:/lib:." # - Property PATH is the ZOA utilities BIN path and Python interpreter path, e.g., # PATH: "/usr/lpp/IBM/zoautil/bin:/usr/lpp/IBM/cyp/v3r8/pyz/bin:/bin" diff --git a/zos_concepts/tso_commands/scripts/inventories/host_vars/zos_host.yml b/zos_concepts/tso_commands/scripts/inventories/host_vars/zos_host.yml index f9d4e5f81..0f5715762 100644 --- a/zos_concepts/tso_commands/scripts/inventories/host_vars/zos_host.yml +++ b/zos_concepts/tso_commands/scripts/inventories/host_vars/zos_host.yml @@ -1,25 +1,64 @@ --- ################################################################################ -# Copyright (c) IBM Corporation 2023 +# Copyright (c) IBM Corporation 2023, 2024 ################################################################################ ################################################################################ # Description of the properties used in this configuration: -# - Property `PYZ` is the python installation home path on the z/OS managed node (target), -# e.g, pyz: "/usr/lpp/IBM/cyp/v3r8/pyz" -# - Property `ZOAU` is the ZOAU installation home on the z/OS managed node (target), -# e.g, zoau: "/usr/lpp/IBM/zoautil" -# - property `ansible_python_interpreter` is the z/OS managed node (target) Python +# - Property `PYZ` is the python installation home path on the z/OS managed +# (target) node e.g, PYZ: "/usr/lpp/IBM/cyp/v3r12/pyz" +# - Property `PYZ_VERSION` is the version of python on the z/OS managed +# (target) node e.g, PYZ_VERSION: "3.12". +# - Property `ZOAU` is the ZOAU installation home on the z/OS managed (target) +# node, e.g, ZOAU: "/usr/lpp/IBM/zoautil". +# - Property `ZOAU_PYTHON_LIBRARY_PATH` is the path to the Z Open Automation +# Utilities (ZOAU) python library. Specifically, the path points to the +# directory containing 'zoautil_py'. Packages installed using 'pip' generally +# default to the 'site-packages' directory within the python installation, +# eg "/usr/lpp/IBM/cyp/v3r12/pyz/lib/python3.12/site-packages/". +# If the installation uses options such as '--user' or '--target', the module +# is installed to a non-default location which must be configured in +# `ZOAU_PYTHON_LIBRARY_PATH`. +# If the wheel installation method is used with the '--target' or '--user' +# option, `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory the wheel +# file was installed to. e.g ZOAU_PYTHON_LIBRARY_PATH: "/usr/zoau-wheel/". +# Else 'ZOAU_PYTHON_LIBRARY_PATH' should point to the directory containing +# the pre-compiled binary. +# For ZOAU v1.2.x, the pre-compiled binary is located in the 'lib' directory. +# e.g "/usr/lpp/IBM/zoautil/lib" or "{{ ZOAU }}/lib". +# For ZOAU v1.3.x, the pre-compiled binary is located in a sub-directory +# corresponding to the `PYZ_VERSION` inside the 'lib' directory, +# e.g "/usr/lpp/IBM/zoautil/lib/3.12" or "{{ ZOAU }}/lib/{{ PYZ_VERSION }}". +# - Property `ansible_python_interpreter` is the z/OS managed node (target) Python # binary installation path, e.g, ansible_python_interpreter: "{{PYZ}}/bin/python3" # -# Note, PYZ and ZOAU environment variables must be configured. +# Note, PYZ, PYZ_VERSION, and ZOAU environment variables must be configured. ################################################################################ PYZ: "path_to_python_installation_on_zos_target" +PYZ_VERSION: "3.xx" + ZOAU: "path_to_zoau_installation_on_zos_target" +# Configuring the `ZOAU_PYTHON_LIBRARY_PATH` property is required. + +# If the ZOAU python package, zoautil_py, has been installed as a wheel (*.whl) +# with the '--target' or '--user' option, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ path_to_wheel_installation_directory }}" + +# If the ZOAU python zoautil_py package has been installed in the default location +# that is part of Python's search path, the `ZOAU_PYTHON_LIBRARY_PATH` environment +# variable must be set as an empty string. Uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "" + +# If using pre-compiled binaries for ZOAU v1.3.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib/{{ PYZ_VERSION }}" + +# If using pre-compiled binaries for ZOAU v1.2.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib" + ################################################################################ # Do not configure, variable substitution will correctly set the -# variable`ansible_python_interpreter` +# variable `ansible_python_interpreter` ################################################################################ ansible_python_interpreter: "{{ PYZ }}/bin/python3" diff --git a/zos_concepts/user_management/add_remove_user/inventories/group_vars/all.yml b/zos_concepts/user_management/add_remove_user/inventories/group_vars/all.yml index a32cce2a3..767d93cc4 100644 --- a/zos_concepts/user_management/add_remove_user/inventories/group_vars/all.yml +++ b/zos_concepts/user_management/add_remove_user/inventories/group_vars/all.yml @@ -1,5 +1,5 @@ ################################################################################ -# Copyright (c) IBM Corporation 2020 +# Copyright (c) IBM Corporation 2020, 2024 ################################################################################ ################################################################################ @@ -9,7 +9,7 @@ environment_vars: _BPXK_AUTOCVT: "ON" ZOAU_HOME: "{{ ZOAU }}" - PYTHONPATH: "{{ ZOAU }}/lib" + PYTHONPATH: "{{ ZOAU_PYTHON_LIBRARY_PATH }}" LIBPATH: "{{ ZOAU }}/lib:{{ PYZ }}/lib:/lib:/usr/lib:." PATH: "{{ ZOAU }}/bin:{{ PYZ }}/bin:/bin:/var/bin" _CEE_RUNOPTS: "FILETAG(AUTOCVT,AUTOTAG) POSIX(ON)" @@ -23,10 +23,12 @@ environment_vars: # Description of the properties used in this configuration: ################################################################################ # - Property BPXK_AUTOCVT must be configured to "ON"; e.g., _BPXK_AUTOCVT: "ON" -# - Property ZOAU_HOME is the ZOA Utilities install root path; e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" -# - Property PYTHONPATH is the ZOA Utilities Python library path; e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" +# - Property ZOAU_HOME is the Z Open Automation Utilities (ZOAU) install root path; +# e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" +# - Property PYTHONPATH is the Z Open Automation Utilities (ZOAU) Python library path; +# e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" # - Property LIBPATH is both the path to the Python libraries on the target -# and the ZOA Utilities Python library path separated by semi-colons; e.g., +# and the Z Open Automation Utilities (ZOAU) Python library path separated by semi-colons; e.g., # LIBPATH: "/usr/lpp/IBM/zoautil/lib/:/usr/lpp/IBM/cyp/v3r8/pyz/lib:/usr/lib:/lib:." # - Property PATH is the ZOA utilities BIN path and Python interpreter path, e.g., # PATH: "/usr/lpp/IBM/zoautil/bin:/usr/lpp/IBM/cyp/v3r8/pyz/bin:/bin" diff --git a/zos_concepts/user_management/add_remove_user/inventories/host_vars/zos_host.yml b/zos_concepts/user_management/add_remove_user/inventories/host_vars/zos_host.yml index cbf8614f2..d385e9ed8 100644 --- a/zos_concepts/user_management/add_remove_user/inventories/host_vars/zos_host.yml +++ b/zos_concepts/user_management/add_remove_user/inventories/host_vars/zos_host.yml @@ -1,25 +1,64 @@ --- ################################################################################ -# Copyright (c) IBM Corporation 2021 +# Copyright (c) IBM Corporation 2021, 2024 ################################################################################ ################################################################################ # Description of the properties used in this configuration: -# - Property `PYZ` is the python installation home path on the z/OS managed node (target), -# e.g, pyz: "/usr/lpp/IBM/cyp/v3r8/pyz" -# - Property `ZOAU` is the ZOAU installation home on the z/OS managed node (target), -# e.g, zoau: "/usr/lpp/IBM/zoautil" -# - property `ansible_python_interpreter` is the z/OS managed node (target) Python +# - Property `PYZ` is the python installation home path on the z/OS managed +# (target) node e.g, PYZ: "/usr/lpp/IBM/cyp/v3r12/pyz" +# - Property `PYZ_VERSION` is the version of python on the z/OS managed +# (target) node e.g, PYZ_VERSION: "3.12". +# - Property `ZOAU` is the ZOAU installation home on the z/OS managed (target) +# node, e.g, ZOAU: "/usr/lpp/IBM/zoautil". +# - Property `ZOAU_PYTHON_LIBRARY_PATH` is the path to the Z Open Automation +# Utilities (ZOAU) python library. Specifically, the path points to the +# directory containing 'zoautil_py'. Packages installed using 'pip' generally +# default to the 'site-packages' directory within the python installation, +# eg "/usr/lpp/IBM/cyp/v3r12/pyz/lib/python3.12/site-packages/". +# If the installation uses options such as '--user' or '--target', the module +# is installed to a non-default location which must be configured in +# `ZOAU_PYTHON_LIBRARY_PATH`. +# If the wheel installation method is used with the '--target' or '--user' +# option, `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory the wheel +# file was installed to. e.g ZOAU_PYTHON_LIBRARY_PATH: "/usr/zoau-wheel/". +# Else 'ZOAU_PYTHON_LIBRARY_PATH' should point to the directory containing +# the pre-compiled binary. +# For ZOAU v1.2.x, the pre-compiled binary is located in the 'lib' directory. +# e.g "/usr/lpp/IBM/zoautil/lib" or "{{ ZOAU }}/lib". +# For ZOAU v1.3.x, the pre-compiled binary is located in a sub-directory +# corresponding to the `PYZ_VERSION` inside the 'lib' directory, +# e.g "/usr/lpp/IBM/zoautil/lib/3.12" or "{{ ZOAU }}/lib/{{ PYZ_VERSION }}". +# - Property `ansible_python_interpreter` is the z/OS managed node (target) Python # binary installation path, e.g, ansible_python_interpreter: "{{PYZ}}/bin/python3" # -# Note, PYZ and ZOAU environment variables must be configured. +# Note, PYZ, PYZ_VERSION, and ZOAU environment variables must be configured. ################################################################################ PYZ: "path_to_python_installation_on_zos_target" +PYZ_VERSION: "3.xx" + ZOAU: "path_to_zoau_installation_on_zos_target" +# Configuring the `ZOAU_PYTHON_LIBRARY_PATH` property is required. + +# If the ZOAU python package, zoautil_py, has been installed as a wheel (*.whl) +# with the '--target' or '--user' option, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ path_to_wheel_installation_directory }}" + +# If the ZOAU python zoautil_py package has been installed in the default location +# that is part of Python's search path, the `ZOAU_PYTHON_LIBRARY_PATH` environment +# variable must be set as an empty string. Uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "" + +# If using pre-compiled binaries for ZOAU v1.3.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib/{{ PYZ_VERSION }}" + +# If using pre-compiled binaries for ZOAU v1.2.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib" + ################################################################################ -# Do not configure, variable substituion will correctly set the -# variable`ansible_python_interpreter` +# Do not configure, variable substitution will correctly set the +# variable `ansible_python_interpreter` ################################################################################ ansible_python_interpreter: "{{ PYZ }}/bin/python3" diff --git a/zos_concepts/volume_management/volume_initialization/init_dasd_vol_and_run_sample_jcl/inventories/group_vars/all.yml b/zos_concepts/volume_management/volume_initialization/init_dasd_vol_and_run_sample_jcl/inventories/group_vars/all.yml index a8bac3e5a..293bb24ed 100644 --- a/zos_concepts/volume_management/volume_initialization/init_dasd_vol_and_run_sample_jcl/inventories/group_vars/all.yml +++ b/zos_concepts/volume_management/volume_initialization/init_dasd_vol_and_run_sample_jcl/inventories/group_vars/all.yml @@ -1,5 +1,5 @@ ################################################################################ -# Copyright (c) IBM Corporation 2023 +# Copyright (c) IBM Corporation 2023, 2024 ################################################################################ ################################################################################ @@ -9,7 +9,7 @@ environment_vars: _BPXK_AUTOCVT: "ON" ZOAU_HOME: "{{ ZOAU }}" - PYTHONPATH: "{{ ZOAU }}/lib" + PYTHONPATH: "{{ ZOAU_PYTHON_LIBRARY_PATH }}" LIBPATH: "{{ ZOAU }}/lib:{{ PYZ }}/lib:/lib:/usr/lib:." PATH: "{{ ZOAU }}/bin:{{ PYZ }}/bin:/bin:/var/bin" _CEE_RUNOPTS: "FILETAG(AUTOCVT,AUTOTAG) POSIX(ON)" @@ -23,10 +23,12 @@ environment_vars: # Description of the properties used in this configuration: ################################################################################ # - Property BPXK_AUTOCVT must be configured to "ON"; e.g., _BPXK_AUTOCVT: "ON" -# - Property ZOAU_HOME is the ZOA Utilities install root path; e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" -# - Property PYTHONPATH is the ZOA Utilities Python library path; e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" +# - Property ZOAU_HOME is the Z Open Automation Utilities (ZOAU) install root path; +# e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" +# - Property PYTHONPATH is the Z Open Automation Utilities (ZOAU) Python library path; +# e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" # - Property LIBPATH is both the path to the Python libraries on the target -# and the ZOA Utilities Python library path separated by semi-colons; e.g., +# and the Z Open Automation Utilities (ZOAU) Python library path separated by semi-colons; e.g., # LIBPATH: "/usr/lpp/IBM/zoautil/lib/:/usr/lpp/IBM/cyp/v3r8/pyz/lib:/usr/lib:/lib:." # - Property PATH is the ZOA utilities BIN path and Python interpreter path, e.g., # PATH: "/usr/lpp/IBM/zoautil/bin:/usr/lpp/IBM/cyp/v3r8/pyz/bin:/bin" diff --git a/zos_concepts/volume_management/volume_initialization/init_dasd_vol_and_run_sample_jcl/inventories/host_vars/zos_host.yml b/zos_concepts/volume_management/volume_initialization/init_dasd_vol_and_run_sample_jcl/inventories/host_vars/zos_host.yml index e9898e9e7..b53850f3f 100644 --- a/zos_concepts/volume_management/volume_initialization/init_dasd_vol_and_run_sample_jcl/inventories/host_vars/zos_host.yml +++ b/zos_concepts/volume_management/volume_initialization/init_dasd_vol_and_run_sample_jcl/inventories/host_vars/zos_host.yml @@ -1,25 +1,65 @@ --- ################################################################################ -# Copyright (c) IBM Corporation 2023 +# Copyright (c) IBM Corporation 2023, 2024 ################################################################################ ################################################################################ # Description of the properties used in this configuration: -# - Property `PYZ` is the python installation home path on the z/OS managed node (target), -# e.g, pyz: "/usr/lpp/IBM/cyp/v3r8/pyz" -# - Property `ZOAU` is the ZOAU installation home on the z/OS managed node (target), -# e.g, zoau: "/usr/lpp/IBM/zoautil" -# - property `ansible_python_interpreter` is the z/OS managed node (target) Python -# binary installation path, e.g, ansible_python_interpreter: "{{PYZ}}/bin/python3.8" +# - Property `PYZ` is the python installation home path on the z/OS managed +# (target) node e.g, PYZ: "/usr/lpp/IBM/cyp/v3r12/pyz" +# - Property `PYZ_VERSION` is the version of python on the z/OS managed +# (target) node e.g, PYZ_VERSION: "3.12". +# - Property `ZOAU` is the ZOAU installation home on the z/OS managed (target) +# node, e.g, ZOAU: "/usr/lpp/IBM/zoautil". +# - Property `ZOAU_PYTHON_LIBRARY_PATH` is the path to the Z Open Automation +# Utilities (ZOAU) python library. Specifically, the path points to the +# directory containing 'zoautil_py'. Packages installed using 'pip' generally +# default to the 'site-packages' directory within the python installation, +# eg "/usr/lpp/IBM/cyp/v3r12/pyz/lib/python3.12/site-packages/". +# If the installation uses options such as '--user' or '--target', the module +# is installed to a non-default location which must be configured in +# `ZOAU_PYTHON_LIBRARY_PATH`. +# If the wheel installation method is used with the '--target' or '--user' +# option, `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory the wheel +# file was installed to. e.g ZOAU_PYTHON_LIBRARY_PATH: "/usr/zoau-wheel/". +# Else 'ZOAU_PYTHON_LIBRARY_PATH' should point to the directory containing +# the pre-compiled binary. +# For ZOAU v1.2.x, the pre-compiled binary is located in the 'lib' directory. +# e.g "/usr/lpp/IBM/zoautil/lib" or "{{ ZOAU }}/lib". +# For ZOAU v1.3.x, the pre-compiled binary is located in a sub-directory +# corresponding to the `PYZ_VERSION` inside the 'lib' directory, +# e.g "/usr/lpp/IBM/zoautil/lib/3.12" or "{{ ZOAU }}/lib/{{ PYZ_VERSION }}". +# - Property `ansible_python_interpreter` is the z/OS managed node (target) Python +# binary installation path, e.g, ansible_python_interpreter: "{{PYZ}}/bin/python3" # -# Note, PYZ and ZOAU environment variables must be configured. +# Note, PYZ, PYZ_VERSION, and ZOAU environment variables must be configured. ################################################################################ PYZ: "path_to_python_installation_on_zos_target" +PYZ_VERSION: "3.xx" + ZOAU: "path_to_zoau_installation_on_zos_target" +# Configuring the `ZOAU_PYTHON_LIBRARY_PATH` property is required. + +# If the ZOAU python package, zoautil_py, has been installed as a wheel (*.whl) +# with the '--target' or '--user' option, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ path_to_wheel_installation_directory }}" + +# If the ZOAU python zoautil_py package has been installed in the default location +# that is part of Python's search path, the `ZOAU_PYTHON_LIBRARY_PATH` environment +# variable must be set as an empty string. Uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "" + +# If using pre-compiled binaries for ZOAU v1.3.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib/{{ PYZ_VERSION }}" + +# If using pre-compiled binaries for ZOAU v1.2.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib" + ################################################################################ -# Do not configure, variable substituion will correctly set the -# variable`ansible_python_interpreter` +# Do not configure, variable substitution will correctly set the +# variable `ansible_python_interpreter` ################################################################################ -ansible_python_interpreter: "{{ PYZ }}/bin/python3.8" +ansible_python_interpreter: "{{ PYZ }}/bin/python3" + diff --git a/zos_concepts/zfsadm/zfs_grow_aggr/inventories/group_vars/all.yml b/zos_concepts/zfsadm/zfs_grow_aggr/inventories/group_vars/all.yml index c1c99b8c2..43d9377be 100644 --- a/zos_concepts/zfsadm/zfs_grow_aggr/inventories/group_vars/all.yml +++ b/zos_concepts/zfsadm/zfs_grow_aggr/inventories/group_vars/all.yml @@ -1,5 +1,5 @@ ################################################################################ -# Copyright (c) IBM Corporation 2022 +# Copyright (c) IBM Corporation 2022, 2024 ################################################################################ ################################################################################ @@ -9,7 +9,7 @@ environment_vars: _BPXK_AUTOCVT: "ON" ZOAU_HOME: "{{ ZOAU }}" - PYTHONPATH: "{{ ZOAU }}/lib" + PYTHONPATH: "{{ ZOAU_PYTHON_LIBRARY_PATH }}" LIBPATH: "{{ ZOAU }}/lib:{{ PYZ }}/lib:/lib:/usr/lib:." PATH: "{{ ZOAU }}/bin:{{ PYZ }}/bin:/bin:/var/bin" _CEE_RUNOPTS: "FILETAG(AUTOCVT,AUTOTAG) POSIX(ON)" @@ -23,10 +23,12 @@ environment_vars: # Description of the properties used in this configuration: ################################################################################ # - Property BPXK_AUTOCVT must be configured to "ON"; e.g., _BPXK_AUTOCVT: "ON" -# - Property ZOAU_HOME is the ZOA Utilities install root path; e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" -# - Property PYTHONPATH is the ZOA Utilities Python library path; e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" +# - Property ZOAU_HOME is the Z Open Automation Utilities (ZOAU) install root path; +# e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" +# - Property PYTHONPATH is the Z Open Automation Utilities (ZOAU) Python library path; +# e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" # - Property LIBPATH is both the path to the Python libraries on the target -# and the ZOA Utilities Python library path separated by semi-colons; e.g., +# and the Z Open Automation Utilities (ZOAU) Python library path separated by semi-colons; e.g., # LIBPATH: "/usr/lpp/IBM/zoautil/lib/:/usr/lpp/IBM/cyp/v3r8/pyz/lib:/usr/lib:/lib:." # - Property PATH is the ZOA utilities BIN path and Python interpreter path, e.g., # PATH: "/usr/lpp/IBM/zoautil/bin:/usr/lpp/IBM/cyp/v3r8/pyz/bin:/bin" diff --git a/zos_concepts/zfsadm/zfs_grow_aggr/inventories/host_vars/zos_host.yml b/zos_concepts/zfsadm/zfs_grow_aggr/inventories/host_vars/zos_host.yml index f59f2c3f3..331e3fb9f 100644 --- a/zos_concepts/zfsadm/zfs_grow_aggr/inventories/host_vars/zos_host.yml +++ b/zos_concepts/zfsadm/zfs_grow_aggr/inventories/host_vars/zos_host.yml @@ -1,25 +1,64 @@ --- ################################################################################ -# Copyright (c) IBM Corporation 2022 +# Copyright (c) IBM Corporation 2022, 2024 ################################################################################ ################################################################################ # Description of the properties used in this configuration: -# - Property `PYZ` is the python installation home path on the z/OS managed node (target), -# e.g, pyz: "/usr/lpp/IBM/cyp/v3r8/pyz" -# - Property `ZOAU` is the ZOAU installation home on the z/OS managed node (target), -# e.g, zoau: "/usr/lpp/IBM/zoautil" -# - property `ansible_python_interpreter` is the z/OS managed node (target) Python +# - Property `PYZ` is the python installation home path on the z/OS managed +# (target) node e.g, PYZ: "/usr/lpp/IBM/cyp/v3r12/pyz" +# - Property `PYZ_VERSION` is the version of python on the z/OS managed +# (target) node e.g, PYZ_VERSION: "3.12". +# - Property `ZOAU` is the ZOAU installation home on the z/OS managed (target) +# node, e.g, ZOAU: "/usr/lpp/IBM/zoautil". +# - Property `ZOAU_PYTHON_LIBRARY_PATH` is the path to the Z Open Automation +# Utilities (ZOAU) python library. Specifically, the path points to the +# directory containing 'zoautil_py'. Packages installed using 'pip' generally +# default to the 'site-packages' directory within the python installation, +# eg "/usr/lpp/IBM/cyp/v3r12/pyz/lib/python3.12/site-packages/". +# If the installation uses options such as '--user' or '--target', the module +# is installed to a non-default location which must be configured in +# `ZOAU_PYTHON_LIBRARY_PATH`. +# If the wheel installation method is used with the '--target' or '--user' +# option, `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory the wheel +# file was installed to. e.g ZOAU_PYTHON_LIBRARY_PATH: "/usr/zoau-wheel/". +# Else 'ZOAU_PYTHON_LIBRARY_PATH' should point to the directory containing +# the pre-compiled binary. +# For ZOAU v1.2.x, the pre-compiled binary is located in the 'lib' directory. +# e.g "/usr/lpp/IBM/zoautil/lib" or "{{ ZOAU }}/lib". +# For ZOAU v1.3.x, the pre-compiled binary is located in a sub-directory +# corresponding to the `PYZ_VERSION` inside the 'lib' directory, +# e.g "/usr/lpp/IBM/zoautil/lib/3.12" or "{{ ZOAU }}/lib/{{ PYZ_VERSION }}". +# - Property `ansible_python_interpreter` is the z/OS managed node (target) Python # binary installation path, e.g, ansible_python_interpreter: "{{PYZ}}/bin/python3" # -# Note, PYZ and ZOAU environment variables must be configured. +# Note, PYZ, PYZ_VERSION, and ZOAU environment variables must be configured. ################################################################################ PYZ: "path_to_python_installation_on_zos_target" +PYZ_VERSION: "3.xx" + ZOAU: "path_to_zoau_installation_on_zos_target" +# Configuring the `ZOAU_PYTHON_LIBRARY_PATH` property is required. + +# If the ZOAU python package, zoautil_py, has been installed as a wheel (*.whl) +# with the '--target' or '--user' option, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ path_to_wheel_installation_directory }}" + +# If the ZOAU python zoautil_py package has been installed in the default location +# that is part of Python's search path, the `ZOAU_PYTHON_LIBRARY_PATH` environment +# variable must be set as an empty string. Uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "" + +# If using pre-compiled binaries for ZOAU v1.3.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib/{{ PYZ_VERSION }}" + +# If using pre-compiled binaries for ZOAU v1.2.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib" + ################################################################################ -# Do not configure, variable substituion will correctly set the -# variable`ansible_python_interpreter` +# Do not configure, variable substitution will correctly set the +# variable `ansible_python_interpreter` ################################################################################ ansible_python_interpreter: "{{ PYZ }}/bin/python3" diff --git a/zos_concepts/zos_operator/zos_operator_basics/inventories/group_vars/all.yml b/zos_concepts/zos_operator/zos_operator_basics/inventories/group_vars/all.yml index a32cce2a3..767d93cc4 100644 --- a/zos_concepts/zos_operator/zos_operator_basics/inventories/group_vars/all.yml +++ b/zos_concepts/zos_operator/zos_operator_basics/inventories/group_vars/all.yml @@ -1,5 +1,5 @@ ################################################################################ -# Copyright (c) IBM Corporation 2020 +# Copyright (c) IBM Corporation 2020, 2024 ################################################################################ ################################################################################ @@ -9,7 +9,7 @@ environment_vars: _BPXK_AUTOCVT: "ON" ZOAU_HOME: "{{ ZOAU }}" - PYTHONPATH: "{{ ZOAU }}/lib" + PYTHONPATH: "{{ ZOAU_PYTHON_LIBRARY_PATH }}" LIBPATH: "{{ ZOAU }}/lib:{{ PYZ }}/lib:/lib:/usr/lib:." PATH: "{{ ZOAU }}/bin:{{ PYZ }}/bin:/bin:/var/bin" _CEE_RUNOPTS: "FILETAG(AUTOCVT,AUTOTAG) POSIX(ON)" @@ -23,10 +23,12 @@ environment_vars: # Description of the properties used in this configuration: ################################################################################ # - Property BPXK_AUTOCVT must be configured to "ON"; e.g., _BPXK_AUTOCVT: "ON" -# - Property ZOAU_HOME is the ZOA Utilities install root path; e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" -# - Property PYTHONPATH is the ZOA Utilities Python library path; e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" +# - Property ZOAU_HOME is the Z Open Automation Utilities (ZOAU) install root path; +# e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" +# - Property PYTHONPATH is the Z Open Automation Utilities (ZOAU) Python library path; +# e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" # - Property LIBPATH is both the path to the Python libraries on the target -# and the ZOA Utilities Python library path separated by semi-colons; e.g., +# and the Z Open Automation Utilities (ZOAU) Python library path separated by semi-colons; e.g., # LIBPATH: "/usr/lpp/IBM/zoautil/lib/:/usr/lpp/IBM/cyp/v3r8/pyz/lib:/usr/lib:/lib:." # - Property PATH is the ZOA utilities BIN path and Python interpreter path, e.g., # PATH: "/usr/lpp/IBM/zoautil/bin:/usr/lpp/IBM/cyp/v3r8/pyz/bin:/bin" diff --git a/zos_concepts/zos_operator/zos_operator_basics/inventories/host_vars/zos_host.yml b/zos_concepts/zos_operator/zos_operator_basics/inventories/host_vars/zos_host.yml index cbf8614f2..d385e9ed8 100644 --- a/zos_concepts/zos_operator/zos_operator_basics/inventories/host_vars/zos_host.yml +++ b/zos_concepts/zos_operator/zos_operator_basics/inventories/host_vars/zos_host.yml @@ -1,25 +1,64 @@ --- ################################################################################ -# Copyright (c) IBM Corporation 2021 +# Copyright (c) IBM Corporation 2021, 2024 ################################################################################ ################################################################################ # Description of the properties used in this configuration: -# - Property `PYZ` is the python installation home path on the z/OS managed node (target), -# e.g, pyz: "/usr/lpp/IBM/cyp/v3r8/pyz" -# - Property `ZOAU` is the ZOAU installation home on the z/OS managed node (target), -# e.g, zoau: "/usr/lpp/IBM/zoautil" -# - property `ansible_python_interpreter` is the z/OS managed node (target) Python +# - Property `PYZ` is the python installation home path on the z/OS managed +# (target) node e.g, PYZ: "/usr/lpp/IBM/cyp/v3r12/pyz" +# - Property `PYZ_VERSION` is the version of python on the z/OS managed +# (target) node e.g, PYZ_VERSION: "3.12". +# - Property `ZOAU` is the ZOAU installation home on the z/OS managed (target) +# node, e.g, ZOAU: "/usr/lpp/IBM/zoautil". +# - Property `ZOAU_PYTHON_LIBRARY_PATH` is the path to the Z Open Automation +# Utilities (ZOAU) python library. Specifically, the path points to the +# directory containing 'zoautil_py'. Packages installed using 'pip' generally +# default to the 'site-packages' directory within the python installation, +# eg "/usr/lpp/IBM/cyp/v3r12/pyz/lib/python3.12/site-packages/". +# If the installation uses options such as '--user' or '--target', the module +# is installed to a non-default location which must be configured in +# `ZOAU_PYTHON_LIBRARY_PATH`. +# If the wheel installation method is used with the '--target' or '--user' +# option, `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory the wheel +# file was installed to. e.g ZOAU_PYTHON_LIBRARY_PATH: "/usr/zoau-wheel/". +# Else 'ZOAU_PYTHON_LIBRARY_PATH' should point to the directory containing +# the pre-compiled binary. +# For ZOAU v1.2.x, the pre-compiled binary is located in the 'lib' directory. +# e.g "/usr/lpp/IBM/zoautil/lib" or "{{ ZOAU }}/lib". +# For ZOAU v1.3.x, the pre-compiled binary is located in a sub-directory +# corresponding to the `PYZ_VERSION` inside the 'lib' directory, +# e.g "/usr/lpp/IBM/zoautil/lib/3.12" or "{{ ZOAU }}/lib/{{ PYZ_VERSION }}". +# - Property `ansible_python_interpreter` is the z/OS managed node (target) Python # binary installation path, e.g, ansible_python_interpreter: "{{PYZ}}/bin/python3" # -# Note, PYZ and ZOAU environment variables must be configured. +# Note, PYZ, PYZ_VERSION, and ZOAU environment variables must be configured. ################################################################################ PYZ: "path_to_python_installation_on_zos_target" +PYZ_VERSION: "3.xx" + ZOAU: "path_to_zoau_installation_on_zos_target" +# Configuring the `ZOAU_PYTHON_LIBRARY_PATH` property is required. + +# If the ZOAU python package, zoautil_py, has been installed as a wheel (*.whl) +# with the '--target' or '--user' option, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ path_to_wheel_installation_directory }}" + +# If the ZOAU python zoautil_py package has been installed in the default location +# that is part of Python's search path, the `ZOAU_PYTHON_LIBRARY_PATH` environment +# variable must be set as an empty string. Uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "" + +# If using pre-compiled binaries for ZOAU v1.3.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib/{{ PYZ_VERSION }}" + +# If using pre-compiled binaries for ZOAU v1.2.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib" + ################################################################################ -# Do not configure, variable substituion will correctly set the -# variable`ansible_python_interpreter` +# Do not configure, variable substitution will correctly set the +# variable `ansible_python_interpreter` ################################################################################ ansible_python_interpreter: "{{ PYZ }}/bin/python3" diff --git a/zos_concepts/zos_ping/inventories/group_vars/all.yml b/zos_concepts/zos_ping/inventories/group_vars/all.yml index a32cce2a3..767d93cc4 100644 --- a/zos_concepts/zos_ping/inventories/group_vars/all.yml +++ b/zos_concepts/zos_ping/inventories/group_vars/all.yml @@ -1,5 +1,5 @@ ################################################################################ -# Copyright (c) IBM Corporation 2020 +# Copyright (c) IBM Corporation 2020, 2024 ################################################################################ ################################################################################ @@ -9,7 +9,7 @@ environment_vars: _BPXK_AUTOCVT: "ON" ZOAU_HOME: "{{ ZOAU }}" - PYTHONPATH: "{{ ZOAU }}/lib" + PYTHONPATH: "{{ ZOAU_PYTHON_LIBRARY_PATH }}" LIBPATH: "{{ ZOAU }}/lib:{{ PYZ }}/lib:/lib:/usr/lib:." PATH: "{{ ZOAU }}/bin:{{ PYZ }}/bin:/bin:/var/bin" _CEE_RUNOPTS: "FILETAG(AUTOCVT,AUTOTAG) POSIX(ON)" @@ -23,10 +23,12 @@ environment_vars: # Description of the properties used in this configuration: ################################################################################ # - Property BPXK_AUTOCVT must be configured to "ON"; e.g., _BPXK_AUTOCVT: "ON" -# - Property ZOAU_HOME is the ZOA Utilities install root path; e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" -# - Property PYTHONPATH is the ZOA Utilities Python library path; e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" +# - Property ZOAU_HOME is the Z Open Automation Utilities (ZOAU) install root path; +# e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" +# - Property PYTHONPATH is the Z Open Automation Utilities (ZOAU) Python library path; +# e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" # - Property LIBPATH is both the path to the Python libraries on the target -# and the ZOA Utilities Python library path separated by semi-colons; e.g., +# and the Z Open Automation Utilities (ZOAU) Python library path separated by semi-colons; e.g., # LIBPATH: "/usr/lpp/IBM/zoautil/lib/:/usr/lpp/IBM/cyp/v3r8/pyz/lib:/usr/lib:/lib:." # - Property PATH is the ZOA utilities BIN path and Python interpreter path, e.g., # PATH: "/usr/lpp/IBM/zoautil/bin:/usr/lpp/IBM/cyp/v3r8/pyz/bin:/bin" diff --git a/zos_concepts/zos_ping/inventories/host_vars/zos_host.yml b/zos_concepts/zos_ping/inventories/host_vars/zos_host.yml index cbf8614f2..d385e9ed8 100644 --- a/zos_concepts/zos_ping/inventories/host_vars/zos_host.yml +++ b/zos_concepts/zos_ping/inventories/host_vars/zos_host.yml @@ -1,25 +1,64 @@ --- ################################################################################ -# Copyright (c) IBM Corporation 2021 +# Copyright (c) IBM Corporation 2021, 2024 ################################################################################ ################################################################################ # Description of the properties used in this configuration: -# - Property `PYZ` is the python installation home path on the z/OS managed node (target), -# e.g, pyz: "/usr/lpp/IBM/cyp/v3r8/pyz" -# - Property `ZOAU` is the ZOAU installation home on the z/OS managed node (target), -# e.g, zoau: "/usr/lpp/IBM/zoautil" -# - property `ansible_python_interpreter` is the z/OS managed node (target) Python +# - Property `PYZ` is the python installation home path on the z/OS managed +# (target) node e.g, PYZ: "/usr/lpp/IBM/cyp/v3r12/pyz" +# - Property `PYZ_VERSION` is the version of python on the z/OS managed +# (target) node e.g, PYZ_VERSION: "3.12". +# - Property `ZOAU` is the ZOAU installation home on the z/OS managed (target) +# node, e.g, ZOAU: "/usr/lpp/IBM/zoautil". +# - Property `ZOAU_PYTHON_LIBRARY_PATH` is the path to the Z Open Automation +# Utilities (ZOAU) python library. Specifically, the path points to the +# directory containing 'zoautil_py'. Packages installed using 'pip' generally +# default to the 'site-packages' directory within the python installation, +# eg "/usr/lpp/IBM/cyp/v3r12/pyz/lib/python3.12/site-packages/". +# If the installation uses options such as '--user' or '--target', the module +# is installed to a non-default location which must be configured in +# `ZOAU_PYTHON_LIBRARY_PATH`. +# If the wheel installation method is used with the '--target' or '--user' +# option, `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory the wheel +# file was installed to. e.g ZOAU_PYTHON_LIBRARY_PATH: "/usr/zoau-wheel/". +# Else 'ZOAU_PYTHON_LIBRARY_PATH' should point to the directory containing +# the pre-compiled binary. +# For ZOAU v1.2.x, the pre-compiled binary is located in the 'lib' directory. +# e.g "/usr/lpp/IBM/zoautil/lib" or "{{ ZOAU }}/lib". +# For ZOAU v1.3.x, the pre-compiled binary is located in a sub-directory +# corresponding to the `PYZ_VERSION` inside the 'lib' directory, +# e.g "/usr/lpp/IBM/zoautil/lib/3.12" or "{{ ZOAU }}/lib/{{ PYZ_VERSION }}". +# - Property `ansible_python_interpreter` is the z/OS managed node (target) Python # binary installation path, e.g, ansible_python_interpreter: "{{PYZ}}/bin/python3" # -# Note, PYZ and ZOAU environment variables must be configured. +# Note, PYZ, PYZ_VERSION, and ZOAU environment variables must be configured. ################################################################################ PYZ: "path_to_python_installation_on_zos_target" +PYZ_VERSION: "3.xx" + ZOAU: "path_to_zoau_installation_on_zos_target" +# Configuring the `ZOAU_PYTHON_LIBRARY_PATH` property is required. + +# If the ZOAU python package, zoautil_py, has been installed as a wheel (*.whl) +# with the '--target' or '--user' option, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ path_to_wheel_installation_directory }}" + +# If the ZOAU python zoautil_py package has been installed in the default location +# that is part of Python's search path, the `ZOAU_PYTHON_LIBRARY_PATH` environment +# variable must be set as an empty string. Uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "" + +# If using pre-compiled binaries for ZOAU v1.3.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib/{{ PYZ_VERSION }}" + +# If using pre-compiled binaries for ZOAU v1.2.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib" + ################################################################################ -# Do not configure, variable substituion will correctly set the -# variable`ansible_python_interpreter` +# Do not configure, variable substitution will correctly set the +# variable `ansible_python_interpreter` ################################################################################ ansible_python_interpreter: "{{ PYZ }}/bin/python3" diff --git a/zos_concepts/zos_script/inventories/group_vars/all.yml b/zos_concepts/zos_script/inventories/group_vars/all.yml index af7a65f6c..fee532210 100644 --- a/zos_concepts/zos_script/inventories/group_vars/all.yml +++ b/zos_concepts/zos_script/inventories/group_vars/all.yml @@ -1,5 +1,5 @@ ################################################################################ -# Copyright (c) IBM Corporation 2023 +# Copyright (c) IBM Corporation 2023, 2024 ################################################################################ ################################################################################ @@ -9,7 +9,7 @@ environment_vars: _BPXK_AUTOCVT: "ON" ZOAU_HOME: "{{ ZOAU }}" - PYTHONPATH: "{{ ZOAU }}/lib" + PYTHONPATH: "{{ ZOAU_PYTHON_LIBRARY_PATH }}" LIBPATH: "{{ ZOAU }}/lib:{{ PYZ }}/lib:/lib:/usr/lib:." PATH: "{{ ZOAU }}/bin:{{ PYZ }}/bin:/bin:/var/bin" _CEE_RUNOPTS: "FILETAG(AUTOCVT,AUTOTAG) POSIX(ON)" @@ -23,10 +23,12 @@ environment_vars: # Description of the properties used in this configuration: ################################################################################ # - Property BPXK_AUTOCVT must be configured to "ON"; e.g., _BPXK_AUTOCVT: "ON" -# - Property ZOAU_HOME is the ZOA Utilities install root path; e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" -# - Property PYTHONPATH is the ZOA Utilities Python library path; e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" +# - Property ZOAU_HOME is the Z Open Automation Utilities (ZOAU) install root path; +# e.g., ZOAU_HOME: "/usr/lpp/IBM/zoautil" +# - Property PYTHONPATH is the Z Open Automation Utilities (ZOAU) Python library path; +# e.g., PYTHONPATH: "/usr/lpp/IBM/zoautil/lib" # - Property LIBPATH is both the path to the Python libraries on the target -# and the ZOA Utilities Python library path separated by semi-colons; e.g., +# and the Z Open Automation Utilities (ZOAU) Python library path separated by semi-colons; e.g., # LIBPATH: "/usr/lpp/IBM/zoautil/lib/:/usr/lpp/IBM/cyp/v3r8/pyz/lib:/usr/lib:/lib:." # - Property PATH is the ZOA utilities BIN path and Python interpreter path, e.g., # PATH: "/usr/lpp/IBM/zoautil/bin:/usr/lpp/IBM/cyp/v3r8/pyz/bin:/bin" diff --git a/zos_concepts/zos_script/inventories/host_vars/zos_host.yml b/zos_concepts/zos_script/inventories/host_vars/zos_host.yml index f9d4e5f81..0f5715762 100644 --- a/zos_concepts/zos_script/inventories/host_vars/zos_host.yml +++ b/zos_concepts/zos_script/inventories/host_vars/zos_host.yml @@ -1,25 +1,64 @@ --- ################################################################################ -# Copyright (c) IBM Corporation 2023 +# Copyright (c) IBM Corporation 2023, 2024 ################################################################################ ################################################################################ # Description of the properties used in this configuration: -# - Property `PYZ` is the python installation home path on the z/OS managed node (target), -# e.g, pyz: "/usr/lpp/IBM/cyp/v3r8/pyz" -# - Property `ZOAU` is the ZOAU installation home on the z/OS managed node (target), -# e.g, zoau: "/usr/lpp/IBM/zoautil" -# - property `ansible_python_interpreter` is the z/OS managed node (target) Python +# - Property `PYZ` is the python installation home path on the z/OS managed +# (target) node e.g, PYZ: "/usr/lpp/IBM/cyp/v3r12/pyz" +# - Property `PYZ_VERSION` is the version of python on the z/OS managed +# (target) node e.g, PYZ_VERSION: "3.12". +# - Property `ZOAU` is the ZOAU installation home on the z/OS managed (target) +# node, e.g, ZOAU: "/usr/lpp/IBM/zoautil". +# - Property `ZOAU_PYTHON_LIBRARY_PATH` is the path to the Z Open Automation +# Utilities (ZOAU) python library. Specifically, the path points to the +# directory containing 'zoautil_py'. Packages installed using 'pip' generally +# default to the 'site-packages' directory within the python installation, +# eg "/usr/lpp/IBM/cyp/v3r12/pyz/lib/python3.12/site-packages/". +# If the installation uses options such as '--user' or '--target', the module +# is installed to a non-default location which must be configured in +# `ZOAU_PYTHON_LIBRARY_PATH`. +# If the wheel installation method is used with the '--target' or '--user' +# option, `ZOAU_PYTHON_LIBRARY_PATH` should point to the directory the wheel +# file was installed to. e.g ZOAU_PYTHON_LIBRARY_PATH: "/usr/zoau-wheel/". +# Else 'ZOAU_PYTHON_LIBRARY_PATH' should point to the directory containing +# the pre-compiled binary. +# For ZOAU v1.2.x, the pre-compiled binary is located in the 'lib' directory. +# e.g "/usr/lpp/IBM/zoautil/lib" or "{{ ZOAU }}/lib". +# For ZOAU v1.3.x, the pre-compiled binary is located in a sub-directory +# corresponding to the `PYZ_VERSION` inside the 'lib' directory, +# e.g "/usr/lpp/IBM/zoautil/lib/3.12" or "{{ ZOAU }}/lib/{{ PYZ_VERSION }}". +# - Property `ansible_python_interpreter` is the z/OS managed node (target) Python # binary installation path, e.g, ansible_python_interpreter: "{{PYZ}}/bin/python3" # -# Note, PYZ and ZOAU environment variables must be configured. +# Note, PYZ, PYZ_VERSION, and ZOAU environment variables must be configured. ################################################################################ PYZ: "path_to_python_installation_on_zos_target" +PYZ_VERSION: "3.xx" + ZOAU: "path_to_zoau_installation_on_zos_target" +# Configuring the `ZOAU_PYTHON_LIBRARY_PATH` property is required. + +# If the ZOAU python package, zoautil_py, has been installed as a wheel (*.whl) +# with the '--target' or '--user' option, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ path_to_wheel_installation_directory }}" + +# If the ZOAU python zoautil_py package has been installed in the default location +# that is part of Python's search path, the `ZOAU_PYTHON_LIBRARY_PATH` environment +# variable must be set as an empty string. Uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "" + +# If using pre-compiled binaries for ZOAU v1.3.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib/{{ PYZ_VERSION }}" + +# If using pre-compiled binaries for ZOAU v1.2.x, uncomment the following line: +# ZOAU_PYTHON_LIBRARY_PATH: "{{ ZOAU }}/lib" + ################################################################################ # Do not configure, variable substitution will correctly set the -# variable`ansible_python_interpreter` +# variable `ansible_python_interpreter` ################################################################################ ansible_python_interpreter: "{{ PYZ }}/bin/python3"