ansible-collections
diff --git a/‎.ansible-lint
Lines changed: 1 addition & 0 deletions b/‎.ansible-lint
Lines changed: 1 addition & 0 deletions
diff --git a/‎CHANGELOG.rst
Lines changed: 19 additions & 3 deletions b/‎CHANGELOG.rst
Lines changed: 19 additions & 3 deletions
diff --git a/‎README.md
Lines changed: 6 additions & 5 deletions b/‎README.md
Lines changed: 6 additions & 5 deletions
diff --git a/‎changelogs/.plugin-cache.yaml
Lines changed: 6 additions & 2 deletions b/‎changelogs/.plugin-cache.yaml
Lines changed: 6 additions & 2 deletions
diff --git a/‎changelogs/changelog.yaml
Lines changed: 70 additions & 0 deletions b/‎changelogs/changelog.yaml
Lines changed: 70 additions & 0 deletions
diff --git a/‎docs/source/filters.rst
Lines changed: 3 additions & 7 deletions b/‎docs/source/filters.rst
Lines changed: 3 additions & 7 deletions
diff --git a/‎docs/source/modules/zos_archive.rst
Lines changed: 5 additions & 5 deletions b/‎docs/source/modules/zos_archive.rst
Lines changed: 5 additions & 5 deletions
diff --git a/‎docs/source/modules/zos_copy.rst
Lines changed: 4 additions & 2 deletions b/‎docs/source/modules/zos_copy.rst
Lines changed: 4 additions & 2 deletions
diff --git a/‎docs/source/modules/zos_fetch.rst
Lines changed: 1 addition & 1 deletion b/‎docs/source/modules/zos_fetch.rst
Lines changed: 1 addition & 1 deletion
@@ -35,6 +35,7 @@ exclude_paths:
   - tests/sanity/ignore-2.11.txt
   - tests/sanity/ignore-2.12.txt
   - tests/sanity/ignore-2.13.txt
+  - tests/sanity/ignore-2.14.txt
   - venv*
 parseable: true
 quiet: false
 
@@ -5,18 +5,23 @@ ibm.ibm_zos_core Release Notes
 .. contents:: Topics
 
 
-v1.9.0-beta.1
-=============
+v1.9.0
+======
 
 Release Summary
 ---------------
 
-Release Date: '2024-01-31'
+Release Date: '2024-03-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>`__
 
+Major Changes
+-------------
+
+- zos_job_submit - when job statuses were read, were limited to AC (active), CC (completed normally), ABEND (ended abnormally) and ? (error unknown), SEC (security error), JCLERROR (job had a jcl error). Now the additional statuses are supported, CANCELLED (job was cancelled), CAB (converter abend), CNV (converter error), SYS (system failure) and FLU (job was flushed). (https://github.com/ansible-collections/ibm_zos_core/pull/1283).
+
 Minor Changes
 -------------
 
@@ -32,11 +37,22 @@ Minor Changes
 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/1288).
