Automated commit to update documentation

IBM · Aug 12, 2024 · c3dbcc8 · c3dbcc8
1 parent e640c67
commit c3dbcc8
Show file tree

Hide file tree

Showing 46 changed files with 2,034 additions and 830 deletions.
diff --git a/_sources/ibm_zos_core/docs/source/modules/zos_apf.rst.txt b/_sources/ibm_zos_core/docs/source/modules/zos_apf.rst.txt
@@ -62,7 +62,7 @@ volume
 
   1. The volume serial number.
 
-  2. Six asterisks (******), indicating that the system must use the volume serial number of the current system residence (SYSRES) volume.
+  2. Six asterisks ``******``, indicating that the system must use the volume serial number of the current system residence (SYSRES) volume.
 
   3. *MCAT*, indicating that the system must use the volume serial number of the volume containing the master catalog.
 
@@ -189,7 +189,7 @@ batch
 
     1. The volume serial number
 
-    2. Six asterisks (******), indicating that the system must use the volume serial number of the current system residence (SYSRES) volume.
+    2. Six asterisks ``******``, indicating that the system must use the volume serial number of the current system residence (SYSRES) volume.
 
     3. *MCAT*, indicating that the system must use the volume serial number of the volume containing the master catalog.
 
@@ -225,7 +225,7 @@ Examples
    - name: Add a library (cataloged) to the APF list and persistence
      zos_apf:
        library: SOME.SEQUENTIAL.DATASET
-       force_dynamic: True
+       force_dynamic: true
        persistent:
          data_set_name: SOME.PARTITIONED.DATASET(MEM)
    - name: Remove a library from the APF list and persistence
@@ -243,7 +243,7 @@ Examples
        batch:
          - library: SOME.SEQ.DS1
          - library: SOME.SEQ.DS2
-           sms: True
+           sms: true
          - library: SOME.SEQ.DS3
            volume: T12345
    - name: Print the APF list matching library pattern or volume serial number

diff --git a/_sources/ibm_zos_core/docs/source/modules/zos_archive.rst.txt b/_sources/ibm_zos_core/docs/source/modules/zos_archive.rst.txt
@@ -35,6 +35,8 @@ src
 
   USS file paths should be absolute paths.
 
+  GDS relative notation is supported.
+
   MVS data sets supported types are: ``SEQ``, ``PDS``, ``PDSE``.
 
   VSAMs are not supported.
@@ -78,7 +80,7 @@ format
 
       | **required**: False
       | **type**: str
-      | **choices**: PACK, SPACK
+      | **choices**: pack, spack
 
 
     xmit_log_data_set
@@ -126,7 +128,7 @@ dest
 
 
 exclude
-  Remote absolute path, glob, or list of paths, globs or data set name patterns for the file, files or data sets to exclude from src list and glob expansion.
+  Remote absolute path, glob, or list of paths, globs, data set name patterns or generation data sets (GDSs) in relative notation for the file, files or data sets to exclude from src list and glob expansion.
 
   Patterns (wildcards) can contain one of the following, `?`, `*`.
 
@@ -203,8 +205,8 @@ dest_data_set
 
     | **required**: False
     | **type**: str
-    | **default**: SEQ
-    | **choices**: SEQ
+    | **default**: seq
+    | **choices**: seq
 
 
   space_primary
@@ -228,21 +230,21 @@ dest_data_set
   space_type
     If the destination data set does not exist, this sets the unit of measurement to use when defining primary and secondary space.
 
-    Valid units of size are ``K``, ``M``, ``G``, ``CYL``, and ``TRK``.
+    Valid units of size are ``k``, ``m``, ``g``, ``cyl``, and ``trk``.
 
     | **required**: False
     | **type**: str
-    | **choices**: K, M, G, CYL, TRK
+    | **choices**: k, m, g, cyl, trk
 
 
   record_format
     If the destination data set does not exist, this sets the format of the data set. (e.g ``FB``)
 
