From fcab7a9963e75d048246cd529234331bad7cbc9f Mon Sep 17 00:00:00 2001 From: Abhijeet Kasurde Date: Fri, 14 Feb 2020 15:00:32 +0530 Subject: [PATCH] os_ironic: Correct parameter name since inception skip_update_of_masked_password is misspelled as skip_update_of_driver_password in the documentation. Change-Id: I439f672b82385b4e317f2442755a81ef9c7c6bda Signed-off-by: Abhijeet Kasurde --- plugins/modules/os_ironic.py | 14 +++++++++++--- tests/sanity/ignore-2.10.txt | 2 -- tests/sanity/ignore-2.9.txt | 2 -- 3 files changed, 11 insertions(+), 7 deletions(-) diff --git a/plugins/modules/os_ironic.py b/plugins/modules/os_ironic.py index 756ffc68..be94b19c 100644 --- a/plugins/modules/os_ironic.py +++ b/plugins/modules/os_ironic.py @@ -103,15 +103,18 @@ options: - See U(https://docs.openstack.org/ironic/latest/install/advanced.html#specifying-the-disk-for-deployment-root-device-hints) for allowed hints. default: "" - skip_update_of_driver_password: + skip_update_of_masked_password: description: - Allows the code that would assert changes to nodes to skip the update if the change is a single line consisting of the password - field. As of Kilo, by default, passwords are always masked to API + field. + - As of Kilo, by default, passwords are always masked to API requests, which means the logic as a result always attempts to re-assert the password field. + - C(skip_update_of_driver_password) is deprecated alias and will be removed in 2.14. type: bool default: 'no' + aliases: [ skip_update_of_driver_password ] availability_zone: description: - Ignored. Present for backwards compatibility @@ -224,7 +227,12 @@ def main(): properties=dict(type='dict', default={}), ironic_url=dict(required=False), chassis_uuid=dict(required=False), - skip_update_of_masked_password=dict(required=False, type='bool'), + skip_update_of_masked_password=dict( + required=False, + type='bool', + aliases=['skip_update_of_driver_password'], + deprecated_aliases=[dict(name='skip_update_of_driver_password', version='2.14')] + ), state=dict(required=False, default='present') ) module_kwargs = openstack_module_kwargs() diff --git a/tests/sanity/ignore-2.10.txt b/tests/sanity/ignore-2.10.txt index 709ab214..14758071 100644 --- a/tests/sanity/ignore-2.10.txt +++ b/tests/sanity/ignore-2.10.txt @@ -22,9 +22,7 @@ plugins/modules/os_image_info.py validate-modules:doc-missing-type plugins/modules/os_ironic.py validate-modules:doc-choices-do-not-match-spec plugins/modules/os_ironic.py validate-modules:doc-missing-type plugins/modules/os_ironic.py validate-modules:doc-required-mismatch -plugins/modules/os_ironic.py validate-modules:nonexistent-parameter-documented plugins/modules/os_ironic.py validate-modules:parameter-type-not-in-doc -plugins/modules/os_ironic.py validate-modules:undocumented-parameter plugins/modules/os_ironic_inspect.py validate-modules:doc-missing-type plugins/modules/os_ironic_node.py validate-modules:doc-choices-do-not-match-spec plugins/modules/os_ironic_node.py validate-modules:doc-default-does-not-match-spec diff --git a/tests/sanity/ignore-2.9.txt b/tests/sanity/ignore-2.9.txt index 82f17670..fd257fa5 100644 --- a/tests/sanity/ignore-2.9.txt +++ b/tests/sanity/ignore-2.9.txt @@ -19,9 +19,7 @@ plugins/modules/os_image.py validate-modules:parameter-type-not-in-doc plugins/modules/os_image_info.py validate-modules:doc-missing-type plugins/modules/os_ironic.py validate-modules:doc-choices-do-not-match-spec plugins/modules/os_ironic.py validate-modules:doc-missing-type -plugins/modules/os_ironic.py validate-modules:nonexistent-parameter-documented plugins/modules/os_ironic.py validate-modules:parameter-type-not-in-doc -plugins/modules/os_ironic.py validate-modules:undocumented-parameter plugins/modules/os_ironic_inspect.py validate-modules:doc-missing-type plugins/modules/os_ironic_node.py validate-modules:doc-choices-do-not-match-spec plugins/modules/os_ironic_node.py validate-modules:doc-default-does-not-match-spec