Automated commit to update documentation

Author: ddimatos

_sources/ibm_zos_core/docs/source/modules/zos_backup_restore.rst.txt

@@ -133,7 +133,7 @@ backup_name
 
 
 recover
-  Specifies if potentially recoverable errors should be ignored.
+  When *recover=true* and *operation=backup* then potentially recoverable errors will be ignored.
 
   | **required**: False
   | **type**: bool
@@ -200,16 +200,18 @@ space_type
 hlq
   Specifies the new HLQ to use for the data sets being restored.
 
-  Defaults to running user's username.
+  If no value is provided, the data sets will be restored with their original HLQs.
 
   | **required**: False
   | **type**: str
 
 
 tmp_hlq
-  Override the default high level qualifier (HLQ) for temporary and backup data sets.
+  Override the default high level qualifier (HLQ) for temporary data sets used in the modules operation.
 
-  The default HLQ is the Ansible user that executes the module and if that is not available, then the value of ``TMPHLQ`` is used.
+  If *tmp_hlq* is set, this value will be applied to all temporary data sets.
+
+  If *tmp_hlq* is not set, the value will be the username who submits the ansible task, this is the default behavior. If the username can not be identified, the value ``TMPHLQ`` is used.
 
   | **required**: False
   | **type**: str
@@ -290,8 +292,8 @@ Examples
        space: 1
        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.
+   - name: Restore data sets from a backup stored in the UNIX file /tmp/temp_backup.dzp.
+       Restore the data sets with the original high level qualifiers.
      zos_backup_restore:
        operation: restore
        backup_name: /tmp/temp_backup.dzp
@@ -347,6 +349,16 @@ Examples
 
 
 
+Notes
+-----
+
+.. note::
+   It is the playbook author or user's responsibility to ensure they have appropriate authority to the RACF FACILITY resource class. A user is described as the remote user, configured to run either the playbook or playbook tasks, who can also obtain escalated privileges to execute as root or another user.
+
+   When using this module, if the RACF FACILITY class profile **STGADMIN.ADR.DUMP.TOLERATE.ENQF** is active, you must have READ access authority to use the module option *recover=true*. If the RACF FACILITY class checking is not set up, any user can use the module option without access to the class.
+
+   If your system uses a different security product, consult that product's documentation to configure the required security classes.
+
 
 
 

_sources/ibm_zos_core/docs/source/modules/zos_blockinfile.rst.txt

@@ -104,6 +104,8 @@ insertbefore
 marker_begin
   This will be inserted at ``{mark}`` in the opening ansible block marker.
 
+  Value needs to be different from *marker_end*.
+
   | **required**: False
   | **type**: str
   | **default**: BEGIN
@@ -112,6 +114,8 @@ marker_begin
 marker_end
   This will be inserted at ``{mark}`` in the closing ansible block marker.
 
+  Value must be different from *marker_begin*.
+
   | **required**: False
   | **type**: str
   | **default**: END
@@ -124,7 +128,7 @@ 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``)
+  Use generation data set (GDS) relative positive name. e.g. *SOME.CREATION(+1*).
 
   | **required**: False
   | **type**: bool

_sources/ibm_zos_core/docs/source/modules/zos_copy.rst.txt

@@ -185,13 +185,13 @@ force_lock
 
 
 ignore_sftp_stderr
-  During data transfer through SFTP, the module fails if the SFTP command directs any content to stderr. The user is able to override this behavior by setting this parameter to ``true``. By doing so, the module would essentially ignore the stderr stream produced by SFTP and continue execution.
+  During data transfer through SFTP, the SFTP command directs content to stderr. By default, the module essentially ignores the stderr stream produced by SFTP and continues execution. The user is able to override this behavior by setting this parameter to ``false``. By doing so, any content written to stderr is considered an error by Ansible and will cause the module to fail.
 
   When Ansible verbosity is set to greater than 3, either through the command line interface (CLI) using **-vvvv** or through environment variables such as **verbosity = 4**, then this parameter will automatically be set to ``true``.
 
   | **required**: False
   | **type**: bool
-  | **default**: False
+  | **default**: True
 
 
 is_binary

_sources/ibm_zos_core/docs/source/modules/zos_fetch.rst.txt

@@ -126,13 +126,13 @@ tmp_hlq
 
 
 ignore_sftp_stderr
-  During data transfer through sftp, the module fails if the sftp command directs any content to stderr. The user is able to override this behavior by setting this parameter to ``true``. By doing so, the module would essentially ignore the stderr stream produced by sftp and continue execution.
+  During data transfer through SFTP, the SFTP command directs content to stderr. By default, the module essentially ignores the stderr stream produced by SFTP and continues execution. The user is able to override this behavior by setting this parameter to ``false``. By doing so, any content written to stderr is considered an error by Ansible and will cause the module to fail.
 
   When Ansible verbosity is set to greater than 3, either through the command line interface (CLI) using **-vvvv** or through environment variables such as **verbosity = 4**, then this parameter will automatically be set to ``true``.
 
   | **required**: False
   | **type**: bool
-  | **default**: False
+  | **default**: True
 
 
 

_sources/ibm_zos_core/docs/source/modules/zos_job_output.rst.txt

@@ -265,7 +265,7 @@ jobs
     | **type**: str
 
   content_type
-    Type of address space.
+    Type of address space used by the job, can be one of the following types. - APPC for a APPC Initiator. - JGRP for a JOBGROUP. - JOB for a Batch job. - STC for a Started task. - TSU for a Time sharing user. - \? for an unknown or pending.
 
     | **type**: str
     | **sample**: JOB

