redfish_command: VirtualMediaInsert does not work with Supermicro

[FRUCHTiii]

SUMMARY

ISSUE TYPE

• Bugfix Pull Request

COMPONENT NAME

redfish_command

ADDITIONAL INFORMATION

Supermicro does not support WriteProtected and Inserted to use by virtual media.
This fixes the issue und adds Supermicro as "image_only" like HP iLO4

Also Supermicro doesn't clear the ImageName after unmounting the ISO so we deleted this check and now just use inserted: false

before

{"failed": true, "msg": "HTTP Error 400 on POST request to 'https://$IP/redfish/v1/Managers/1/VirtualMedia/CD1/Actions/VirtualMedia.InsertMedia', extended message: 'The property Inserted is not in the list of valid properties for the resource.'", "invocation": {"module_args": {"category": "Manager", "command": ["VirtualMediaInsert"], "baseuri": "$IP", "username": "ADMIN", "password": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER", "virtual_media": {"image_url": "http://dl-cdn.alpinelinux.org/alpine/v3.16/releases/x86_64/alpine-standard-3.16.0-x86_64.iso", "media_types": ["CD", "DVD"], "inserted": true, "write_protected": true, "username": null, "password": null, "transfer_protocol_type": null, "transfer_method": null}, "resource_id": "1", "account_properties": {}, "timeout": 10, "update_targets": [], "auth_token": null, "session_uri": null, "id": null, "new_username": null, "new_password": null, "roleid": null, "update_username": null, "bootdevice": null, "uefi_target": null, "boot_next": null, "update_image_uri": null, "update_protocol": null, "update_creds": null}}}

after

{"changed": true, "session": {}, "msg": "Action was successful", "invocation": {"module_args": {"category": "Manager", "command": ["VirtualMediaInsert"], "baseuri": "$IP", "username": "ADMIN", "password": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER", "virtual_media": {"image_url": "http://dl-cdn.alpinelinux.org/alpine/v3.16/releases/x86_64/alpine-standard-3.16.0-x86_64.iso", "media_types": ["CD", "DVD"], "inserted": true, "write_protected": true, "username": null, "password": null, "transfer_protocol_type": null, "transfer_method": null}, "resource_id": "1", "account_properties": {}, "timeout": 10, "update_targets": [], "auth_token": null, "session_uri": null, "id": null, "new_username": null, "new_password": null, "roleid": null, "update_username": null, "bootdevice": null, "uefi_target": null, "boot_next": null, "update_image_uri": null, "update_protocol": null, "update_creds": null}}}

[felixfontein]

Thanks for your contribution! Could you please add a changelog fragment? Thanks.

[ansibullbot]

cc @Bhavya06 @mraineri @rajeevkallur @renxulei @tomasg2012 @xmadsen
click here for bot help

[ansibullbot]

The test ansible-test sanity --test pylint [explain] failed with 1 error:

plugins/module_utils/redfish_utils.py:2241:0: trailing-whitespace: Trailing whitespace

The test ansible-test sanity --test pep8 [explain] failed with 2 errors:

plugins/module_utils/redfish_utils.py:2241:1: W293: blank line contains whitespace
plugins/module_utils/redfish_utils.py:2295:161: E501: line too long (166 > 160 characters)

The test ansible-test sanity --test pep8 [explain] failed with 2 errors:

plugins/module_utils/redfish_utils.py:2241:1: W293: blank line contains whitespace
plugins/module_utils/redfish_utils.py:2295:161: E501: line too long (166 > 160 characters)

The test ansible-test sanity --test pep8 [explain] failed with 2 errors:

plugins/module_utils/redfish_utils.py:2241:1: W293: blank line contains whitespace
plugins/module_utils/redfish_utils.py:2295:161: E501: line too long (166 > 160 characters)

The test ansible-test sanity --test pylint [explain] failed with 1 error:

plugins/module_utils/redfish_utils.py:2241:0: trailing-whitespace: Trailing whitespace

The test ansible-test sanity --test pep8 [explain] failed with 2 errors:

plugins/module_utils/redfish_utils.py:2241:1: W293: blank line contains whitespace
plugins/module_utils/redfish_utils.py:2295:161: E501: line too long (166 > 160 characters)

The test ansible-test sanity --test pylint [explain] failed with 1 error:

plugins/module_utils/redfish_utils.py:2241:0: trailing-whitespace: Trailing whitespace

The test ansible-test sanity --test pylint [explain] failed with 1 error:

plugins/module_utils/redfish_utils.py:2241:0: trailing-whitespace: Trailing whitespace

click here for bot help

[FRUCHTiii]

@felixfontein I've just added the changelog could you please have a look.

[mraineri]

This looks good. Out of curiosity, does removing inserted and write_protected from the playbook work without any code changes? In general, it shouldn't be needed to specify those two parameters since there's well-known default behavior defined in the standard when going through the "InsertMedia" action path.

[felixfontein]

Looks good to me. @mraineri is everything still fine for you?

[mraineri]

One thing that came out in the group's review is that it's not really typical for a user to specify "inserted" or "write_protected" in these types of requests; while the standard allows for it, the real simple case is the user provides the image URI and the service does everything else needed.

So, one of the questions that came up is if @FRUCHTiii really needs to provide "inserted" or "write_protected" in their playbook and if there's the possibility it can just be simplified on that end. But, if it's really needed, the changes look good. We'll just need to be cognizant of the possibility that Supermicro may add support for those parameters in the future.

[FRUCHTiii]

I don't know if I understand you correctly @mraineri
I don't us inserted or write_protected in my playbook.

But the code will insert it every time.

My playbooks looks like this:

tasks:
  - name: eject virtual media (if previous installation finished unclean)
    redfish_command:
      category: Manager
      command: VirtualMediaEject 
      baseuri: "{{ ipmi_ip }}"
      username: "{{ ipmi_user }}"
      password: "{{ ipmi_pass }}"
      virtual_media:
        image_url: 'http://dl-cdn.alpinelinux.org/alpine/v3.16/releases/x86_64/alpine-standard-3.16.0-x86_64.iso'
      resource_id: 1
    ignore_errors: true

  - name: insert virtual media
    redfish_command:
      category: Manager
      command: VirtualMediaInsert 
      baseuri: "{{ ipmi_ip }}"
      username: "{{ ipmi_user }}"
      password: "{{ ipmi_pass }}"
      virtual_media:
        image_url: "http://dl-cdn.alpinelinux.org/alpine/v3.16/releases/x86_64/alpine-standard-3.16.0-x86_64.iso"
        media_types:
          - CD
          - DVD
      resource_id: 1

  - name: set one-time boot device to {{ bootdevice }}
    redfish_command:
      category: Systems
      command: SetOneTimeBoot
      bootdevice: "{{ bootdevice }}"
      boot_next: "{{ boot_next }}"
      baseuri: "{{ ipmi_ip }}"
      username: "{{ ipmi_user }}"
      password: "{{ ipmi_pass }}"

  - name: reboot system
    redfish_command:
      category: Systems
      command: PowerForceRestart
      baseuri: "{{ ipmi_ip }}"
      username: "{{ ipmi_user }}"
      password: "{{ ipmi_pass }}"

[mraineri]

Ah, I see now. I was under the impression "inserted" and "write_protected" are only provided if specified in the playbook. Clearly that isn't the case here. Thanks for showing me this. Looks good on my end now!