{"id":21217042,"url":"https://github.com/ansible-collections/ibm_zos_cics","last_synced_at":"2025-07-10T11:33:11.179Z","repository":{"id":41831143,"uuid":"274508240","full_name":"ansible-collections/ibm_zos_cics","owner":"ansible-collections","description":"The IBM z/OS CICS collection supports management of CICS resources and definitions in Ansible via the CMCI REST API provided by CICS.","archived":false,"fork":false,"pushed_at":"2024-10-23T16:50:03.000Z","size":6374,"stargazers_count":15,"open_issues_count":4,"forks_count":22,"subscribers_count":12,"default_branch":"main","last_synced_at":"2024-10-23T23:28:10.345Z","etag":null,"topics":["ansible","cics","zos"],"latest_commit_sha":null,"homepage":"https://galaxy.ansible.com/ui/repo/published/ibm/ibm_zos_cics/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ansible-collections.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.rst","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-06-23T21:02:08.000Z","updated_at":"2024-10-23T12:10:54.000Z","dependencies_parsed_at":"2024-03-28T12:29:03.993Z","dependency_job_id":"8c211479-33d2-4f32-862e-9ca4bf781ebb","html_url":"https://github.com/ansible-collections/ibm_zos_cics","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ansible-collections%2Fibm_zos_cics","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ansible-collections%2Fibm_zos_cics/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ansible-collections%2Fibm_zos_cics/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ansible-collections%2Fibm_zos_cics/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ansible-collections","download_url":"https://codeload.github.com/ansible-collections/ibm_zos_cics/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225637324,"owners_count":17500360,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ansible","cics","zos"],"created_at":"2024-11-20T21:56:49.784Z","updated_at":"2025-07-10T11:33:11.173Z","avatar_url":"https://github.com/ansible-collections.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# IBM z/OS CICS collection\n\nThe **IBM® z/OS® CICS® collection**, also represented as **ibm\\_zos\\_cics**\nin this document, is part of the broader initiative to bring Ansible Automation to IBM Z® through the offering\n**Red Hat® Ansible Certified Content for IBM Z®**. The **IBM z/OS CICS collection** supports management of CICS\nresources and definitions through the CMCI REST API provided by CICS as well as provisioning of standalone CICS regions.\n\nThis CICS collection works in conjunction with other Ansible collections for IBM Z,\nsuch as the [IBM z/OS core collection](https://github.com/ansible-collections/ibm_zos_core).\nIt is also possible to use it independently to perform automation tasks solely in CICS.\n\n\n## Red Hat Ansible Certified Content for IBM Z\n\n**Red Hat® Ansible Certified Content for IBM Z** provides the ability to\nconnect IBM Z® to clients' wider enterprise automation strategy through the\nAnsible Automation Platform ecosystem. This enables development and operations\nautomation on Z through a seamless, unified workflow orchestration with\nconfiguration management, provisioning, and application deployment in\none easy-to-use platform.\n\nThe **IBM z/OS CICS collection** is following the\n**Red Hat® Ansible Certified Content for IBM Z®** method of distributing\ncontent. Collections are developed in the open, and when content is ready\nfor use it is released to\n[Ansible Galaxy](https://galaxy.ansible.com/search?keywords=zos_\u0026order_by=-relevance\u0026deprecated=false\u0026type=collection\u0026page=1)\nfor community adoption. Once contributors review community usage, feedback,\nand are satisfied with the content published, the collection will then be\nreleased to [Ansible Automation Hub](https://www.ansible.com/products/automation-hub)\nas **certified** and **IBM supported** for\n**Red Hat® Ansible Automation Platform subscribers**. \n\n\nFor guides and reference, please review the [documentation](https://ibm.github.io/z_ansible_collections_doc/index.html).\n\n## Features\n\nThe IBM CICS collection includes\n[modules](https://ibm.github.io/z_ansible_collections_doc/ibm_zos_cics/docs/source/modules.html),\n[sample playbooks](https://github.com/IBM/z_ansible_collections_samples),\nand ansible-doc to:\n\n- Automate tasks in CICS.\n- Provision or deprovision CICS regions.\n- Start or stop a CICS region.\n\n## Requirements\n\nThe tasks in the IBM® z/OS® CICS® collection can be classified into two types, CMCI tasks and provisioning tasks, and they have different requirements for the managed nodes.\n\n\nFor details on the different requirements, please see [here](https://ibm.github.io/z_ansible_collections_doc/ibm_zos_cics/docs/source/requirements_managed.html).\n\n\n  \n## Installation\n\nYou can install this collection with the Ansible Galaxy command-line tool:\n```sh\nansible-galaxy collection install ibm.ibm_zos_cics\n```\n\n\nYou can also include it in a requirements.yml file and install it with ansible-galaxy collection install -r requirements.yml, using the format:\n```sh\ncollections:\n  - name: ibm.ibm_zos_cics\n```\n\n\nTo install a specific version of the collection or upgrade an existing installation to a specific version, for example installing 2.2.0, use the following syntax:\n```sh\nansible-galaxy collection install ibm.ibm_zos_cics:2.2.0\n```\n\n\nIf you want to upgrade the collection to the latest version, you can run:\n```sh\nansible-galaxy collection install ibm.ibm_zos_cics --upgrade\n```\n\nAs part of the installation, the collection requirements must be made available to Ansible through the use of environment variables. The preferred configuration is to place the environment variables in group_vars and host_vars. An example of the variables file can be seen here:\n\n\n```sh\npyz: \"path_to_python_installation_on_zos_target\"\nzoau: \"path_to_zoau_installation_on_zos_target\"\n\nenvironment_vars:\n  _BPXK_AUTOCVT: \"ON\"\n  ZOAU_HOME: \"{{ zoau }}\"\n  PYTHONPATH: \"{{ zoau }}/lib\"\n  LIBPATH: \"{{ zoau }}/lib:{{ pyz }}/lib:/lib:/usr/lib:.\"\n  PATH: \"{{ zoau }}/bin:{{ pyz }}/bin:/bin:/var/bin\"\n  _CEE_RUNOPTS: \"FILETAG(AUTOCVT,AUTOTAG) POSIX(ON)\"\n  _TAG_REDIR_ERR: \"txt\"\n  _TAG_REDIR_IN: \"txt\"\n  _TAG_REDIR_OUT: \"txt\"\n  LANG: \"C\"\n```\n\n## Use cases\n\n* Use case name: Provision a standalone CICS region \n  * Actors:\n    * System Programmer\n  * Description:\n    * A system programmer can provision a set of region data sets and start up a standalone CICS region.\n  * Flow:\n    * Create and activate a VTAM node to ensure user has a valid applid\n    * Create region data sets\n    * Update the CSD data set with a CSDUP script\n    * Create CICS startup JCL data set\n    * Submit the CICS startup JCL data set as a job using zoau's jsub\n* Use case name: Deprovision a standalone CICS region\n  * Actors:\n    * System Programmer\n  * Description:\n    * A system programmer can stop a standalone CICS region and delete the region data sets.\n  * Flow:\n    * Stop the CICS region\n    * Check the CICS region has been shut down\n    * If it has not stopped, shut the region down with state \"immediate\" or cancel the job.\n    * Delete the region data sets\n    * Delete the CICS startup JCL data set\n* Use case name: Provision an SMSS CICS region\n  * Actors:\n    * System Programmer\n  * Description:\n    * A system programmer can start a SMSS CICS region.\n  * Flow:\n    * Create and activate a VTAM node to ensure user has a valid applid\n    * Ensure user has an allocated/free port available\n    * Create region data sets\n    * Update the CSD data with a CSDUP script which also alters the TCPIP service\n    * Create CICS startup JCL data set\n    * Submit the CICS startup JCL data set as a job using zoau's jsub task\n* Use case name: Install a bundle in a CICS region\n  * Actors:\n    * Application Developer\n  * Description:\n    * An application developer can install a CICS bundle into a CICS region\n  * Flow:\n    * Find if the CICS bundle already exists in the target region\n    * Disable and discard existing CICS bundle\n    * Install bundle definition into the target region\n    * Wait for bundle to reach enabled status\n* Use case name: Deploy a program to a CICS region\n  * Actors:\n    * Application Developer\n  * Description:\n    * An application developer can deploy a program to a CICS region\n  * Flow:\n    * Copy load module to load library\n    * Use NEWCOPY PROGRAM to deploy program into CICS\n\n## Release notes and roadmap\n\nThe collection's cumulative release notes can be reviewed [here](https://ibm.github.io/z_ansible_collections_doc/ibm_zos_cics/docs/source/release_notes.html).\n\n\u003cbr/\u003eThe collection's changelogs can be reviewed in the following table.\n\n| Version  | Status         | Release notes | Changelogs |\n|----------|----------------|---------------|------------|\n| 2.2.0   | Released       | [Release notes](https://ibm.github.io/z_ansible_collections_doc/ibm_zos_cics/docs/source/release_notes.html#version-2-2-0)    | [Changelogs](https://github.com/ansible-collections/ibm_zos_cics/blob/v2.2.0/CHANGELOG.rst)  |\n| 2.1.1   | Released       | [Release notes](https://ibm.github.io/z_ansible_collections_doc/ibm_zos_cics/docs/source/release_notes.html#version-2-1-1)    | [Changelogs](https://github.com/ansible-collections/ibm_zos_cics/blob/v2.1.1/CHANGELOG.rst)  |\n| 2.1.0   | Released       | [Release notes](https://ibm.github.io/z_ansible_collections_doc/ibm_zos_cics/docs/source/release_notes.html#version-2-1-0)    | [Changelogs](https://github.com/ansible-collections/ibm_zos_cics/blob/v2.1.0/CHANGELOG.rst)  |\n| 2.0.x    | Released       | [Release notes](https://ibm.github.io/z_ansible_collections_doc/ibm_zos_cics/docs/source/release_notes.html#version-2-0-0)    | [Changelogs](https://github.com/ansible-collections/ibm_zos_cics/blob/v2.0.0/CHANGELOG.rst)  |\n| 1.0.x    | Released       | [Release notes](https://ibm.github.io/z_ansible_collections_doc/ibm_zos_cics/docs/source/release_notes.html#version-1-0-6)    | [Changelogs](https://github.com/ansible-collections/ibm_zos_cics/blob/v1.0.6/CHANGELOG.rst)  |\n\n\n## Related information \n\nExample playbooks and use cases can be found in the [z/OS playbook repository](https://github.com/IBM/z_ansible_collections_samples).\nSupplemental content on getting started with Ansible, architecture and use cases is available [here](https://ibm.github.io/z_ansible_collections_doc/reference/helpful_links.html).\n\n## Contributing\n\nWe welcome contributions! Find out how in our [contribution guide](https://github.com/ansible-collections/ibm_zos_cics/blob/main/CONTRIBUTING.md).\n\n## Copyright \n\n© Copyright IBM Corporation 2021, 2025.\n\n## License\n\nThis collection is licensed under the [Apache License,\nVersion 2.0](https://opensource.org/licenses/Apache-2.0).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fansible-collections%2Fibm_zos_cics","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fansible-collections%2Fibm_zos_cics","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fansible-collections%2Fibm_zos_cics/lists"}