adding the async and action documentation to all modules. (#1987)

* adding the async and action documentation to all modules.

* resolving sanity issues

* adding changelog

* modifying as per review comments fetch and unarchive still does not support that.

* updating changelog as per review comments

Author: Rohitcodes28

changelogs/fragments/1987-async_documentation.yml

@@ -0,0 +1,72 @@
+trivial:
+  - zos_apf - Add documentation for async and action support.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1987).
+
+  - zos_archive - Add documentation for async and action support.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1987).
+
+  - zos_backup_restore - Add documentation for async and action support.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1987).
+
+  - zos_blockinfile - Add documentation for async and action support.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1987).
+
+  - zos_copy - Add documentation for async and action support.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1987).
+
+  - zos_data_set - Add documentation for async and action support.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1987).
+
+  - zos_encode - Add documentation for async and action support.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1987).
+
+  - zos_fetch - Add documentation for async and action support.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1987).
+
+  - zos_find - Add documentation for async and action support.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1987).
+
+  - zos_gather_facts - Add documentation for async and action support.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1987).
+
+  - zos_job_output - Add documentation for async and action support.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1987).
+
+  - zos_job_query - Add documentation for async and action support.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1987).
+
+  - zos_job_submit - Add documentation for async and action support.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1987).
+
+  - zos_lineinfile - Add documentation for async and action support.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1987).
+
+  - zos_mount - Add documentation for async and action support.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1987).
+
+  - zos_mvs_raw - Add documentation for async and action support.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1987).
+
+  - zos_operator - Add documentation for async and action support.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1987).
+
+  - zos_operator_action_query - Add documentation for async and action support.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1987).
+
+  - zos_ping - Add documentation for async and action support.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1987).
+
+  - zos_script - Add documentation for async and action support.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1987).
+
+  - zos_tso_command - Add documentation for async and action support.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1987).
+
+  - zos_unarchive - Add documentation for async and action support.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1987).
+
+  - zos_volume_init - Add documentation for async and action support.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1987).
+
+  - zos_zfs_resize - Add documentation for async and action support.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1987).

plugins/modules/zos_apf.py

@@ -195,6 +195,15 @@
         required: False
         type: bool
         default: False
+
+attributes:
+  action:
+    support: none
+    description: Indicates this has a corresponding action plugin so some parts of the options can be executed on the controller.
+  async:
+    support: full
+    description: Supports being used with the ``async`` keyword.
+
 notes:
     - It is the playbook author or user's responsibility to ensure they have
       appropriate authority to the RACF® FACILITY resource class. A user is

plugins/modules/zos_archive.py

@@ -1,7 +1,7 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
 
-# Copyright (c) IBM Corporation 2023, 2024
+# Copyright (c) IBM Corporation 2023, 2025
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
@@ -307,6 +307,14 @@
     default: false
     required: false
 
+attributes:
+  action:
+    support: none
+    description: Indicates this has a corresponding action plugin so some parts of the options can be executed on the controller.
+  async:
+    support: full
+    description: Supports being used with the ``async`` keyword.
+
 notes:
   - 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

plugins/modules/zos_backup_restore.py

@@ -1,7 +1,7 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
 
-# Copyright (c) IBM Corporation 2020, 2024
+# Copyright (c) IBM Corporation 2020, 2025
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
@@ -200,6 +200,15 @@
         not be identified, the value C(TMPHLQ) is used.
     required: false
     type: str
+
+attributes:
+  action:
+    support: none
+    description: Indicates this has a corresponding action plugin so some parts of the options can be executed on the controller.
+  async:
+    support: full
+    description: Supports being used with the ``async`` keyword.
+
 notes:
     - It is the playbook author or user's responsibility to ensure they have
       appropriate authority to the RACF FACILITY resource class. A user is

plugins/modules/zos_blockinfile.py

@@ -174,6 +174,15 @@
     required: false
     type: int
     default: 0
+
+attributes:
+  action:
+    support: none
+    description: Indicates this has a corresponding action plugin so some parts of the options can be executed on the controller.
+  async:
+    support: full
+    description: Supports being used with the ``async`` keyword.
+
 notes:
   - It is the playbook author or user's responsibility to avoid files
     that should not be encoded, such as binary files. A user is described

plugins/modules/zos_copy.py

@@ -1,7 +1,7 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
 
-# Copyright (c) IBM Corporation 2019, 2024
+# Copyright (c) IBM Corporation 2019, 2025
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
@@ -522,6 +522,14 @@
 extends_documentation_fragment:
   - ibm.ibm_zos_core.template
 
+attributes:
+  action:
+    support: full
+    description: Indicates this has a corresponding action plugin so some parts of the options can be executed on the controller.
+  async:
+    support: full
+    description: Supports being used with the ``async`` keyword.
+
 notes:
     - Destination data sets are assumed to be in catalog. When trying to copy
       to an uncataloged data set, the module assumes that the data set does

plugins/modules/zos_data_set.py

@@ -649,6 +649,13 @@
         required: false
         default: false
 
+attributes:
+  action:
+    support: none
+    description: Indicates this has a corresponding action plugin so some parts of the options can be executed on the controller.
+  async:
+    support: full
+    description: Supports being used with the ``async`` keyword.
 """
 EXAMPLES = r"""
 - name: Create a sequential data set if it does not exist

plugins/modules/zos_encode.py

@@ -1,7 +1,7 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
 
-# Copyright (c) IBM Corporation 2019, 2024
+# Copyright (c) IBM Corporation 2019, 2025
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
@@ -120,6 +120,15 @@
         that is not available, then the value C(TMPHLQ) is used.
     required: false
     type: str
+
+attributes:
+  action:
+    support: none
+    description: Indicates this has a corresponding action plugin so some parts of the options can be executed on the controller.
+  async:
+    support: full
+    description: Supports being used with the ``async`` keyword.
+
 notes:
   - It is the playbook author or user's responsibility to avoid files that should
     not be encoded, such as binary files. A user is described as the remote user,

plugins/modules/zos_fetch.py

@@ -1,7 +1,7 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
 
-# Copyright (c) IBM Corporation 2019, 2024
+# Copyright (c) IBM Corporation 2019, 2025
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
@@ -135,6 +135,15 @@
     type: bool
     required: false
     default: true
+
+attributes:
+  action:
+    support: full
+    description: Indicates this has a corresponding action plugin so some parts of the options can be executed on the controller.
+  async:
+    support: none
+    description: Supports being used with the ``async`` keyword.
+
 notes:
     - When fetching PDSE and VSAM data sets, temporary storage will be used
       on the remote z/OS system. After the PDSE or VSAM data set is

plugins/modules/zos_find.py

@@ -1,7 +1,7 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
 
-# Copyright (c) IBM Corporation 2020, 2024
+# Copyright (c) IBM Corporation 2020, 2025
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
@@ -165,6 +165,14 @@
     type: bool
     required: false
 
+attributes:
+  action:
+    support: none
+    description: Indicates this has a corresponding action plugin so some parts of the options can be executed on the controller.
+  async:
+    support: full
+    description: Supports being used with the ``async`` keyword.
+
 notes:
   - Only cataloged data sets will be searched. If an uncataloged data set needs to
     be searched, it should be cataloged first. The L(zos_data_set,./zos_data_set.html) module can be