Skip to content

Commit 13ca5d0

Browse files
mayankmani-sdefernandofloresg
mayankmani-sde
and
fernandofloresg
authored
[Documentation][zos_data_set]Set all boolean parameters to false by default and update documentation (#1992)
* added default value False in columns and removed comments * added default values false in columns for extended attributes * added default values false in columns for fifo attributes and removed comments * reverted back * Made empty parameters to be accepeted as default "False" * Removed Comments in Documents for Empty Parameters " Default is False" * Added "default: false" in documentation for extended parameters * Added by default false in code for extended parameters * "default: false" in documentation for purge parameters * Added by default false in code for purge parameters * "default: false" in documentation for scratch parameters * Added by default false in code for scratch parameters * "default: false" in documentation for fifo parameters * Added by default false in code for fifo parameters * fixed sanity issue * fixed sanity issue * fixed sanity issue extra spaces * Fixed Sanity issue * PR Raised - #1967 * Rename 1967-zos_data_set-enable-by-default-attributes.yml to 1992-zos_data_set-enable-by-default-attributes.yml * Update changelogs/fragments/1992-zos_data_set-enable-by-default-attributes.yml Co-authored-by: Fernando Flores <[email protected]> --------- Co-authored-by: Fernando Flores <[email protected]>
1 parent dc2ef9c commit 13ca5d0

File tree

2 files changed

+38
-26
lines changed

2 files changed

+38
-26
lines changed

‎changelogs/fragments/1992-zos_data_set-enable-by-default-attributes.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
trivial:
2+
- zos_data_set - Updated documentation on zos_data_set and enabled the default value to be false for GDG attributes.
3+
(https://github.com/ansible-collections/ibm_zos_core/pull/1992).

‎plugins/modules/zos_data_set.py

Lines changed: 35 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -244,25 +244,25 @@
244244
- If false, removes only the oldest GDS entry when a new GDS is created that causes GDG limit to be exceeded.
245245
- If true, removes all GDS entries from a GDG base when a new GDS is created that causes the
246246
GDG limit to be exceeded.
247-
- Default is false.
248247
type: bool
249248
required: false
249+
default: false
250250
extended:
251251
description:
252252
- Sets the I(extended) attribute for Generation Data Groups.
253253
- If false, allow up to 255 generation data sets (GDSs) to be associated with the GDG.
254254
- If true, allow up to 999 generation data sets (GDS) to be associated with the GDG.
255-
- Default is false.
256255
type: bool
257256
required: false
257+
default: false
258258
fifo:
259259
description:
260260
- Sets the I(fifo) attribute for Generation Data Groups.
261261
- If false, the order is the newest GDS defined to the oldest GDS. This is the default value.
262262
- If true, the order is the oldest GDS defined to the newest GDS.
263-
- Default is false.
264263
type: bool
265264
required: false
265+
default: false
266266
limit:
267267
description:
268268
- Sets the I(limit) attribute for Generation Data Groups.
@@ -278,6 +278,7 @@
278278
is rolled off and the C(scratch) option is set.
279279
type: bool
280280
required: false
281+
default: false
281282
scratch:
282283
description:
283284
- Sets the I(scratch) attribute for Generation Data Groups.
@@ -286,6 +287,7 @@
286287
EMPTY/NOEMPTY processing.
287288
type: bool
288289
required: false
290+
default: false
289291
volumes:
290292
description:
291293
- >
@@ -560,25 +562,25 @@
560562
- If false, removes only the oldest GDS entry when a new GDS is created that causes GDG limit to be exceeded.
561563
- If true, removes all GDS entries from a GDG base when a new GDS is created that causes the
562564
GDG limit to be exceeded.
563-
- Default is false.
564565
type: bool
565566
required: false
567+
default: false
566568
extended:
567569
description:
568570
- Sets the I(extended) attribute for Generation Data Groups.
569571
- If false, allow up to 255 generation data sets (GDSs) to be associated with the GDG.
570572
- If true, allow up to 999 generation data sets (GDS) to be associated with the GDG.
571-
- Default is false.
572573
type: bool
573574
required: false
575+
default: false
574576
fifo:
575577
description:
576578
- Sets the I(fifo) attribute for Generation Data Groups.
577579
- If false, the order is the newest GDS defined to the oldest GDS. This is the default value.
578580
- If true, the order is the oldest GDS defined to the newest GDS.
579-
- Default is false.
580581
type: bool
581582
required: false
583+
default: false
582584
limit:
583585
description:
584586
- Sets the I(limit) attribute for Generation Data Groups.
@@ -594,6 +596,7 @@
594596
is rolled off and the C(scratch) option is set.
595597
type: bool
596598
required: false
599+
default: false
597600
scratch:
598601
description:
599602
- Sets the I(scratch) attribute for Generation Data Groups.
@@ -602,6 +605,7 @@
602605
EMPTY/NOEMPTY processing.
603606
type: bool
604607
required: false
608+
default: false
605609
volumes:
606610
description:
607611
- >
@@ -1541,23 +1545,28 @@ def parse_and_validate_args(params):
15411545
),
15421546
empty=dict(
15431547
type="bool",
1544-
required=False
1548+
required=False,
1549+
default=False
15451550
),
15461551
purge=dict(
15471552
type="bool",
1548-
required=False
1553+
required=False,
1554+
default=False
15491555
),
15501556
scratch=dict(
15511557
type="bool",
1552-
required=False
1558+
required=False,
1559+
default=False
15531560
),
15541561
extended=dict(
15551562
type="bool",
1556-
required=False
1563+
required=False,
1564+
default=False
15571565
),
15581566
fifo=dict(
15591567
type="bool",
1560-
required=False
1568+
required=False,
1569+
default=False
15611570
),
15621571
force=dict(
15631572
type="bool",
@@ -1632,11 +1641,11 @@ def parse_and_validate_args(params):
16321641
),
16331642
# GDG options
16341643
limit=dict(type="int", required=False),
1635-
empty=dict(type="bool", required=False),
1636-
purge=dict(type="bool", required=False),
1637-
scratch=dict(type="bool", required=False),
1638-
extended=dict(type="bool", required=False),
1639-
fifo=dict(type="bool", required=False),
1644+
empty=dict(type="bool", required=False, default=False),
1645+
purge=dict(type="bool", required=False, default=False),
1646+
scratch=dict(type="bool", required=False, default=False),
1647+
extended=dict(type="bool", required=False, default=False),
1648+
fifo=dict(type="bool", required=False, default=False),
16401649
# End of GDG options
16411650
volumes=dict(
16421651
type=volumes,
@@ -1755,11 +1764,11 @@ def run_module():
17551764
),
17561765
# GDG options
17571766
limit=dict(type="int", required=False),
1758-
empty=dict(type="bool", required=False),
1759-
purge=dict(type="bool", required=False),
1760-
scratch=dict(type="bool", required=False),
1761-
extended=dict(type="bool", required=False),
1762-
fifo=dict(type="bool", required=False),
1767+
empty=dict(type="bool", required=False, default=False),
1768+
purge=dict(type="bool", required=False, default=False),
1769+
scratch=dict(type="bool", required=False, default=False),
1770+
extended=dict(type="bool", required=False, default=False),
1771+
fifo=dict(type="bool", required=False, default=False),
17631772
volumes=dict(type="raw", required=False, aliases=["volume"]),
17641773
force=dict(
17651774
type="bool",
@@ -1825,11 +1834,11 @@ def run_module():
18251834
),
18261835
# GDG options
18271836
limit=dict(type="int", required=False, no_log=False),
1828-
empty=dict(type="bool", required=False),
1829-
purge=dict(type="bool", required=False),
1830-
scratch=dict(type="bool", required=False),
1831-
extended=dict(type="bool", required=False),
1832-
fifo=dict(type="bool", required=False),
1837+
empty=dict(type="bool", required=False, default=False),
1838+
purge=dict(type="bool", required=False, default=False),
1839+
scratch=dict(type="bool", required=False, default=False),
1840+
extended=dict(type="bool", required=False, default=False),
1841+
fifo=dict(type="bool", required=False, default=False),
18331842
# End of GDG options
18341843
volumes=dict(
18351844
type="raw",

0 commit comments

Comments
 (0)