Skip to content

Commit e4b0b48

Browse files
committed
Automated commit to update documentation
1 parent c3dbcc8 commit e4b0b48

File tree

7 files changed

+198
-95
lines changed

7 files changed

+198
-95
lines changed

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

+19-21
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ ims_acb_gen -- Generate IMS ACB
1616

1717
Synopsis
1818
--------
19-
- The ims_acb_gen module generates an IMS application control block (ACB) necessary for an IMS application program to be scheduled and run.
20-
- 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.
19+
- The ims\_acb\_gen module generates an IMS application control block (ACB) necessary for an IMS application program to be scheduled and run.
20+
- 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.
2121
- The DBD and PSB control blocks will be merged and expanded into an IMS internal format called application control blocks (ACBs).
2222

2323

@@ -43,17 +43,15 @@ command_input
4343
compression
4444
PRECOMP,POSTCOMP, in any combination, cause the required in-place compression.
4545

46-
The choices are not mutually exclusive -- PRECOMP or POSTCOMP or PRECOMP,POSTCOMP can be used
47-
4846
The default is none.
4947

5048
| **required**: False
5149
| **type**: str
52-
| **choices**: PRECOMP, POSTCOMP
50+
| **choices**: precomp, postcomp, precomp,postcomp, PRECOMP, POSTCOMP, PRECOMP,POSTCOMP
5351
5452

5553
psb_name
56-
The name of the PS**s**. Specifies that blocks are built or deleted for all PSBs that are named on this control statement.
54+
The name of the PSB(s). Specifies that blocks are built or deleted for all PSBs that are named on this control statement.
5755

5856
This field requires "ALL" or a list of psb names to be specified.
5957

@@ -73,7 +71,7 @@ dbd_name
7371
acb_lib
7472
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.
7573

76-
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.
74+
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.
7775

7876
| **required**: True
7977
| **type**: str
@@ -82,7 +80,7 @@ acb_lib
8280
psb_lib
8381
The ACB Maintenance utility receives input from the IMS PSBLIB data set.
8482

85-
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.
83+
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.
8684

8785
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.
8886

@@ -102,11 +100,11 @@ dbd_lib
102100
103101

104102
steplib
105-
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.
103+
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.
106104

107-
The steplib parameter can also be specified in the target inventory's environment_vars.
105+
The steplib parameter can also be specified in the target inventory's environment\_vars.
108106

109-
The steplib input parameter to the module will take precedence over the value specified in the environment_vars.
107+
The steplib input parameter to the module will take precedence over the value specified in the environment\_vars.
110108

111109
| **required**: False
112110
| **type**: list
@@ -122,11 +120,11 @@ reslib
122120
123121

124122
build_psb
125-
Specifies whether ims_acb_gen rebuilds all PSBs that reference a changed DBD in the *dbdname* parameter.
123+
Specifies whether ims\_acb\_gen rebuilds all PSBs that reference a changed DBD in the \ :emphasis:`dbdname`\ parameter.
126124

127-
TRUE indicates that ims_acb_gen rebuilds all PSBs that reference the changed DBD on the *dbdname* parameter.
125+
TRUE indicates that ims\_acb\_gen rebuilds all PSBs that reference the changed DBD on the \ :emphasis:`dbdname`\ parameter.
128126

129-
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.
127+
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.
130128

131129
| **required**: False
132130
| **type**: bool
@@ -201,15 +199,15 @@ Notes
201199
-----
202200

203201
.. note::
204-
The *steplib* parameter can also be specified in the target inventory's environment_vars.
202+
The \ :emphasis:`steplib`\ parameter can also be specified in the target inventory's environment\_vars.
205203

206-
The *steplib* input parameter to the module will take precedence over the value specified in the environment_vars.
204+
The \ :emphasis:`steplib`\ input parameter to the module will take precedence over the value specified in the environment\_vars.
207205

208-
If only the *steplib* parameter is specified, then only the *steplib* concatenation will be used to resolve the IMS RESLIB dataset.
206+
If only the \ :emphasis:`steplib`\ parameter is specified, then only the \ :emphasis:`steplib`\ concatenation will be used to resolve the IMS RESLIB dataset.
209207

210-
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.
208+
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.
211209

212-
Specifying only *reslib* without *steplib* is not supported.
210+
Specifying only \ :emphasis:`reslib`\ without \ :emphasis:`steplib`\ is not supported.
213211

214212
The ACB Maintenenace utility SYSUT3/SYSUT4 DD options are not supported by this module.
215213

