diff --git a/changelogs/fragments/56809-add-options-type-info-for-redfish-modules.yaml b/changelogs/fragments/56809-add-options-type-info-for-redfish-modules.yaml new file mode 100644 index 00000000000..355e9a6ab00 --- /dev/null +++ b/changelogs/fragments/56809-add-options-type-info-for-redfish-modules.yaml @@ -0,0 +1,3 @@ +--- +bugfixes: +- "add options type info for Redfish modules (https://github.com/ansible/ansible/issues/54688)" diff --git a/lib/ansible/modules/remote_management/redfish/idrac_redfish_command.py b/lib/ansible/modules/remote_management/redfish/idrac_redfish_command.py index 8b9a7043251..fa02be2ee62 100644 --- a/lib/ansible/modules/remote_management/redfish/idrac_redfish_command.py +++ b/lib/ansible/modules/remote_management/redfish/idrac_redfish_command.py @@ -25,22 +25,27 @@ options: required: true description: - Category to execute on OOB controller + type: str command: required: true description: - List of commands to execute on OOB controller + type: list baseuri: required: true description: - Base URI of OOB controller + type: str username: required: true description: - User for authentication with OOB controller + type: str password: required: true description: - Password for authentication with OOB controller + type: str timeout: description: - Timeout in seconds for URL requests to OOB controller diff --git a/lib/ansible/modules/remote_management/redfish/idrac_redfish_config.py b/lib/ansible/modules/remote_management/redfish/idrac_redfish_config.py index 7ca883fee69..6c512a35126 100644 --- a/lib/ansible/modules/remote_management/redfish/idrac_redfish_config.py +++ b/lib/ansible/modules/remote_management/redfish/idrac_redfish_config.py @@ -30,28 +30,34 @@ options: required: true description: - List of commands to execute on iDRAC + type: list baseuri: required: true description: - Base URI of iDRAC + type: str username: required: true description: - User for authentication with iDRAC + type: str password: required: true description: - Password for authentication with iDRAC + type: str manager_attribute_name: required: false description: - name of iDRAC attribute to update default: 'null' + type: str manager_attribute_value: required: false description: - value of iDRAC attribute to update default: 'null' + type: str timeout: description: - Timeout in seconds for URL requests to iDRAC controller diff --git a/lib/ansible/modules/remote_management/redfish/idrac_redfish_facts.py b/lib/ansible/modules/remote_management/redfish/idrac_redfish_facts.py index eaa397addd0..bf9584cc846 100644 --- a/lib/ansible/modules/remote_management/redfish/idrac_redfish_facts.py +++ b/lib/ansible/modules/remote_management/redfish/idrac_redfish_facts.py @@ -25,22 +25,27 @@ options: required: true description: - Category to execute on iDRAC controller + type: str command: required: true description: - List of commands to execute on iDRAC controller + type: list baseuri: required: true description: - Base URI of iDRAC controller + type: str username: required: true description: - User for authentication with iDRAC controller + type: str password: required: true description: - Password for authentication with iDRAC controller + type: str timeout: description: - Timeout in seconds for URL requests to OOB controller diff --git a/lib/ansible/modules/remote_management/redfish/redfish_command.py b/lib/ansible/modules/remote_management/redfish/redfish_command.py index 965283949e6..f909009d119 100644 --- a/lib/ansible/modules/remote_management/redfish/redfish_command.py +++ b/lib/ansible/modules/remote_management/redfish/redfish_command.py @@ -27,47 +27,57 @@ options: required: true description: - Category to execute on OOB controller + type: str command: required: true description: - List of commands to execute on OOB controller + type: list baseuri: required: true description: - Base URI of OOB controller + type: str username: required: true description: - User for authentication with OOB controller + type: str version_added: "2.8" password: required: true description: - Password for authentication with OOB controller + type: str id: required: false description: - ID of user to add/delete/modify + type: str version_added: "2.8" new_username: required: false description: - name of user to add/delete/modify + type: str version_added: "2.8" new_password: required: false description: - password of user to add/delete/modify + type: str version_added: "2.8" roleid: required: false description: - role of user to add/delete/modify + type: str version_added: "2.8" bootdevice: required: false description: - bootdevice when setting boot configuration + type: str timeout: description: - Timeout in seconds for URL requests to OOB controller @@ -78,11 +88,13 @@ options: required: false description: - UEFI target when bootdevice is "UefiTarget" + type: str version_added: "2.9" boot_next: required: false description: - BootNext target when bootdevice is "UefiBootNext" + type: str version_added: "2.9" author: "Jose Delarosa (@jose-delarosa)" diff --git a/lib/ansible/modules/remote_management/redfish/redfish_config.py b/lib/ansible/modules/remote_management/redfish/redfish_config.py index 333b7e7c4b1..44c09ca38fd 100644 --- a/lib/ansible/modules/remote_management/redfish/redfish_config.py +++ b/lib/ansible/modules/remote_management/redfish/redfish_config.py @@ -26,34 +26,41 @@ options: required: true description: - Category to execute on OOB controller + type: str command: required: true description: - List of commands to execute on OOB controller + type: list baseuri: required: true description: - Base URI of OOB controller + type: str username: required: true description: - User for authentication with OOB controller + type: str version_added: "2.8" password: required: true description: - Password for authentication with OOB controller + type: str bios_attribute_name: required: false description: - name of BIOS attribute to update default: 'null' + type: str version_added: "2.8" bios_attribute_value: required: false description: - value of BIOS attribute to update default: 'null' + type: str version_added: "2.8" timeout: description: diff --git a/lib/ansible/modules/remote_management/redfish/redfish_facts.py b/lib/ansible/modules/remote_management/redfish/redfish_facts.py index 79236266241..76c77caef27 100644 --- a/lib/ansible/modules/remote_management/redfish/redfish_facts.py +++ b/lib/ansible/modules/remote_management/redfish/redfish_facts.py @@ -26,23 +26,28 @@ options: description: - List of categories to execute on OOB controller default: ['Systems'] + type: list command: required: false description: - List of commands to execute on OOB controller + type: list baseuri: required: true description: - Base URI of OOB controller + type: str username: required: true description: - User for authentication with OOB controller + type: str version_added: "2.8" password: required: true description: - Password for authentication with OOB controller + type: str timeout: description: - Timeout in seconds for URL requests to OOB controller