[New module] zos_started_task

docs/source/modules/zos_apf.rst

@@ -106,15 +106,15 @@ tmp_hlq
 
 
 persistent
-  Add/remove persistent entries to or from *data_set_name*
+  Add/remove persistent entries to or from *target*
 
   ``library`` will not be persisted or removed if ``persistent=None``
 
   | **required**: False
   | **type**: dict
 
 
-  data_set_name
+  target
     The data set name used for persisting or removing a ``library`` from the APF list.
 
     | **required**: True
@@ -138,7 +138,7 @@ persistent
 
 
   backup
-    Creates a backup file or backup data set for *data_set_name*, including the timestamp information to ensure that you retrieve the original APF list defined in *data_set_name*".
+    Creates a backup file or backup data set for *target*, including the timestamp information to ensure that you retrieve the original APF list defined in *target*".
 
     *backup_name* can be used to specify a backup file name if *backup=true*.
 
@@ -152,7 +152,7 @@ persistent
   backup_name
     Specify the USS file name or data set name for the destination backup.
 
-    If the source *data_set_name* is a USS file or path, the backup_name name must be a file or path name, and the USS file or path must be an absolute path name.
+    If the source *target* is a USS file or path, the backup_name name must be a file or path name, and the USS file or path must be an absolute path name.
 
     If the source is an MVS data set, the backup_name must be an MVS data set name.
 
@@ -241,18 +241,18 @@ Examples
        library: SOME.SEQUENTIAL.DATASET
        force_dynamic: true
        persistent:
-         data_set_name: SOME.PARTITIONED.DATASET(MEM)
+         target: SOME.PARTITIONED.DATASET(MEM)
    - name: Remove a library from the APF list and persistence
      zos_apf:
        state: absent
        library: SOME.SEQUENTIAL.DATASET
        volume: T12345
        persistent:
-         data_set_name: SOME.PARTITIONED.DATASET(MEM)
+         target: SOME.PARTITIONED.DATASET(MEM)
    - name: Batch libraries with custom marker, persistence for the APF list
      zos_apf:
        persistent:
-         data_set_name: "SOME.PARTITIONED.DATASET(MEM)"
+         target: "SOME.PARTITIONED.DATASET(MEM)"
          marker: "/* {mark} PROG001 USR0010 */"
        batch:
          - library: SOME.SEQ.DS1
@@ -304,13 +304,32 @@ stdout
   | **returned**: always
   | **type**: str
 
+stdout_lines
+  List of strings containing individual lines from STDOUT.
+
+  | **returned**: always
+  | **type**: list
+
 stderr
   The error messages from ZOAU command apfadm
 
   | **returned**: always
   | **type**: str
   | **sample**: BGYSC1310E ADD Error: Dataset COMMON.LINKLIB volume COMN01 is already present in APF list.
 
+stderr_lines
+  List of strings containing individual lines from STDERR.
+
+  | **returned**: always
+  | **type**: list
+  | **sample**:
+
+    .. code-block:: json
+
+        [
+            "BGYSC1310E ADD Error: Dataset COMMON.LINKLIB volume COMN01 is already present in APF list."
+        ]
+
 rc
   The return code from ZOAU command apfadm
 

docs/source/modules/zos_archive.rst

@@ -55,7 +55,7 @@ format
   | **type**: dict
 
 
-  name
+  type
     The compression format to use.
 
     | **required**: False
@@ -64,15 +64,15 @@ format
     | **choices**: bz2, gz, tar, zip, terse, xmit, pax
 
 
-  format_options
+  options
     Options specific to a compression format.
 
     | **required**: False
     | **type**: dict
 
 
-    terse_pack
-      Compression option for use with the terse format, *name=terse*.
+    spack
+      Compression option for use with the terse format, *type=terse*.
 
       Pack will compress records in a data set so that the output results in lossless data compression.
 
@@ -81,8 +81,8 @@ format
       Spack will produce smaller output and take approximately 3 times longer than pack compression.
 
       | **required**: False
-      | **type**: str
-      | **choices**: pack, spack
+      | **type**: bool
+      | **default**: True
 
 
     xmit_log_data_set
