release-v1.9.1

Version 1.9.1

Bugfixes

• zos_find - Option size failed if a PDS/E matched the pattern, now filtering on utilized size for a PDS/E is supported.
• zos_mvs_raw - Option tmp_hlq when creating temporary data sets was previously ignored, now the option honors the High Level Qualifier for temporary data sets created during the module execution.

Availability

• Automation Hub
• Galaxy
• GitHub

Requirements

The IBM z/OS core collection has several dependencies, please review the z/OS core support matrix to understand both the
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_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.

  • If the appropriate level of ZOAU can not be installed, some options are to:

    • 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.

• zos_data_set - An undocumented option size was defined in module zos_data_set, this has been removed to satisfy collection certification, use the intended and documented space_primary option.

• 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.

release-v1.10.0-beta.1

Major Changes

• Starting with IBM Ansible z/OS core version 1.10.x, ZOAU version 1.3.0 will be required.
• Starting with IBM Ansible z/OS core version 1.10.x, all module options are case sensitive,
  review the porting guide for specifics.
• The README has been updated with a new template.
• The Reference section has been renamed to Requirements and now includes a support matrix.

Minor Changes

• zos_apf - Enhanced error messages when an exception is caught.
• zos_backup_restore - Added option tmp_hlq to the user module to override the default high level qualifier (HLQ) for temporary and backup data sets.
• zos_copy - Documented module options group and owner.

Bugfixes

• zos_apf - Option list previously only returned one data set, now it returns a list of retrieved data sets.

• zos_blockinfile - Option block when containing double double quotation marks results in a task failure (failed=True); now the module handles this case to avoid failure.

• zos_find - Option size failed if a PDS/E matched the pattern, now filtering on utilized size for a PDS/E is supported.

• zos_job_submit

  • Did not default to location=DATA_SET when no location was defined, now the location defaults to DATA_SET.
  • Option max_rc previously did not influence a modules status, now the option value influences the tasks failure status.

• zos_mvs_raw - Option tmp_hlq when creating temporary data sets was previously ignored, now the option honors the High Level Qualifier for temporary data sets created during the module execution.

Porting Guide

This section discusses the behavioral changes between ibm_zos_core v1.9.0 and ibm_zos_core v1.10.0-beta.1.
It is intended to assist in updating your playbooks so this collection will continue to work.

• zos_archive

  • option terse_pack no longer accepts uppercase choices, users should replace them with lowercase ones.
  • suboption record_format of dest_data_set no longer accepts uppercase choices, users should replace them with lowercase ones.
  • suboption space_type of dest_data_set no longer accepts uppercase choices, users should replace them with lowercase ones.
  • suboption type of dest_data_set no longer accepts uppercase choices, users should replace them with lowercase ones.

• zos_backup_restore - option space_type no longer accepts uppercase choices, users should replace them with lowercase ones.

• zos_copy

  • suboption record_format of dest_data_set no longer accepts uppercase choices, users should replace them with lowercase ones.
  • suboption space_type of dest_data_set no longer accepts uppercase choices, users should replace them with lowercase ones.
  • suboption type of dest_data_set no longer accepts uppercase choices, users should replace them with lowercase ones.

• zos_data_set

  • option record_format no longer accepts uppercase choices, users should replace them with lowercase ones.
  • option space_type no longer accepts uppercase choices, users should replace them with lowercase ones.
  • option type no longer accepts uppercase choices, users should replace them with lowercase ones.
  • options inside batch no longer accept uppercase choices, users should replace them with lowercase ones.

• zos_job_submit - option location no longer accepts uppercase choices, users should replace them with lowercase ones.

• zos_mount

  • option automove no longer accepts uppercase choices, users should replace them with lowercase ones.
  • option fs_type no longer accepts uppercase choices, users should replace them with lowercase ones.
  • option mount_opts no longer accepts uppercase choices, users should replace them with lowercase ones.
  • option tag_untagged no longer accepts uppercase choices, users should replace them with lowercase ones.
  • option unmount_opts no longer accepts uppercase choices, users should replace them with lowercase ones.

• zos_mvs_raw

  • options inside dd_concat no longer accept uppercase choices, users should replace them with lowercase ones.
  • suboption record_format of dd_data_set no longer accepts uppercase choices, users should replace them with lowercase ones.
  • suboption record_format of dd_unix no longer accepts uppercase choices, users should replace them with lowercase ones.
  • suboption space_type of dd_data_set no longer accepts uppercase choices, users should replace them with lowercase ones.
  • suboption type of dd_data_set no longer accepts uppercase choices, users should replace them with lowercase ones.
  • 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.

• zos_unarchive

  • suboption record_format of dest_data_set no longer accepts uppercase choices, users should replace them with lowercase ones.
  • suboption space_type of dest_data_set no longer accepts uppercase choices, users should replace them with lowercase ones.
  • suboption type of dest_data_set no longer accepts uppercase choices, users should replace them with lowercase ones.

Availability

• Galaxy
• GitHub

Requirements

The IBM z/OS core collection has several dependencies, please review the z/OS core support matrix to understand both the
controller and z/OS managed node dependencies.

release-v1.9.0

Version 1.9.0

Major Changes

• IBM Ansible z/OS core collection (ibm_zos_core) version 1.9.0 will be the last release to support ZOAU 1.2.x.

  • IBM Ansible z/OS core version 1.9.0 will continue to receive security updates and bug fixes.

• Starting with IBM Ansible z/OS core version 1.10.0, ZOAU version 1.3.0 will be required.

• IBM Open Enterprise SDK for Python version 3.9.x is no longer supported.

Minor Changes

• zos_apf - Improved exception handling when the module is unable to process a response originating as a batch update.

• zos_copy - Improved performance when copying multiple members from one PDS/E to another PDS/E.

• zos_job_output - Has been enhanced to allow for both a job ID and owner to be selected when obtaining job output, removing the prior mutual exclusivity.

• zos_operator - Improved the modules handling of ZOAU import errors allowing for the traceback to flow back to the source.

• zos_job_query - Improved the modules handling of ZOAU import errors allowing for the traceback to flow back to the source.

• zos_job_submit

  • Improved messages in the action plugin.

  • Improved the action plugin performance, flow and use of undocumented variables.

  • Improved the modules handling of ZOAU import errors allowing for the traceback to flow back to the source.

  • Improved job status support, now the supported statuses for property ret_code[msg] are:

    • Job status ABEND indicates the job ended abnormally.
    • Job status AC indicates the job is active, often a started task or job taking long.
    • Job status CAB indicates a converter abend.
    • Job status CANCELED indicates the job was canceled.
    • Job status CNV indicates a converter error.
    • Job status FLU indicates the job was flushed.
    • Job status JCLERR or JCL ERROR indicates the JCL has an error.
    • Job status SEC or SEC ERROR indicates the job as encountered a security error.
    • Job status SYS indicates a system failure.
    • Job status ? indicates status can not be determined.

• zos_tso_command

  • Has been updated with a new example demonstrating how to explicitly execute a REXX script in a data set.
  • Has been updated with a new exmaple demonstrating how to chain multiple TSO commands into one invocation using semicolons.

• zos_mvs_raw

  • Has been enhanced to ensure that instream-data for option dd_input contain blanks in columns 1 and 2 while retaining a maximum length
    of 80 columns for strings and a list of strings. This is generally the requirement for most z/OS programs.
  • Has been updated with new examples demonstrating a YAML block indicator, often helpful when wanting to control the
    instream-data formatting.

Bugfixes

• zos_apf - Fixed an issue that when operation=list was selected and more than one data set entry was fetched, only one
  data set was returned, now the complete list is returned.

• zos_copy

  • Fixed an issue that when copying an aliased executable from a data set to a non-existent data set, the destination
    datasets primary and secondary extents would not match the source data set extent sizes.
  • Fixed an issue when performing a copy operation to an existing file, the copied file resulted in having corrupted contents.

• zos_job_submit

  • Fixed an issue that when no location is set, the default is not correctly configured to location=DATA_SET.
  • Fixed an issue that when a JCL error is encountered, the ret_code[msg_code] no longer will contain the multi line marker used to coordinate errors.
  • Fixed an issue that when a response was returned, the property ret_code[msg_text] was incorrectly returned over ret_code[msg_txt].
  • Fixed an issue that when JCL contained TYPRUN=SCAN, the module would fail. The module no longer fails and an appropriate message and response is returned.
  • Fixed an issue that when JCL contained either TYPRUN=COPY, TYPRUN=HOLD, or TYPRUN=JCLHOLD an improper message was returned and the job submission failed.
    Now the job will fail under the condition that the module has exceeded its wait time and return a proper message.
  • Fixed an issue where when option wait_time_s was used, the duration would be approximately 5 seconds longer than what reported in the duration.
    Now the duration is the accounting from when the job is submitted to when the module reads the job output.

• zos_job_output - Fixed an issue that when using a job ID with less than 8 characters, would result in a traceback. The fix
  supports shorter job IDs as well as the use of wildcards.

• zos_job_query - Fixed an issue that when using a job ID with less than 8 characters, would result in a traceback. The fix
  supports shorter job IDs as well as the use of wildcards.

• zos_unarchive

  • Fixed an issue that when using a local file with the USS format option, the module would fail to send the archive to the managed node.
  • Fixed an issue that occurred when unarchiving USS files, the module would leave temporary files behind on the managed node.

• module_utils

  • job.py - Improved exception handling and added a message inside the content of the ddname when a non-printable
    character (character that can not be converted to UTF-8) is encountered.
  • data_set.py - Fixed an issue that when a volser name less than 6 characters was encountered, the volser name was padded with hyphens to have length 6.

Known Issues

Several modules have reported UTF-8 decoding errors when interacting with results that contain non-printable UTF-8 characters in the response.

• This occurs when a module receives content that does not correspond to a UTF-8 value. These include modules zos_job_submit, zos_job_output,
  ``zos_operator_action_query``` but are not limited to this list. This has been addressed in this release and corrected with ZOAU version 1.2.5.6.

• If the appropriate level of ZOAU can not be installed, some options are to:

  • 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.
  • If the error is resulting from a batch job, add ignore_errors:true to the task and capture the output into a variable and extract the job ID with
    a regular expression and 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.

An undocumented option size was defined in module zos_data_set, this has been removed to satisfy collection certification, use the intended
and documented space_primary option.Version 1.9.0

Major Changes

• IBM Ansible z/OS core collection (ibm_zos_core) version 1.9.0 will be the last release to support ZOAU 1.2.x.

  • IBM Ansible z/OS core version 1.9.0 will continue to receive security updates and bug fixes.

• Starting with IBM Ansible z/OS core version 1.10.0, ZOAU version 1.3.0 will be required.

• IBM Open Enterprise SDK for Python version 3.9.x is no longer supported.

Minor Changes

• zos_apf - Improved exception handling when the module is unable to process a response originating as a batch update.

• zos_copy - Improved performance when copying multiple members from one PDS/E to another PDS/E.

• zos_job_output - Has been enhanced to allow for both a job ID and owner to be selected when obtaining job output, removing the prior mutual exclusivity.

• zos_operator - Improved the modules handling of ZOAU import errors allowing for the traceback to flow back to the source.

• zos_job_query - Improved the modules handling of ZOAU import errors allowing for the traceback to flow back to the source.

• zos_job_submit

  • Improved messages in the action plugin.

  • Improved the action plugin performance, flow and use of undocumented variables.

  • Improved the modules handling of ZOAU import errors allowing for the traceback to flow back to the source.

  • Improved job status support, now the supported statuses for property ret_code[msg] are:

    • Job status ABEND indicates the job ended abnormally.
    • Job status AC indicates the job is active, often a started task or job taking long.
    • Job status CAB indicates a converter abend.
    • Job status CANCELED indicates the job was canceled.
    • Job status CNV indicates a converter error.
    • Job status FLU indicates the job was flushed.
    • Job status JCLERR or JCL ERROR indicates the JCL has an error.
    • Job status SEC or SEC ERROR indicates the job as encountered a security error.
    • Job status SYS indicates a system failure.
    • Job status ? indicates status can not be determined.

• zos_tso_command

  • Has been updated with a new example demonstrating how to explicitly execute a REXX script in a data set.
  • Has been updated with a new exmaple demonstrating how to chain multiple TSO commands into one invocation using semicolons.

• zos_mvs_raw

  • Has been enhanced to ensure that instream-data for option dd_input contain blanks in columns 1 and 2 while retaining a maximum length
    of 80 columns for strings and a list of strings. This is generally the requirement for most z/OS programs.
  • Has been updated...

release-v1.9.0-beta.1

Version 1.9.0-beta.1

Minor Changes

• zos_apf - Improved exception handling when the module is unable to process a response originating as a batch update.

• zos_copy - Improved performance when copying multiple members from one PDS/E to another PDS/E.

• zos_job_output - Has been enhanced to allow for both a job ID and owner to be selected when obtaining job output,
  removing the prior mutual exclusivity.

• zos_operator - Improved the modules handling of ZOAU import errors allowing for the traceback to flow back to the source.

• zos_job_query - Improved the modules handling of ZOAU import errors allowing for the traceback to flow back to the source.

• zos_job_submit

  • Improved messages in the action plugin.
  • Improved the action plugin performance, flow and use of undocumented variables.
  • Improved the modules handling of ZOAU import errors allowing for the traceback to flow back to the source.

• zos_tso_command - Has been updated with a new example demonstrating how to explicitly execute a REXX script in a data set.

• zos_mvs_raw

  • Has been enhanced to ensure that instream-data for option dd_input contain blanks in columns 1 and 2 while retaining a maximum length of 80 columns for strings and a list of strings. This is generally the requirement for most z/OS programs.
  • Has been updated with new examples demonstrating a YAML block indicator, often helpful when wanting to control the instream-data formatting.

Bugfixes

• zos_copy

  • Fixed an issue when copying an aliased executable from a data set to a non-existent data set, the destination data sets primary
    and secondary extents would not match the source data set extent sizes.
  • Fixed an issue when performing a copy operation to an existing file, the copied file resulted in having corrupted contents.

• zos_job_output - Fixed an issue that when using a job ID with less than 8 characters would result in a traceback. The fix supports shorter job IDs as well as the use of wildcards.

• zos_job_query - Fixed an issue that when using a job ID with less than 8 characters would result in a traceback. The fix supports shorter job IDs as well as the use of wildcards.

• zos_unarchive

  • Fixed an issue when using a local file with the USS format option that would fail sending it to the managed node.
  • Fixed an issue that occurred when unarchiving USS files that would leave temporary files behind on the managed node.

Known Issues

Several modules have reported UTF-8 decoding errors when interacting with results that contain non-printable UTF-8 characters in the response.

This occurs when a module receives content that does not correspond to a UTF-8 value. These include modules zos_job_submit, zos_job_output, zos_operator_action_query but are not limited to this list. This will be addressed in ibm_zos_core version 1.10.0-beta.1. Each case is unique, some options to work around the error are below.

• Specify that the ASA assembler option be enabled to instruct the assembler to use ANSI control characters instead of machine code control characters.
• Add ignore_errors:true to the playbook task so the task error will not fail the playbook.
• If the error is resulting from a batch job, add ignore_errors:true to the task and capture the output into a variable and extract the job ID with a regular expression and then use zos_job_output to display the DD without the non-printable character such as the DD JESMSGLG.

Availability

• Galaxy
• GitHub

Reference

• Supported by z/OS® V2R4 or later
• Supported by the z/OS® shell
• Supported by IBM Open Enterprise SDK for Python 3.9 - 3.11
• Supported by IBM Z Open Automation Utilities 1.2.5 (or later) but prior to version 1.3.

release-v1.8.0

Version 1.8.0

New Modules

• zos_script - Run scripts in z/OS

Minor Changes

• zos_archive

  • Add validation into path joins to detect unauthorized path traversals.
  • Enhanced test cases to use test lines the same length of the record length.

• zos_copy

  • Add validation into path joins to detect unauthorized path traversals.
  • Add new option force_lock that can copy into data sets that are already in use by other processes (DISP=SHR). User needs to use with caution because this is subject to race conditions and can lead to data loss.
  • Includes a new option executable that enables copying of executables such as load modules or program objects to both USS and partitioned data sets. When the dest option contains a non-existent data set, zos_copy will create a data set with the appropriate attributes for an executable.
  • Introduces a new option 'aliases' to enable preservation of member aliases when copying data to partitioned data sets (PDS) destinations from USS or other PDS sources. Copying aliases of text based members to/from USS is not supported.
  • Add support in zos_copy for text files and data sets containing ASA control characters.

• zos_fetch - Add validation into path joins to detect unauthorized path traversals.

• zos_job_submit

  • Change action plugin call from copy to zos_copy.
  • Previous code did not return output, but still requested job data from the target system. This changes to honor return_output=false by not querying the job dd segments at all.

• zos_operator - Changed system to call wait=true parameter to zoau call. Requires zoau 1.2.5 or later.

• zos_operator_action_query - Add a max delay of 5 seconds on each part of the operator_action_query. Requires zoau 1.2.5 or later.

• zos_unarchive

  • Add validation into path joins to detect unauthorized path traversals.
  • Enhanced test cases to use test lines the same length of the record length.

• module_utils/template - Add validation into path joins to detect unauthorized path traversals.

• zos_tso_command - Add example for executing explicitly a REXX script from a data set.

• zos_script - Add support for remote_tmp from the Ansible configuration to setup where temporary files will be created, replacing the module option tmp_path.

Bugfixes

• zos_copy

  • Update option to include LIBRARY as dest_dataset/suboption value. Documentation updated to reflect this change.
  • When copying an executable data set from controller to managed node, copy operation failed with an encoding error. Fix now avoids encoding when executable option is selected.
  • 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.
  • 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.

• zos_job_submit

  • Temporary files were created in tmp directory. Fix now ensures the deletion of files every time the module run.
  • The last line of the jcl was missing in the input. Fix now ensures the presence of the full input in job_submit.

• zos_lineinfile - A duplicate entry was made even if line was already present in the target file. Fix now prevents a duplicate entry if the line already exists in the target file.

• zos_operator

  • The last line of the operator was missing in the response of the module. The fix now ensures the presence of the full output of the operator.
  • The module was ignoring the wait time argument. The module now passes the wait time argument to ZOAU.

• zos_operator_action_query - The module was ignoring the wait time argument. The module now passes the wait time argument to ZOAU.

• zos_unarchive - When zos_unarchive fails during unpack either with xmit or terse it does not clean the temporary data sets created. Fix now removes the temporary data sets.

Known Issues

• Several modules have reported UTF8 decoding errors when interacting with results that contain non-printable UTF8 characters in the response. This occurs when a module receives content that does not correspond to a UTF-8 value. These include modules zos_job_submit, zos_job_output, zos_operator_action_query but are not limited to this list. This will be addressed in ibm_zos_core version 1.10.0-beta.1. Each case is unique, some options to work around the error are below. - Specify that the ASA assembler option be enabled to instruct the assembler to use ANSI control characters instead of machine code control characters. - Add ignore_errors:true to the playbook task so the task error will not fail the playbook. - If the error is resulting from a batch job, add ignore_errors:true to the task and capture the output into a variable and extract the job ID with a regular expression and then use zos_job_output to display the DD without the non-printable character such as the DD JESMSGLG.
• With later versions of ansible-core used with ibm_zos_core collection a warning has started to appear "Module "ansible.builtin.command" returned non UTF-8 data in the JSON response" that is currently being reviewed. There are no recommendations at this point.

Availability

• Automation Hub
• Galaxy
• GitHub

Reference

• Supported by z/OS®_ V2R4 or later
• Supported by the z/OS® shell
• Supported by IBM Open Enterprise SDK for Python 3.9 - 3.11
• Supported by IBM Z Open Automation Utilities 1.2.4 (or later) but prior to version 1.3.

release-v1.8.0-beta.1

Version 1.8.0-beta.1

New Modules

• zos_script - Run scripts in z/OS

Minor Changes

• zos_archive

  • Add validation into path joins to detect unauthorized path traversals.
  • Enhanced test cases to use test lines the same length of the record length.

• zos_copy

  • Add validation into path joins to detect unauthorized path traversals.
  • Add new option force_lock that can copy into data sets that are already in use by other processes (DISP=SHR). User needs to use with caution because this is subject to race conditions and can lead to data loss.
  • includes a new option executable that enables copying of executables such as load modules or program objects to both USS and partitioned data sets. When the dest option contains a non-existent data set, zos_copy will create a data set with the appropriate attributes for an executable.
  • introduces a new option 'aliases' to enable preservation of member aliases when copying data to partitioned data sets (PDS) destinations from USS or other PDS sources. Copying aliases of text based members to/from USS is not supported.
  • add support in zos_copy for text files and data sets containing ASA control characters.

• zos_fetch - Add validation into path joins to detect unauthorized path traversals.

• zos_job_submit - Change action plugin call from copy to zos_copy.

• zos_operator - Changed system to call 'wait=true' parameter to zoau call. Requires zoau 1.2.5 or later.

• zos_operator_action_query - Add a max delay of 5 seconds on each part of the operator_action_query. Requires zoau 1.2.5 or later.

• zos_unarchive

  • Add validation into path joins to detect unauthorized path traversals.
  • Enhanced test cases to use test lines the same length of the record length.

• module_utils/template - Add validation into path joins to detect unauthorized path traversals.

Bugfixes

• zos_copy - Update option limit to include LIBRARY as dest_dataset/suboption value. Documentation updated to reflect this change.
• zos_job_submit - Temporary files were created in tmp directory. Fix now ensures the deletion of files every time the module run.
• zos_job_submit - The last line of the jcl was missing in the input. Fix now ensures the presence of the full input in job_submit.
• zos_lineinfile - A duplicate entry was made even if line was already present in the target file. Fix now prevents a duplicate entry if the line already exists in the target file.
• zos_operator - The last line of the operator was missing in the response of the module. The fix now ensures the presence of the full output of the operator.

Known Issues

• Several modules have reported UTF8 decoding errors when interacting with results that contain non-printable UTF8 characters in the response. This occurs when a module receives content that does not correspond to a UTF-8 value. These include modules zos_job_submit, zos_job_output, zos_operator_action_query but are not limited to this list. This will be addressed in ibm_zos_core version 1.10.0-beta.1. Each case is unique, some options to work around the error are below. - Specify that the ASA assembler option be enabled to instruct the assembler to use ANSI control characters instead of machine code control characters. - Add ignore_errors:true to the playbook task so the task error will not fail the playbook. - If the error is resulting from a batch job, add ignore_errors:true to the task and capture the output into a variable and extract the job ID with a regular expression and then use zos_job_output to display the DD without the non-printable character such as the DD JESMSGLG.
• With later versions of ansible-core used with ibm_zos_core collection a warning has started to appear "Module "ansible.builtin.command" returned non UTF-8 data in the JSON response" that is currently being reviewed. There are no recommendations at this point.

Availability

• Galaxy
• GitHub

Reference

• Supported by z/OS® V2R4 or later
• Supported by the z/OS® shell
• Supported by IBM Open Enterprise SDK for Python 3.9 - 3.11
• Supported by IBM Z Open Automation Utilities 1.2.4 (or later) but prior to version 1.3.

release-v1.7.0

Version 1.7.0

New Modules

• zos_archive - archive files, data sets and extend archives on z/OS. Formats include, bz2, gz, tar, zip, terse, xmit and pax.
• zos_unarchive - unarchive files and data sets on z/OS. Formats include, bz2, gz, tar, zip, terse, xmit and pax.

Major Changes

-- zos_copy and zos_job_submit - supports Jinja2 templating which is essential for handling tasks that require advanced file modifications such as JCL.

Minor Changes

• zos_copy

  - displays the data set attributes when the destination does not exist and was created by the module.
  - reverts the logic that would automatically create backups in the event of a module failure leaving it up to the user to decide if a backup is needed.
  

• zos_data_set - supports record format F (fixed) where one physical block on disk is one logical record and all the blocks and records are the same size.

• zos_job_output - displays job information asid, creation date, creation time, job class, priority, queue position, service class and conditionally program name (when ZOAU is v1.2.4 or later).

• zos_job_query

  - displays job information *asid*, *creation date*, *creation time*, *job class*, *priority*, *queue position*, *service class* and conditionally *program name* (when ZOAU is v 1.2.4 or later).
  - removes unnecessary queries to find DDs improving the modules performance.
  

• zos_job_submit - displays job information asid, creation date, creation time, job class, priority, queue position, service class and conditionally program name (when ZOAU is v1.2.4 or later).

• zos_archive

  - When XMIT encounters a space error because of the destination (dest) or log data set has reached capacity, the module raises an appropriate error message.
  - When the destination (dest) data set space is not provided, then the module computes it using the source (src) given the pattern provided.
  

• zos_unarchive

  - When copying to the z/OS managed node (remote_src) results in a failure, a proper error message is displayed
  - When copying to the z/OS managed node (remote_src), if the option *primary_space* is not defined, then it is defaulted to 5M.
  

Bugfixes

• zos_data_set - fixes occasionally occurring orphaned VSAM cluster components such as INDEX when present=absent.

• zos_fetch - fixes the warning that appeared about the use of _play_context.verbosity.

• zos_copy

  - fixes the warning that appeared about the use of *_play_context.verbosity*.
  - fixes an issue where subdirectories would not be encoded.
  - fixes an issue where when mode was set, the mode was not applied to existing directories and files.
  - displays a error message when copying into a data set that is being accessed by another process and no longer returns with *changed=true*.
  

• zos_job_output - displays an appropriate error message for a job is not found in the spool.

• zos_operator - fixes the false reports that a command failed when keywords such as error were seen, the module now acts as a passthrough.

• zos_archive - Module did not return the proper src state after archiving. Fix now displays the status of the src after the operation.

Availability

• Automation Hub
• Galaxy
• GitHub

Reference

• Supported by z/OS® V2R4 or later
• Supported by the z/OS® shell
• Supported by IBM Open Enterprise SDK for Python_ 3.9 - 3.11
• Supported by IBM Z Open Automation Utilities 1.2.3 (or later) but prior to version 1.3.

release-v1.7.0-beta.2

Minor Changes

• zos_archive

  - When xmit faces a space error in xmit operation because of dest or log data set being filled raises an appropriate error hint.
  - If destination data set space is not provided then the module computes it based on the src list and/or expanded src list based on pattern provided.
  

• zos_unarchive

  - When copying to remote fails now a proper error message is displayed.
  - When copying to remote if space_primary is not defined, then is defaulted to 5M.
  

Bugfixes

• zos_archive - Module did not return the proper src state after archiving. Fix now displays the status of the src after the operation.

Availability

• Galaxy
• GitHub

Reference

• Supported by z/OS V2R3 or later
• Supported by the z/OS® shell
• Supported by IBM Open Enterprise SDK for Python 3.9 - 3.11
• Supported by IBM Z Open Automation Utilities 1.2.3 (or later) but prior to version 1.3.

release-v1.7.0-beta.1

New Modules

• zos_archive - archive files, data sets and extend archives on z/OS. Formats include, bz2, gz, tar, zip, terse, xmit and pax.
• zos_unarchive - unarchive files and data sets in z/OS. Formats include, bz2, gz, tar, zip, terse, xmit and pax.

Major Changes

-- zos_copy and zos_job_submit - supports Jinja2 templating which is essential for handling tasks that require advanced file modifications such as JCL.

Minor Changes

• zos_copy

  - displays the data set attributes when the destination does not exist and was created by the module.
  - reverts the logic that would automatically create backups in the event of a module failure leaving it up to the user to decide if a backup is needed.
  

• zos_data_set - supports record format F (fixed) where one physical block on disk is one logical record and all the blocks and records are the same size.

• zos_job_output - displays job information asid, creation date, creation time, job class, priority, queue position, service class and conditionally program name (when ZOAU is v 1.2.4 or later).

• zos_job_query
  - displays job information asid, creation date, creation time, job class, priority, queue position, service class and conditionally program name (when ZOAU is v 1.2.4 or later).
  - removes unnecessary queries to find DDs improving the modules performance.

• zos_job_submit - displays job information asid, creation date, creation time, job class, priority, queue position, service class and conditionally program name (when ZOAU is v 1.2.4 or later).

Bugfixes

• zos_data_set - fixes occasionally occurring orphaned VSAM cluster components such as INDEX when present=absent.

• zos_fetch - fixes the warning that appeared about the use of _play_context.verbosity.

• zos_copy

  - fixes the warning that appeared about the use of _play_context.verbosity.
  - fixes an issue where subdirectories would not be encoded.
  - fixes an issue where when mode was set, the mode was not applied to existing directories and files.
  - displays a error message when copying into a data set that is being accessed by another process and no longer returns with `changed=true`.
  

zos_job_output - displays an appropriate error message for a job is not found in the spool.
zos_operator - fixes the false reports that a command failed when keywords such as error were seen, the module now acts as a passthrough.

Availability

• Galaxy
• GitHub

Reference

• Supported by z/OS V2R3_ or later
• Supported by the z/OS® shell
• Supported by IBM Open Enterprise SDK for Python 3.9 - 3.11
• Supported by IBM Z Open Automation Utilities 1.2.3 (or later) but prior to version 1.3.

release-v1.6.0

Version 1.6.0

New Modules

• zos_volume_init - Can initialize volumes or minidisks on target z/OS systems which includes creating a volume label and an entry into the volume table of contents (VTOC).

Minor Changes

• zos_blockinfile - Adds an enhancement to allow double quotes within a block.

• zos_copy

  - Updates the behavior of the `mode` option so that permissions are applied to existing directories and contents.
  - Adds an enhancement to option `restore_backup` to track modified members in a data set in the event of an error, restoring them to their previous state without reallocating the data set.
  

• zos_data_set - Adds a new option named force to enable deletion of a data member in a PDSE that is simultaneously in use by others.

• zos_job_query - Enables embedded positional wild card placement throughout job_name and job_id parameters.

• zos_lineinfile - Adds a new option named force to enable modification of a data member in a data set that is simultaneously in use by others.

• zos_tso_command - Adds a new option named max_rc to enable non-zero return codes lower than the specified maximum return as succeeded.

• module_utils

  - job - Adds support for positional wild card placement for `job_name`` and `job_id`.
  - Adds support for import *common.text.converters* over the deprecated *_text* import.
  

Bugfixes

• zos_copy

  - Fixes a bug where files not encoded in IBM-1047 would trigger an error while computing the record length for a new destination dataset.
  - Fixes a bug where the module would change the mode for a directory when copying in the contents of another directory.
  - Fixes a bug where the incorrect encoding would be used during normalization, particularly when processing newlines in files.
  - Fixes a bug where binary files were not excluded when normalizing data to remove newlines.
  - Fixes a bug where a *_play_context.verbosity* deprecation warning would appear.
  

• zos_fetch - Fixes a bug where a _play_context.verbosity deprecation warning would appear.

• zos_encode - Fixes a bug where converted files were not tagged with the new code set afterwards.

• zos_find - Fixes a bug where the module would stop searching and exit after the first value in a list was not found.

• zos_lineinfile

  - Removes use of Python f-string to ensure support for Python 2.7 on the controller.
  - Fixes a bug where an incorrect error message would be raised when a USS source was not found.
  

• module_utils

  - data_set - Fixes an failure caused by cataloging a VSAM data set when the data set is not cataloged.
  

• zos_data_set - Fixes a bug that will leave VSAM data set cluster components behind when instructed to delete the data set (present=absent).

• zos_gather_facts - Fixes a bug that prevented the module from executing with newer versions of ZOAU.

Availability

• Automation Hub
• Galaxy
• GitHub

Reference

• Supported by z/OS V2R3_ or later
• Supported by the z/OS® shell
• Supported by IBM Open Enterprise SDK for Python_3.9 - 3.11
• Supported by IBM Z Open Automation Utilities 1.2.2 (or later) but prior to version 1.3.