[Enabler][2294]Add_aliases_and_deprecation_messages_for_new_version

.secrets.baseline

@@ -0,0 +1,85 @@
+{
+  "exclude": {
+    "files": "zos_mvs_raw.rst|^.secrets.baseline$",
+    "lines": null
+  },
+  "generated_at": "2025-10-06T17:53:30Z",
+  "plugins_used": [
+    {
+      "name": "AWSKeyDetector"
+    },
+    {
+      "name": "ArtifactoryDetector"
+    },
+    {
+      "name": "AzureStorageKeyDetector"
+    },
+    {
+      "base64_limit": 4.5,
+      "name": "Base64HighEntropyString"
+    },
+    {
+      "name": "BasicAuthDetector"
+    },
+    {
+      "name": "BoxDetector"
+    },
+    {
+      "name": "CloudantDetector"
+    },
+    {
+      "ghe_instance": "github.ibm.com",
+      "name": "GheDetector"
+    },
+    {
+      "name": "GitHubTokenDetector"
+    },
+    {
+      "hex_limit": 3,
+      "name": "HexHighEntropyString"
+    },
+    {
+      "name": "IbmCloudIamDetector"
+    },
+    {
+      "name": "IbmCosHmacDetector"
+    },
+    {
+      "name": "JwtTokenDetector"
+    },
+    {
+      "keyword_exclude": null,
+      "name": "KeywordDetector"
+    },
+    {
+      "name": "MailchimpDetector"
+    },
+    {
+      "name": "NpmDetector"
+    },
+    {
+      "name": "PrivateKeyDetector"
+    },
+    {
+      "name": "SlackDetector"
+    },
+    {
+      "name": "SoftlayerDetector"
+    },
+    {
+      "name": "SquareOAuthDetector"
+    },
+    {
+      "name": "StripeDetector"
+    },
+    {
+      "name": "TwilioKeyDetector"
+    }
+  ],
+  "results": {},
+  "version": "0.13.1+ibm.64.dss",
+  "word_list": {
+    "file": null,
+    "hash": null
+  }
+}

branch_protection_rules.json

@@ -0,0 +1,12 @@
+[{
+    "type": "branch-protection",
+    "name": "code-review",
+    "params": {
+      "checks": [
+        "tekton/code-branch-protection",
+        "tekton/code-unit-tests",
+        "tekton/code-vulnerability-scan",
+        "tekton/code-detect-secrets"
+      ]
+    }
+}]

changelogs/fragments/2553-Add_aliases_and_deprecation_messages_for_new_version.yml

@@ -0,0 +1,32 @@
+minor_changes:
+  - zos_apf - Adds new aliases ``target`` for ``data_set_nam``  and warning message that will be deprecated on 2.0.0.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2353).
+  - zos_archive - Adds new aliases ``type`` for ``name`` and warning message that will be deprecated on 2.0.0.
+  - zos_archive - Adds new aliases ``options`` for ``format_options`` and warning message that will be deprecated on 2.0.0.
+  - zos_archive - Adds new aliases ``spack`` for ``terse_pack`` and warning message that will be deprecated on 2.0.0.
+  - zos_archive - Adds new aliases ``adrdssus`` for ``use_adrdssu`` and warning message that will be deprecated on 2.0.0.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2353).
+  - zos_copy - Adds new aliases ``replace`` for ``force`` and warning message that will be deprecated on 2.0.0.
+  - zos_copy - Adds new aliases ``binary`` for ``is_binary`` and warning message that will be deprecated on 2.0.0.
+  - zos_copy - Adds warning message for ``force_lock`` that will be deprecated on 2.0.0.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2353).
+  - zos_fetch - Adds new aliases ``binary`` for ``is_binary`` and warning message that will be deprecated on 2.0.0.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2353).
+  - zos_find - Adds warning message for ``pds_paths`` that will be deprecated on 2.0.0.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2353).
+  - zos_job_output - Adds new aliases ``dd_name`` for ``ddname`` and warning message that will be aliases on 2.0.0.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2353).
+  - zos_job_submit - Adds new aliases ``remote_src`` for ``location`` and warning message that will be deprecated on 2.0.0.
+  - zos_job_submit - Adds new aliases ``wait_time`` for ``wait_time_s`` and warning message that will be deprecated on 2.0.0.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2353).
+  - zos_mount - Adds new aliases ``name`` for ``data_store`` and warning message that will be deprecated on 2.0.0.
+  - zos_mount - Adds new aliases ``marker`` for ``comment`` and warning message that will be deprecated on 2.0.0.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2353).
+  - zos_operator - Adds new aliases ``wait_time_s`` for ``wait_time`` and warning message that will be deprecated on 2.0.0.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2353).
+  - zos_operator_action_query - Adds new aliases ``literal`` for ``use_regex`` and warning message that will be deprecated on 2.0.0.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2353).
+  - zos_unarchive - Adds new aliases ``type`` for ``name`` and warning message that will be deprecated on 2.0.0.
+  - zos_unarchive - Adds new aliases ``options`` for ``format_options`` and warning message that will be deprecated on 2.0.0.
+  - zos_unarchive - Adds new aliases ``adrdssus`` for ``use_adrdssu`` and warning message that will be deprecated on 2.0.0.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2353).

