ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

redfish_command: VirtualMediaInsert does not work with HPE iLO4 (#4596)

Browse source 
* Inserted not supported in patch on some hardware

Signed-off-by: Adam Robinson <adarobin@umich.edu>

* return error for ilo4 options with no defaults

* Update changelog

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

* make virtual_media_insert_via_patch backwards compatible

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

* remove ilo 4 specific properties check

* return ExtendedInfo as a string if no Message

* only worry about Inserted and WriteProtected

* update changelog

* fix for PEP8

* fix up comments

* fix VirtualMediaEject for iLO4 as well

* update changlog

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

Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
Adam Robinson 2022-05-05 01:56:26 -04:00 committed by GitHub
parent dd9afc09a8
commit f8889d1dd8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 47 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
changelogs/fragments/4595-fix-VirtualMediaInsert-iLO4.yml Normal file
View file

@ -0,0 +1,10 @@
bugfixes:
- redfish_command - the iLO4 Redfish implementation only supports the ``image_url`` parameter in
the underlying API calls to ``VirtualMediaInsert`` and ``VirtualMediaEject``. Any values set
(or the defaults) for ``write_protected`` or ``inserted`` will be ignored
(https://github.com/ansible-collections/community.general/pull/4596).
minor_changes:
- redfish_* modules - the contents of ``@Message.ExtendedInfo`` will be returned as a string in the event
that ``@Message.ExtendedInfo.Messages`` does not exist. This is likely more useful than the
standard HTTP error
(https://github.com/ansible-collections/community.general/pull/4596).

42
plugins/module_utils/redfish_utils.py
View file

@ -188,7 +188,12 @@ class RedfishUtils(object):
body = error.read().decode('utf-8')
data = json.loads(body)
ext_info = data['error']['@Message.ExtendedInfo']
msg = ext_info[0]['Message']
# if the ExtendedInfo contains a user friendly message send it
# otherwise try to send the entire contents of ExtendedInfo
try:
msg = ext_info[0]['Message']
except Exception:
msg = str(data['error']['@Message.ExtendedInfo'])
except Exception:
pass
return msg
@ -2236,7 +2241,7 @@ class RedfishUtils(object):
payload[param] = options.get(option)
return payload
def virtual_media_insert_via_patch(self, options, param_map, uri, data):
def virtual_media_insert_via_patch(self, options, param_map, uri, data, image_only=False):
# get AllowableValues
ai = dict((k[:-24],
{'AllowableValues': v}) for k, v in data.items()
@ -2245,6 +2250,13 @@ class RedfishUtils(object):
payload = self._insert_virt_media_payload(options, param_map, data, ai)
if 'Inserted' not in payload:
payload['Inserted'] = True
# Some hardware (such as iLO 4) only supports the Image property on the PATCH operation
# Inserted and WriteProtected are not writable
if image_only:
del payload['Inserted']
del payload['WriteProtected']
# PATCH the resource
response = self.patch_request(self.root_uri + uri, payload)
if response['ret'] is False:
@ -2260,6 +2272,7 @@ class RedfishUtils(object):
'TransferProtocolType': 'transfer_protocol_type',
'TransferMethod': 'transfer_method'
}
image_only = False
image_url = options.get('image_url')
if not image_url:
return {'ret': False,
@ -2273,6 +2286,12 @@ class RedfishUtils(object):
data = response['data']
if 'VirtualMedia' not in data:
return {'ret': False, 'msg': "VirtualMedia resource not found"}
# Some hardware (such as iLO 4) only supports the Image property on the PATCH operation
# Inserted and WriteProtected are not writable
if data["FirmwareVersion"].startswith("iLO 4"):
image_only = True
virt_media_uri = data["VirtualMedia"]["@odata.id"]
response = self.get_request(self.root_uri + virt_media_uri)
if response['ret'] is False:
@ -2315,7 +2334,7 @@ class RedfishUtils(object):
'msg': "%s action not found and PATCH not allowed"
% '#VirtualMedia.InsertMedia'}
return self.virtual_media_insert_via_patch(options, param_map,
uri, data)
uri, data, image_only)
# get the action property
action = data['Actions']['#VirtualMedia.InsertMedia']
@ -2334,12 +2353,18 @@ class RedfishUtils(object):
return response
return {'ret': True, 'changed': True, 'msg': "VirtualMedia inserted"}
def virtual_media_eject_via_patch(self, uri):
def virtual_media_eject_via_patch(self, uri, image_only=False):
# construct payload
payload = {
'Inserted': False,
'Image': None
}
# Some hardware (such as iLO 4) only supports the Image property on the PATCH operation
# Inserted is not writable
if image_only:
del payload['Inserted']
# PATCH resource
response = self.patch_request(self.root_uri + uri, payload)
if response['ret'] is False:
@ -2360,6 +2385,13 @@ class RedfishUtils(object):
data = response['data']
if 'VirtualMedia' not in data:
return {'ret': False, 'msg': "VirtualMedia resource not found"}
# Some hardware (such as iLO 4) only supports the Image property on the PATCH operation
# Inserted is not writable
image_only = False
if data["FirmwareVersion"].startswith("iLO 4"):
image_only = True
virt_media_uri = data["VirtualMedia"]["@odata.id"]
response = self.get_request(self.root_uri + virt_media_uri)
if response['ret'] is False:
@ -2384,7 +2416,7 @@ class RedfishUtils(object):
return {'ret': False,
'msg': "%s action not found and PATCH not allowed"
% '#VirtualMedia.EjectMedia'}
return self.virtual_media_eject_via_patch(uri)
return self.virtual_media_eject_via_patch(uri, image_only)
else:
# POST to the EjectMedia Action
action = data['Actions']['#VirtualMedia.EjectMedia']