[PR #7295/eae7161b backport][stable-7] Adding deprecation for timeout parameter from 10 to 60 for redfish_info, redfish_config and redfish_command (#7327)

Adding deprecation for timeout parameter from 10 to 60 for redfish_info, redfish_config and redfish_command (#7295)

* Adding deprecation for timeout from 10 to 60 for redfish_info, redfish_config and redfish_command

* Adding changelog fragment and sanity fixes

* Update changelogs/fragments/7295-adding_deprecation_for_timeout_in_redfish_info_config_command.yml

Agreed. Thanks!

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update changelogs/fragments/7295-adding_deprecation_for_timeout_in_redfish_info_config_command.yml

Agreed. Thanks!

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update plugins/modules/redfish_command.py

Agreed. Thanks!

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update plugins/modules/redfish_command.py

Agreed. Thanks!

Co-authored-by: Felix Fontein <felix@fontein.de>

* Updating release version

---------

Co-authored-by: Kushal <t-s.kushal@hpe.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit eae7161bf0)

Co-authored-by: TSKushal <44438079+TSKushal@users.noreply.github.com>

changelogs/fragments/7295-adding_deprecation_for_timeout_in_redfish_info_config_command.yml

@@ -0,0 +1,2 @@
+deprecated_features:
+  - redfish_info, redfish_config, redfish_command - the default value ``10`` for the ``timeout`` option is deprecated and will change to ``60`` in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/7295).

plugins/modules/redfish_command.py

@@ -109,7 +109,8 @@ options:
   timeout:
     description:
       - Timeout in seconds for HTTP requests to OOB controller.
-    default: 10
+      - The default value for this param is C(10) but that is being deprecated
+        and it will be replaced with C(60) in community.general 9.0.0.
     type: int
   boot_override_mode:
     description:
@@ -782,7 +783,7 @@ def main():
             update_username=dict(type='str', aliases=["account_updatename"]),
             account_properties=dict(type='dict', default={}),
             bootdevice=dict(),
-            timeout=dict(type='int', default=10),
+            timeout=dict(type='int'),
             uefi_target=dict(),
             boot_next=dict(),
             boot_override_mode=dict(choices=['Legacy', 'UEFI']),
@@ -829,6 +830,16 @@ def main():
         supports_check_mode=False
     )
 
+    if module.params['timeout'] is None:
+        timeout = 10
+        module.deprecate(
+            'The default value {0} for parameter param1 is being deprecated and it will be replaced by {1}'.format(
+                10, 60
+            ),
+            version='9.0.0',
+            collection_name='community.general'
+        )
+
     category = module.params['category']
     command_list = module.params['command']
 

plugins/modules/redfish_config.py

@@ -64,7 +64,8 @@ options:
   timeout:
     description:
       - Timeout in seconds for HTTP requests to OOB controller.
-    default: 10
+      - The default value for this param is C(10) but that is being deprecated
+        and it will be replaced with C(60) in community.general 9.0.0.
     type: int
   boot_order:
     required: false
@@ -347,7 +348,7 @@ def main():
             password=dict(no_log=True),
             auth_token=dict(no_log=True),
             bios_attributes=dict(type='dict', default={}),
-            timeout=dict(type='int', default=10),
+            timeout=dict(type='int'),
             boot_order=dict(type='list', elements='str', default=[]),
             network_protocols=dict(
                 type='dict',
@@ -379,6 +380,16 @@ def main():
         supports_check_mode=False
     )
 
+    if module.params['timeout'] is None:
+        timeout = 10
+        module.deprecate(
+            'The default value {0} for parameter param1 is being deprecated and it will be replaced by {1}'.format(
+                10, 60
+            ),
+            version='9.0.0',
+            collection_name='community.general'
+        )
+
     category = module.params['category']
     command_list = module.params['command']
 

plugins/modules/redfish_info.py

@@ -60,7 +60,8 @@ options:
   timeout:
     description:
       - Timeout in seconds for HTTP requests to OOB controller.
-    default: 10
+      - The default value for this param is C(10) but that is being deprecated
+        and it will be replaced with C(60) in community.general 9.0.0.
     type: int
   update_handle:
     required: false
@@ -386,7 +387,7 @@ def main():
             username=dict(),
             password=dict(no_log=True),
             auth_token=dict(no_log=True),
-            timeout=dict(type='int', default=10),
+            timeout=dict(type='int'),
             update_handle=dict(),
         ),
         required_together=[
@@ -401,6 +402,16 @@ def main():
         supports_check_mode=True,
     )
 
+    if module.params['timeout'] is None:
+        timeout = 10
+        module.deprecate(
+            'The default value {0} for parameter param1 is being deprecated and it will be replaced by {1}'.format(
+                10, 60
+            ),
+            version='9.0.0',
+            collection_name='community.general'
+        )
+
     # admin credentials used for authentication
     creds = {'user': module.params['username'],
              'pswd': module.params['password'],