Update zos_data_set member description created (#816)

* Update zos_data_set module member description

Signed-off-by: ddimatos <dimatos@gmail.com>

* Adding fix for uncataloged vsam and non-vsam data sets

Signed-off-by: ddimatos <dimatos@gmail.com>

* Fixes the issue of parts of a vsam cluster remaining behind and allows user to correctly delete DS not in cat

Signed-off-by: ddimatos <dimatos@gmail.com>

* Update module doc to explain data set deltion for given volume

Signed-off-by: ddimatos <dimatos@gmail.com>

* Unbound local var fix

Signed-off-by: ddimatos <dimatos@gmail.com>

* Lint corrections

Signed-off-by: ddimatos <dimatos@gmail.com>

* remove unused imports

Signed-off-by: ddimatos <dimatos@gmail.com>

* Added 2.16 ignore since our pipeline supports devel which is at this time 2.16

Signed-off-by: ddimatos <dimatos@gmail.com>

* Update module doc to explain data set deltion for given volumegit

Signed-off-by: ddimatos <dimatos@gmail.com>

* Added changelog fragment

Signed-off-by: ddimatos <dimatos@gmail.com>

* Update grammar issue

Signed-off-by: ddimatos <dimatos@gmail.com>

---------

Signed-off-by: ddimatos <dimatos@gmail.com>

Author: ddimatos

changelogs/fragments/816-zos_data_set-update-vsam.yml

@@ -0,0 +1,14 @@
+trivial:
+- zos_data_set - when a member is created by the module, the format is type
+  data which is not suitable for executables. This change describes the
+  format used when creating member.
+  (https://github.com/ansible-collections/ibm_zos_core/pull/816)
+bugfixes:
+- zos_data_set - Reported a failure caused when `present=absent` for a VSAM
+  data set leaving behind cluster components. Fix introduces a new logical
+  flow that will evaluate the volumes, compare it to the provided value and
+  if necessary catalog and delete.
+  (https://github.com/ansible-collections/ibm_zos_core/pull/816).
+- module_utils - data_set.py - Reported a failure caused when cataloging a
+  VSAM data set. Fix now corrects how VSAM data sets are cataloged.
+  (https://github.com/ansible-collections/ibm_zos_core/pull/816).

docs/source/modules/zos_data_set.rst

@@ -56,6 +56,9 @@ state
   If *state=absent* and *volumes* is provided, and the data set is not found in the catalog, the module attempts to perform catalog using supplied *name* and *volumes*. If the attempt to catalog the data set catalog fails, then no action is taken. Module completes successfully with *changed=False*.
 
 
+  If *state=absent* and *volumes* is provided, and the data set is found in the catalog, the module compares the catalog volume attributes to the provided *volumes*. If the volume attributes are different, the cataloged data set will be uncataloged temporarily while the requested data set be deleted is cataloged. The module will catalog the original data set on completion, if the attempts to catalog fail, no action is taken. Module completes successfully with *changed=False*.
+
+
   If *state=present* and the data set does not exist on the managed node, create and catalog the data set, module completes successfully with *changed=True*.
 
 
@@ -65,6 +68,9 @@ state
   If *state=present* and *replace=False* and the data set is present on the managed node, no action taken, module completes successfully with *changed=False*.
 
 
+  If *state=present* and *type=MEMBER* and the member does not exist in the data set, create a member formatted to store data, module completes successfully with *changed=True*. Note, a PDSE does not allow a mixture of formats such that there is executables (program objects) and data. The member created is formatted to store data, not an executable.
+
+
   If *state=cataloged* and *volumes* is provided and the data set is already cataloged, no action taken, module completes successfully with *changed=False*.
 
 
@@ -74,7 +80,7 @@ state
   If *state=cataloged* and *volumes* is provided and the data set is not cataloged, module attempts to perform catalog using supplied *name* and *volumes*. If the attempt to catalog the data set catalog fails, returns failure with *changed=False*.
 
 
-  If *state=uncataloged* and the data set is not found, no action taken , module completes successfully with *changed=False*.
+  If *state=uncataloged* and the data set is not found, no action taken, module completes successfully with *changed=False*.
 
 
   If *state=uncataloged* and the data set is found, the data set is uncataloged, module completes successfully with *changed=True*.
@@ -321,6 +327,9 @@ batch
     If *state=absent* and *volumes* is provided, and the data set is not found in the catalog, the module attempts to perform catalog using supplied *name* and *volumes*. If the attempt to catalog the data set catalog fails, then no action is taken. Module completes successfully with *changed=False*.
 
 
+    If *state=absent* and *volumes* is provided, and the data set is found in the catalog, the module compares the catalog volume attributes to the provided *volumes*. If they volume attributes are different, the cataloged data set will be uncataloged temporarily while the requested data set be deleted is cataloged. The module will catalog the original data set on completion, if the attempts to catalog fail, no action is taken. Module completes successfully with *changed=False*.
+
+
     If *state=present* and the data set does not exist on the managed node, create and catalog the data set, module completes successfully with *changed=True*.
 
 
@@ -330,6 +339,9 @@ batch
     If *state=present* and *replace=False* and the data set is present on the managed node, no action taken, module completes successfully with *changed=False*.
 
 
+    If *state=present* and *type=MEMBER* and the member does not exist in the data set, create a member formatted to store data, module completes successfully with *changed=True*. Note, a PDSE does not allow a mixture of formats such that there is executables (program objects) and data. The member created is formatted to store data, not an executable.
+
+
     If *state=cataloged* and *volumes* is provided and the data set is already cataloged, no action taken, module completes successfully with *changed=False*.
 
 
@@ -339,7 +351,7 @@ batch
     If *state=cataloged* and *volumes* is provided and the data set is not cataloged, module attempts to perform catalog using supplied *name* and *volumes*. If the attempt to catalog the data set catalog fails, returns failure with *changed=False*.
 
 
-    If *state=uncataloged* and the data set is not found, no action taken , module completes successfully with *changed=False*.
+    If *state=uncataloged* and the data set is not found, no action taken, module completes successfully with *changed=False*.
 
 
     If *state=uncataloged* and the data set is found, the data set is uncataloged, module completes successfully with *changed=True*.
@@ -352,7 +364,7 @@ batch
 
 
   type
-    The data set type to be used when creating a data set. (e.g ``pdse``)
+    The data set type to be used when creating a data set. (e.g ``PDSE``)
 
     ``MEMBER`` expects to be used with an existing partitioned data set.