Merge main 1.10.0 beta.1 into dev

.github/ISSUE_TEMPLATE/bug_issue.yml

@@ -39,19 +39,12 @@ body:
         - v1.11.0-beta.1
         - v1.10.0
         - v1.10.0-beta.1
-        - v1.9.0
-        - v1.9.0-beta.1
-        - v1.8.0 (default)
+        - v1.9.0 (default)
+        - v1.8.0
         - v1.7.0
         - v1.6.0
         - v1.5.0
-        - v1.4.1
-        - v1.3.6
-        - v1.3.5
-        - v1.3.3
-        - v1.3.1
-        - v1.3.0
-      default: 8
+      default: 6
     validations:
       required: true
   - type: dropdown
@@ -70,10 +63,6 @@ body:
         - v1.2.4
         - v1.2.3
         - v1.2.2
-        - v1.2.1
-        - v1.2.0
-        - v1.1.1
-        - v1.0.3
       default: 5
     validations:
       required: true
@@ -88,8 +77,6 @@ body:
         - v3.12.x
         - v3.11.x (default)
         - v3.10.x
-        - v3.9.x
-        - v3.8.x
       default: 2
     validations:
       required: true

.github/ISSUE_TEMPLATE/collaboration_issue.yml

@@ -48,19 +48,12 @@ body:
         - v1.11.0-beta.1
         - v1.10.0
         - v1.10.0-beta.1
-        - v1.9.0
-        - v1.9.0-beta.1
-        - v1.8.0 (default)
+        - v1.9.0 (default)
+        - v1.8.0
         - v1.7.0
         - v1.6.0
         - v1.5.0
-        - v1.4.1
-        - v1.3.6
-        - v1.3.5
-        - v1.3.3
-        - v1.3.1
-        - v1.3.0
-      default: 8
+      default: 6
     validations:
       required: false
   - type: dropdown
@@ -79,10 +72,6 @@ body:
         - v1.2.4
         - v1.2.3
         - v1.2.2
-        - v1.2.1
-        - v1.2.0
-        - v1.1.1
-        - v1.0.3
       default: 5
     validations:
       required: false
@@ -97,8 +86,6 @@ body:
         - v3.12.x
         - v3.11.x (default)
         - v3.10.x
-        - v3.9.x
-        - v3.8.x
       default: 2
     validations:
       required: false

.github/ISSUE_TEMPLATE/doc_issue.yml

@@ -40,19 +40,12 @@ body:
         - v1.11.0-beta.1
         - v1.10.0
         - v1.10.0-beta.1
-        - v1.9.0
-        - v1.9.0-beta.1
-        - v1.8.0 (default)
+        - v1.9.0 (default)
+        - v1.8.0
         - v1.7.0
         - v1.6.0
         - v1.5.0
-        - v1.4.1
-        - v1.3.6
-        - v1.3.5
-        - v1.3.3
-        - v1.3.1
-        - v1.3.0
-      default: 8
+      default: 6
     validations:
       required: false
   - type: dropdown

.github/ISSUE_TEMPLATE/module_issue.yml

@@ -32,6 +32,6 @@ body:
           - As a < type of user >, I want < some goal > so that < some reason >.
         Examples:
           - As a z/OS System Admin, I can grow zFS aggregates with Ansible so that my data sets don't fill up.
-          - As a Junior developer, I want to be able to zip and unzip arives using Ansible, so that I don't have to perform operations elsewhere.
+          - As a Junior developer, I want to be able to zip and unzip archives using Ansible, so that I don't have to perform operations elsewhere.
     validations:
       required: false

changelogs/.plugin-cache.yaml

@@ -135,4 +135,4 @@ plugins:
   strategy: {}
   test: {}
   vars: {}
-version: 1.9.0
+version: 1.10.0-beta.1

changelogs/changelog.yaml

@@ -78,6 +78,173 @@ releases:
       name: zos_tso_command
       namespace: ''
     release_date: '2022-06-07'
