How ansible-collections/ibm_zos_cics works
This Ansible collection automates CICS resource management through CMCI and provisions or stops standalone CICS regions. Its user workflow begins with an Ansible task, dispatches to a collection module, and returns results; provisioning additionally prepares region data sets and startup JCL before region startup. The README documents these capabilities and workflows. Sampled source confirms the auxiliary-data-set action dispatch and parts of CMCI and JCL handling; other module internals were not sampled, so their relationships are shown only where documented.
Main entry points: modules Resource tasks · cmci_get.py CMCI task modules · region_jcl.py Region JCL · aux_temp_storage.py Aux temp storage
Components 28
CMCI resource management
- CMCI task modules
plugins/modules/cmci_get.py - CMCI GET
plugins/modules/cmci_get.py - CMCI create
plugins/modules/cmci_create.py - CMCI update
plugins/modules/cmci_update.py - CMCI delete
plugins/modules/cmci_delete.py - CMCI action
plugins/modules/cmci_action.py
CICS resource modules
- Resource tasks
plugins/modules - Aux temp storage
plugins/modules/aux_temp_storage.py - Auxiliary trace
plugins/modules/aux_trace.py - CSD management
plugins/modules/csd.py - Global catalog
plugins/modules/global_catalog.py - Local catalog
plugins/modules/local_catalog.py - Local request queue
plugins/modules/local_request_queue.py - TD intrapartition
plugins/modules/td_intrapartition.py - Transaction dump
plugins/modules/transaction_dump.py - Aux temp action
plugins/action/aux_temp_storage.py
Region provisioning
- Region JCL
plugins/modules/region_jcl.py - Stop region
plugins/modules/stop_region.py - Stop action plugin
plugins/action/stop_region.py
Shared runtime
- CMCI client
plugins/module_utils/cmci.py - JCL renderer
plugins/module_utils/_jcl_helper.py - Data-set operations
plugins/module_utils/_data_set.py - Data-set dispatcher
plugins/plugin_utils/_module_action_plugin.py - Aux storage helper
plugins/module_utils/_aux_temp_storage.py
Other components
- Ansible user
- CICS CMCI API
- System programmer
- z/OS region services
Connections 26
- Ansible user → CMCI task modules: requests resource task
README.md - CMCI task modules → CMCI client: uses CMCI
- CMCI client → CICS CMCI API: sends REST requests
README.md - Ansible user → Resource tasks: requests CICS task
README.md - Ansible user → Region JCL: provisions region
README.md - Ansible user → Stop region: stops region
README.md - Region JCL → Data-set operations: manages data sets
- Region JCL → JCL renderer: renders JCL
plugins/modules/region_jcl.py - Stop region → Stop action plugin: dispatches stop
- Stop action plugin → z/OS region services: checks and stops region
README.md - Aux temp action → Data-set dispatcher: dispatches module
plugins/action/aux_temp_storage.py - Data-set dispatcher → Aux temp storage: executes module
plugins/plugin_utils/_module_action_plugin.py - Aux temp storage → Aux storage helper: uses helper
plugins/modules/aux_temp_storage.py - Resource tasks → Aux temp storage: includes
- Resource tasks → Auxiliary trace: includes
- Resource tasks → CSD management: includes
- Resource tasks → Global catalog: includes
- Resource tasks → Local catalog: includes
- Resource tasks → Local request queue: includes
- Resource tasks → TD intrapartition: includes
- Resource tasks → Transaction dump: includes
- CMCI task modules → CMCI GET: implements GET
plugins/modules/cmci_get.py - CMCI task modules → CMCI create: implements create
- CMCI task modules → CMCI update: implements update
- CMCI task modules → CMCI delete: implements delete
- CMCI task modules → CMCI action: implements action