Adding the check mode documentation (#2000)

Rohitcodes28 · web-flow · commit c68a06a9d4d2 · 2025-03-24T12:47:53.000-06:00
* adding the check mode documentation

* changelog addition

* modifying documentation for volume_init and zfs_resize

* changing docs as per review comments
diff --git a/changelogs/fragments/2000-documentation-for-check_mode-all-modules.yml b/changelogs/fragments/2000-documentation-for-check_mode-all-modules.yml
@@ -0,0 +1,69 @@
+trivial:
+  - zos_apf - Add documentation for check mode.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2000).
+
+  - zos_archive - Add documentation for check mode.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2000).
+
+  - zos_backup_restore - Add documentation for check mode.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2000).
+
+  - zos_blockinfile - Add documentation for check mode.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2000).
+
+  - zos_copy - Add documentation for check mode.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2000).
+
+  - zos_data_set - Add documentation for check mode.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2000).
+
+  - zos_encode - Add documentation for check mode.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2000).
+
+  - zos_fetch - Add documentation for check mode.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2000).
+
+  - zos_find - Add documentation for check mode.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2000).
+
+  - zos_gather_facts - Add documentation for check mode.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2000).
+
+  - zos_job_output - Add documentation for check mode.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2000).
+
+  - zos_job_query - Add documentation for check mode.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2000).
+
+  - zos_job_submit - Add documentation for check mode.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2000).
+
+  - zos_lineinfile - Add documentation for check mode.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2000).
+
+  - zos_mount - Add documentation for check mode.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2000).
+
+  - zos_mvs_raw - Add documentation for check mode.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2000).
+
+  - zos_operator - Add documentation for check mode.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2000).
+
+  - zos_operator_action_query - Add documentation for check mode.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2000).
+
+  - zos_ping - Add documentation for check mode.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2000).
+
+  - zos_tso_command - Add documentation for check mode.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2000).
+
+  - zos_unarchive - Add documentation for check mode.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2000).
+
+  - zos_volume_init - Add documentation for check mode.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2000).
+
+  - zos_zfs_resize - Add documentation for check mode.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2000).
diff --git a/plugins/modules/zos_apf.py b/plugins/modules/zos_apf.py
@@ -203,6 +203,9 @@
   async:
     support: full
     description: Supports being used with the ``async`` keyword.
+  check_mode:
+    support: none
+    description: Can run in check_mode and return changed status prediction without modifying target. If not supported, the action will be skipped.
 
 notes:
     - It is the playbook author or user's responsibility to ensure they have
diff --git a/plugins/modules/zos_archive.py b/plugins/modules/zos_archive.py
@@ -314,6 +314,9 @@
   async:
     support: full
     description: Supports being used with the ``async`` keyword.
+  check_mode:
+    support: full
+    description: Can run in check_mode and return changed status prediction without modifying target. If not supported, the action will be skipped.
 
 notes:
   - This module does not perform a send or transmit operation to a remote
diff --git a/plugins/modules/zos_backup_restore.py b/plugins/modules/zos_backup_restore.py
@@ -208,6 +208,9 @@
   async:
     support: full
     description: Supports being used with the ``async`` keyword.
+  check_mode:
+    support: none
+    description: Can run in check_mode and return changed status prediction without modifying target. If not supported, the action will be skipped.
 
 notes:
     - It is the playbook author or user's responsibility to ensure they have
diff --git a/plugins/modules/zos_blockinfile.py b/plugins/modules/zos_blockinfile.py
@@ -182,6 +182,9 @@
   async:
     support: full
     description: Supports being used with the ``async`` keyword.
+  check_mode:
+    support: none
+    description: Can run in check_mode and return changed status prediction without modifying target. If not supported, the action will be skipped.
 
 notes:
   - It is the playbook author or user's responsibility to avoid files
diff --git a/plugins/modules/zos_copy.py b/plugins/modules/zos_copy.py
@@ -529,6 +529,9 @@
   async:
     support: full
     description: Supports being used with the ``async`` keyword.
+  check_mode:
+    support: none
+    description: Can run in check_mode and return changed status prediction without modifying target. If not supported, the action will be skipped.
 
 notes:
     - Destination data sets are assumed to be in catalog. When trying to copy