_sources/ibm_zos_core/docs/source/modules/zos_job_query.rst.txt

@@ -134,6 +134,7 @@ jobs
         [
             {
                 "asid": 0,
+                "content_type": "JOB",
                 "creation_date": "2023-05-03",
                 "creation_time": "12:13:00",
                 "job_class": "K",
@@ -147,6 +148,7 @@ jobs
             },
             {
                 "asid": 4,
+                "content_type": "JOB",
                 "creation_date": "2023-05-03",
                 "creation_time": "12:14:00",
                 "job_class": "A",
@@ -181,6 +183,36 @@ jobs
     | **type**: str
     | **sample**: JOB01427
 
+  content_type
+    Type of address space used by the job, can be one of the following types.
+
+    APPC for a APPC Initiator.
+
+    JGRP for a JOBGROUP.
+
+    JOB for a Batch job.
+
+    STC for a Started task.
+
+    TSU for a Time sharing user.
+
+    \? for an unknown or pending.
+
+    | **type**: str
+    | **sample**: STC
+
+  system
+    The job entry system that MVS uses to do work.
+
+    | **type**: str
+    | **sample**: STL1
+
+  subsystem
+    The job entry subsystem that MVS uses to do work.
+
+    | **type**: str
+    | **sample**: STL1
+
   ret_code
     Return code output collected from job log.
 

_sources/ibm_zos_core/docs/source/modules/zos_job_submit.rst.txt

@@ -31,7 +31,7 @@ Parameters
 src
   The source file or data set containing the JCL to submit.
 
-  It could be a physical sequential data set, a partitioned data set qualified by a member or a path (e.g. ``USER.TEST``, V(USER.JCL(TEST\))), or a generation data set from a generation data group (for example, V(USER.TEST.GDG(-2\))).
+  It could be a physical sequential data set, a partitioned data set qualified by a member or a path (e.g. ``USER.TEST``, ``USER.JCL(TEST)``), or a generation data set from a generation data group (for example, ``USER.TEST.GDG(-2)``).
 
   Or a USS file. (e.g ``/u/tester/demo/sample.jcl``)
 
@@ -592,6 +592,24 @@ jobs
     | **type**: str
     | **sample**: HELLO
 
+  content_type
+    Type of address space used by the job, can be one of the following types.
+
+    APPC for a APPC Initiator.
+
+    JGRP for a JOBGROUP.
+
+    JOB for a Batch job.
+
+    STC for a Started task.
+
+    TSU for a Time sharing user.
+
+    \? for an unknown or pending.
+
+    | **type**: str
+    | **sample**: STC
+
   duration
     The total lapsed time the JCL ran for.
 

_sources/ibm_zos_core/docs/source/modules/zos_mvs_raw.rst.txt

@@ -425,7 +425,7 @@ dds
 
         *src_encoding* and *response_encoding* are only used when *type=text*.
 
-        ``base64`` means return content in binary mode.
+        ``base64`` means return content as base64 encoded in binary.
 
         | **required**: True
         | **type**: str
@@ -616,7 +616,7 @@ dds
 
         *src_encoding* and *response_encoding* are only used when *type=text*.
 
-        ``base64`` means return content in binary mode.
+        ``base64`` means return content as base64 encoded in binary.
 
         | **required**: True
         | **type**: str
@@ -690,7 +690,7 @@ dds
 
         *src_encoding* and *response_encoding* are only used when *type=text*.
 
-        ``base64`` means return content in binary mode.
+        ``base64`` means return content as base64 encoded in binary.
 
         | **required**: True
         | **type**: str
@@ -747,7 +747,7 @@ dds
 
         *src_encoding* and *response_encoding* are only used when *type=text*.
 
-        ``base64`` means return content in binary mode.
+        ``base64`` means return content as base64 encoded in binary.
 
         | **required**: True
         | **type**: str
@@ -1164,7 +1164,7 @@ dds
 
             *src_encoding* and *response_encoding* are only used when *type=text*.
 
-            ``base64`` means return content in binary mode.
+            ``base64`` means return content as base64 encoded in binary.
 
             | **required**: True
             | **type**: str
@@ -1348,7 +1348,7 @@ dds
 
             *src_encoding* and *response_encoding* are only used when *type=text*.
 
-            ``base64`` means return content in binary mode.
+            ``base64`` means return content as base64 encoded in binary.
 
             | **required**: True
             | **type**: str
@@ -1415,7 +1415,7 @@ dds
 
             *src_encoding* and *response_encoding* are only used when *type=text*.
 
-            ``base64`` means return content in binary mode.
+            ``base64`` means return content as base64 encoded in binary.
 
             | **required**: True
             | **type**: str

_sources/ibm_zos_core/docs/source/modules/zos_operator.rst.txt

@@ -37,6 +37,8 @@ cmd
 
   For example, to display job by job name the command would be ``cmd:"\\$dj''HELLO''"``
 
+  By default, the command will be converted to uppercase before execution, to control this behavior, see the *case_sensitive* option below.
+
   | **required**: True
   | **type**: str
 
@@ -63,6 +65,14 @@ wait_time_s
   | **default**: 1
 
 
+case_sensitive
+  If ``true``, the command will not be converted to uppercase before execution. Instead, the casing will be preserved just as it was written in a task.
+
+  | **required**: False
+  | **type**: bool
+  | **default**: False
+
+
 
 
 Examples