-    Choices are case-insensitive.
+    Choices are case-sensitive.
 
     | **required**: False
     | **type**: str
-    | **choices**: FB, VB, FBA, VBA, U
+    | **choices**: fb, vb, fba, vba, u
 
 
   record_length
@@ -348,7 +350,7 @@ Examples
          name: tar
 
    # Archive multiple files
-   - name: Compress list of files into a zip
+   - name: Archive list of files into a zip
      zos_archive:
        src:
          - /tmp/archive/foo.txt
@@ -358,33 +360,54 @@ Examples
        name: zip
 
    # Archive one data set into terse
-   - name: Compress data set into a terse
+   - name: Archive data set into a terse
      zos_archive:
        src: "USER.ARCHIVE.TEST"
        dest: "USER.ARCHIVE.RESULT.TRS"
        format:
          name: terse
 
    # Use terse with different options
-   - name: Compress data set into a terse, specify pack algorithm and use adrdssu
+   - 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
+           terse_pack: "spack"
+           use_adrdssu: true
 
    # Use a pattern to store
-   - name: Compress data set pattern using xmit
+   - name: Archive data set pattern using xmit
      zos_archive:
        src: "USER.ARCHIVE.*"
        exclude_sources: "USER.ARCHIVE.EXCLUDE.*"
        dest: "USER.ARCHIVE.RESULT.XMIT"
        format:
          name: xmit
 
+   - name: Archive multiple GDSs into a terse
+     zos_archive:
+       src:
+         - "USER.GDG(0)"
+         - "USER.GDG(-1)"
+         - "USER.GDG(-2)"
+       dest: "USER.ARCHIVE.RESULT.TRS"
+       format:
+         name: terse
+         format_options:
+           use_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
+
 
 
 

diff --git a/_sources/ibm_zos_core/docs/source/modules/zos_backup_restore.rst.txt b/_sources/ibm_zos_core/docs/source/modules/zos_backup_restore.rst.txt
@@ -49,6 +49,8 @@ data_sets
   include
     When *operation=backup*, specifies a list of data sets or data set patterns to include in the backup.
 
+    When *operation=backup* GDS relative names are supported.
+
     When *operation=restore*, specifies a list of data sets or data set patterns to include when restoring from a backup.
 
     The single asterisk, ``*``, is used in place of exactly one qualifier. In addition, it can be used to indicate to DFSMSdss that only part of a qualifier has been specified.
@@ -66,6 +68,8 @@ data_sets
   exclude
     When *operation=backup*, specifies a list of data sets or data set patterns to exclude from the backup.
 
+    When *operation=backup* GDS relative names are supported.
+
     When *operation=restore*, specifies a list of data sets or data set patterns to exclude when restoring from a backup.
 
     The single asterisk, ``*``, is used in place of exactly one qualifier. In addition, it can be used to indicate that only part of a qualifier has been specified."
@@ -122,6 +126,8 @@ backup_name
 
   There are no enforced conventions for backup names. However, using a common extension like ``.dzp`` for UNIX files and ``.DZP`` for data sets will improve readability.
 
+  GDS relative names are supported when *operation=restore*.
+
   | **required**: True
   | **type**: str
 
@@ -182,13 +188,13 @@ space
 space_type
   The unit of measurement to use when defining data set space.
 
-  Valid units of size are ``K``, ``M``, ``G``, ``CYL``, and ``TRK``.
+  Valid units of size are ``k``, ``m``, ``g``, ``cyl``, and ``trk``.
 
-  When *full_volume=True*, *space_type* defaults to ``G``, otherwise default is ``M``
+  When *full_volume=True*, *space_type* defaults to ``g``, otherwise default is ``m``
 
   | **required**: False
   | **type**: str
-  | **choices**: K, M, G, CYL, TRK
+  | **choices**: k, m, g, cyl, trk
 
 
 hlq
@@ -200,6 +206,15 @@ hlq
   | **type**: str
 
 
