Skip to content

Commit c3efec3

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

15 files changed

+297
-177
lines changed

_sources/ibm_zos_core/docs/source/modules/zos_archive.rst.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -397,7 +397,7 @@ Examples
397397
format:
398398
name: terse
399399
format_options:
400-
use_adrdssu: True
400+
use_adrdssu: true
401401

402402
- name: Archive multiple data sets into a new GDS
403403
zos_archive:
@@ -406,7 +406,7 @@ Examples
406406
format:
407407
name: terse
408408
format_options:
409-
use_adrdssu: True
409+
use_adrdssu: true
410410

411411

412412

_sources/ibm_zos_core/docs/source/modules/zos_blockinfile.rst.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ src
3333

3434
The USS file must be an absolute pathname.
3535

36-
Generation data set (GDS) relative name of generation already created. ``e.g. SOME.CREATION(-1.)``
36+
Generation data set (GDS) relative name of generation already created. e.g. *SOME.CREATION(-1*).
3737

3838
| **required**: True
3939
| **type**: str
@@ -295,7 +295,7 @@ Examples
295295
zos_blockinfile:
296296
src: SOME.CREATION.TEST
297297
insertbefore: BOF
298-
backup: True
298+
backup: true
299299
backup_name: CREATION.GDS(+1)
300300
block: "{{ CONTENT }}"
301301

_sources/ibm_zos_core/docs/source/modules/zos_encode.rst.txt

+1
Original file line numberDiff line numberDiff line change
@@ -279,6 +279,7 @@ Examples
279279

280280

281281

282+
282283
Notes
283284
-----
284285

_sources/ibm_zos_core/docs/source/modules/zos_find.rst.txt

-1
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,6 @@ Examples
253253

254254

255255

256-
257256
Notes
258257
-----
259258

_sources/ibm_zos_core/docs/source/modules/zos_lineinfile.rst.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ src
3333

3434
The USS file must be an absolute pathname.
3535

36-
Generation data set (GDS) relative name of generation already created. ``e.g. SOME.CREATION(-1.)``
36+
Generation data set (GDS) relative name of generation already created. e.g. *SOME.CREATION(-1*).
3737

3838
| **required**: True
3939
| **type**: str
@@ -262,7 +262,7 @@ Examples
262262
zos_lineinfile:
263263
src: SOME.CREATION.TEST
264264
insertafter: EOF
265-
backup: True
265+
backup: true
266266
backup_name: CREATION.GDS(+1)
267267
line: 'Should be a working test now'
268268

_sources/ibm_zos_core/docs/source/modules/zos_unarchive.rst.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ src
3939

4040
MVS data sets supported types are ``SEQ``, ``PDS``, ``PDSE``.
4141

42-
GDS relative names are supported ``e.g. USER.GDG(-1)``.
42+
GDS relative names are supported. e.g. *USER.GDG(-1*).
4343

4444
| **required**: True
4545
| **type**: str
@@ -151,7 +151,7 @@ owner
151151
include
152152
A list of directories, files or data set names to extract from the archive.
153153

154-
GDS relative names are supported ``e.g. USER.GDG(-1)``.
154+
GDS relative names are supported. e.g. *USER.GDG(-1*).
155155

156156
When ``include`` is set, only those files will we be extracted leaving the remaining files in the archive.
157157

@@ -165,7 +165,7 @@ include
165165
exclude
166166
List the directory and file or data set names that you would like to exclude from the unarchive action.
167167

168-
GDS relative names are supported ``e.g. USER.GDG(-1)``.
168+
GDS relative names are supported. e.g. *USER.GDG(-1*).
169169

170170
Mutually exclusive with include.
171171

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

+106-64
Original file line numberDiff line numberDiff line change
@@ -6,75 +6,92 @@
66
Releases
77
========
88

9-
Version 1.11.0-beta.1
10-
=====================
9+
Version 1.11.0
10+
==============
1111

1212
Minor Changes
1313
-------------
1414

15-
- ``zos_apf`` - Added support that auto-escapes 'library' names containing symbols.
16-
- ``zos_archive`` - Added support for GDG and GDS relative name notation to archive data sets. Added support for data set names with special characters like $, /#, /- and @.
17-
- ``zos_backup_restore`` - Added support for GDS relative name notation to include or exclude data sets when operation is backup. Added support for data set names with special characters like $, /#, and @.
18-
- ``zos_blockinfile`` - Added support for GDG and GDS relative name notation to specify a data set. And backup in new generations. Added support for data set names with special characters like $, /#, /- and @.
19-
- ``zos_copy`` - Added support for copying from and copying to generation data sets (GDS) and generation data groups (GDG) including using a GDS for backup.
20-
- ``zos_data_set`` - Added support for GDG and GDS relative name notation to create, delete, catalog and uncatalog a data set. Added support for data set names with special characters like $, /#, /- and @.
21-
- ``zos_encode`` - Added support for converting the encodings of generation data sets (GDS). Also added support to backup into GDS.
22-
- ``zos_fetch`` - Added support for fetching generation data groups (GDG) and generation data sets (GDS). Added support for specifying data set names with special characters like $, /#, /- and @.
23-
- ``zos_find`` - Added support for finding generation data groups (GDG) and generation data sets (GDS). Added support for specifying data set names with special characters like $, /#, /- and @.
24-
- ``zos_job_submit``
15+
- ``zos_apf`` - Added support for data set names (libraries) with special characters ($, /#, /- and @).
16+
- ``zos_archive``
2517

26-
- Improved the mechanism for copying to remote systems by removing the use of deepcopy, which had previously resulted in the module failing on some systems.
27-
- Added support for running JCL stored in generation data groups (GDG) and generation data sets (GDS).
18+
- Added support for GDG and GDS relative name notation to archive data sets.
19+
- Added support for data set names with special characters ($, /#, /- and @).
2820

29-
- ``zos_lineinfile`` - Added support for GDG and GDS relative name notation to specify the target data set and to backup into new generations. Added support for data set names with special characters like $, /#, /- and @.
30-
- ``zos_mount`` - Added support for data set names with special characters ($, /#, /- and @).
31-
- ``zos_mvs_raw`` - Added support for GDG and GDS relative name notation to specify data set names. Added support for data set names with special characters like $, /#, /- and @.
32-
- ``zos_script`` - Improved the mechanism for copying to remote systems by removing the use of deepcopy, which had previously resulted in the module failing on some systems.
33-
- ``zos_tso_command`` - Added support for using GDG and GDS relative name notation in running TSO commands. Added support for data set names with special characters like $, /#, /- and @.
34-
- ``zos_unarchive``
21+
- ``zos_backup_restore``
3522

36-
- Added support for data set names with special characters like $, /#, /- and @.
37-
- Improved the mechanism for copying to remote systems by removing the use of deepcopy, which had previously resulted in the module failing on some systems.
23+
- Added support for GDS relative name notation to include or exclude data sets when operation is backup.
24+
- Added support for data set names with special characters ($, /#, /- and @).
3825

39-
Bugfixes
40-
--------
26+
- ``zos_blockinfile``
27+
28+
- Added support for GDG and GDS relative name notation to specify a data set. And backup in new generations.
29+
- Added support for data set names with special characters ($, /#, /- and @).
4130

4231
- ``zos_copy``
4332

44-
- a regression in version 1.4.0 made the module stop automatically computing member names when copying a single file into a PDS/E. Fix now lets a user copy a single file into a PDS/E without adding a member in the dest option.
45-
- module would use opercmd to check if a non existent destination data set is locked. Fix now only checks if the destination is already present.
33+
- Added support for copying from and to generation data sets (GDS) and generation data groups (GDG) including using a GDS for backup.
34+
- Added support for data set names with special characters ($, /#, /- and @).
4635

47-
- ``zos_data_set`` - When checking if a data set is cataloged, module failed to account for exceptions which occurred during the LISTCAT. The fix now raises an MVSCmdExecError if the return code from LISTCAT is too high.
48-
- ``zos_job_submit`` - The module was not propagating any error types including UnicodeDecodeError, JSONDecodeError, TypeError, KeyError when encountered. The fix now shares the type error in the error message.
49-
- ``zos_mvs_raw`` - The first character of each line in dd_output was missing. The fix now includes the first character of each line.
36+
- ``zos_data_set``
5037

51-
Availability
52-
------------
38+
- Added support for GDG and GDS relative name notation to create, delete, catalog and uncatalog a data set.
39+
- Added support for data set names with special characters ($, /#, /- and @).
5340

54-
* `Galaxy`_
55-
* `GitHub`_
41+
- ``zos_encode``
5642

57-
Requirements
58-
------------
43+
- Added support for converting the encodings of generation data sets (GDS).
44+
- Added support for data set names with special characters ($, /#, /- and @).
5945

60-
The IBM z/OS core collection has several dependencies, please review the `z/OS core support matrix`_ to understand both the
61-
controller and z/OS managed node dependencies.
46+
- ``zos_fetch``
6247

63-
Known Issues
64-
------------
65-
- ``zos_job_submit`` - when setting 'location' to 'local' and not specifying the from and to encoding, the modules defaults are not read leaving the file in its original encoding; explicitly set the encodings instead of relying on the default.
66-
- ``zos_job_submit`` - when submitting JCL, the response value returned for **byte_count** is incorrect.
67-
- ``zos_apf`` - When trying to remove a library that contains the '$' character in the name from APF(authorized program facility), operation will fail.
68-
- In the past, choices could be defined in either lower or upper case. Now, only the case that is identified in the docs can be set, this is so that the collection can continue to maintain certified status.
48+
- Added support for fetching generation data groups (GDG) and generation data sets (GDS).
49+
- Added support for data set names with special characters ($, /#, /- and @).
6950

51+
- ``zos_find``
7052

71-
Version 1.9.2
72-
=============
53+
- Added support for finding generation data groups (GDG) and generation data sets (GDS).
54+
- Added support for data set names with special characters ($, /#, /- and @).
55+
56+
- ``zos_job_submit``
57+
58+
- Improved the mechanism for copying to remote systems by removing the use of deepcopy, which had previously resulted in the module failing on some systems.
59+
- Added support for running JCL stored in generation data groups (GDG) and generation data sets (GDS).
60+
- Added support for data set names with special characters ($, /#, /- and @).
61+
62+
- ``zos_lineinfile``
63+
64+
- Added support for GDG and GDS relative name notation to specify the target data set and to backup into new generations.
65+
- Added support for data set names with special characters ($, /#, /- and @).
66+
67+
- ``zos_mount`` - Added support for data set names with special characters ($, /#, /- and @).
68+
- ``zos_mvs_raw``
69+
70+
- Added support for GDG and GDS relative name notation to specify data set names.
71+
- Added support for data set names with special characters ($, /#, /- and @).
72+
73+
- ``zos_script`` - Improved the mechanism for copying to remote systems by removing the use of deepcopy, which had previously resulted in the module failing on some systems.
74+
- ``zos_tso_command``
75+
76+
- Added support for using GDG and GDS relative name notation in running TSO commands.
77+
- Added support for data set names with special characters ($, /#, /- and @).
78+
79+
- ``zos_unarchive``
80+
81+
- Improved the mechanism for copying to remote systems by removing the use of deepcopy, which had previously resulted in the module failing on some systems.
82+
- Added support for data set names with special characters ($, /#, /- and @).
7383

7484
Bugfixes
7585
--------
7686

77-
- ``zos_copy`` - when creating the destination data set, the module would unnecessarily check if a data set is locked by another process. The module no longer performs this check when it creates the data set.
87+
- ``zos_copy``
88+
89+
- Fixes the issue that prevents the module from automatically computing member names when copying a file into a PDS/E. The module now computes the member name when copying into a PDS/E.
90+
- Fixes an issue that would perform an unnecessary check if a destination data set is locked for data sets the module created. The module only performs this check for destinations that are present.
91+
92+
- ``zos_data_set`` - When checking if a data set is cataloged, module failed to account for exceptions which occurred during the LISTCAT. The module now raises an MVSCmdExecError if the return code from LISTCAT exceeds the determined threshold.
93+
- ``zos_job_submit`` - Was not propagating any error types including UnicodeDecodeError, JSONDecodeError, TypeError, KeyError when encountered. The module now shares the error type (UnicodeDecodeError, JSONDecodeError, TypeError, KeyError) in the error message.
94+
- ``zos_mvs_raw`` - The first character of each line in dd_output was missing. The module now includes the first character of each line.
7895

7996
Availability
8097
------------
@@ -87,28 +104,13 @@ Requirements
87104
------------
88105

89106
The IBM z/OS core collection has several dependencies, please review the `z/OS core support matrix`_ to understand both the
90-
controller and z/OS managed node dependencies.
107+
control node and z/OS managed node dependencies.
91108

92109
Known Issues
93110
------------
94-
95-
- ``zos_job_submit`` - when setting 'location' to 'LOCAL' and not specifying the from and to encoding, the modules defaults are not read leaving the file in its original encoding; explicitly set the encodings instead of relying on the default.
111+
- ``zos_job_submit`` - when setting 'location' to 'local' and not specifying the from and to encoding, the modules defaults are not read leaving the file in its original encoding; explicitly set the encodings instead of relying on the default.
96112
- ``zos_job_submit`` - when submitting JCL, the response value returned for **byte_count** is incorrect.
97-
98-
- ``zos_job_submit``, ``zos_job_output``, ``zos_operator_action_query`` - encounters UTF-8 decoding errors when interacting with results that contain non-printable UTF-8 characters in the response. This has been addressed in this release and corrected with **ZOAU version 1.2.5.6** or later.
99-
100-
- If the appropriate level of ZOAU can not be installed, some options are to:
101-
102-
- Specify that the ASA assembler option be enabled to instruct the assembler to use ANSI control characters instead of machine code control characters.
103-
- Ignore module errors by using **ignore_errors:true** for a specific playbook task.
104-
- If the error is resulting from a batch job, add **ignore_errors:true** to the task and capture the output into a registered variable to extract the
105-
job ID with a regular expression. Then use ``zos_job_output`` to display the DD without the non-printable character such as the DD **JESMSGLG**.
106-
- If the error is the result of a batch job, set option **return_output** to false so that no DDs are read which could contain the non-printable UTF-8 characters.
107-
108-
- ``zos_data_set`` - An undocumented option **size** was defined in module **zos_data_set**, this has been removed to satisfy collection certification, use the intended and documented **space_primary** option.
109-
110-
- In the past, choices could be defined in either lower or upper case. Now, only the case that is identified in the docs can be set, this is so that the collection can continue to maintain certified status.
111-
113+
- ``zos_apf`` - When trying to remove a library that contains the '$' character in the name from APF(authorized program facility), operation will fail.
112114

113115
Version 1.10.0
114116
==============
@@ -228,6 +230,46 @@ Known Issues
228230
- In the past, choices could be defined in either lower or upper case. Now, only the case that is identified in the docs can be set, this is so that the collection can continue to maintain certified status.
229231
- Use of special characters (#, @, $, \- ) in different options like data set names and commands is not fully supported, some modules support them but is the user responsibility to escape them. Read each module documentation for further details.
230232

233+
Version 1.9.2
234+
=============
235+
236+
Bugfixes
237+
--------
238+
239+
- ``zos_copy`` - when creating the destination data set, the module would unnecessarily check if a data set is locked by another process. The module no longer performs this check when it creates the data set.
240+
241+
Availability
242+
------------
243+
244+
* `Automation Hub`_
245+
* `Galaxy`_
246+
* `GitHub`_
247+
248+
Requirements
249+
------------
250+
251+
The IBM z/OS core collection has several dependencies, please review the `z/OS core support matrix`_ to understand both the
252+
controller and z/OS managed node dependencies.
253+
254+
Known Issues
255+
------------
256+
257+
- ``zos_job_submit`` - when setting 'location' to 'LOCAL' and not specifying the from and to encoding, the modules defaults are not read leaving the file in its original encoding; explicitly set the encodings instead of relying on the default.
258+
- ``zos_job_submit`` - when submitting JCL, the response value returned for **byte_count** is incorrect.
259+
260+
- ``zos_job_submit``, ``zos_job_output``, ``zos_operator_action_query`` - encounters UTF-8 decoding errors when interacting with results that contain non-printable UTF-8 characters in the response. This has been addressed in this release and corrected with **ZOAU version 1.2.5.6** or later.
261+
262+
- If the appropriate level of ZOAU can not be installed, some options are to:
263+
264+
- Specify that the ASA assembler option be enabled to instruct the assembler to use ANSI control characters instead of machine code control characters.
265+
- Ignore module errors by using **ignore_errors:true** for a specific playbook task.
266+
- If the error is resulting from a batch job, add **ignore_errors:true** to the task and capture the output into a registered variable to extract the
267+
job ID with a regular expression. Then use ``zos_job_output`` to display the DD without the non-printable character such as the DD **JESMSGLG**.
268+
- If the error is the result of a batch job, set option **return_output** to false so that no DDs are read which could contain the non-printable UTF-8 characters.
269+
270+
- ``zos_data_set`` - An undocumented option **size** was defined in module **zos_data_set**, this has been removed to satisfy collection certification, use the intended and documented **space_primary** option.
271+
272+
- In the past, choices could be defined in either lower or upper case. Now, only the case that is identified in the docs can be set, this is so that the collection can continue to maintain certified status.
231273

232274
Version 1.9.1
233275
=============

_sources/ibm_zos_core/docs/source/resources/releases_maintenance.rst.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ The z/OS managed node includes several shells, currently the only supported shel
8989
+---------+----------------------------+---------------------------------------------------+---------------+---------------+
9090
| Version | Controller | Managed Node | GA | End of Life |
9191
+=========+============================+===================================================+===============+===============+
92-
| 1.11.x |- `ansible-core`_ >=2.15.x |- `z/OS`_ V2R4 - V2Rx | In preview | TBD |
92+
| 1.11.x |- `ansible-core`_ >=2.15.x |- `z/OS`_ V2R4 - V2Rx | 1 Oct 2024 | 1 Oct 2026 |
9393
| |- `Ansible`_ >=8.0.x |- `z/OS shell`_ | | |
9494
| |- `AAP`_ >=2.4 |- IBM `Open Enterprise SDK for Python`_ | | |
9595
| | |- IBM `Z Open Automation Utilities`_ >=1.3.1 | | |

ibm_zos_core/docs/source/modules/zos_archive.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -537,7 +537,7 @@ <h2><a class="toc-backref" href="#id3">Examples</a><a class="headerlink" href="#
537537
<span class="nt">format</span><span class="p">:</span>
538538
<span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">terse</span>
539539
<span class="nt">format_options</span><span class="p">:</span>
540-
<span class="nt">use_adrdssu</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">True</span>
540+
<span class="nt">use_adrdssu</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">true</span>
541541

542542
<span class="p p-Indicator">-</span> <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Archive multiple data sets into a new GDS</span>
543543
<span class="nt">zos_archive</span><span class="p">:</span>
@@ -546,7 +546,7 @@ <h2><a class="toc-backref" href="#id3">Examples</a><a class="headerlink" href="#
546546
<span class="nt">format</span><span class="p">:</span>
547547
<span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">terse</span>
548548
<span class="nt">format_options</span><span class="p">:</span>
549-
<span class="nt">use_adrdssu</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">True</span>
549+
<span class="nt">use_adrdssu</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">true</span>
550550
</pre></div>
551551
</div>
552552
</div>

0 commit comments

Comments
 (0)