Automated commit to update documentation

IBM · May 17, 2024 · 660e6aa · 660e6aa
1 parent b3b3353
commit 660e6aa
Show file tree

Hide file tree

Showing 42 changed files with 1,877 additions and 1,916 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
@@ -78,7 +78,7 @@ format
 
       | **required**: False
       | **type**: str
-      | **choices**: PACK, SPACK
+      | **choices**: pack, spack
 
 
     xmit_log_data_set
@@ -203,8 +203,8 @@ dest_data_set
 
     | **required**: False
     | **type**: str
-    | **default**: SEQ
-    | **choices**: SEQ
+    | **default**: seq
+    | **choices**: seq
 
 
   space_primary
@@ -228,21 +228,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
@@ -373,8 +373,8 @@ Examples
        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

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
@@ -182,13 +182,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 +200,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
@@ -232,7 +241,7 @@ Examples
        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 +251,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 +263,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 +314,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_copy.rst.txt b/_sources/ibm_zos_core/docs/source/modules/zos_copy.rst.txt
@@ -91,7 +91,7 @@ dest
 
   If ``dest`` is a nonexistent USS file, it will be created.
 
-  If ``dest`` is a new USS file or replacement, the file will be appropriately tagged with either the system's default locale or the encoding option defined. If the USS file is a replacement, the user must have write authority to the file either through ownership, group or other permissions, else the copy will fail.
+  If ``dest`` is a new USS file or replacement, the file will be appropriately tagged with either the system's default locale or the encoding option defined. If the USS file is a replacement, the user must have write authority to the file either through ownership, group or other permissions, else the module will fail.
 
   If ``dest`` is a nonexistent data set, it will be created following the process outlined here and in the ``volume`` option.
 
@@ -132,7 +132,7 @@ encoding
   to
     The encoding to be converted to
 
-    | **required**: True
+    | **required**: False
     | **type**: str
 
 
@@ -234,6 +234,17 @@ local_follow
   | **default**: True
 
 
+group
+  Name of the group that will own the file system objects.
+
+  When left unspecified, it uses the current group of the current user unless you are root, in which case it can preserve the previous ownership.
+
+  This option is only applicable if ``dest`` is USS, otherwise ignored.
+
+  | **required**: False
+  | **type**: str
+
+
 mode
   The permission of the destination file or directory.
 
@@ -249,6 +260,17 @@ mode
   | **type**: str
 
 
+owner
+  Name of the user that should own the filesystem object, as would be passed to the chown command.
+
+  When left unspecified, it uses the current user unless you are root, in which case it can preserve the previous ownership.
+
+  This option is only applicable if ``dest`` is USS, otherwise ignored.
+
+  | **required**: False
+  | **type**: str
+
+
 remote_src
   If set to ``false``, the module searches for ``src`` at the local machine.
 
@@ -321,7 +343,7 @@ dest_data_set
 
     | **required**: True
     | **type**: str
-    | **choices**: KSDS, ESDS, RRDS, LDS, SEQ, PDS, PDSE, MEMBER, BASIC, LIBRARY
+    | **choices**: ksds, esds, rrds, lds, seq, pds, pdse, member, basic, library
 
 
   space_primary
@@ -345,21 +367,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``)
+    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
@@ -390,9 +412,9 @@ dest_data_set
   key_offset
     The key offset to use when creating a KSDS data set.
 
-    *key_offset* is required when *type=KSDS*.
+    *key_offset* is required when *type=ksds*.
 
-    *key_offset* should only be provided when *type=KSDS*
+    *key_offset* should only be provided when *type=ksds*
 
     | **required**: False
     | **type**: int
@@ -401,9 +423,9 @@ dest_data_set
   key_length
     The key length to use when creating a KSDS data set.
 
-    *key_length* is required when *type=KSDS*.
+    *key_length* is required when *type=ksds*.
 
-    *key_length* should only be provided when *type=KSDS*
+    *key_length* should only be provided when *type=ksds*
 
     | **required**: False
     | **type**: int
@@ -613,7 +635,7 @@ Examples
      zos_copy:
        src: /path/to/foo.conf
        dest: /etc/foo.conf
-       mode: 0644
+       mode: "0644"
        group: foo
        owner: bar
 
@@ -743,11 +765,11 @@ Examples
        remote_src: true
        volume: '222222'
        dest_data_set:
-         type: SEQ
+         type: seq
          space_primary: 10
          space_secondary: 3
-         space_type: K
-         record_format: VB
+         space_type: k
+         record_format: vb
          record_length: 150
 
    - name: Copy a Program Object and its aliases on a remote system to a new PDSE member MYCOBOL
@@ -846,12 +868,12 @@ destination_attributes
 
         {
             "block_size": 32760,
-            "record_format": "FB",
+            "record_format": "fb",
             "record_length": 45,
             "space_primary": 2,
             "space_secondary": 1,
-            "space_type": "K",
-            "type": "PDSE"
+            "space_type": "k",
+            "type": "pdse"
         }
 
   block_size
@@ -864,7 +886,7 @@ destination_attributes
     Record format of the dataset.
 
     | **type**: str
-    | **sample**: FB
+    | **sample**: fb
 
   record_length
     Record length of the dataset.
@@ -888,13 +910,13 @@ destination_attributes
     Unit of measurement for space.
 
     | **type**: str
-    | **sample**: K
+    | **sample**: k
 
   type
     Type of dataset allocated.
 
     | **type**: str
-    | **sample**: PDSE
+    | **sample**: pdse
 
 
 checksum