+tmp_hlq
+  Override the default high level qualifier (HLQ) for temporary and backup data sets.
+
+  The default HLQ is the Ansible user that executes the module and if that is not available, then the value of ``TMPHLQ`` is used.
+
+  | **required**: False
+  | **type**: str
+
+
 
 
 Examples
@@ -226,13 +241,22 @@ Examples
          exclude: user.private.*
        backup_name: MY.BACKUP.DZP
 
+   - name: Backup a list of GDDs to data set my.backup.dzp
+     zos_backup_restore:
+       operation: backup
+       data_sets:
+         include:
+           - user.gdg(-1)
+           - user.gdg(0)
+       backup_name: my.backup.dzp
+
    - name: Backup all datasets matching the pattern USER.** to UNIX file /tmp/temp_backup.dzp, ignore recoverable errors.
      zos_backup_restore:
        operation: backup
        data_sets:
          include: user.**
        backup_name: /tmp/temp_backup.dzp
-       recover: yes
+       recover: true
 
    - name: Backup all datasets matching the pattern USER.** to data set MY.BACKUP.DZP,
        allocate 100MB for data sets used in backup process.
@@ -242,7 +266,7 @@ Examples
          include: user.**
        backup_name: MY.BACKUP.DZP
        space: 100
-       space_type: M
+       space_type: m
 
    - name:
        Backup all datasets matching the pattern USER.** that are present on the volume MYVOL1 to data set MY.BACKUP.DZP,
@@ -254,17 +278,17 @@ Examples
        volume: MYVOL1
        backup_name: MY.BACKUP.DZP
        space: 100
-       space_type: M
+       space_type: m
 
    - name: Backup an entire volume, MYVOL1, to the UNIX file /tmp/temp_backup.dzp,
        allocate 1GB for data sets used in backup process.
      zos_backup_restore:
        operation: backup
        backup_name: /tmp/temp_backup.dzp
        volume: MYVOL1
-       full_volume: yes
+       full_volume: true
        space: 1
-       space_type: G
+       space_type: g
 
    - name: Restore data sets from backup stored in the UNIX file /tmp/temp_backup.dzp.
        Use z/OS username as new HLQ.
@@ -305,10 +329,10 @@ Examples
      zos_backup_restore:
        operation: restore
        volume: MYVOL2
-       full_volume: yes
+       full_volume: true
        backup_name: MY.BACKUP.DZP
        space: 1
-       space_type: G
+       space_type: g
 
    - name: Restore data sets from backup stored in the UNIX file /tmp/temp_backup.dzp.
        Specify DB2SMS10 for the SMS storage and management classes to use for the restored

diff --git a/_sources/ibm_zos_core/docs/source/modules/zos_blockinfile.rst.txt b/_sources/ibm_zos_core/docs/source/modules/zos_blockinfile.rst.txt
@@ -33,6 +33,8 @@ src
 
   The USS file must be an absolute pathname.
 
+  Generation data set (GDS) relative name of generation already created.  ``e.g. SOME.CREATION(-1.)``
+
   | **required**: True
   | **type**: str
 
@@ -122,6 +124,8 @@ backup
 
   The backup file name will be returned on either success or failure of module execution such that data can be retrieved.
 
+  Use generation data set (GDS) relative positive name. ``e.g. SOME.CREATION(+1``)
+
   | **required**: False
   | **type**: bool
   | **default**: False
@@ -281,6 +285,20 @@ Examples
        marker_end: "End Ansible Block Insertion 2"
        block: "{{ CONTENT }}"
 
+   - name: Add a block to a gds
+     zos_blockinfile:
+       src: TEST.SOME.CREATION(0)
+       insertafter: EOF
+       block: "{{ CONTENT }}"
+
+   - name: Add a block to dataset and backup in a new generation of gds
+     zos_blockinfile:
+       src: SOME.CREATION.TEST
+       insertbefore: BOF
+       backup: True
+       backup_name: CREATION.GDS(+1)
+       block: "{{ CONTENT }}"
+