Skip to content

Commit

Permalink
Add support for Oem params (ansible-collections#7330)
Browse files Browse the repository at this point in the history
* Add support for "Oem" parameters in the MultipartHTTPPushUpdate redfish_command

* Add doc entry

* Add changelog fragment
Add version_added field

* Re-word the changelog fragment

* After further testing this should not have a default definition as
it should not be in the payload if not defined
  • Loading branch information
sseekamp authored and Eric Trombly committed Oct 25, 2023
1 parent 9b42032 commit 4a5dea7
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 0 deletions.
2 changes: 2 additions & 0 deletions changelogs/fragments/7330-redfish-utils-oem-params.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
minor_changes:
- redfish_command - add new option ``update_oem_params`` for the ``MultipartHTTPPushUpdate`` command (https://github.com/ansible-collections/community.general/issues/7331).
3 changes: 3 additions & 0 deletions plugins/module_utils/redfish_utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -1745,6 +1745,7 @@ def multipath_http_push_update(self, update_opts):
image_file = update_opts.get('update_image_file')
targets = update_opts.get('update_targets')
apply_time = update_opts.get('update_apply_time')
oem_params = update_opts.get('update_oem_params')

# Ensure the image file is provided
if not image_file:
Expand Down Expand Up @@ -1775,6 +1776,8 @@ def multipath_http_push_update(self, update_opts):
payload["Targets"] = targets
if apply_time:
payload["@Redfish.OperationApplyTime"] = apply_time
if oem_params:
payload["Oem"] = oem_params
multipart_payload = {
'UpdateParameters': {'content': json.dumps(payload), 'mime_type': 'application/json'},
'UpdateFile': {'filename': image_file, 'content': image_payload, 'mime_type': 'application/octet-stream'}
Expand Down
10 changes: 10 additions & 0 deletions plugins/modules/redfish_command.py
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,12 @@
- InMaintenanceWindowOnReset
- OnStartUpdateRequest
version_added: '6.1.0'
update_oem_params:
required: false
description:
- Properties for HTTP Multipart Push Updates.
type: dict
version_added: '7.5.0'
update_handle:
required: false
description:
Expand Down Expand Up @@ -601,6 +607,8 @@
update_image_file: ~/images/myupdate.img
update_targets:
- /redfish/v1/UpdateService/FirmwareInventory/BMC
update_oem_params:
PreserveConfiguration: false
- name: Perform requested operations to continue the update
community.general.redfish_command:
Expand Down Expand Up @@ -792,6 +800,7 @@ def main():
update_image_file=dict(type='path'),
update_protocol=dict(),
update_targets=dict(type='list', elements='str', default=[]),
update_oem_params=dict(type='dict'),
update_creds=dict(
type='dict',
options=dict(
Expand Down Expand Up @@ -874,6 +883,7 @@ def main():
'update_targets': module.params['update_targets'],
'update_creds': module.params['update_creds'],
'update_apply_time': module.params['update_apply_time'],
'update_oem_params': module.params['update_oem_params'],
'update_handle': module.params['update_handle'],
}

Expand Down

0 comments on commit 4a5dea7

Please sign in to comment.