+- zos_apf - When operation=list was selected and more than one data set entry was fetched, the module only returned one data set. Fix now returns the complete list. (https://github.com/ansible-collections/ibm_zos_core/pull/1236).
 - zos_copy - When copying an executable data set with aliases and destination did not exist, destination data set was created with wrong attributes. Fix now creates destination data set with the same attributes as the source. (https://github.com/ansible-collections/ibm_zos_core/pull/1066).
 - zos_copy - When performing a copy operation to an existing file, the copied file resulted in having corrupted contents. Fix now implements a workaround to not use the specific copy routine that corrupts the file contents. (https://github.com/ansible-collections/ibm_zos_core/pull/1064).
+- zos_data_set - Fixes a small parsing bug in module_utils/data_set function which extracts volume serial(s) from a LISTCAT command output. Previously a leading '-' was left behind for volser strings under 6 chars. (https://github.com/ansible-collections/ibm_zos_core/pull/1247).
 - zos_job_output - When passing a job ID or name less than 8 characters long, the module sent the full stack trace as the module's message. Change now allows the use of a shorter job ID or name, as well as wildcards. (https://github.com/ansible-collections/ibm_zos_core/pull/1078).
 - zos_job_query - The module handling ZOAU import errors obscured the original traceback when an import error ocurred. Fix now passes correctly the context to the user. (https://github.com/ansible-collections/ibm_zos_core/pull/1042).
 - zos_job_query - When passing a job ID or name less than 8 characters long, the module sent the full stack trace as the module's message. Change now allows the use of a shorter job ID or name, as well as wildcards. (https://github.com/ansible-collections/ibm_zos_core/pull/1078).
+- 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/1120).
+- zos_job_submit - when a JCL error occurred, the ret_code[msg_code] contained JCLERROR followed by an integer where the integer appeared to be a reason code when actually it is a multi line marker used to coordinate errors spanning more than one line. Now when a JCLERROR occurs, only the JCLERROR is returned for property ret_code[msg_code]. (https://github.com/ansible-collections/ibm_zos_core/pull/1283).
+- zos_job_submit - when a response was returned, it contained an undocumented property; ret_code[msg_text]. Now when a response is returned, it correctly returns property ret_code[msg_txt]. (https://github.com/ansible-collections/ibm_zos_core/pull/1283).
+- zos_job_submit - when typrun=copy was used in JCL it would fail the module with an improper message and error condition. While this case continues to be considered a failure, the message has been corrected and it fails under the condition that not enough time has been added to the modules execution. (https://github.com/ansible-collections/ibm_zos_core/pull/1283).
+- zos_job_submit - when typrun=hold was used in JCL it would fail the module with an improper message and error condition. While this case continues to be considered a failure, the message has been corrected and it fails under the condition that not enough time has been added to the modules execution. (https://github.com/ansible-collections/ibm_zos_core/pull/1283).
+- zos_job_submit - when typrun=jchhold was used in JCL it would fail the module with an improper message and error condition. While this case continues to be considered a failure, the message has been corrected and it fails under the condition that not enough time has been added to the modules execution. (https://github.com/ansible-collections/ibm_zos_core/pull/1283).
+- zos_job_submit - when typrun=scan was used in JCL, it would fail the module. Now typrun=scan no longer fails the module and an appropriate message is returned with appropriate return code values. (https://github.com/ansible-collections/ibm_zos_core/pull/1283).
+- zos_job_submit - when wait_time_s was used, the duration would run approximately 5 second longer than reported in the duration. Now the when duration is returned, it is the actual accounting from when the job is submitted to when the module reads the job output. (https://github.com/ansible-collections/ibm_zos_core/pull/1283).
 - zos_operator - The module handling ZOAU import errors obscured the original traceback when an import error ocurred. Fix now passes correctly the context to the user. (https://github.com/ansible-collections/ibm_zos_core/pull/1042).
 - zos_unarchive - Using a local file with a USS format option failed when sending to remote because dest_data_set option had an empty dictionary. Fix now leaves dest_data_set as None when using a USS format option. (https://github.com/ansible-collections/ibm_zos_core/pull/1045).
 - zos_unarchive - When unarchiving USS files, the module left temporary files on the remote. Change now removes temporary files. (https://github.com/ansible-collections/ibm_zos_core/pull/1073).
 
@@ -51,7 +51,7 @@ and ansible-doc to automate tasks on z/OS.
 
 Ansible version compatibility
 =============================
-This collection has been tested against **Ansible Core** versions >=2.14.
+This collection has been tested against **Ansible Core** versions >=2.15.
 The Ansible Core versions supported for this collection align to the
 [ansible-core support matrix](https://docs.ansible.com/ansible/latest/reference_appendices/release_and_maintenance.html#ansible-core-support-matrix). Review the
 [Ansible community changelogs](https://docs.ansible.com/ansible/latest/reference_appendices/release_and_maintenance.html#ansible-community-changelogs) for corresponding **Ansible community packages**
@@ -64,11 +64,12 @@ for more more information on supported versions of Ansible.
 
 Other Dependencies
 ==================
-This release of the **IBM z/OS core collection** requires the z/OS managed node have:
-- [z/OS](https://www.ibm.com/docs/en/zos) V2R4 or later.
+This release of the **IBM z/OS core collection** requires the z/OS managed node have the following:
+- [z/OS](https://www.ibm.com/docs/en/zos)
 - [z/OS shell](https://www.ibm.com/support/knowledgecenter/en/SSLTBW_2.4.0/com.ibm.zos.v2r4.bpxa400/part1.htm).
-- [IBM Open Enterprise SDK for Python](https://www.ibm.com/products/open-enterprise-python-zos) 3.9 - 3.11.
-- [IBM Z Open Automation Utilities](https://www.ibm.com/docs/en/zoau/1.2.x) 1.2.5 (or later) but prior to version 1.3.
+- [IBM Open Enterprise SDK for Python](https://www.ibm.com/products/open-enterprise-python-zos)
+- [IBM Z Open Automation Utilities](https://www.ibm.com/docs/en/zoau/1.2.x)
+For specific dependency versions, please review the [release notes](https://ibm.github.io/z_ansible_collections_doc/ibm_zos_core/docs/source/release_notes.html) for the version of the IBM Ansible z/OS core installed.
 
 Copyright
 =========
 
@@ -6,7 +6,11 @@ plugins:
   callback: {}
   cliconf: {}
   connection: {}
-  filter: {}
+  filter:
+    filter_wtor_messages:
+      description: Filter a list of WTOR messages
+      name: filter_wtor_messages
+      version_added: 1.2.0
   httpapi: {}
   inventory: {}
   lookup: {}
@@ -131,4 +135,4 @@ plugins:
   strategy: {}
   test: {}
   vars: {}
-version: 1.9.0-beta.1
+version: 1.9.0
@@ -1176,6 +1176,76 @@ releases:
       name: zos_script
       namespace: ''
     release_date: '2023-10-24'
+  1.9.0:
+    changes:
+      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/1288).
+      - zos_apf - When operation=list was selected and more than one data set entry
+        was fetched, the module only returned one data set. Fix now returns the complete
+        list. (https://github.com/ansible-collections/ibm_zos_core/pull/1236).
+      - zos_data_set - Fixes a small parsing bug in module_utils/data_set function
+        which extracts volume serial(s) from a LISTCAT command output. Previously
+        a leading '-' was left behind for volser strings under 6 chars. (https://github.com/ansible-collections/ibm_zos_core/pull/1247).
+      - 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/1120).
+      - zos_job_submit - when a JCL error occurred, the ret_code[msg_code] contained
+        JCLERROR followed by an integer where the integer appeared to be a reason
+        code when actually it is a multi line marker used to coordinate errors spanning
+        more than one line. Now when a JCLERROR occurs, only the JCLERROR is returned
+        for property ret_code[msg_code]. (https://github.com/ansible-collections/ibm_zos_core/pull/1283).
+      - zos_job_submit - when a response was returned, it contained an undocumented
+        property; ret_code[msg_text]. Now when a response is returned, it correctly
+        returns property ret_code[msg_txt]. (https://github.com/ansible-collections/ibm_zos_core/pull/1283).
+      - zos_job_submit - when typrun=copy was used in JCL it would fail the module
+        with an improper message and error condition. While this case continues to
+        be considered a failure, the message has been corrected and it fails under
+        the condition that not enough time has been added to the modules execution.
+        (https://github.com/ansible-collections/ibm_zos_core/pull/1283).
+      - zos_job_submit - when typrun=hold was used in JCL it would fail the module
+        with an improper message and error condition. While this case continues to
+        be considered a failure, the message has been corrected and it fails under
+        the condition that not enough time has been added to the modules execution.
+        (https://github.com/ansible-collections/ibm_zos_core/pull/1283).
+      - zos_job_submit - when typrun=jchhold was used in JCL it would fail the module
+        with an improper message and error condition. While this case continues to
+        be considered a failure, the message has been corrected and it fails under
+        the condition that not enough time has been added to the modules execution.
+        (https://github.com/ansible-collections/ibm_zos_core/pull/1283).
+      - zos_job_submit - when typrun=scan was used in JCL, it would fail the module.
+        Now typrun=scan no longer fails the module and an appropriate message is returned
+        with appropriate return code values. (https://github.com/ansible-collections/ibm_zos_core/pull/1283).
+      - zos_job_submit - when wait_time_s was used, the duration would run approximately
+        5 second longer than reported in the duration. Now the when duration is returned,
+        it is the actual accounting from when the job is submitted to when the module
+        reads the job output. (https://github.com/ansible-collections/ibm_zos_core/pull/1283).
+      major_changes:
+      - zos_job_submit - when job statuses were read, were limited to AC (active),
+        CC (completed normally), ABEND (ended abnormally) and ? (error unknown), SEC
+        (security error), JCLERROR (job had a jcl error). Now the additional statuses
+        are supported, CANCELLED (job was cancelled), CAB (converter abend), CNV (converter
+        error), SYS (system failure) and FLU (job was flushed). (https://github.com/ansible-collections/ibm_zos_core/pull/1283).
+      release_summary: 'Release Date: ''2024-03-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:
+    - 1120-bugfix-zos_job_submit-default_value.yml
+    - 1236-bugfix-zos_apf-return-list.yml
+    - 1246-bugfix-zos_job_submit-typrun.yml
+    - 1247-volser-parsing-leading-dash-bugfix.yml
+    - 1288-job-submit-non-utf8-chars.yml
+    - 1292-doc-zos_tso_command-example.yml
+    - 1294-doc-zos_ping-scp.yml
+    - 1296-doc-sftp-collection-requirements.yml
+    - v1.9.0_summary.yml
+    release_date: '2024-03-16'
   1.9.0-beta.1:
     changes:
       bugfixes:
 
@@ -5,13 +5,9 @@
 Filters
 =======
 
-Filters in Ansible are from Jinja2, and are used to transform data inside
-a template expression. The templates operate on the Ansible controller, and not
-on the target host. Therefore, filters execute on the controller as they augment
-the data locally.
-
-Jinja2 ships with many filters as does Ansible, and also allows users to add
-their own custom filters.
+Filters are used to transform data inside a template expression. The templates
+operate on the Ansible controller, not on the managed node. Therefore,
+filters execute on the controller as they augment the data locally.
 
 The **IBM z/OS core collection** includes filters and their usage in sample
 playbooks. Unlike collections that can be identified at the top level using the
 
@@ -342,15 +342,15 @@ Examples
    # Simple archive
    - name: Archive file into a tar
      zos_archive:
-       path: /tmp/archive/foo.txt
+       src: /tmp/archive/foo.txt
        dest: /tmp/archive/foo_archive_test.tar
        format:
          name: tar
 
    # Archive multiple files
    - name: Compress list of files into a zip
      zos_archive:
-       path:
+       src:
          - /tmp/archive/foo.txt
          - /tmp/archive/bar.txt
        dest: /tmp/archive/foo_bar_archive_test.zip
@@ -360,15 +360,15 @@ Examples
    # Archive one data set into terse
    - name: Compress data set into a terse
      zos_archive:
-       path: "USER.ARCHIVE.TEST"
+       src: "USER.ARCHIVE.TEST"
        dest: "USER.ARCHIVE.RESULT.TRS"
        format:
          name: terse
 
    # Use terse with different options
    - name: Compress data set into a terse, specify pack algorithm and use adrdssu
      zos_archive:
-       path: "USER.ARCHIVE.TEST"
+       src: "USER.ARCHIVE.TEST"
        dest: "USER.ARCHIVE.RESULT.TRS"
        format:
          name: terse
@@ -379,7 +379,7 @@ Examples
    # Use a pattern to store
    - name: Compress data set pattern using xmit
      zos_archive:
-       path: "USER.ARCHIVE.*"
+       src: "USER.ARCHIVE.*"
        exclude_sources: "USER.ARCHIVE.EXCLUDE.*"
        dest: "USER.ARCHIVE.RESULT.XMIT"
        format:
 
@@ -91,6 +91,8 @@ dest
 
   If ``dest`` is a nonexistent USS file, it will be created.
 
+  If ``dest`` is a new USS file or replacement, the file will be appropriately tagged with either the system's default locale or the encoding option defined. If the USS file is a replacement, the user must have write authority to the file either through ownership, group or other permissions, else the copy will fail.
+
   If ``dest`` is a nonexistent data set, it will be created following the process outlined here and in the ``volume`` option.
 
   If ``dest`` is a nonexistent data set, the attributes assigned will depend on the type of ``src``. If ``src`` is a USS file, ``dest`` will have a Fixed Block (FB) record format and the remaining attributes will be computed. If *is_binary=true*, ``dest`` will have a Fixed Block (FB) record format with a record length of 80, block size of 32760, and the remaining attributes will be computed. If *executable=true*,``dest`` will have an Undefined (U) record format with a record length of 0, block size of 32760, and the remaining attributes will be computed.
@@ -787,9 +789,9 @@ Notes
 
    For supported character sets used to encode data, refer to the `documentation <https://ibm.github.io/z_ansible_collections_doc/ibm_zos_core/docs/source/resources/character_set.html>`_.
 
-   `zos_copy <./zos_copy.html>`_ uses SFTP (Secure File Transfer Protocol) for the underlying transfer protocol; Co:Z SFTP is not supported. In the case of Co:z SFTP, you can exempt the Ansible userid on z/OS from using Co:Z thus falling back to using standard SFTP.
+   This module uses SFTP (Secure File Transfer Protocol) for the underlying transfer protocol; SCP (secure copy protocol) and Co:Z SFTP are not supported. In the case of Co:z SFTP, you can exempt the Ansible user id on z/OS from using Co:Z thus falling back to using standard SFTP. If the module detects SCP, it will temporarily use SFTP for transfers, if not available, the module will fail.
 
-   Beginning in version 1.8.x, zos_copy will no longer attempt to autocorrect a copy of a data type member into a PDSE that contains program objects. You can control this behavior using module option executable that will signify an executable is being copied into a PDSE with other executables. Mixing data type members with program objects will be responded with a (FSUM8976,./zos_copy.html) error.
+   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 ``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.
 
 
 
 
@@ -204,7 +204,7 @@ Notes
 
    For supported character sets used to encode data, refer to the `documentation <https://ibm.github.io/z_ansible_collections_doc/ibm_zos_core/docs/source/resources/character_set.html>`_.
 
-   `zos_fetch <./zos_fetch.html>`_ uses SFTP (Secure File Transfer Protocol) for the underlying transfer protocol; Co:Z SFTP is not supported. In the case of Co:z SFTP, you can exempt the Ansible userid on z/OS from using Co:Z thus falling back to using standard SFTP.
+   This module uses SFTP (Secure File Transfer Protocol) for the underlying transfer protocol; SCP (secure copy protocol) and Co:Z SFTP are not supported. In the case of Co:z SFTP, you can exempt the Ansible user id on z/OS from using Co:Z thus falling back to using standard SFTP. If the module detects SCP, it will temporarily use SFTP for transfers, if not available, the module will fail.
Original file line number	Diff line number	Diff line change
`@@ -204,7 +204,7 @@ Notes`
`204`	`204`
`205`	`205`	For supported character sets used to encode data, refer to the `documentation <https://ibm.github.io/z_ansible_collections_doc/ibm_zos_core/docs/source/resources/character_set.html>`_.
`206`	`206`
`207`		- `zos_fetch <./zos_fetch.html>`_ uses SFTP (Secure File Transfer Protocol) for the underlying transfer protocol; Co:Z SFTP is not supported. In the case of Co:z SFTP, you can exempt the Ansible userid on z/OS from using Co:Z thus falling back to using standard SFTP.
	`207`	`+ This module uses SFTP (Secure File Transfer Protocol) for the underlying transfer protocol; SCP (secure copy protocol) and Co:Z SFTP are not supported. In the case of Co:z SFTP, you can exempt the Ansible user id on z/OS from using Co:Z thus falling back to using standard SFTP. If the module detects SCP, it will temporarily use SFTP for transfers, if not available, the module will fail.`
`208`	`208`
`209`	`209`
`210`	`210`