diff --git a/plugins/modules/zos_data_set.py b/plugins/modules/zos_data_set.py
@@ -660,6 +660,9 @@
   async:
     support: full
     description: Supports being used with the ``async`` keyword.
+  check_mode:
+    support: full
+    description: Can run in check_mode and return changed status prediction without modifying target. If not supported, the action will be skipped.
 """
 EXAMPLES = r"""
 - name: Create a sequential data set if it does not exist
diff --git a/plugins/modules/zos_encode.py b/plugins/modules/zos_encode.py
@@ -128,6 +128,9 @@
   async:
     support: full
     description: Supports being used with the ``async`` keyword.
+  check_mode:
+    support: none
+    description: Can run in check_mode and return changed status prediction without modifying target. If not supported, the action will be skipped.
 
 notes:
   - It is the playbook author or user's responsibility to avoid files that should
diff --git a/plugins/modules/zos_fetch.py b/plugins/modules/zos_fetch.py
@@ -143,6 +143,9 @@
   async:
     support: none
     description: Supports being used with the ``async`` keyword.
+  check_mode:
+    support: none
+    description: Can run in check_mode and return changed status prediction without modifying target. If not supported, the action will be skipped.
 
 notes:
     - When fetching PDSE and VSAM data sets, temporary storage will be used
diff --git a/plugins/modules/zos_find.py b/plugins/modules/zos_find.py
@@ -172,6 +172,9 @@
   async:
     support: full
     description: Supports being used with the ``async`` keyword.
+  check_mode:
+    support: none
+    description: Can run in check_mode and return changed status prediction without modifying target. If not supported, the action will be skipped.
 
 notes:
   - Only cataloged data sets will be searched. If an uncataloged data set needs to
diff --git a/plugins/modules/zos_gather_facts.py b/plugins/modules/zos_gather_facts.py
@@ -69,6 +69,9 @@
   async:
     support: full
     description: Supports being used with the ``async`` keyword.
+  check_mode:
+    support: full
+    description: Can run in check_mode and return changed status prediction without modifying target. If not supported, the action will be skipped.
 """
 
 EXAMPLES = r"""
diff --git a/plugins/modules/zos_job_output.py b/plugins/modules/zos_job_output.py
@@ -69,6 +69,9 @@
   async:
     support: full
     description: Supports being used with the ``async`` keyword.
+  check_mode:
+    support: full
+    description: Can run in check_mode and return changed status prediction without modifying target. If not supported, the action will be skipped.
 """
 
 EXAMPLES = r"""
diff --git a/plugins/modules/zos_job_query.py b/plugins/modules/zos_job_query.py
@@ -69,6 +69,9 @@
   async:
     support: full
     description: Supports being used with the ``async`` keyword.
+  check_mode:
+    support: full
+    description: Can run in check_mode and return changed status prediction without modifying target. If not supported, the action will be skipped.
 """
 
 EXAMPLES = r"""
diff --git a/plugins/modules/zos_job_submit.py b/plugins/modules/zos_job_submit.py
@@ -140,6 +140,9 @@
   async:
     support: full
     description: Supports being used with the ``async`` keyword.
+  check_mode:
+    support: full
+    description: Can run in check_mode and return changed status prediction without modifying target. If not supported, the action will be skipped.
 
 notes:
   - For supported character sets used to encode data, refer to the
diff --git a/plugins/modules/zos_lineinfile.py b/plugins/modules/zos_lineinfile.py
@@ -196,6 +196,9 @@
   async:
     support: full
     description: Supports being used with the ``async`` keyword.
+  check_mode:
+    support: full
+    description: Can run in check_mode and return changed status prediction without modifying target. If not supported, the action will be skipped.
 
 notes:
   - It is the playbook author or user's responsibility to avoid files
diff --git a/plugins/modules/zos_mount.py b/plugins/modules/zos_mount.py
@@ -312,6 +312,9 @@
   async:
     support: full
     description: Supports being used with the ``async`` keyword.