@@ -224,7 +222,7 @@ Return Values
224222

225223

226224
msg
227-
Execution result message from the ims_acb_gen module.
225+
Execution result message from the ims\_acb\_gen module.
228226

229227
| **returned**: always
230228
| **type**: str
@@ -254,7 +252,7 @@ changed
254252
debug
255253
additional messages returned from ZOAU.
256254

257-
For more information, refer to the `ZOAU messages documentation <https://www.ibm.com/support/knowledgecenter/en/SSKFYE_1.0.0/bgy.html>`_
255+
For more information, refer to the \ `ZOAU messages documentation <https://www.ibm.com/support/knowledgecenter/en/SSKFYE_1.0.0/bgy.html>`__\
258256

259257
| **returned**: always
260258
| **type**: str

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

+10-10
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,9 @@ proclib
6666
steplib
6767
Points to IMS.SDFSRESL, which contains the IMS nucleus and required IMS modules.
6868

69-
The steplib parameter can also be specified in the target inventory's environment_vars.
69+
The steplib parameter can also be specified in the target inventory's environment\_vars.
7070

71-
The steplib input parameter to the module will take precedence over the value specified in the environment_vars.
71+
The steplib input parameter to the module will take precedence over the value specified in the environment\_vars.
7272

7373
| **required**: False
7474
| **type**: list
@@ -133,7 +133,7 @@ Examples
133133

134134

135135
- name: Example of DDL statements are in a dataset
136-
ims_data_definition:
136+
ims_ddl:
137137
online: True
138138
ims_id: IMS1
139139
reslib:
@@ -144,7 +144,7 @@ Examples
144144
- SOME.IMS.PROCLIB
145145
sql_input: SOME.IMS.SQL
146146
- name: Example of DDL statements in which VERBOSE and AUTOCOMMIT control options are specified
147-
ims_data_definition:
147+
ims_ddl:
148148
online: True
149149
ims_id: IMS1
150150
reslib:
@@ -158,7 +158,7 @@ Examples
158158
auto_commit: true
159159

160160
- name: Example of DDL statements in which SIMULATE control options is specified
161-
ims_data_definition:
161+
ims_ddl:
162162
online: True
163163
ims_id: IMS1
164164
reslib:
@@ -171,7 +171,7 @@ Examples
171171
simulate: true
172172

173173
- name: Example of DDL statements in which DYNAMIC_PROGRAMVIEW control option is specified
174-
ims_data_definition:
174+
ims_ddl:
175175
online: True
176176
ims_id: IMS1
177177
reslib:
@@ -191,13 +191,13 @@ Notes
191191
-----
192192

193193
.. note::
194-
The *steplib* parameter can also be specified in the target inventory's environment_vars.
194+
The \ :emphasis:`steplib`\ parameter can also be specified in the target inventory's environment\_vars.
195195

196-
The *steplib* input parameter to the module will take precedence over the value specified in the environment_vars.
196+
The \ :emphasis:`steplib`\ input parameter to the module will take precedence over the value specified in the environment\_vars.
197197

198-
If only the *steplib* parameter is specified, then only the *steplib* concatenation will be used to resolve the IMS RESLIB data set.
198+
If only the \ :emphasis:`steplib`\ parameter is specified, then only the \ :emphasis:`steplib`\ concatenation will be used to resolve the IMS RESLIB data set.
199199

200-
Specifying only *reslib* without *steplib* is not supported.
200+
Specifying only \ :emphasis:`reslib`\ without \ :emphasis:`steplib`\ is not supported.
201201

202202
Currently ddl error messages are returned within the content block of the module response.
203203

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

+53-1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,56 @@
66
Releases
77
========
88

9+
10+
Version 1.3.0
11+
====================
12+
13+
Notes
14+
-----
15+
16+
* Update recommended
17+
18+
* 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.
19+
* No other changes from version 1.3.0-beta.1 release. Collection promoted to certified content with version 1.3.0.
20+
21+
Availability
22+
------------
23+
24+
* `Automation Hub`_
25+
* `Galaxy`_
26+
* `GitHub`_
27+
28+
29+
30+
Known Issues
31+
------------
32+
33+
- ``ims_command`` - STEPLIB is required and needs to be defined as an environment variable.
34+
- ``ims_command`` - Currently, this module requires to have plex parameter defined.
35+
36+
37+
38+
Reference
39+
---------
40+
41+
* Supported by IBM z/OS core collection v1.5.0 or later
42+
* Supported by IBM Z Open Enterprise Python for z/OS 3.9 - 3.12
43+
* Supported by IBM Z Open Automation Utilities 1.2.2 or later (but prior to 1.3)
44+
45+
* 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
46+
* Supported by z/OS V2R4 (or later) but prior to version V3R1
47+
* The z/OS® shell
48+
49+
.. _centralized content:
50+
https://ibm.github.io/z_ansible_collections_doc/index.html
51+
52+
.. _GitHub:
53+
https://github.com/ansible-collections/ibm_zos_ims
54+
55+
.. _Galaxy:
56+
https://galaxy.ansible.com/ibm/ibm_zos_ims
57+
58+
959
Version 1.3.0-beta.1
1060
====================
1161

@@ -43,7 +93,9 @@ Reference
4393
* Supported by IBM z/OS core collection v1.5.0 or later
4494
* Supported by IBM Z Open Enterprise Python for z/OS: 3.9 or later
4595
* Supported by IBM Z Open Automation Utilities 1.2.2 or later (but prior to 1.3)
46-
* Supported by z/OS V2R4
96+
97+
* 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
98+
* Supported by z/OS V2R4 (or later) but prior to version V3R1
4799
* The z/OS® shell
48100

49101
.. _centralized content:

ibm_zos_ims/docs/source/modules/ims_acb_gen.html

+3-4
Original file line numberDiff line numberDiff line change
@@ -232,15 +232,14 @@ <h2><a class="toc-backref" href="#id2">Parameters</a><a class="headerlink" href=
232232
</div>
233233
</dd>
234234
<dt>compression</dt><dd><p>PRECOMP,POSTCOMP, in any combination, cause the required in-place compression.</p>
235-
<p>The choices are not mutually exclusive – PRECOMP or POSTCOMP or PRECOMP,POSTCOMP can be used</p>
236235
<p>The default is none.</p>
237236
<div class="line-block">
238237
<div class="line"><strong>required</strong>: False</div>
239238
<div class="line"><strong>type</strong>: str</div>
240-
<div class="line"><strong>choices</strong>: PRECOMP, POSTCOMP</div>
239+
<div class="line"><strong>choices</strong>: precomp, postcomp, precomp,postcomp, PRECOMP, POSTCOMP, PRECOMP,POSTCOMP</div>
241240
</div>
242241
</dd>
243-
<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>
242+
<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>
244243
<p>This field requires “ALL” or a list of psb names to be specified.</p>
245244
<div class="line-block">
246245
<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=
263262
</div>
264263
</dd>
265264
<dt>psb_lib</dt><dd><p>The ACB Maintenance utility receives input from the IMS PSBLIB data set.</p>
266-
<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>
265+
<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>
267266
<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>
268267
<div class="line-block">
269268
<div class="line"><strong>required</strong>: True</div>

ibm_zos_ims/docs/source/modules/ims_ddl.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,7 @@ <h2><a class="toc-backref" href="#id2">Parameters</a><a class="headerlink" href=
301301
<div class="section" id="examples">
302302
<h2><a class="toc-backref" href="#id3">Examples</a><a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
303303
<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>
304-
<span class="nt">ims_data_definition</span><span class="p">:</span>
304+
<span class="nt">ims_ddl</span><span class="p">:</span>
305305
<span class="nt">online</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">True</span>
306306
<span class="nt">ims_id</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">IMS1</span>
307307
<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="#
312312
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">SOME.IMS.PROCLIB</span>
313313
<span class="nt">sql_input</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SOME.IMS.SQL</span>
314314
<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>
315-
<span class="nt">ims_data_definition</span><span class="p">:</span>
315+
<span class="nt">ims_ddl</span><span class="p">:</span>
316316
<span class="nt">online</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">True</span>
317317
<span class="nt">ims_id</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">IMS1</span>
318318
<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="#
326326
<span class="nt">auto_commit</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">true</span>
327327

328328
<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>
329-
<span class="nt">ims_data_definition</span><span class="p">:</span>
329+
<span class="nt">ims_ddl</span><span class="p">:</span>
330330
<span class="nt">online</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">True</span>
331331
<span class="nt">ims_id</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">IMS1</span>
332332
<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="#
339339
<span class="nt">simulate</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">true</span>
340340

341341
<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>
342-
<span class="nt">ims_data_definition</span><span class="p">:</span>
342+
<span class="nt">ims_ddl</span><span class="p">:</span>
343343
<span class="nt">online</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">True</span>
344344
<span class="nt">ims_id</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">IMS1</span>
345345
<span class="nt">reslib</span><span class="p">:</span>

0 commit comments

Comments
 (0)