plugins/modules/zos_apf.py

@@ -113,6 +113,7 @@
             the APF list.
         required: True
         type: str
+        aliases: [target]
       marker:
         description:
           - The marker line template.
@@ -439,6 +440,7 @@ def main():
                     data_set_name=dict(
                         type='str',
                         required=True,
+                        aliases=["target"],
                     ),
                     marker=dict(
                         type='str',
@@ -503,7 +505,7 @@ def main():
             arg_type='dict',
             required=False,
             options=dict(
-                data_set_name=dict(arg_type='str', required=True),
+                data_set_name=dict(arg_type='str', required=True, aliases=["target"]),
                 marker=dict(arg_type='str', required=False, default='/* {mark} ANSIBLE MANAGED BLOCK <timestamp> */'),
                 backup=dict(arg_type='bool', default=False),
                 backup_name=dict(arg_type='str', required=False, default=None),
@@ -534,6 +536,11 @@ def main():
     try:
         parser = better_arg_parser.BetterArgParser(arg_defs)
         parsed_args = parser.parse_args(module.params)
+
+        if module.params.get('data_set_name') is not None:
+            module.warn("The 'data_set_name' parameter is deprecated and will be removed in a 2.0.0 release.\n"
+                        "Please use 'target' instead.")
+
     except ValueError as err:
         module.fail_json(msg="Parameter verification failed", stderr=str(err))
 

plugins/modules/zos_archive.py

@@ -57,6 +57,7 @@
         type: str
         required: false
         default: gz
+        aliases: [type]
         choices:
           - bz2
           - gz
@@ -70,6 +71,7 @@
           - Options specific to a compression format.
         type: dict
         required: false
+        aliases: [options]
         suboptions:
           terse_pack:
             description:
@@ -86,6 +88,7 @@
             choices:
               - pack
               - spack
+            aliases: [spack]
           xmit_log_data_set:
             description:
               - Provide the name of a data set to store xmit log output.
@@ -105,6 +108,7 @@
                 portable format before using C(xmit) or C(terse).
             type: bool
             default: false
+            aliases: [adrdssus]
   dest:
     description:
       - The remote absolute path or data set where the archive should be
@@ -1874,22 +1878,26 @@ def run_module():
                     name=dict(
                         type='str',
                         default='gz',
-                        choices=['bz2', 'gz', 'tar', 'zip', 'terse', 'xmit', 'pax']
+                        choices=['bz2', 'gz', 'tar', 'zip', 'terse', 'xmit', 'pax'],
+                        aliases=['type']
                     ),
                     format_options=dict(
                         type='dict',
                         required=False,
+                        aliases=['options'],
                         options=dict(
                             terse_pack=dict(
                                 type='str',
                                 choices=['pack', 'spack'],
+                                aliases=['spack'],
                             ),
                             xmit_log_data_set=dict(
                                 type='str',
                             ),
                             use_adrdssu=dict(
                                 type='bool',
                                 default=False,
+                                aliases=['adrdssu'],
                             )
                         ),
                     ),
@@ -1969,16 +1977,19 @@ def run_module():
                 name=dict(
                     type='str',
                     default='gz',
-                    choices=['bz2', 'gz', 'tar', 'zip', 'terse', 'xmit', 'pax']
+                    choices=['bz2', 'gz', 'tar', 'zip', 'terse', 'xmit', 'pax'],
+                    aliases=["type"],
                 ),
                 format_options=dict(
                     type='dict',
                     required=False,
+                    aliases=["options"],
                     options=dict(
                         terse_pack=dict(
                             type='str',
                             required=False,
                             choices=['pack', 'spack'],
+                            aliases=["spack"],
                         ),
                         xmit_log_data_set=dict(
                             type='str',
@@ -1987,6 +1998,7 @@ def run_module():
                         use_adrdssu=dict(
                             type='bool',
                             default=False,
+                            aliases=["adrdssu"],
                         )
                     ),
                     default=dict(
@@ -2051,6 +2063,20 @@ def run_module():
     try:
         parser = better_arg_parser.BetterArgParser(arg_defs)
         parsed_args = parser.parse_args(module.params)
+
+        if module.params.get('format') is not None and module.params.get('format').get('name') is not None:
+            module.warn("The 'name' parameter is deprecated and will be removed in a 2.0.0 release.\n"
+                        "Please use 'type' instead.")
+        if module.params.get('format') is not None and module.params.get('format').get('format_options') is not None:
+            module.warn("The 'format_options' parameter is deprecated and will be removed in a 2.0.0 release.\n"
+                        "Please use 'options' instead.")
+        if module.params.get('format') is not None and module.params.get('format').get('format_options') is not None and module.params.get('format').get('format_options').get("terse_pack") is not None:
+            module.warn("The 'terse_pack' parameter is deprecated and will be removed in a 2.0.0 release.\n"
+                        "Please use 'spack' instead.")
+        if module.params.get('format') is not None and module.params.get('format').get('format_options') is not None and module.params.get('format').get('format_options').get("use_adrdssu")is not None:
+            module.warn("The 'use_adrdssu' parameter is deprecated and will be removed in a 2.0.0 release.\n"
+                        "Please use 'adrdssu' instead.")
+
         module.params = parsed_args
     except ValueError as err:
         module.fail_json(msg="Parameter verification failed", stderr=str(err))

plugins/modules/zos_copy.py

@@ -193,6 +193,7 @@
     type: bool
     default: false
     required: false
+    aliases: [replace]
   force_lock:
     description:
       - By default, when C(dest) is a MVS data set and is being used by another
@@ -236,6 +237,7 @@
     type: bool
     default: false
     required: false
+    aliases: [binary]
   executable:
     description:
       - If set to C(true), indicates that the file or library to be copied is an executable.
@@ -4015,7 +4017,7 @@ def main():
         argument_spec=dict(
             src=dict(type='str'),
             dest=dict(required=True, type='str'),
-            is_binary=dict(type='bool', default=False),
+            is_binary=dict(type='bool', default=False, aliases=["binary"]),
             executable=dict(type='bool', default=False),
             asa_text=dict(type='bool', default=False),
             aliases=dict(type='bool', default=False, required=False),
@@ -4108,7 +4110,7 @@ def main():
                     autoescape=dict(type='bool', default=True),
                 )
             ),
-            force=dict(type='bool', default=False),
+            force=dict(type='bool', default=False, aliases=["replace"]),
             force_lock=dict(type='bool', default=False),
             mode=dict(type='str', required=False),
             owner=dict(type='str', required=False),
@@ -4120,7 +4122,7 @@ def main():
     arg_def = dict(
         src=dict(arg_type='data_set_or_path', required=False),
         dest=dict(arg_type='data_set_or_path', required=True),
-        is_binary=dict(arg_type='bool', required=False, default=False),
+        is_binary=dict(arg_type='bool', required=False, default=False, aliases=["binary"]),
         executable=dict(arg_type='bool', required=False, default=False),
         asa_text=dict(arg_type='bool', required=False, default=False),
         aliases=dict(arg_type='bool', required=False, default=False),
@@ -4132,6 +4134,7 @@ def main():
         checksum=dict(arg_type='str', required=False),
         validate=dict(arg_type='bool', required=False),
         volume=dict(arg_type='str', required=False),
+        force=dict(type='bool', default=False, aliases=["replace"]),
         force_lock=dict(type='bool', default=False),
 
         dest_data_set=dict(
@@ -4210,6 +4213,16 @@ def main():
             )
         )
 
+    if module.params.get("force") is not None:
+        module.warn("The 'force' parameter is deprecated and will be removed in a 2.0.0 release.\n"
+                        "Please use 'replace' instead.")
+    if module.params.get("force_lock") is not None:
+        module.warn("The 'force_lock' parameter is deprecated and will be removed in a 2.0.0 release.\n"
+                        "For the 2.0.0 version please use 'force' instead.")
+    if module.params.get("is_binary") is not None:
+        module.warn("The 'is_binary' parameter is deprecated and will be removed in a 2.0.0 release.\n"
+                        "Please use 'binary' instead.")
+
     res_args = conv_path = None
     try:
         res_args, conv_path = run_module(module, arg_def)

plugins/modules/zos_fetch.py

@@ -83,6 +83,7 @@
     required: false
     default: "false"
     type: bool
+    aliases: [binary]
   use_qualifier:
     description:
       - Indicates whether the data set high level qualifier should be used when
@@ -849,7 +850,7 @@ def run_module():
             dest=dict(required=True, type="path"),
             fail_on_missing=dict(required=False, default=True, type="bool"),
             flat=dict(required=False, default=False, type="bool"),
-            is_binary=dict(required=False, default=False, type="bool"),
+            is_binary=dict(required=False, default=False, type="bool", aliases=["binary"]),
             use_qualifier=dict(required=False, default=False, type="bool"),
             validate_checksum=dict(required=False, default=True, type="bool"),
             encoding=dict(required=False, type="dict"),
@@ -872,7 +873,7 @@ def run_module():
         src=dict(arg_type="data_set_or_path", required=True),
         dest=dict(arg_type="path", required=True),
         fail_on_missing=dict(arg_type="bool", required=False, default=True),
-        is_binary=dict(arg_type="bool", required=False, default=False),
+        is_binary=dict(arg_type="bool", required=False, default=False, aliases=["binary"]),
         use_qualifier=dict(arg_type="bool", required=False, default=False),
         tmp_hlq=dict(type='qualifier_or_empty', required=False, default=None),
     )
@@ -907,6 +908,11 @@ def run_module():
 
     fetch_handler = FetchHandler(module)
     try:
+
+        if module.params.get("is_binary") is not None:
+            module.warn("The 'is_binary' parameter is deprecated and will be removed in a 2.0.0 release.\n"
+                        "Please use 'binary' instead.")
+
         parser = better_arg_parser.BetterArgParser(arg_def)
         parsed_args = parser.parse_args(module.params)
     except ValueError as err: