Merge pull request #132 from andrewhughes101/main

Copy content for provisioing modules for release 2.1.0

.bandit.baseline

@@ -0,0 +1,210 @@
+{
+  "errors": [],
+  "generated_at": "2024-05-20T09:55:19Z",
+  "metrics": {
+    "./__init__.py": {
+      "CONFIDENCE.HIGH": 0,
+      "CONFIDENCE.LOW": 0,
+      "CONFIDENCE.MEDIUM": 0,
+      "CONFIDENCE.UNDEFINED": 0,
+      "SEVERITY.HIGH": 0,
+      "SEVERITY.LOW": 0,
+      "SEVERITY.MEDIUM": 0,
+      "SEVERITY.UNDEFINED": 0,
+      "loc": 0,
+      "nosec": 0,
+      "skipped_tests": 0
+    },
+    "./docs/ansible-doc-extractor-collections.py": {
+      "CONFIDENCE.HIGH": 0,
+      "CONFIDENCE.LOW": 0,
+      "CONFIDENCE.MEDIUM": 0,
+      "CONFIDENCE.UNDEFINED": 0,
+      "SEVERITY.HIGH": 0,
+      "SEVERITY.LOW": 0,
+      "SEVERITY.MEDIUM": 0,
+      "SEVERITY.UNDEFINED": 0,
+      "loc": 18,
+      "nosec": 0,
+      "skipped_tests": 0
+    },
+    "./docs/source/conf.py": {
+      "CONFIDENCE.HIGH": 0,
+      "CONFIDENCE.LOW": 0,
+      "CONFIDENCE.MEDIUM": 0,
+      "CONFIDENCE.UNDEFINED": 0,
+      "SEVERITY.HIGH": 0,
+      "SEVERITY.LOW": 0,
+      "SEVERITY.MEDIUM": 0,
+      "SEVERITY.UNDEFINED": 0,
+      "loc": 11,
+      "nosec": 0,
+      "skipped_tests": 0
+    },
+    "./plugins/__init__.py": {
+      "CONFIDENCE.HIGH": 0,
+      "CONFIDENCE.LOW": 0,
+      "CONFIDENCE.MEDIUM": 0,
+      "CONFIDENCE.UNDEFINED": 0,
+      "SEVERITY.HIGH": 0,
+      "SEVERITY.LOW": 0,
+      "SEVERITY.MEDIUM": 0,
+      "SEVERITY.UNDEFINED": 0,
+      "loc": 0,
+      "nosec": 0,
+      "skipped_tests": 0
+    },
+    "./plugins/doc_fragments/cmci.py": {
+      "CONFIDENCE.HIGH": 0,
+      "CONFIDENCE.LOW": 0,
+      "CONFIDENCE.MEDIUM": 0,
+      "CONFIDENCE.UNDEFINED": 0,
+      "SEVERITY.HIGH": 0,
+      "SEVERITY.LOW": 0,
+      "SEVERITY.MEDIUM": 0,
+      "SEVERITY.UNDEFINED": 0,
+      "loc": 259,
+      "nosec": 0,
+      "skipped_tests": 0
+    },
+    "./plugins/module_utils/__init__.py": {
+      "CONFIDENCE.HIGH": 0,
+      "CONFIDENCE.LOW": 0,
+      "CONFIDENCE.MEDIUM": 0,
+      "CONFIDENCE.UNDEFINED": 0,
+      "SEVERITY.HIGH": 0,
+      "SEVERITY.LOW": 0,
+      "SEVERITY.MEDIUM": 0,
+      "SEVERITY.UNDEFINED": 0,
+      "loc": 0,
+      "nosec": 0,
+      "skipped_tests": 0
+    },
+    "./plugins/module_utils/cmci.py": {
+      "CONFIDENCE.HIGH": 0,
+      "CONFIDENCE.LOW": 0,
+      "CONFIDENCE.MEDIUM": 1,
+      "CONFIDENCE.UNDEFINED": 0,
+      "SEVERITY.HIGH": 0,
+      "SEVERITY.LOW": 1,
+      "SEVERITY.MEDIUM": 0,
+      "SEVERITY.UNDEFINED": 0,
+      "loc": 633,
+      "nosec": 0,
+      "skipped_tests": 0
+    },
+    "./plugins/modules/__init__.py": {
+      "CONFIDENCE.HIGH": 0,
+      "CONFIDENCE.LOW": 0,
+      "CONFIDENCE.MEDIUM": 0,
+      "CONFIDENCE.UNDEFINED": 0,
+      "SEVERITY.HIGH": 0,
+      "SEVERITY.LOW": 0,
+      "SEVERITY.MEDIUM": 0,
+      "SEVERITY.UNDEFINED": 0,
+      "loc": 0,
+      "nosec": 0,
+      "skipped_tests": 0
+    },
+    "./plugins/modules/cmci_action.py": {
+      "CONFIDENCE.HIGH": 0,
+      "CONFIDENCE.LOW": 0,
+      "CONFIDENCE.MEDIUM": 0,
+      "CONFIDENCE.UNDEFINED": 0,
+      "SEVERITY.HIGH": 0,
+      "SEVERITY.LOW": 0,
+      "SEVERITY.MEDIUM": 0,
+      "SEVERITY.UNDEFINED": 0,
+      "loc": 505,
+      "nosec": 0,
+      "skipped_tests": 0
+    },
+    "./plugins/modules/cmci_create.py": {
+      "CONFIDENCE.HIGH": 0,
+      "CONFIDENCE.LOW": 0,
+      "CONFIDENCE.MEDIUM": 0,
+      "CONFIDENCE.UNDEFINED": 0,
+      "SEVERITY.HIGH": 0,
+      "SEVERITY.LOW": 0,
+      "SEVERITY.MEDIUM": 0,
+      "SEVERITY.UNDEFINED": 0,
+      "loc": 468,
+      "nosec": 0,
+      "skipped_tests": 0
+    },
+    "./plugins/modules/cmci_delete.py": {
+      "CONFIDENCE.HIGH": 0,
+      "CONFIDENCE.LOW": 0,
+      "CONFIDENCE.MEDIUM": 0,
+      "CONFIDENCE.UNDEFINED": 0,
+      "SEVERITY.HIGH": 0,
+      "SEVERITY.LOW": 0,
+      "SEVERITY.MEDIUM": 0,
+      "SEVERITY.UNDEFINED": 0,
+      "loc": 447,
+      "nosec": 0,
+      "skipped_tests": 0
+    },
+    "./plugins/modules/cmci_get.py": {
+      "CONFIDENCE.HIGH": 0,
+      "CONFIDENCE.LOW": 0,
+      "CONFIDENCE.MEDIUM": 0,
+      "CONFIDENCE.UNDEFINED": 0,
+      "SEVERITY.HIGH": 0,
+      "SEVERITY.LOW": 0,
+      "SEVERITY.MEDIUM": 0,
+      "SEVERITY.UNDEFINED": 0,
+      "loc": 535,
+      "nosec": 0,
+      "skipped_tests": 0
+    },
+    "./plugins/modules/cmci_update.py": {
+      "CONFIDENCE.HIGH": 0,
+      "CONFIDENCE.LOW": 0,
+      "CONFIDENCE.MEDIUM": 0,
+      "CONFIDENCE.UNDEFINED": 0,
+      "SEVERITY.HIGH": 0,
+      "SEVERITY.LOW": 0,
+      "SEVERITY.MEDIUM": 0,
+      "SEVERITY.UNDEFINED": 0,
+      "loc": 477,
+      "nosec": 0,
+      "skipped_tests": 0
+    },
+    "_totals": {
+      "CONFIDENCE.HIGH": 0,
+      "CONFIDENCE.LOW": 0,
+      "CONFIDENCE.MEDIUM": 1,
+      "CONFIDENCE.UNDEFINED": 0,
+      "SEVERITY.HIGH": 0,
+      "SEVERITY.LOW": 1,
+      "SEVERITY.MEDIUM": 0,
+      "SEVERITY.UNDEFINED": 0,
+      "loc": 3353,
+      "nosec": 0,
+      "skipped_tests": 0
+    }
+  },
+  "results": [
+    {
+      "code": "35 CMCI_USER = 'cmci_user'\n36 CMCI_PASSWORD = 'cmci_password'\n37 CMCI_CERT = 'cmci_cert'\n",
+      "col_offset": 16,
+      "end_col_offset": 31,
+      "filename": "./plugins/module_utils/cmci.py",
+      "issue_confidence": "MEDIUM",
+      "issue_cwe": {
+        "id": 259,
+        "link": "https://cwe.mitre.org/data/definitions/259.html"
+      },
+      "issue_severity": "LOW",
+      "issue_text": "Possible hardcoded password: 'cmci_password'",
+      "line_number": 36,
+      "line_range": [
+        36
+      ],
+      "more_info": "https://bandit.readthedocs.io/en/1.7.8/plugins/b105_hardcoded_password_string.html",
+      "test_id": "B105",
+      "test_name": "hardcoded_password_string"
+    }
+  ]
+}

