Automated commit to update documentation

_sources/ibm_zos_ims/docs/source/modules/ims_acb_gen.rst.txt

@@ -16,8 +16,8 @@ ims_acb_gen -- Generate IMS ACB
 
 Synopsis
 --------
-- The ims_acb_gen module generates an IMS application control block (ACB) necessary for an IMS application program to be scheduled and run.
-- The ims_dbd_gen and ims_psb_gen modules can be used to generate the associated IMS database descriptors (DBDs) and program specification block (PSBs) to be used with the ims_acb_gen module.
+- The ims\_acb\_gen module generates an IMS application control block (ACB) necessary for an IMS application program to be scheduled and run.
+- The ims\_dbd\_gen and ims\_psb\_gen modules can be used to generate the associated IMS database descriptors (DBDs) and program specification block (PSBs) to be used with the ims\_acb\_gen module.
 - The DBD and PSB control blocks will be merged and expanded into an IMS internal format called application control blocks (ACBs).
 
 
@@ -43,17 +43,15 @@ command_input
 compression
   PRECOMP,POSTCOMP, in any combination, cause the required in-place compression.
 
-  The choices are not mutually exclusive -- PRECOMP or POSTCOMP or PRECOMP,POSTCOMP can be used
-
   The default is none.
 
   | **required**: False
   | **type**: str
-  | **choices**: PRECOMP, POSTCOMP
+  | **choices**: precomp, postcomp, precomp,postcomp, PRECOMP, POSTCOMP, PRECOMP,POSTCOMP
 
 
 psb_name
-  The name of the PS**s**. Specifies that blocks are built or deleted for all PSBs that are named on this control statement.
+  The name of the PSB(s). Specifies that blocks are built or deleted for all PSBs that are named on this control statement.
 
   This field requires "ALL" or a list of psb names to be specified.
 
@@ -73,7 +71,7 @@ dbd_name
 acb_lib
   The ACB Maintenance utility maintains the prebuilt blocks (ACB) library (IMS.ACBLIB). The ACB library is a consolidated library of program (PSB) and database (DBD) descriptions.
 
-  The IMS acb_lib must be used exclusively. The module can only be executed using an ACB library which is not concurrently allocated to an active IMS system.
+  The IMS acb\_lib must be used exclusively. The module can only be executed using an ACB library which is not concurrently allocated to an active IMS system.
 
   | **required**: True
   | **type**: str
@@ -82,7 +80,7 @@ acb_lib
 psb_lib
   The ACB Maintenance utility receives input from the IMS PSBLIB data set.
 
-  The ACB Maintenance utility does not change the PS**s** in PSBLIB. If changes are made in PSBs or DBDs that require changes in the associated PSB, make these changes before running the module.
+  The ACB Maintenance utility does not change the PSB(s) in PSBLIB. If changes are made in PSBs or DBDs that require changes in the associated PSB, make these changes before running the module.
 
   Changes in PSBs might also require modifications to the affected application programs. For example, if a DBD has a segment name changed, all PSBs which are sensitive to that segment must have their SENSEG statements changed.
 
@@ -102,11 +100,11 @@ dbd_lib
 
 
 steplib
-  Points to the IMS SDFSRESL data set, which contains the IMS nucleus and required IMS modules. If STEPLIB is unauthorized by having unauthorized libraries that are concatenated to SDFSRESL, you must specify the *reslib* parameter.
+  Points to the IMS SDFSRESL data set, which contains the IMS nucleus and required IMS modules. If STEPLIB is unauthorized by having unauthorized libraries that are concatenated to SDFSRESL, you must specify the \ :emphasis:`reslib`\  parameter.
 
-  The steplib parameter can also be specified in the target inventory's environment_vars.
+  The steplib parameter can also be specified in the target inventory's environment\_vars.
 
-  The steplib input parameter to the module will take precedence over the value specified in the environment_vars.
+  The steplib input parameter to the module will take precedence over the value specified in the environment\_vars.
 
   | **required**: False
   | **type**: list
@@ -122,11 +120,11 @@ reslib
 
 
 build_psb
-  Specifies whether ims_acb_gen rebuilds all PSBs that reference a changed DBD in the *dbdname* parameter.
+  Specifies whether ims\_acb\_gen rebuilds all PSBs that reference a changed DBD in the \ :emphasis:`dbdname`\  parameter.
 