@@ -98,7 +98,7 @@ format
       | **type**: str
 
 
-    use_adrdssu
+    adrdssu
       If set to true, the ``zos_archive`` module will use Data Facility Storage Management Subsystem data set services (DFSMSdss) program ADRDSSU to compress data sets into a portable format before using ``xmit`` or ``terse``.
 
       | **required**: False
@@ -407,7 +407,7 @@ Examples
        src: /tmp/archive/foo.txt
        dest: /tmp/archive/foo_archive_test.tar
        format:
-         name: tar
+         type: tar
 
    # Archive multiple files
    - name: Archive list of files into a zip
@@ -417,26 +417,26 @@ Examples
          - /tmp/archive/bar.txt
        dest: /tmp/archive/foo_bar_archive_test.zip
        format:
-       name: zip
+       type: zip
 
    # Archive one data set into terse
    - name: Archive data set into a terse
      zos_archive:
        src: "USER.ARCHIVE.TEST"
        dest: "USER.ARCHIVE.RESULT.TRS"
        format:
-         name: terse
+         type: terse
 
    # Use terse with different options
    - name: Archive data set into a terse, specify pack algorithm and use adrdssu
      zos_archive:
        src: "USER.ARCHIVE.TEST"
        dest: "USER.ARCHIVE.RESULT.TRS"
        format:
-         name: terse
-         format_options:
-           terse_pack: "spack"
-           use_adrdssu: true
+         type: terse
+         options:
+           spack: true
+           adrdssu: true
 
    # Use a pattern to store
    - name: Archive data set pattern using xmit
@@ -445,7 +445,7 @@ Examples
        exclude_sources: "USER.ARCHIVE.EXCLUDE.*"
        dest: "USER.ARCHIVE.RESULT.XMIT"
        format:
-         name: xmit
+         type: xmit
 
    - name: Archive multiple GDSs into a terse
      zos_archive:
@@ -455,25 +455,25 @@ Examples
          - "USER.GDG(-2)"
        dest: "USER.ARCHIVE.RESULT.TRS"
        format:
-         name: terse
-         format_options:
-           use_adrdssu: true
+         type: terse
+         options:
+           adrdssu: true
 
    - name: Archive multiple data sets into a new GDS
      zos_archive:
        src: "USER.ARCHIVE.*"
        dest: "USER.GDG(+1)"
        format:
-         name: terse
-         format_options:
-           use_adrdssu: true
+         type: terse
+         options:
+           adrdssu: true
 
    - name: Encode the source data set into Latin-1 before archiving into a terse data set
      zos_archive:
        src: "USER.ARCHIVE.TEST"
        dest: "USER.ARCHIVE.RESULT.TRS"
        format:
-         name: terse
+         type: terse
        encoding:
          from: IBM-1047
          to: ISO8859-1
@@ -485,9 +485,9 @@ Examples
          - "USER.ARCHIVE2.TEST"
        dest: "USER.ARCHIVE.RESULT.TRS"
        format:
-         name: terse
-         format_options:
-           use_adrdssu: true
+         type: terse
+         options:
+           adrdssu: true
        encoding:
          from: IBM-1047
          to: ISO8859-1
@@ -503,7 +503,7 @@ Notes
 .. note::
    This module does not perform a send or transmit operation to a remote node. If you want to transport the archive you can use zos_fetch to retrieve to the controller and then zos_copy or zos_unarchive for copying to a remote or send to the remote and then unpack the archive respectively.
 
-   When packing and using ``use_adrdssu`` flag the module will take up to two times the space indicated in ``dest_data_set``.
+   When packing and using ``adrdssu`` flag the module will take up to two times the space indicated in ``dest_data_set``.
 
    tar, zip, bz2 and pax are archived using python ``tarfile`` library which uses the latest version available for each format, for compatibility when opening from system make sure to use the latest available version for the intended format.
 
@@ -524,6 +524,12 @@ Return Values
 -------------
 
 
+dest
+  The remote absolute path or data set where the archive was created.
+
+  | **returned**: always
+  | **type**: str
+
 state
   The state of the input ``src``.