Merged cherry pick (#1548)

Author: fernandofloresg

.ansible-lint

@@ -20,6 +20,7 @@ exclude_paths:
   - changelogs/
   - collections/
   - docs/
+  - importer_result.json
   - scripts/
   - test_config.yml
   - tests/*.ini

CHANGELOG.rst

@@ -78,6 +78,20 @@ releases:
       name: zos_tso_command
       namespace: ''
     release_date: '2022-06-07'
+  1.10.0:
+    changes:
+      release_summary: 'Release Date: ''2024-06-11''
+
+        This changelog describes all changes made to the modules and plugins included
+
+        in this collection. The release date is the date the changelog is created.
+
+        For additional details such as required dependencies and availability review
+
+        the collections `release notes <https://ibm.github.io/z_ansible_collections_doc/ibm_zos_core/docs/source/release_notes.html>`__'
+    fragments:
+    - v1.10.0_summary.yml
+    release_date: '2024-06-11'
   1.10.0-beta.1:
     changes:
       breaking_changes:

README.md

@@ -0,0 +1,6 @@
+release_summary: |
+  Release Date: '2024-06-11'
+  This changelog describes all changes made to the modules and plugins included
+  in this collection. The release date is the date the changelog is created.
+  For additional details such as required dependencies and availability review
+  the collections `release notes <https://ibm.github.io/z_ansible_collections_doc/ibm_zos_core/docs/source/release_notes.html>`__

changelogs/changelog.yaml

@@ -815,6 +815,10 @@ Notes
 
    Beginning in version 1.8.x, zos\_copy will no longer attempt to correct a copy of a data type member into a PDSE that contains program objects. You can control this behavior using module option \ :literal:`executable`\  that will signify an executable is being copied into a PDSE with other executables. Mixing data type members with program objects will result in a (FSUM8976,./zos\_copy.html) error.
 
+   It is the playbook author or user's responsibility to ensure they have appropriate authority to the RACF FACILITY resource class. A user is described as the remote user, configured either for the playbook or playbook tasks, who can also obtain escalated privileges to execute as root or another user.
+
+   To use this module, you must define the RACF FACILITY class profile and allow READ access to RACF FACILITY profile MVS.MCSOPER.ZOAU. If your system uses a different security product, consult that product's documentation to configure the required security classes.
+
 
 
 See Also

changelogs/fragments/v1.10.0_summary.yml

@@ -35,7 +35,7 @@ cmd
 
   If the command contains any special characters ($, &, etc), they must be escaped using double backslashes like \\\\\\$.
 
-  For example, to display job by job name the command would be \ :literal:`cmd:"\\\\$dj''HELLO''"`\ 
+  For example, to display job by job name the command would be ``cmd:"\\$dj''HELLO''"``
 
   | **required**: True
   | **type**: str

docs/source/modules/zos_copy.rst

@@ -275,6 +275,12 @@ Examples
        cmd: ./scripts/PROGRAM
        removes: /u/user/pgm_input.txt
 
+   - name: Run a shell script on the remote system
+     zos_script:
+       cmd: ./scripts/program.sh
+       executable: /bin/sh
+       remote_src: true
+
 
 
 

docs/source/modules/zos_operator.rst

@@ -6,8 +6,8 @@
 Releases
 ========
 
-Version 1.10.0-beta.1
-=====================
+Version 1.10.0
+==============
 
 Major Changes
 -------------
@@ -95,6 +95,7 @@ It is intended to assist in updating your playbooks so this collection will cont
 Availability
 ------------
 
+* `Automation Hub`_
 * `Galaxy`_
 * `GitHub`_
 
@@ -106,19 +107,24 @@ controller and z/OS managed node dependencies.
 
 Known Issues
 ------------
-
+- ``zos_job_submit`` - when setting 'location' to 'local' and not specifying the from and to encoding, the modules defaults are not read leaving the file in its original encoding; explicitly set the encodings instead of relying on the default.
 - ``zos_job_submit`` - when submitting JCL, the response value returned for **byte_count** is incorrect.
+- ``zos_data_set`` - When data set creation fails, exception can throw a bad import error instead of data set creation error.
+- ``zos_copy`` - To use this module, you must define the RACF FACILITY class profile and allow READ access to RACF FACILITY profile MVS.MCSOPER.ZOAU. If your system uses a different security product, consult that product's documentation to configure the required security classes.
+- ``zos_job_submit``, ``zos_job_output``, ``zos_operator_action_query`` - encounters JSON decoding (DecodeError, TypeError, KeyError) errors when interacting with results that contain non-printable UTF-8 characters in the response. This will be addressed in **ZOAU version 1.3.2** and later.
 
-- ``zos_job_submit``, ``zos_job_output``, ``zos_operator_action_query`` - encounters UTF-8 decoding errors when interacting with results that contain non-printable UTF-8 characters in the response.
-
-   - If you encounter this, some options are to:
+   - Some options to work around this known issue are:
 
       - Specify that the ASA assembler option be enabled to instruct the assembler to use ANSI control characters instead of machine code control characters.
       - Ignore module errors by using  **ignore_errors:true** for a specific playbook task.
       - If the error is resulting from a batch job, add **ignore_errors:true** to the task and capture the output into a registered variable to extract the
         job ID with a regular expression. Then use ``zos_job_output`` to display the DD without the non-printable character such as the DD **JESMSGLG**.
       - If the error is the result of a batch job, set option **return_output** to false so that no DDs are read which could contain the non-printable UTF-8 characters.
 
+- In the past, choices could be defined in either lower or upper case. Now, only the case that is identified in the docs can be set, this is so that the collection can continue to maintain certified status.
+- Use of special characters (#, @, $, \- ) in different options like data set names and commands is not fully supported, some modules support them but is the user responsibility to escape them. Read each module documentation for further details.
+
+
 Version 1.9.1
 =============
 
@@ -144,7 +150,7 @@ controller and z/OS managed node dependencies.
 Known Issues
 ------------
 
-- ``zos_job_submit`` - when setting 'location' to 'LOCAL' and not specifying the from and to encoding, the modules defaults are not read leaving the file in its original encoding; explicitly set the encodings instead of relying on the default.
+- ``zos_job_submit`` - when setting 'location' to 'local' and not specifying the from and to encoding, the modules defaults are not read leaving the file in its original encoding; explicitly set the encodings instead of relying on the default.
 - ``zos_job_submit`` - when submitting JCL, the response value returned for **byte_count** is incorrect.
 
 - ``zos_job_submit``, ``zos_job_output``, ``zos_operator_action_query`` - encounters UTF-8 decoding errors when interacting with results that contain non-printable UTF-8 characters in the response. This has been addressed in this release and corrected with **ZOAU version 1.2.5.6** or later.

docs/source/modules/zos_script.rst

@@ -23,22 +23,22 @@ currently supported.
 For example, if a collection releases with a minimum version of ``ansible-core`` 2.14.0 (Ansible 7.0) and later this
 enters into EOL, then a newer supported version of ``ansible-core`` (Ansible) must be selected. When choosing a newer
 ``ansible-core`` (Ansible) version, review the `ansible-core support matrix`_ to select the appropriate dependencies.
-This is important to note, different releases of ``ansible-core`` can require newer controller and managed node
+This is important to note, different releases of ``ansible-core`` can require newer control node and managed node
 dependencies such as is the case with Python.
 
-If the controller is Ansible Automation Platform (AAP), review the `Red Hat Ansible Automation Platform Life Cycle`_
+If the control node is Ansible Automation Platform (AAP), review the `Red Hat Ansible Automation Platform Life Cycle`_
 to select a supported AAP version.
 
 For IBM product lifecycle information, you can search for products using a product name, version or ID. For example,
-to view IBM's **Open Enterprise SDK for Python** lifecycle, search on product ID `5655-PYT`_, and for **Z Open Automation Utilities**,
-search on product ID `5698-PA1`_.
+to view IBM's `Open Enterprise SDK for Python lifecycle`_, search on product ID `5655-PYT`_, and for
+`Z Open Automation Utilities lifecycle`_, search on product ID `5698-PA1`_.
 
 Support Matrix
 ==============
 +---------+----------------------------+---------------------------------------------------+---------------+---------------+
 | Version | Controller                 | Managed Node                                      | GA            | End of Life   |
 +=========+============================+===================================================+===============+===============+
-| 1.10.x  |- `ansible-core`_ >=2.15.x  |- `z/OS`_ V2R4 - V2Rx                              | In preview    | TBD           |
+| 1.10.x  |- `ansible-core`_ >=2.15.x  |- `z/OS`_ V2R4 - V2Rx                              | 21 June 2024  | 21 June 2026  |
 |         |- `Ansible`_ >=8.0.x        |- `z/OS shell`_                                    |               |               |
 |         |- `AAP`_ >=2.4              |- IBM `Open Enterprise SDK for Python`_            |               |               |
 |         |                            |- IBM `Z Open Automation Utilities`_ >=1.3.0       |               |               |
@@ -88,8 +88,12 @@ Support Matrix
    https://www.ibm.com/support/knowledgecenter/en/SSLTBW_2.4.0/com.ibm.zos.v2r4.bpxa400/part1.htm
 .. _z/OS:
    https://www.ibm.com/docs/en/zos
+.. _Open Enterprise SDK for Python lifecycle:
+   https://www.ibm.com/support/pages/lifecycle/search?q=5655-PYT
 .. _5655-PYT:
    https://www.ibm.com/support/pages/lifecycle/search?q=5655-PYT
+.. _Z Open Automation Utilities lifecycle:
+   https://www.ibm.com/support/pages/lifecycle/search?q=5698-PA1
 .. _5698-PA1:
    https://www.ibm.com/support/pages/lifecycle/search?q=5698-PA1
 .. _ansible-core: