The new zos_started_task module debuts in version 1.16.0-beta.1, enabling Ansible playbooks to interact directly with started tasks on z/OS.
This module allows you to perform operations such as starting, canceling, stopping, modifying, and querying the status of started tasks, simplifying what used to require complex TSO or operator commands, and even more complex, trying to parse the output of the commands in playbooks!! It’s ideal for automating operations workflows, validating environments, or orchestrating service restarts as part of a larger automation pipeline.
So, of course, stopping or canceling it is just as simple:
- name: Stop a started task using it's task name.
zos_started_task:
state: "stopped"
task_name: "SAMPLE"
But wait, that stops all started tasks whose name is SAMPLE, what happens if I want to stop a specific task, well you can use the task id or asid:
- name: Stop a started task using a started task id.
zos_started_task:
state: "stopped"
task_id: "STC00087"
This unlocks handling a core z/OS operation as an automation block that was not previously available, hope this helps setting up your LPARs! We will do a deep dive in the GA blog later this year.
Enhancements
This release continues to refine existing modules with better error handling, new aliases for improved usability, and enhanced support for z/OS-specific operations. Below are some of the highlights:
- zos_apf
- Adds new alias target for data_set_name and a warning message that it will be deprecated on 2.0.0.
- zos_archive
- Adds new alias adrdssu for use_adrdssu and a warning message that it will be deprecated on 2.0.0.
- Adds new alias options for format_options and a warning message that it will be deprecated on 2.0.0.
- Adds new alias type for name and a warning message that it will be deprecated on 2.0.0.
- zos_backup_restore
- Adds compress option to enable compression of partitioned data sets using hardware compression if available.
- Adds terse option to modify the behavior of executing an AMATERSE step to compress the temporary data set for the backup.
- zos_copy
- Adds a better error message that gives user a hint that copy issue can be due to a GDS part of src GDG is being used by another process.
- Adds new alias binary for is_binary and warning message that will be deprecated on 2.0.0.
- Adds new alias replace for force and a warning message that it will be deprecated on 2.0.0.
- zos_data_set
- Enhances error messages when creating a Generation Data Group fails.
- Enhances error messages when deleting a Generation Data Group fails.
- Adds noscratch functionality into the scratch option. This allows uncataloging a data set without deleting it from the volume's VTOC.
- zos_fetch
- Adds new alias binary for is_binary and warning message that will be deprecated on 2.0.0.
- zos_job_output
- Adds new alias dd_name for ddname and warning message that will be alias on 2.0.0.
- Adds support to query SYSIN DDs from a job with new option input.
- zos_job_submit
- Adds new alias wait_time for wait_time_s and warning message that will be deprecated on 2.0.0.
- Adds support for jobs with TYPRUN=JCLHOLD and TYPRUN=HOLD.
- zos_mount
- Adds new alias marker for comment and warning message that will be deprecated on 2.0.0.
- Adds new alias name for data_store and warning message that will be deprecated on 2.0.0.
- zos_mvs_raw
- Adds new raw option under dd_data_set that lets the MVS program create datasets with its own DCB attributes without the user having to specify them.
- zos_operator
- Adds new alias wait_time for wait_time_s and warning message that will be deprecated on 2.0.0.
- zos_unarchive
- Adds new alias adrdssu for use_adrdssu and warning message that will be deprecated on 2.0.0.
- Adds new alias options for format_options and warning message that will be deprecated on 2.0.0.
- Adds new alias type for name and warning message that will be deprecated on 2.0.0.
Bugfixes
- zos_backup_restore – Module documentation stated that default space_type for a backup was m but module would use bytes instead. Fix now uses the correct default space type, which is m for megabytes.
What are we working on?
Yes, you read that right: version 2.0 is coming next year! Over the past quarter and a half, we've been hard at work crafting a major release that brings a fresh wave of enhancements, standardized module interfaces, and a redesigned experience that embraces powerful new features.
We chose to work on a 2.0 version this year in celebration of the collection’s 5-year anniversary, a milestone that reflects how far we've come. One of the key drivers behind this release was the need to evolve the zos_backup_restore module. With ZOAU now supporting more advanced capabilities, the existing interface simply couldn’t accommodate them effectively. A redesign was not just beneficial, it was necessary.
As you can imagine, a lot can change in five years. Some of our module interfaces had drifted from their original design, and several option names were not aligned with our latest guidelines. This release gave us the perfect opportunity to modernize those interfaces, ensuring consistency and paving the way for future innovation.
We’re really excited about what’s ahead: roles, filters, improved debugging options, and a bunch of other enhancements we can’t wait to share with you!
But before we get too far ahead, we want to help you prepare. With the final minor release in the 1.x.x series, we’re starting to roll out deprecation notices for some option names that will be renamed in 2.0. This gives you a chance to take the first step toward updating your playbooks and easing into the migration.
We know change can be a bit of a process, but we’re here to make it as smooth as possible—and trust us, the new features will be worth it!
Got questions or feedback?
Drop by our GitHub discussions or open issues at: https://github.com/ansible-collections/ibm_zos_core/issues