+  check_mode:
+    support: full
+    description: Can run in check_mode and return changed status prediction without modifying target. If not supported, the action will be skipped.
 
 notes:
     - All data sets are always assumed to be cataloged.
diff --git a/plugins/modules/zos_mvs_raw.py b/plugins/modules/zos_mvs_raw.py
@@ -1240,6 +1240,9 @@
   async:
     support: full
     description: Supports being used with the ``async`` keyword.
+  check_mode:
+    support: full
+    description: Can run in check_mode and return changed status prediction without modifying target. If not supported, the action will be skipped.
 
 notes:
     - When executing programs using L(zos_mvs_raw,./zos_mvs_raw.html), you may encounter errors
diff --git a/plugins/modules/zos_operator.py b/plugins/modules/zos_operator.py
@@ -77,6 +77,9 @@
   async:
     support: full
     description: Supports being used with the ``async`` keyword.
+  check_mode:
+    support: none
+    description: Can run in check_mode and return changed status prediction without modifying target. If not supported, the action will be skipped.
 
 notes:
     - Commands may need to use specific prefixes like $, they can be discovered by
diff --git a/plugins/modules/zos_operator_action_query.py b/plugins/modules/zos_operator_action_query.py
@@ -100,6 +100,9 @@
   async:
     support: full
     description: Supports being used with the ``async`` keyword.
+  check_mode:
+    support: none
+    description: Can run in check_mode and return changed status prediction without modifying target. If not supported, the action will be skipped.
 """
 
 EXAMPLES = r"""
diff --git a/plugins/modules/zos_ping.py b/plugins/modules/zos_ping.py
@@ -39,6 +39,9 @@
   async:
     support: full
     description: Supports being used with the ``async`` keyword.
+  check_mode:
+    support: none
+    description: Can run in check_mode and return changed status prediction without modifying target. If not supported, the action will be skipped.
 
 notes:
     - This module is written in REXX and relies on the SCP protocol to transfer the source to
diff --git a/plugins/modules/zos_script.py b/plugins/modules/zos_script.py
@@ -105,7 +105,7 @@
     description: Supports being used with the ``async`` keyword.
   check_mode:
     support: none
-    description: Can run in check_mode and return changed status prediction without modifying target, if not supported the action will be skipped.
+    description: Can run in check_mode and return changed status prediction without modifying target. If not supported, the action will be skipped.
   diff_mode:
     support: none
     description: Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.
diff --git a/plugins/modules/zos_tso_command.py b/plugins/modules/zos_tso_command.py
@@ -52,6 +52,9 @@
   async:
     support: full
     description: Supports being used with the ``async`` keyword.
+  check_mode:
+    support: full
+    description: Can run in check_mode and return changed status prediction without modifying target. If not supported, the action will be skipped.
 """
 
 RETURN = r"""
diff --git a/plugins/modules/zos_unarchive.py b/plugins/modules/zos_unarchive.py
@@ -320,6 +320,9 @@
   async:
     support: none
     description: Supports being used with the ``async`` keyword.
+  check_mode:
+    support: full
+    description: Can run in check_mode and return changed status prediction without modifying target. If not supported, the action will be skipped.
 
 notes:
   - VSAMs are not supported.
diff --git a/plugins/modules/zos_volume_init.py b/plugins/modules/zos_volume_init.py
@@ -139,6 +139,9 @@
   async:
     support: full
     description: Supports being used with the ``async`` keyword.
+  check_mode:
+    support: none
+    description: Can run in check_mode and return changed status prediction without modifying target. If not supported, the action will be skipped.
 """
 EXAMPLES = r"""
 - name: Initialize target volume with all default options. Target volume address is '1234', set volume name to 'DEMO01'.
diff --git a/plugins/modules/zos_zfs_resize.py b/plugins/modules/zos_zfs_resize.py
@@ -88,6 +88,9 @@
   async:
     support: full
     description: Supports being used with the ``async`` keyword.
+  check_mode:
+    support: none
+    description: Can run in check_mode and return changed status prediction without modifying target. If not supported, the action will be skipped.
 
 notes:
   - If needed, allocate the zFS trace output data set as a PDSE with RECFM=VB, LRECL=133 with a primary allocation of at least