+  1.10.0-beta.1:
+    changes:
+      breaking_changes:
+      - zos_archive - option ``terse_pack`` no longer accepts uppercase choices, users
+        should replace them with lowercase ones. (https://github.com/ansible-collections/ibm_zos_core/pull/1388).
+      - zos_archive - suboption ``record_format`` of ``dest_data_set`` no longer accepts
+        uppercase choices, users should replace them with lowercase ones. (https://github.com/ansible-collections/ibm_zos_core/pull/1388).
+      - zos_archive - suboption ``space_type`` of ``dest_data_set`` no longer accepts
+        uppercase choices, users should replace them with lowercase ones. (https://github.com/ansible-collections/ibm_zos_core/pull/1388).
+      - zos_archive - suboption ``type`` of ``dest_data_set`` no longer accepts uppercase
+        choices, users should replace them with lowercase ones. (https://github.com/ansible-collections/ibm_zos_core/pull/1388).
+      - zos_backup_restore - option ``space_type`` no longer accepts uppercase choices,
+        users should replace them with lowercase ones. (https://github.com/ansible-collections/ibm_zos_core/pull/1388).
+      - zos_copy - suboption ``record_format`` of ``dest_data_set`` no longer accepts
+        uppercase choices, users should replace them with lowercase ones. (https://github.com/ansible-collections/ibm_zos_core/pull/1388).
+      - zos_copy - suboption ``space_type`` of ``dest_data_set`` no longer accepts
+        uppercase choices, users should replace them with lowercase ones. (https://github.com/ansible-collections/ibm_zos_core/pull/1388).
+      - zos_copy - suboption ``type`` of ``dest_data_set`` no longer accepts uppercase
+        choices, users should replace them with lowercase ones. (https://github.com/ansible-collections/ibm_zos_core/pull/1388).
+      - zos_data_set - option ``record_format`` no longer accepts uppercase choices,
+        users should replace them with lowercase ones. (https://github.com/ansible-collections/ibm_zos_core/pull/1388).
+      - zos_data_set - option ``space_type`` no longer accepts uppercase choices,
+        users should replace them with lowercase ones. (https://github.com/ansible-collections/ibm_zos_core/pull/1388).
+      - zos_data_set - option ``type`` no longer accepts uppercase choices, users
+        should replace them with lowercase ones. (https://github.com/ansible-collections/ibm_zos_core/pull/1388).
+      - zos_data_set - options inside ``batch`` no longer accept uppercase choices,
+        users should replace them with lowercase ones. (https://github.com/ansible-collections/ibm_zos_core/pull/1388).
+      - zos_job_submit - option ``location`` no longer accepts uppercase choices,
+        users should replace them with lowercase ones. (https://github.com/ansible-collections/ibm_zos_core/pull/1388).
+      - zos_mount - option ``automove`` no longer accepts uppercase choices, users
+        should replace them with lowercase ones. (https://github.com/ansible-collections/ibm_zos_core/pull/1388).
+      - zos_mount - option ``fs_type`` no longer accepts uppercase choices, users
+        should replace them with lowercase ones. (https://github.com/ansible-collections/ibm_zos_core/pull/1388).
+      - zos_mount - option ``mount_opts`` no longer accepts uppercase choices, users
+        should replace them with lowercase ones. (https://github.com/ansible-collections/ibm_zos_core/pull/1388).
+      - zos_mount - option ``tag_untagged`` no longer accepts uppercase choices, users
+        should replace them with lowercase ones. (https://github.com/ansible-collections/ibm_zos_core/pull/1388).
+      - zos_mount - option ``unmount_opts`` no longer accepts uppercase choices, users
+        should replace them with lowercase ones. (https://github.com/ansible-collections/ibm_zos_core/pull/1388).
+      - zos_mvs_raw - options inside ``dd_concat`` no longer accept uppercase choices,
+        users should replace them with lowercase ones. (https://github.com/ansible-collections/ibm_zos_core/pull/1388).
+      - zos_mvs_raw - suboption ``record_format`` of ``dd_data_set`` no longer accepts
+        uppercase choices, users should replace them with lowercase ones. (https://github.com/ansible-collections/ibm_zos_core/pull/1388).
+      - zos_mvs_raw - suboption ``record_format`` of ``dd_unix`` no longer accepts
+        uppercase choices, users should replace them with lowercase ones. (https://github.com/ansible-collections/ibm_zos_core/pull/1388).
+      - zos_mvs_raw - suboption ``space_type`` of ``dd_data_set`` no longer accepts
+        uppercase choices, users should replace them with lowercase ones. (https://github.com/ansible-collections/ibm_zos_core/pull/1388).
+      - zos_mvs_raw - suboption ``type`` of ``dd_data_set`` no longer accepts uppercase
+        choices, users should replace them with lowercase ones. (https://github.com/ansible-collections/ibm_zos_core/pull/1388).
+      - zos_mvs_raw - suboptions ``disposition_normal`` and ``disposition_abnormal``
+        of ``dd_data_set`` no longer accept ``catlg`` and ``uncatlg`` as choices.
+        This also applies when defining a ``dd_data_set`` inside ``dd_concat``. (https://github.com/ansible-collections/ibm_zos_core/pull/1388).
+      - zos_unarchive - suboption ``record_format`` of ``dest_data_set`` no longer
+        accepts uppercase choices, users should replace them with lowercase ones.
+        (https://github.com/ansible-collections/ibm_zos_core/pull/1388).
+      - zos_unarchive - suboption ``space_type`` of ``dest_data_set`` no longer accepts
+        uppercase choices, users should replace them with lowercase ones. (https://github.com/ansible-collections/ibm_zos_core/pull/1388).
+      - zos_unarchive - suboption ``type`` of ``dest_data_set`` no longer accepts
+        uppercase choices, users should replace them with lowercase ones. (https://github.com/ansible-collections/ibm_zos_core/pull/1388).
+      bugfixes:
+      - module_utils/job.py - job output containing non-printable characters would
+        crash modules. Fix now handles the error gracefully and returns a message
+        to the user inside `content` of the `ddname` that failed. (https://github.com/ansible-collections/ibm_zos_core/pull/1261).
+      - zos_apf - List option only returned one data set. Fix now returns the list
+        of retrieved data sets. (https://github.com/ansible-collections/ibm_zos_core/pull/1204).
+      - zos_blockinfile - Using double quotation marks inside a block resulted in
+        a false positive result with ZOAU 1.3. Fix now handles this special case to
+        avoid false negatives. (https://github.com/ansible-collections/ibm_zos_core/pull/1340).
+      - zos_find - Filter size failed if a PDS/E matched the pattern. Fix now gets
+        the correct size for PDS/Es. (https://github.com/ansible-collections/ibm_zos_core/pull/1443).
+      - zos_job_submit - Was ignoring the default value for location=DATA_SET, now
+        when location is not specified it will default to DATA_SET. (https://github.com/ansible-collections/ibm_zos_core/pull/1220).
+      - zos_job_submit - when the argument max_rc was different than 0 the changed
+        response returned as false. Fix now return a changed response as true when
+        the rc is not 0 and max_rc is above or equal to the value of the job. (https://github.com/ansible-collections/ibm_zos_core/pull/1345).
+      - zos_mvs_raw - The module ignored the value of `tmp_hlq` option when creating
+        temporary data sets. Fix now honors the value if provided and uses it as High
+        Level Qualifier for temporary data sets created during the module execution.
+        (https://github.com/ansible-collections/ibm_zos_core/pull/1320).
+      minor_changes:
+      - zos_apf - Enhanced error messages when an exception is caught. (https://github.com/ansible-collections/ibm_zos_core/pull/1204).
+      - zos_backup_restore - Add tmp_hlq option to the user interface to override
+        the default high level qualifier (HLQ) for temporary and backup. (https://github.com/ansible-collections/ibm_zos_core/pull/1265).
+      - zos_copy - Documented `group` and `owner` options. (https://github.com/ansible-collections/ibm_zos_core/pull/1307).
+      - zos_copy - Improve zos_copy performance when copying multiple members from
+        one PDS/E to another. (https://github.com/ansible-collections/ibm_zos_core/pull/1183).
+      release_summary: 'Release Date: ''2024-05-08''
+
+        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:
+    - 1032-clean-job_submit-test.yml
+    - 1152-zos-lineinfile-remove-zos_copy-dependency.yml
+    - 1156-zos_archive-remove-zos_copy_dep.yml
+    - 1157-remove-zos-copy-from-zos-encode-tests.yml
+    - 1165-remove-zos-copy-dep-from-zos-fetch.yml
+    - 1167-remove-zos-copy-from-zos-blockinfile-tests.yml
+    - 1169-util-job-zoau-migration.yml
+    - 1179-remove-zos_encode-from_zos_lineinfile-tests.yml
+    - 1181-zoau-migration-zos_operator.yml
+    - 1182-migrate-module-utils-data-set.yml
+    - 1183-copy-members.yml
+    - 1184-remove-zos-fetch-dep-from-zos-copy.yml
+    - 1187-migrate-module-utils-copy.yml
+    - 1188-migrate-module_utils-backup.yml
+    - 1189-migrate-module_utils-encode.yml
+    - 1190-migrate-module_utils-dd_statement.yml
+    - 1196-zoau-migration-zos_gather_facts.yml
+    - 1202-doc-gen-script-portability.yml
+    - 1204-migrate-zos_apf.yml
+    - 1209-zoau-migration-zos_job_submit.yml
+    - 1215-Migrate_zos_operator_action_query.yml
+    - 1216-Validate_module_zos_job_output_migration.yml
+    - 1217-validate-job-query.yml
+    - 1218-migrate-zos_encode.yml
+    - 1220-bugfix-zos_job_submit-default_value.yml
+    - 1222-zoau-migration-zos_copy.yml
+    - 1227-migrate-zos_archive.yml
+    - 1228-zos_find-remove-zos_lineinfile_dep.yml
+    - 1229-migrate-zos_fetch.yml
+    - 1237-migrate-zos_mount.yml
+    - 1238-migrate-zos_unarchive.yml
+    - 1242-zoau-migration-zos_data_set.yml
+    - 1256_Migrate_zos_blockinfile_and_lineinfile.yml
+    - 1257-zoau-import-zos_apf.yml
+    - 1261-job-submit-non-utf8-chars.yml
+    - 1265_Migrate_zos_backup_restore.yml
+    - 1270-quick-fix-len-of-volumes-work-around.yml
+    - 1286-update-zos_archive-zos_unarchive-docs.yml
+    - 1295-doc-zos_ping-scp.yml
+    - 1298-Remove_local_charset_from_zos_fetch.yml
+    - 1307-update-sanity-zos_copy.yml
+    - 1320-Zos_mvs_raw_ignores_tmp_hlq.yml
+    - 1322-update-docstring-encode.yml
+    - 1331-update-docstring-ickdsf.yml
+    - 1332-update-docstring-import_handler.yml
+    - 1333-update-docstring-job.yml
+    - 1336-update-docstring-validation.yml
+    - 1340-Work_around_fix_false_positive.yml
+    - 1345-max_rc_more_than_0_doesn_not_put_change_as_true.yml
+    - 1347-update-docstring-zos_data_set.yml
+    - 1348-update-docstring-zos_encode.yml
+    - 1349-update-docstring-zos_fetch.yml
+    - 1350-update-docstring-zos_find.yml
+    - 1351-update-docstring-zos_gather_facts.yml
+    - 1352-update-docstring-zos_job_output.yml
+    - 1353-update-docstring-zos_job_query.yml
+    - 1354-update-docstring-zos_job_submit.yml
+    - 1355-update-docstring-zos_lineinfile.yml
+    - 1356-update-docstring-zos_mount.yml
+    - 1388-lowercase-choices.yml
+    - 1390-update-docstring-zos_script.yml
+    - 1391-update-docstring-zos_tso_command.yml
+    - 1392-update-docstring-zos_volume_init.yml
+    - 1393-update-docstring-zos_apf.yml
+    - 1394-Update_docstring-zos_operator_action_query.yml
+    - 1443-zos_find-filter-size.yml
+    - 692-changelog-lint-ac-tool.yml
+    - 971-bug-job_submit-can-stacktrace.yml
+    - 992-fix-sanity4to6.yml
+    - v1.10.0-beta.1_summary.yml
+    release_date: '2024-05-08'
   1.2.1:
     changes:
       bugfixes:

docs/scripts/pre-template.sh

@@ -22,7 +22,7 @@
 # and Jinja2 template, and later sphinx html.
 # This requries that the ansible collection be prebuilt so that it can find
 # the template.py within the collection (not within the git project). Thus run
-# './ac --ac-build' before the make file that builds doc. 
+# './ac --ac-build' before the make file that builds doc.
 ################################################################################
 
 template_doc_source=`ansible-config dump|grep DEFAULT_MODULE_PATH| cut -d'=' -f2|sed 's/[][]//g' | tr -d \'\" |sed 's/modules/doc_fragments\/template.py/g'`

docs/source/index.rst

@@ -90,10 +90,9 @@ ansible-doc to automate tasks on z/OS.
    community_guides
    license
 
+.. toctree::
+   :maxdepth: 1
+   :caption: Reference
 
-
-
-
-
-
-
+   reference/documentation
+   reference/community

docs/source/modules/zos_apf.rst

@@ -62,7 +62,7 @@ volume
 
   1. The volume serial number.
 
-  2. Six asterisks (\*\*\*\*\*\*), indicating that the system must use the volume serial number of the current system residence (SYSRES) volume.
+  2. Six asterisks \ :literal:`\*\*\*\*\*\*`\ , indicating that the system must use the volume serial number of the current system residence (SYSRES) volume.
 
   3. \*MCAT\*, indicating that the system must use the volume serial number of the volume containing the master catalog.
 
@@ -189,7 +189,7 @@ batch
 
     1. The volume serial number
 
-    2. Six asterisks (\*\*\*\*\*\*), indicating that the system must use the volume serial number of the current system residence (SYSRES) volume.
+    2. Six asterisks \ :literal:`\*\*\*\*\*\*`\ , indicating that the system must use the volume serial number of the current system residence (SYSRES) volume.
 
     3. \*MCAT\*, indicating that the system must use the volume serial number of the volume containing the master catalog.
 
@@ -225,7 +225,7 @@ Examples
    - name: Add a library (cataloged) to the APF list and persistence
      zos_apf:
        library: SOME.SEQUENTIAL.DATASET
-       force_dynamic: True
+       force_dynamic: true
        persistent:
          data_set_name: SOME.PARTITIONED.DATASET(MEM)
    - name: Remove a library from the APF list and persistence
@@ -243,7 +243,7 @@ Examples
        batch:
          - library: SOME.SEQ.DS1
          - library: SOME.SEQ.DS2
-           sms: True
+           sms: true
          - library: SOME.SEQ.DS3
            volume: T12345
    - name: Print the APF list matching library pattern or volume serial number