-  TRUE indicates that ims_acb_gen rebuilds all PSBs that reference the changed DBD on the *dbdname* parameter.
+  TRUE indicates that ims\_acb\_gen rebuilds all PSBs that reference the changed DBD on the \ :emphasis:`dbdname`\  parameter.
 
-  FALSE indicates that ims_acb_gen does not rebuild PSBs that reference the changed DBD if the changed DBD does not change the physical structure of the database.
+  FALSE indicates that ims\_acb\_gen does not rebuild PSBs that reference the changed DBD if the changed DBD does not change the physical structure of the database.
 
   | **required**: False
   | **type**: bool
@@ -201,15 +199,15 @@ Notes
 -----
 
 .. note::
-   The *steplib* parameter can also be specified in the target inventory's environment_vars.
+   The \ :emphasis:`steplib`\  parameter can also be specified in the target inventory's environment\_vars.
 
-   The *steplib* input parameter to the module will take precedence over the value specified in the environment_vars.
+   The \ :emphasis:`steplib`\  input parameter to the module will take precedence over the value specified in the environment\_vars.
 
-   If only the *steplib* parameter is specified, then only the *steplib* concatenation will be used to resolve the IMS RESLIB dataset.
+   If only the \ :emphasis:`steplib`\  parameter is specified, then only the \ :emphasis:`steplib`\  concatenation will be used to resolve the IMS RESLIB dataset.
 
-   If both *steplib* and *reslib* are specified, then both parameters will be used by the ACB Maintenenace Utility and *reslib* will be used to resolve the IMS RESLIB dataset.
+   If both \ :emphasis:`steplib`\  and \ :emphasis:`reslib`\  are specified, then both parameters will be used by the ACB Maintenenace Utility and \ :emphasis:`reslib`\  will be used to resolve the IMS RESLIB dataset.
 
-   Specifying only *reslib* without *steplib* is not supported.
+   Specifying only \ :emphasis:`reslib`\  without \ :emphasis:`steplib`\  is not supported.
 
    The ACB Maintenenace utility SYSUT3/SYSUT4 DD options are not supported by this module.
 
@@ -224,7 +222,7 @@ Return Values
 
 
 msg
-  Execution result message from the ims_acb_gen module.
+  Execution result message from the ims\_acb\_gen module.
 
   | **returned**: always
   | **type**: str
@@ -254,7 +252,7 @@ changed
 debug
   additional messages returned from ZOAU.
 
-  For more information, refer to the `ZOAU messages documentation <https://www.ibm.com/support/knowledgecenter/en/SSKFYE_1.0.0/bgy.html>`_
+  For more information, refer to the \ `ZOAU messages documentation <https://www.ibm.com/support/knowledgecenter/en/SSKFYE_1.0.0/bgy.html>`__\ 
 
   | **returned**: always
   | **type**: str

_sources/ibm_zos_ims/docs/source/modules/ims_ddl.rst.txt

@@ -66,9 +66,9 @@ proclib
 steplib
   Points to IMS.SDFSRESL, which contains the IMS nucleus and required IMS modules.
 
-  The steplib parameter can also be specified in the target inventory's environment_vars.
+  The steplib parameter can also be specified in the target inventory's environment\_vars.
 
-  The steplib input parameter to the module will take precedence over the value specified in the environment_vars.
+  The steplib input parameter to the module will take precedence over the value specified in the environment\_vars.
 
   | **required**: False
   | **type**: list
@@ -133,7 +133,7 @@ Examples
 
 
    - name: Example of DDL statements are in a dataset
-     ims_data_definition:
+     ims_ddl:
        online: True
        ims_id: IMS1
        reslib:
@@ -144,7 +144,7 @@ Examples
          - SOME.IMS.PROCLIB
        sql_input: SOME.IMS.SQL
    - name: Example of DDL statements in which VERBOSE and AUTOCOMMIT control options are specified
-     ims_data_definition:
+     ims_ddl:
        online: True
        ims_id: IMS1
        reslib:
@@ -158,7 +158,7 @@ Examples
        auto_commit: true
 
    - name: Example of DDL statements in which SIMULATE control options is specified
-     ims_data_definition:
+     ims_ddl:
        online: True
        ims_id: IMS1
        reslib:
@@ -171,7 +171,7 @@ Examples
        simulate: true
 
    - name: Example of DDL statements in which DYNAMIC_PROGRAMVIEW control option is specified
-     ims_data_definition:
+     ims_ddl:
        online: True
        ims_id: IMS1
        reslib:
@@ -191,13 +191,13 @@ Notes
 -----
 
 .. note::
-   The *steplib* parameter can also be specified in the target inventory's environment_vars.
+   The \ :emphasis:`steplib`\  parameter can also be specified in the target inventory's environment\_vars.
 
-   The *steplib* input parameter to the module will take precedence over the value specified in the environment_vars.
+   The \ :emphasis:`steplib`\  input parameter to the module will take precedence over the value specified in the environment\_vars.
 
-   If only the *steplib* parameter is specified, then only the *steplib* concatenation will be used to resolve the IMS RESLIB data set.
+   If only the \ :emphasis:`steplib`\  parameter is specified, then only the \ :emphasis:`steplib`\  concatenation will be used to resolve the IMS RESLIB data set.
 
-   Specifying only *reslib* without *steplib* is not supported.
+   Specifying only \ :emphasis:`reslib`\  without \ :emphasis:`steplib`\  is not supported.
 
    Currently ddl error messages are returned within the content block of the module response.
 

_sources/ibm_zos_ims/docs/source/release_notes.rst.txt

@@ -6,6 +6,56 @@
 Releases
 ========
 
+
+Version 1.3.0
+====================
+
+Notes
+-----
+
+* Update recommended
+
+  * type() was replaced by isinstance() in the code for gen utilities since ansible-core 2.16 supports Python 3.12 and that version deprecated type() function. 
+  * No other changes from version 1.3.0-beta.1 release. Collection promoted to certified content with version 1.3.0.
+
+Availability
+------------
+
+* `Automation Hub`_
+* `Galaxy`_
+* `GitHub`_
+
+
+
+Known Issues
+------------
+
+- ``ims_command`` - STEPLIB is required and needs to be defined as an environment variable.
+- ``ims_command`` - Currently, this module requires to have plex parameter defined.
+
+
+
+Reference
+---------
+
+* Supported by IBM z/OS core collection v1.5.0 or later
+* Supported by IBM Z Open Enterprise Python for z/OS 3.9 - 3.12
+* Supported by IBM Z Open Automation Utilities 1.2.2 or later (but prior to 1.3)
+
+  * ZOAU minimum supported version may vary depending on the z/OS core collection version that is chosen. For details on z/OS core collection requirements, see: https://github.com/ansible-collections/ibm_zos_core/releases
+* Supported by z/OS V2R4 (or later) but prior to version V3R1
+* The z/OS® shell
+
+.. _centralized content:
+   https://ibm.github.io/z_ansible_collections_doc/index.html
+
+.. _GitHub:
+   https://github.com/ansible-collections/ibm_zos_ims
+
+.. _Galaxy:
+   https://galaxy.ansible.com/ibm/ibm_zos_ims
+
+
 Version 1.3.0-beta.1
 ====================
 
@@ -43,7 +93,9 @@ Reference
 * Supported by IBM z/OS core collection v1.5.0 or later
 * Supported by IBM Z Open Enterprise Python for z/OS: 3.9 or later
 * Supported by IBM Z Open Automation Utilities 1.2.2 or later (but prior to 1.3)
-* Supported by z/OS V2R4
+
+  * ZOAU minimum supported version may vary depending on the z/OS core collection version that is chosen. For details on z/OS core collection requirements, see: https://github.com/ansible-collections/ibm_zos_core/releases
+* Supported by z/OS V2R4 (or later) but prior to version V3R1
 * The z/OS® shell
 
 .. _centralized content:

ibm_zos_ims/docs/source/modules/ims_acb_gen.html

@@ -232,15 +232,14 @@ <h2><a class="toc-backref" href="#id2">Parameters</a><a class="headerlink" href=
 </div>
 </dd>
 <dt>compression</dt><dd><p>PRECOMP,POSTCOMP, in any combination, cause the required in-place compression.</p>
-<p>The choices are not mutually exclusive – PRECOMP or POSTCOMP or PRECOMP,POSTCOMP can be used</p>
 <p>The default is none.</p>
 <div class="line-block">
 <div class="line"><strong>required</strong>: False</div>
 <div class="line"><strong>type</strong>: str</div>
-<div class="line"><strong>choices</strong>: PRECOMP, POSTCOMP</div>
+<div class="line"><strong>choices</strong>: precomp, postcomp, precomp,postcomp, PRECOMP, POSTCOMP, PRECOMP,POSTCOMP</div>
 </div>
 </dd>
-<dt>psb_name</dt><dd><p>The name of the PS**s**. Specifies that blocks are built or deleted for all PSBs that are named on this control statement.</p>
+<dt>psb_name</dt><dd><p>The name of the PSB(s). Specifies that blocks are built or deleted for all PSBs that are named on this control statement.</p>
 <p>This field requires “ALL” or a list of psb names to be specified.</p>
 <div class="line-block">
 <div class="line"><strong>required</strong>: False</div>
@@ -263,7 +262,7 @@ <h2><a class="toc-backref" href="#id2">Parameters</a><a class="headerlink" href=
 </div>
 </dd>
 <dt>psb_lib</dt><dd><p>The ACB Maintenance utility receives input from the IMS PSBLIB data set.</p>
-<p>The ACB Maintenance utility does not change the PS**s** in PSBLIB. If changes are made in PSBs or DBDs that require changes in the associated PSB, make these changes before running the module.</p>
+<p>The ACB Maintenance utility does not change the PSB(s) in PSBLIB. If changes are made in PSBs or DBDs that require changes in the associated PSB, make these changes before running the module.</p>
 <p>Changes in PSBs might also require modifications to the affected application programs. For example, if a DBD has a segment name changed, all PSBs which are sensitive to that segment must have their SENSEG statements changed.</p>
 <div class="line-block">
 <div class="line"><strong>required</strong>: True</div>

ibm_zos_ims/docs/source/modules/ims_ddl.html

@@ -301,7 +301,7 @@ <h2><a class="toc-backref" href="#id2">Parameters</a><a class="headerlink" href=
 <div class="section" id="examples">
 <h2><a class="toc-backref" href="#id3">Examples</a><a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
 <div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span> <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Example of DDL statements are in a dataset</span>
-  <span class="nt">ims_data_definition</span><span class="p">:</span>
+  <span class="nt">ims_ddl</span><span class="p">:</span>
     <span class="nt">online</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">True</span>
     <span class="nt">ims_id</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">IMS1</span>
     <span class="nt">reslib</span><span class="p">:</span>
@@ -312,7 +312,7 @@ <h2><a class="toc-backref" href="#id3">Examples</a><a class="headerlink" href="#
       <span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">SOME.IMS.PROCLIB</span>
     <span class="nt">sql_input</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SOME.IMS.SQL</span>
 <span class="p p-Indicator">-</span> <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Example of DDL statements in which VERBOSE and AUTOCOMMIT control options are specified</span>
-  <span class="nt">ims_data_definition</span><span class="p">:</span>
+  <span class="nt">ims_ddl</span><span class="p">:</span>
     <span class="nt">online</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">True</span>
     <span class="nt">ims_id</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">IMS1</span>
     <span class="nt">reslib</span><span class="p">:</span>
@@ -326,7 +326,7 @@ <h2><a class="toc-backref" href="#id3">Examples</a><a class="headerlink" href="#
     <span class="nt">auto_commit</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">true</span>
 
 <span class="p p-Indicator">-</span> <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Example of DDL statements in which SIMULATE control options is specified</span>
-  <span class="nt">ims_data_definition</span><span class="p">:</span>
+  <span class="nt">ims_ddl</span><span class="p">:</span>
     <span class="nt">online</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">True</span>
     <span class="nt">ims_id</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">IMS1</span>
     <span class="nt">reslib</span><span class="p">:</span>
@@ -339,7 +339,7 @@ <h2><a class="toc-backref" href="#id3">Examples</a><a class="headerlink" href="#
     <span class="nt">simulate</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">true</span>
 
 <span class="p p-Indicator">-</span> <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Example of DDL statements in which DYNAMIC_PROGRAMVIEW control option is specified</span>
-  <span class="nt">ims_data_definition</span><span class="p">:</span>
+  <span class="nt">ims_ddl</span><span class="p">:</span>
     <span class="nt">online</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">True</span>
     <span class="nt">ims_id</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">IMS1</span>
     <span class="nt">reslib</span><span class="p">:</span>