.gitignore

@@ -5,7 +5,12 @@ docs/build/
 __pycache__
 venv*
 .venv
+core
 tests/output
 ibm-ibm_zos_cics-*.tar.gz
 tests/integration/inventory
-tests/integration/variables/cmci.yml
+tests/integration/inventory_zos.yml
+tests/integration/variables/cmci.yml
+tests/integration/variables/provisioning.yml
+tests/integration/variables/utilities.yml
+tests/integration/variables/zos.yml

CHANGELOG.rst

@@ -5,6 +5,47 @@ ibm.ibm_zos_cics Release Notes
 .. contents:: Topics
 
 
+v2.1.0
+======
+
+Release Summary
+---------------
+
+General Availability of CICS provisioning modules. You can use these Ansible modules to create automation tasks that provision or deprovision, and start or stop a CICS region. Sample playbooks show you how to do this with the latest version of the Ansible IBM z/OS CICS collection. All modules were initially released with Version 1.1.0-beta as noted below. Subsequent Version 1.1.0-beta releases may include enhancements and bugfixes for these modules. Refer to the What's new of Version 1.1.0-beta releases for details.
+This release replaces all the previous 1.1.0-beta* releases.
+You can use the following modules for provisioning and managing CICS TS data sets
+``aux_temp_storage`` for the CICS auxiliary temporary storage data set. This module was initially released as ``auxiliary_temp`` with Version 1.1.0-beta.4. The module is changed to ``aux_temp_storage`` in Version 2.1.0.
+``aux_trace`` for the CICS auxiliary trace data sets. This module was initially released as ``trace`` with Version 1.1.0-beta.4. The module is changed to ``aux_trace`` in Version 2.1.0.
+``csd`` for the CICS system definition data set. This module was initially released with Version 1.1.0-beta.4.
+``global_catalog`` for the CICS global catalog data set. This module was initially released with Version 1.1.0-beta.4.
+``local_request_queue`` for the CICS local request queue data set. This module was initially released with Version 1.1.0-beta.3.
+``td_intrapartition`` for the CICS transient data intrapartition data set. This module was initially released as ``intrapartition`` with Version 1.1.0-beta.4. The module is changed to ``td_intrapartition`` in Version 2.1.0.
+``transaction_dump`` for the CICS transaction dump data sets. This module was initially released with Version 1.1.0-beta.4.
+You can use the following modules for CICS startup and shutdown operations
+``region_jcl`` - Create a CICS startup JCL data set. This module replaces ``start_cics``, which was released with Version 1.1.0-beta.5. ``region_jcl`` is significantly different from ``start_cics`` in function. ``region_jcl`` creates a data set that contains the startup JCL, but doesn't perform the actual startup processing. ``region_jcl`` also supports definition and allocation of user data sets with the ``user_data_sets`` parameter.
+``stop_region`` - Stop a CICS region. This module was initially released as ``stop_cics`` with Version 1.1.0-beta.5. The module is changed to ``stop_region`` in Version 2.1.0. In Version 2.1.0, ``stop_region`` supports a new input parameter, ``job_name`` so that you can use the job name, which is typically the CICS's APPLID, to identify a running CICS region.
+The group name for the CICS provisioning modules is ``region``. However, in the Version 1.1.0-beta releases, the group name was ``region_group``.
+CICS provisioning modules provide support for all in-service CICS TS releases including the latest CICS TS 6.2.
+
+Deprecated Features
+-------------------
+
+- The group name for the CMCI modules is changed to ``cmci`` instead of ``cmci_group``. ``cmci_group`` is deprecated.
+
+New Modules
+-----------
+
+- ibm.ibm_zos_cics.aux_temp_storage - Create and remove the CICS auxiliary temporary storage data set
+- ibm.ibm_zos_cics.aux_trace - Allocate auxiliary trace data sets
+- ibm.ibm_zos_cics.csd - Create, remove, and manage the CICS CSD
+- ibm.ibm_zos_cics.global_catalog - Create, remove, and manage the CICS global catalog
+- ibm.ibm_zos_cics.local_catalog - Create, remove, and manage the CICS local catalog
+- ibm.ibm_zos_cics.local_request_queue - Create and remove the CICS local request queue
+- ibm.ibm_zos_cics.region_jcl - Create CICS startup JCL data set
+- ibm.ibm_zos_cics.stop_region - Stop a CICS region
+- ibm.ibm_zos_cics.td_intrapartition - Create and remove the CICS transient data intrapartition data set
+- ibm.ibm_zos_cics.transaction_dump - Allocate transaction dump data sets
+
 v2.0.0
 ======
 

