Skip to content

Commit 9d182de

Browse files
Rohitcodes28Rohitcodes28
authored
adding the async and action documentation to all modules. (#1987)
* adding the async and action documentation to all modules. * resolving sanity issues * adding changelog * modifying as per review comments fetch and unarchive still does not support that. * updating changelog as per review comments
1 parent 83bcfc6 commit 9d182de

24 files changed

+283
-17
lines changed

‎changelogs/fragments/1987-async_documentation.yml‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
trivial:
2+
- zos_apf - Add documentation for async and action support.
3+
(https://github.com/ansible-collections/ibm_zos_core/pull/1987).
4+
5+
- zos_archive - Add documentation for async and action support.
6+
(https://github.com/ansible-collections/ibm_zos_core/pull/1987).
7+
8+
- zos_backup_restore - Add documentation for async and action support.
9+
(https://github.com/ansible-collections/ibm_zos_core/pull/1987).
10+
11+
- zos_blockinfile - Add documentation for async and action support.
12+
(https://github.com/ansible-collections/ibm_zos_core/pull/1987).
13+
14+
- zos_copy - Add documentation for async and action support.
15+
(https://github.com/ansible-collections/ibm_zos_core/pull/1987).
16+
17+
- zos_data_set - Add documentation for async and action support.
18+
(https://github.com/ansible-collections/ibm_zos_core/pull/1987).
19+
20+
- zos_encode - Add documentation for async and action support.
21+
(https://github.com/ansible-collections/ibm_zos_core/pull/1987).
22+
23+
- zos_fetch - Add documentation for async and action support.
24+
(https://github.com/ansible-collections/ibm_zos_core/pull/1987).
25+
26+
- zos_find - Add documentation for async and action support.
27+
(https://github.com/ansible-collections/ibm_zos_core/pull/1987).
28+
29+
- zos_gather_facts - Add documentation for async and action support.
30+
(https://github.com/ansible-collections/ibm_zos_core/pull/1987).
31+
32+
- zos_job_output - Add documentation for async and action support.
33+
(https://github.com/ansible-collections/ibm_zos_core/pull/1987).
34+
35+
- zos_job_query - Add documentation for async and action support.
36+
(https://github.com/ansible-collections/ibm_zos_core/pull/1987).
37+
38+
- zos_job_submit - Add documentation for async and action support.
39+
(https://github.com/ansible-collections/ibm_zos_core/pull/1987).
40+
41+
- zos_lineinfile - Add documentation for async and action support.
42+
(https://github.com/ansible-collections/ibm_zos_core/pull/1987).
43+
44+
- zos_mount - Add documentation for async and action support.
45+
(https://github.com/ansible-collections/ibm_zos_core/pull/1987).
46+
47+
- zos_mvs_raw - Add documentation for async and action support.
48+
(https://github.com/ansible-collections/ibm_zos_core/pull/1987).
49+
50+
- zos_operator - Add documentation for async and action support.
51+
(https://github.com/ansible-collections/ibm_zos_core/pull/1987).
52+
53+
- zos_operator_action_query - Add documentation for async and action support.
54+
(https://github.com/ansible-collections/ibm_zos_core/pull/1987).
55+
56+
- zos_ping - Add documentation for async and action support.
57+
(https://github.com/ansible-collections/ibm_zos_core/pull/1987).
58+
59+
- zos_script - Add documentation for async and action support.
60+
(https://github.com/ansible-collections/ibm_zos_core/pull/1987).
61+
62+
- zos_tso_command - Add documentation for async and action support.
63+
(https://github.com/ansible-collections/ibm_zos_core/pull/1987).
64+
65+
- zos_unarchive - Add documentation for async and action support.
66+
(https://github.com/ansible-collections/ibm_zos_core/pull/1987).
67+
68+
- zos_volume_init - Add documentation for async and action support.
69+
(https://github.com/ansible-collections/ibm_zos_core/pull/1987).
70+
71+
- zos_zfs_resize - Add documentation for async and action support.
72+
(https://github.com/ansible-collections/ibm_zos_core/pull/1987).

‎plugins/modules/zos_apf.py‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,15 @@
195195
required: False
196196
type: bool
197197
default: False
198+
199+
attributes:
200+
action:
201+
support: none
202+
description: Indicates this has a corresponding action plugin so some parts of the options can be executed on the controller.
203+
async:
204+
support: full
205+
description: Supports being used with the ``async`` keyword.
206+
198207
notes:
199208
- It is the playbook author or user's responsibility to ensure they have
200209
appropriate authority to the RACF® FACILITY resource class. A user is

‎plugins/modules/zos_archive.py‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/usr/bin/python
22
# -*- coding: utf-8 -*-
33

4-
# Copyright (c) IBM Corporation 2023, 2024
4+
# Copyright (c) IBM Corporation 2023, 2025
55
# Licensed under the Apache License, Version 2.0 (the "License");
66
# you may not use this file except in compliance with the License.
77
# You may obtain a copy of the License at
@@ -307,6 +307,14 @@
307307
default: false
308308
required: false
309309
310+
attributes:
311+
action:
312+
support: none
313+
description: Indicates this has a corresponding action plugin so some parts of the options can be executed on the controller.
314+
async:
315+
support: full
316+
description: Supports being used with the ``async`` keyword.
317+
310318
notes:
311319
- This module does not perform a send or transmit operation to a remote
312320
node. If you want to transport the archive you can use zos_fetch to

‎plugins/modules/zos_backup_restore.py‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/usr/bin/python
22
# -*- coding: utf-8 -*-
33

4-
# Copyright (c) IBM Corporation 2020, 2024
4+
# Copyright (c) IBM Corporation 2020, 2025
55
# Licensed under the Apache License, Version 2.0 (the "License");
66
# you may not use this file except in compliance with the License.
77
# You may obtain a copy of the License at
@@ -200,6 +200,15 @@
200200
not be identified, the value C(TMPHLQ) is used.
201201
required: false
202202
type: str
203+
204+
attributes:
205+
action:
206+
support: none
207+
description: Indicates this has a corresponding action plugin so some parts of the options can be executed on the controller.
208+
async:
209+
support: full
210+
description: Supports being used with the ``async`` keyword.
211+
203212
notes:
204213
- It is the playbook author or user's responsibility to ensure they have
205214
appropriate authority to the RACF FACILITY resource class. A user is

‎plugins/modules/zos_blockinfile.py‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,15 @@
174174
required: false
175175
type: int
176176
default: 0
177+
178+
attributes:
179+
action:
180+
support: none
181+
description: Indicates this has a corresponding action plugin so some parts of the options can be executed on the controller.
182+
async:
183+
support: full
184+
description: Supports being used with the ``async`` keyword.
185+
177186
notes:
178187
- It is the playbook author or user's responsibility to avoid files
179188
that should not be encoded, such as binary files. A user is described

‎plugins/modules/zos_copy.py‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/usr/bin/python
22
# -*- coding: utf-8 -*-
33

4-
# Copyright (c) IBM Corporation 2019, 2024
4+
# Copyright (c) IBM Corporation 2019, 2025
55
# Licensed under the Apache License, Version 2.0 (the "License");
66
# you may not use this file except in compliance with the License.
77
# You may obtain a copy of the License at
@@ -522,6 +522,14 @@
522522
extends_documentation_fragment:
523523
- ibm.ibm_zos_core.template
524524
525+
attributes:
526+
action:
527+
support: full
528+
description: Indicates this has a corresponding action plugin so some parts of the options can be executed on the controller.
529+
async:
530+
support: full
531+
description: Supports being used with the ``async`` keyword.
532+
525533
notes:
526534
- Destination data sets are assumed to be in catalog. When trying to copy
527535
to an uncataloged data set, the module assumes that the data set does

‎plugins/modules/zos_data_set.py‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -649,6 +649,13 @@
649649
required: false
650650
default: false
651651
652+
attributes:
653+
action:
654+
support: none
655+
description: Indicates this has a corresponding action plugin so some parts of the options can be executed on the controller.
656+
async:
657+
support: full
658+
description: Supports being used with the ``async`` keyword.
652659
"""
653660
EXAMPLES = r"""
654661
- name: Create a sequential data set if it does not exist

‎plugins/modules/zos_encode.py‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/usr/bin/python
22
# -*- coding: utf-8 -*-
33

4-
# Copyright (c) IBM Corporation 2019, 2024
4+
# Copyright (c) IBM Corporation 2019, 2025
55
# Licensed under the Apache License, Version 2.0 (the "License");
66
# you may not use this file except in compliance with the License.
77
# You may obtain a copy of the License at
@@ -120,6 +120,15 @@
120120
that is not available, then the value C(TMPHLQ) is used.
121121
required: false
122122
type: str
123+
124+
attributes:
125+
action:
126+
support: none
127+
description: Indicates this has a corresponding action plugin so some parts of the options can be executed on the controller.
128+
async:
129+
support: full
130+
description: Supports being used with the ``async`` keyword.
131+
123132
notes:
124133
- It is the playbook author or user's responsibility to avoid files that should
125134
not be encoded, such as binary files. A user is described as the remote user,

‎plugins/modules/zos_fetch.py‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/usr/bin/python
22
# -*- coding: utf-8 -*-
33

4-
# Copyright (c) IBM Corporation 2019, 2024
4+
# Copyright (c) IBM Corporation 2019, 2025
55
# Licensed under the Apache License, Version 2.0 (the "License");
66
# you may not use this file except in compliance with the License.
77
# You may obtain a copy of the License at
@@ -135,6 +135,15 @@
135135
type: bool
136136
required: false
137137
default: true
138+
139+
attributes:
140+
action:
141+
support: full
142+
description: Indicates this has a corresponding action plugin so some parts of the options can be executed on the controller.
143+
async:
144+
support: none
145+
description: Supports being used with the ``async`` keyword.
146+
138147
notes:
139148
- When fetching PDSE and VSAM data sets, temporary storage will be used
140149
on the remote z/OS system. After the PDSE or VSAM data set is

‎plugins/modules/zos_find.py‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/usr/bin/python
22
# -*- coding: utf-8 -*-
33

4-
# Copyright (c) IBM Corporation 2020, 2024
4+
# Copyright (c) IBM Corporation 2020, 2025
55
# Licensed under the Apache License, Version 2.0 (the "License");
66
# you may not use this file except in compliance with the License.
77
# You may obtain a copy of the License at
@@ -165,6 +165,14 @@
165165
type: bool
166166
required: false
167167
168+
attributes:
169+
action:
170+
support: none
171+
description: Indicates this has a corresponding action plugin so some parts of the options can be executed on the controller.
172+
async:
173+
support: full
174+
description: Supports being used with the ``async`` keyword.
175+
168176
notes:
169177
- Only cataloged data sets will be searched. If an uncataloged data set needs to
170178
be searched, it should be cataloged first. The L(zos_data_set,./zos_data_set.html) module can be

0 commit comments

Comments
 (0)