mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-06-03 06:49:10 -07:00
Redfish modules for Western Digital UltraStar Data102 storage enclosures (#4885)
* WDC Redfish Info / Command modules for Western Digital Ultrastar Data102 storage enclosures. Initial commands include: * FWActivate * UpdateAndActivate * SimpleUpdateStatus * delete unnecessary __init__.py modules * PR Feedback Notes list not guaranteed to be sorted Use EXAMPLES tos how specifying ioms/basuri Import missing_required_lib * Apply suggestions from code review Suggestions that could be auto-committed. Co-authored-by: Felix Fontein <felix@fontein.de> * Remove DNSCacheBypass It is now the caller's responsibility to deal with stale IP addresses. * Remove dnspython dependency. Fix bug that this uncovered. * Apply suggestions from code review Co-authored-by: Felix Fontein <felix@fontein.de> * PR Feedback * Documentation, simple update status output format, unit tests. Add docs showing how to use SimpleUpdateStatus Change the format of SimpleUpateStatus format, put the results in a sub-object. Fix unit tests whose asserts weren't actually running. * PR Feedback register: result on the 2nd example * Final adjustments for merging for 5.4.0 Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
Mike
GitHub
parent
ade54bceb8
commit
be70d18e3f
7 changed files with 1827 additions and 0 deletions
252
plugins/modules/remote_management/redfish/wdc_redfish_command.py
Normal file
252
plugins/modules/remote_management/redfish/wdc_redfish_command.py
Normal file
|
|
@ -0,0 +1,252 @@
|
|||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# Copyright (c) 2022 Western Digital Corporation
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: wdc_redfish_command
|
||||
short_description: Manages WDC UltraStar Data102 Out-Of-Band controllers using Redfish APIs
|
||||
version_added: 5.4.0
|
||||
description:
|
||||
- Builds Redfish URIs locally and sends them to remote OOB controllers to
|
||||
perform an action.
|
||||
- Manages OOB controller firmware. For example, Firmware Activate, Update and Activate.
|
||||
options:
|
||||
category:
|
||||
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
|
||||
elements: str
|
||||
baseuri:
|
||||
description:
|
||||
- Base URI of OOB controller. Must include this or I(ioms).
|
||||
type: str
|
||||
ioms:
|
||||
description:
|
||||
- List of IOM FQDNs for the enclosure. Must include this or I(baseuri).
|
||||
type: list
|
||||
elements: str
|
||||
username:
|
||||
description:
|
||||
- User for authentication with OOB controller.
|
||||
type: str
|
||||
password:
|
||||
description:
|
||||
- Password for authentication with OOB controller.
|
||||
type: str
|
||||
auth_token:
|
||||
description:
|
||||
- Security token for authentication with OOB controller.
|
||||
type: str
|
||||
timeout:
|
||||
description:
|
||||
- Timeout in seconds for URL requests to OOB controller.
|
||||
default: 10
|
||||
type: int
|
||||
update_image_uri:
|
||||
required: false
|
||||
description:
|
||||
- The URI of the image for the update.
|
||||
type: str
|
||||
update_creds:
|
||||
required: false
|
||||
description:
|
||||
- The credentials for retrieving the update image.
|
||||
type: dict
|
||||
suboptions:
|
||||
username:
|
||||
required: false
|
||||
description:
|
||||
- The username for retrieving the update image.
|
||||
type: str
|
||||
password:
|
||||
required: false
|
||||
description:
|
||||
- The password for retrieving the update image.
|
||||
type: str
|
||||
requirements:
|
||||
- dnspython (2.1.0 for Python 3, 1.16.0 for Python 2)
|
||||
notes:
|
||||
- In the inventory, you can specify baseuri or ioms. See the EXAMPLES section.
|
||||
- ioms is a list of FQDNs for the enclosure's IOMs.
|
||||
|
||||
|
||||
author: Mike Moerk (@mikemoerk)
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: Firmware Activate (required after SimpleUpdate to apply the new firmware)
|
||||
community.general.wdc_redfish_command:
|
||||
category: Update
|
||||
command: FWActivate
|
||||
ioms: "{{ ioms }}"
|
||||
username: "{{ username }}"
|
||||
password: "{{ password }}"
|
||||
|
||||
- name: Firmware Activate with individual IOMs specified
|
||||
community.general.wdc_redfish_command:
|
||||
category: Update
|
||||
command: FWActivate
|
||||
ioms:
|
||||
- iom1.wdc.com
|
||||
- iom2.wdc.com
|
||||
username: "{{ username }}"
|
||||
password: "{{ password }}"
|
||||
|
||||
- name: Firmware Activate with baseuri specified
|
||||
community.general.wdc_redfish_command:
|
||||
category: Update
|
||||
command: FWActivate
|
||||
baseuri: "iom1.wdc.com"
|
||||
username: "{{ username }}"
|
||||
password: "{{ password }}"
|
||||
|
||||
|
||||
- name: Update and Activate (orchestrates firmware update and activation with a single command)
|
||||
community.general.wdc_redfish_command:
|
||||
category: Update
|
||||
command: UpdateAndActivate
|
||||
ioms: "{{ ioms }}"
|
||||
username: "{{ username }}"
|
||||
password: "{{ password }}"
|
||||
update_image_uri: "{{ update_image_uri }}"
|
||||
update_creds:
|
||||
username: operator
|
||||
password: supersecretpwd
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
msg:
|
||||
description: Message with action result or error description
|
||||
returned: always
|
||||
type: str
|
||||
sample: "Action was successful"
|
||||
'''
|
||||
|
||||
from ansible_collections.community.general.plugins.module_utils.wdc_redfish_utils import WdcRedfishUtils
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible.module_utils.common.text.converters import to_native
|
||||
|
||||
CATEGORY_COMMANDS_ALL = {
|
||||
"Update": [
|
||||
"FWActivate",
|
||||
"UpdateAndActivate"
|
||||
]
|
||||
}
|
||||
|
||||
|
||||
def main():
|
||||
module = AnsibleModule(
|
||||
argument_spec=dict(
|
||||
category=dict(required=True),
|
||||
command=dict(required=True, type='list', elements='str'),
|
||||
ioms=dict(type='list', elements='str'),
|
||||
baseuri=dict(),
|
||||
username=dict(),
|
||||
password=dict(no_log=True),
|
||||
auth_token=dict(no_log=True),
|
||||
update_creds=dict(
|
||||
type='dict',
|
||||
options=dict(
|
||||
username=dict(),
|
||||
password=dict(no_log=True)
|
||||
)
|
||||
),
|
||||
update_image_uri=dict(),
|
||||
timeout=dict(type='int', default=10)
|
||||
),
|
||||
required_together=[
|
||||
('username', 'password'),
|
||||
],
|
||||
required_one_of=[
|
||||
('username', 'auth_token'),
|
||||
('baseuri', 'ioms')
|
||||
],
|
||||
mutually_exclusive=[
|
||||
('username', 'auth_token'),
|
||||
],
|
||||
supports_check_mode=True
|
||||
)
|
||||
|
||||
category = module.params['category']
|
||||
command_list = module.params['command']
|
||||
|
||||
# admin credentials used for authentication
|
||||
creds = {'user': module.params['username'],
|
||||
'pswd': module.params['password'],
|
||||
'token': module.params['auth_token']}
|
||||
|
||||
# timeout
|
||||
timeout = module.params['timeout']
|
||||
|
||||
# Check that Category is valid
|
||||
if category not in CATEGORY_COMMANDS_ALL:
|
||||
module.fail_json(msg=to_native("Invalid Category '%s'. Valid Categories = %s" % (category, sorted(CATEGORY_COMMANDS_ALL.keys()))))
|
||||
|
||||
# Check that all commands are valid
|
||||
for cmd in command_list:
|
||||
# Fail if even one command given is invalid
|
||||
if cmd not in CATEGORY_COMMANDS_ALL[category]:
|
||||
module.fail_json(msg=to_native("Invalid Command '%s'. Valid Commands = %s" % (cmd, CATEGORY_COMMANDS_ALL[category])))
|
||||
|
||||
# Build root URI(s)
|
||||
if module.params.get("baseuri") is not None:
|
||||
root_uris = ["https://" + module.params['baseuri']]
|
||||
else:
|
||||
root_uris = [
|
||||
"https://" + iom for iom in module.params['ioms']
|
||||
]
|
||||
rf_utils = WdcRedfishUtils(creds, root_uris, timeout, module,
|
||||
resource_id=None, data_modification=True)
|
||||
|
||||
# Organize by Categories / Commands
|
||||
|
||||
if category == "Update":
|
||||
# execute only if we find UpdateService resources
|
||||
resource = rf_utils._find_updateservice_resource()
|
||||
if resource['ret'] is False:
|
||||
module.fail_json(msg=resource['msg'])
|
||||
# update options
|
||||
update_opts = {
|
||||
'update_creds': module.params['update_creds']
|
||||
}
|
||||
for command in command_list:
|
||||
if command == "FWActivate":
|
||||
if module.check_mode:
|
||||
result = {
|
||||
'ret': True,
|
||||
'changed': True,
|
||||
'msg': 'FWActivate not performed in check mode.'
|
||||
}
|
||||
else:
|
||||
result = rf_utils.firmware_activate(update_opts)
|
||||
elif command == "UpdateAndActivate":
|
||||
update_opts["update_image_uri"] = module.params['update_image_uri']
|
||||
result = rf_utils.update_and_activate(update_opts)
|
||||
|
||||
if result['ret'] is False:
|
||||
module.fail_json(msg=to_native(result['msg']))
|
||||
else:
|
||||
del result['ret']
|
||||
changed = result.get('changed', True)
|
||||
session = result.get('session', dict())
|
||||
module.exit_json(changed=changed,
|
||||
session=session,
|
||||
msg='Action was successful' if not module.check_mode else result.get(
|
||||
'msg', "No action performed in check mode."
|
||||
))
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
214
plugins/modules/remote_management/redfish/wdc_redfish_info.py
Normal file
214
plugins/modules/remote_management/redfish/wdc_redfish_info.py
Normal file
|
|
@ -0,0 +1,214 @@
|
|||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# Copyright (c) 2022 Western Digital Corporation
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: wdc_redfish_info
|
||||
short_description: Manages WDC UltraStar Data102 Out-Of-Band controllers using Redfish APIs
|
||||
version_added: 5.4.0
|
||||
description:
|
||||
- Builds Redfish URIs locally and sends them to remote OOB controllers to
|
||||
get information back.
|
||||
options:
|
||||
category:
|
||||
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
|
||||
elements: str
|
||||
baseuri:
|
||||
description:
|
||||
- Base URI of OOB controller. Must include this or I(ioms).
|
||||
type: str
|
||||
ioms:
|
||||
description:
|
||||
- List of IOM FQDNs for the enclosure. Must include this or I(baseuri).
|
||||
type: list
|
||||
elements: str
|
||||
username:
|
||||
description:
|
||||
- User for authentication with OOB controller.
|
||||
type: str
|
||||
password:
|
||||
description:
|
||||
- Password for authentication with OOB controller.
|
||||
type: str
|
||||
auth_token:
|
||||
description:
|
||||
- Security token for authentication with OOB controller.
|
||||
type: str
|
||||
timeout:
|
||||
description:
|
||||
- Timeout in seconds for URL requests to OOB controller.
|
||||
default: 10
|
||||
type: int
|
||||
|
||||
notes:
|
||||
- In the inventory, you can specify baseuri or ioms. See the EXAMPLES section.
|
||||
- ioms is a list of FQDNs for the enclosure's IOMs.
|
||||
|
||||
author: Mike Moerk (@mikemoerk)
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: Get Simple Update Status with individual IOMs specified
|
||||
community.general.wdc_redfish_info:
|
||||
category: Update
|
||||
command: SimpleUpdateStatus
|
||||
ioms:
|
||||
- iom1.wdc.com
|
||||
- iom2.wdc.com
|
||||
username: "{{ username }}"
|
||||
password: "{{ password }}"
|
||||
register: result
|
||||
|
||||
- name: Print fetched information
|
||||
ansible.builtin.debug:
|
||||
msg: "{{ result.redfish_facts.simple_update_status.entries | to_nice_json }}"
|
||||
|
||||
- name: Get Simple Update Status with baseuri specified
|
||||
community.general.wdc_redfish_info:
|
||||
category: Update
|
||||
command: SimpleUpdateStatus
|
||||
baseuri: "iom1.wdc.com"
|
||||
username: "{{ username }}"
|
||||
password: "{{ password }}"
|
||||
register: result
|
||||
|
||||
- name: Print fetched information
|
||||
ansible.builtin.debug:
|
||||
msg: "{{ result.redfish_facts.simple_update_status.entries | to_nice_json }}"
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
Description:
|
||||
description: Firmware update status description.
|
||||
returned: always
|
||||
type: str
|
||||
sample:
|
||||
- Ready for FW update
|
||||
- FW update in progress
|
||||
- FW update completed. Waiting for activation.
|
||||
ErrorCode:
|
||||
description: Numeric error code for firmware update status. Non-zero indicates an error condition.
|
||||
returned: always
|
||||
type: int
|
||||
sample:
|
||||
- 0
|
||||
EstimatedRemainingMinutes:
|
||||
description: Estimated number of minutes remaining in firmware update operation.
|
||||
returned: always
|
||||
type: int
|
||||
sample:
|
||||
- 0
|
||||
- 20
|
||||
StatusCode:
|
||||
description: Firmware update status code.
|
||||
returned: always
|
||||
type: int
|
||||
sample:
|
||||
- 0 (Ready for FW update)
|
||||
- 1 (FW update in progress)
|
||||
- 2 (FW update completed. Waiting for activation.)
|
||||
- 3 (FW update failed.)
|
||||
'''
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible.module_utils.common.text.converters import to_native
|
||||
from ansible_collections.community.general.plugins.module_utils.wdc_redfish_utils import WdcRedfishUtils
|
||||
|
||||
CATEGORY_COMMANDS_ALL = {
|
||||
"Update": ["SimpleUpdateStatus"]
|
||||
}
|
||||
|
||||
|
||||
def main():
|
||||
result = {}
|
||||
module = AnsibleModule(
|
||||
argument_spec=dict(
|
||||
category=dict(required=True),
|
||||
command=dict(required=True, type='list', elements='str'),
|
||||
ioms=dict(type='list', elements='str'),
|
||||
baseuri=dict(),
|
||||
username=dict(),
|
||||
password=dict(no_log=True),
|
||||
auth_token=dict(no_log=True),
|
||||
timeout=dict(type='int', default=10)
|
||||
),
|
||||
required_together=[
|
||||
('username', 'password'),
|
||||
],
|
||||
required_one_of=[
|
||||
('username', 'auth_token'),
|
||||
('baseuri', 'ioms')
|
||||
],
|
||||
mutually_exclusive=[
|
||||
('username', 'auth_token'),
|
||||
],
|
||||
supports_check_mode=True
|
||||
)
|
||||
|
||||
category = module.params['category']
|
||||
command_list = module.params['command']
|
||||
|
||||
# admin credentials used for authentication
|
||||
creds = {'user': module.params['username'],
|
||||
'pswd': module.params['password'],
|
||||
'token': module.params['auth_token']}
|
||||
|
||||
# timeout
|
||||
timeout = module.params['timeout']
|
||||
|
||||
# Check that Category is valid
|
||||
if category not in CATEGORY_COMMANDS_ALL:
|
||||
module.fail_json(msg=to_native("Invalid Category '%s'. Valid Categories = %s" % (category, sorted(CATEGORY_COMMANDS_ALL.keys()))))
|
||||
|
||||
# Check that all commands are valid
|
||||
for cmd in command_list:
|
||||
# Fail if even one command given is invalid
|
||||
if cmd not in CATEGORY_COMMANDS_ALL[category]:
|
||||
module.fail_json(msg=to_native("Invalid Command '%s'. Valid Commands = %s" % (cmd, CATEGORY_COMMANDS_ALL[category])))
|
||||
|
||||
# Build root URI(s)
|
||||
if module.params.get("baseuri") is not None:
|
||||
root_uris = ["https://" + module.params['baseuri']]
|
||||
else:
|
||||
root_uris = [
|
||||
"https://" + iom for iom in module.params['ioms']
|
||||
]
|
||||
rf_utils = WdcRedfishUtils(creds, root_uris, timeout, module,
|
||||
resource_id=None,
|
||||
data_modification=False
|
||||
)
|
||||
|
||||
# Organize by Categories / Commands
|
||||
|
||||
if category == "Update":
|
||||
# execute only if we find UpdateService resources
|
||||
resource = rf_utils._find_updateservice_resource()
|
||||
if resource['ret'] is False:
|
||||
module.fail_json(msg=resource['msg'])
|
||||
for command in command_list:
|
||||
if command == "SimpleUpdateStatus":
|
||||
simple_update_status_result = rf_utils.get_simple_update_status()
|
||||
if simple_update_status_result['ret'] is False:
|
||||
module.fail_json(msg=to_native(result['msg']))
|
||||
else:
|
||||
del simple_update_status_result['ret']
|
||||
result["simple_update_status"] = simple_update_status_result
|
||||
module.exit_json(changed=False, redfish_facts=result)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
Loading…
Add table
Add a link
Reference in a new issue