CONTRIBUTING.md

@@ -1,4 +1,4 @@
-# (c) Copyright IBM Corp. 2020,2021
+# (c) Copyright IBM Corp. 2020,2023
 # Developer guide
 
 ### Licensing

README.md

@@ -3,7 +3,7 @@
 The **IBM® z/OS® CICS® collection**, also represented as **ibm\_zos\_cics**
 in this document, is part of the broader initiative to bring Ansible Automation to IBM Z® through the offering
 **Red Hat® Ansible Certified Content for IBM Z®**. The **IBM z/OS CICS collection** supports management of CICS
-resources and definitions via the CMCI REST API provided by CICS.
+resources and definitions through the CMCI REST API provided by CICS as well as provisioning of standalone CICS regions.
 
 This CICS collection works in conjunction with other Ansible collections for IBM Z,
 such as the [IBM z/OS core collection](https://github.com/ansible-collections/ibm_zos_core).
@@ -38,7 +38,11 @@ For guides and reference, please review the [documentation](https://ibm.github.i
 The IBM CICS collection includes
 [modules](https://ibm.github.io/z_ansible_collections_doc/ibm_zos_cics/docs/source/modules.html),
 [sample playbooks](https://github.com/IBM/z_ansible_collections_samples),
-and ansible-doc to automate tasks in CICS.
+and ansible-doc to:
+
+- Automate tasks in CICS.
+- Provision or deprovision CICS regions.
+- Start or stop a CICS region.
 
 ## Contributing
 

changelogs/.plugin-cache.yaml

@@ -11,6 +11,16 @@ plugins:
   inventory: {}
   lookup: {}
   module:
+    aux_temp_storage:
+      description: Create and remove the CICS auxiliary temporary storage data set
+      name: aux_temp_storage
+      namespace: ''
+      version_added: 2.1.0
+    aux_trace:
+      description: Allocate auxiliary trace data sets
+      name: aux_trace
+      namespace: ''
+      version_added: 2.1.0
     cmci_action:
       description: Perform actions on CICS and CICSPlex SM resources
       name: cmci_action
@@ -36,9 +46,49 @@ plugins:
       name: cmci_update
       namespace: ''
       version_added: 1.0.0
+    csd:
+      description: Create, remove, and manage the CICS CSD
+      name: csd
+      namespace: ''
+      version_added: 2.1.0
+    global_catalog:
+      description: Create, remove, and manage the CICS global catalog
+      name: global_catalog
+      namespace: ''
+      version_added: 2.1.0
+    local_catalog:
+      description: Create, remove, and manage the CICS local catalog
+      name: local_catalog
+      namespace: ''
+      version_added: 2.1.0
+    local_request_queue:
+      description: Create and remove the CICS local request queue
+      name: local_request_queue
+      namespace: ''
+      version_added: 2.1.0
+    region_jcl:
+      description: Create CICS startup JCL data set
+      name: region_jcl
+      namespace: ''
+      version_added: 2.1.0
+    stop_region:
+      description: Stop a CICS region
+      name: stop_region
+      namespace: ''
+      version_added: 2.1.0
+    td_intrapartition:
+      description: Create and remove the CICS transient data intrapartition data set
+      name: td_intrapartition
+      namespace: ''
+      version_added: 2.1.0
+    transaction_dump:
+      description: Allocate transaction dump data sets
+      name: transaction_dump
+      namespace: ''
+      version_added: 2.1.0
   netconf: {}
   shell: {}
   strategy: {}
   test: {}
   vars: {}
-version: 2.0.0
+version: 2.1.0