VirtualMediaEject should not require image_url #3042

smalleni · 2021-07-21T18:13:25Z

Summary

When using redfish_command (https://github.com/ansible-collections/community.general/blob/main/plugins/modules/remote_management/redfish/redfish_command.py) I want to eject all virtual media and looks like the module expects a value for image_url for this to work. There are cases when a user wants to eject all virtual media and it might not be possible to know the exact urls of the virtual media previously supported. It looks like redfish supports ejecting all virtual media without providig an image_url link (dell/iDRAC-Redfish-Scripting#24 (comment)), however I see an error like

TASK [boot-iso : DELL - Eject Virtual Media (if any)] *******************************************************************************************************************************
Wednesday 21 July 2021  12:48:53 -0500 (0:00:11.918)       0:02:23.541 ******** 
fatal: [e16-h12-b02-fc640.rdu2.scalelab.redhat.com]: FAILED! => {"changed": false, "msg": "image_url option required for VirtualMediaEject"}

if I try passing an empty dictionary to virtual_media

Issue Type

Bug Report

Component Name

redfish_command

Ansible Version

[smalleni@unknown74d83e950f42 jetlag]$ ansible --version
ansible 2.9.21
  config file = /home/smalleni/Documents/code/jetlag/ansible.cfg
  configured module search path = ['/home/smalleni/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
  ansible python module location = /usr/lib/python3.8/site-packages/ansible
  executable location = /usr/bin/ansible
  python version = 3.8.7 (default, Jan 20 2021, 00:00:00) [GCC 10.2.1 20201125 (Red Hat 10.2.1-9)]

Configuration

[smalleni@unknown74d83e950f42 jetlag]$ ansible-config dump --only-changed
DEFAULT_CALLBACK_WHITELIST(/home/smalleni/Documents/code/jetlag/ansible.cfg) = ['profile_tasks']

OS / Environment

Fedora 32

Steps to Reproduce

    - name: DELL - Eject Virtual Media (if any)
      community.general.redfish_command:
        category: Manager
        command: VirtualMediaEject
        baseuri: "{{ hostvars[item]['bmc_address'] }}"
        username: "{{ hostvars[item]['bmc_user'] }}"
        password: "{{ hostvars[item]['bmc_password'] }}"
        virtual_media:
          image_url: "http://{{ http_store_host }}:{{ http_store_port }}/{{ hostvars[item]['boot_iso'] }}"
        resource_id: iDRAC.Embedded.1
      ignore_errors: yes

Expected Results

I expect to be able to unmount all virtual media without being required to know the urls of all the virtualmedia previously mounted.

Actual Results

TASK [boot-iso : DELL - Eject Virtual Media (if any)] *******************************************************************************************************************************
Wednesday 21 July 2021  12:48:53 -0500 (0:00:11.918)       0:02:23.541 ******** 
fatal: [e16-h12-b02-fc640.rdu2.scalelab.redhat.com]: FAILED! => {"changed": false, "msg": "image_url option required for VirtualMediaEject"}

Code of Conduct

I agree to follow the Ansible Code of Conduct

The text was updated successfully, but these errors were encountered:

ansibullbot · 2021-07-21T18:14:40Z

Files identified in the description:

plugins/modules/remote_management/redfish/redfish_command.py

If these files are inaccurate, please update the component name section of the description or use the !component bot command.

click here for bot help

ansibullbot · 2021-07-21T18:14:40Z

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

smalleni · 2021-07-21T18:19:48Z

Looks like there is an explicit check for image_url:

community.general/plugins/module_utils/redfish_utils.py

Lines 2325 to 2327 in ea822c7

    
           if not image_url: 
        
               return {'ret': False, 
        
                       'msg': "image_url option required for VirtualMediaEject"}

And it is used to to find the virtual media to eject at:

community.general/plugins/module_utils/redfish_utils.py

Line 2347 in ea822c7

uri, data, eject = self._find_virt_media_to_eject(resources, image_url)

mraineri · 2021-07-21T18:32:57Z

Yes, at least with the behavior we've implemented today the image URL is needed since the expectation is the user is specifying the image URL for the ISO to eject. I think we need to consider some things first before making changes.

If the image URL is not given, then what exactly should be ejected? All virtual media your example indicates? This seems a bit heavy handed in my opinion, but others might like this behavior. Redfish itself doesn't support an "eject all" type of operation, and I suspect the script you're referencing is either using OEM actions or is just looping on all slots and ejecting everything.

Should a user be allowed specify an alternative identifier (such as the "Id" of the virtual media instance) in order to control what slot is ejected?

Certainly would like opinions from others for desired behavior. I do like the idea of keeping the mandatory argument list as minimal as possible, but would like to agree upon the desired behavior first.

smalleni · 2021-07-21T19:04:37Z

Yes, at least with the behavior we've implemented today the image URL is needed since the expectation is the user is specifying the image URL for the ISO to eject. I think we need to consider some things first before making changes.

If the image URL is not given, then what exactly should be ejected? All virtual media your example indicates? This seems a bit heavy handed in my opinion, but others might like this behavior. Redfish itself doesn't support an "eject all" type of operation, and I suspect the script you're referencing is either using OEM actions or is just looping on all slots and ejecting everything.

Should a user be allowed specify an alternative identifier (such as the "Id" of the virtual media instance) in order to control what slot is ejected?

Certainly would like opinions from others for desired behavior. I do like the idea of keeping the mandatory argument list as minimal as possible, but would like to agree upon the desired behavior first.

Thank you for taking a look quickly. This is especially useful in our situation where the hardware nodes get recycled quite a bit between tenants and we might have things lingering around from previous tenants. Hence the need to remove any virtualmedia. I thought redifsh supported this but perhaps not then? I thought I saw

Method: POST
URI: https://<idrac_ip_address>/redfish/v1/Managers/iDRAC.Embedded.1/VirtualMedia/CD/Actions/VirtualMedia.EjectMedia
BODY:
{}

mraineri · 2021-07-22T12:46:29Z

That particular example ejects a virtual media instance called "CD"; there are other virtual media instances in the collection. Essentially you'd replace the segment "CD" in the URI for the action with another instance identifier (I think "USB" is another one used by iDRAC).

smalleni · 2021-07-22T14:18:47Z

That particular example ejects a virtual media instance called "CD"; there are other virtual media instances in the collection. Essentially you'd replace the segment "CD" in the URI for the action with another instance identifier (I think "USB" is another one used by iDRAC).

Got it, but since it doesn't require an image url, maybe even in ansible we can support ejecting all media instance of a particular media type?

mraineri · 2021-07-22T20:05:33Z

Maybe an explicit "all" option just for clarity? I'd be concerned with having default behavior eject everything since the other slot could be in use for another user.

smalleni · 2021-07-30T19:51:46Z

Maybe an explicit "all" option just for clarity? I'd be concerned with having default behavior eject everything since the other slot could be in use for another user.

Sure, but it's really useful for sysadmins to be able to eject all virtual media. Either it is a default option when you don't provide image_url or you have to explicitly ask for it, either is fine.

At the end of the day I want to be able to eject virtual media (either of a particular type like CD or of all types) without the image_url since I may not always know the image_url used by a user who had used the hardware previouly.

mraineri · 2021-08-06T19:07:33Z

The group has discussed this a bit and is okay with adding a dedicated "eject all" command in order to keep the semantics of the existing eject command as is.

Is this something you'd be able to work on?

ansibullbot · 2021-12-17T21:38:37Z

cc @Bhavya06 @rajeevkallur
click here for bot help

ansibullbot · 2022-11-03T01:14:32Z

cc @jose-delarosa
click here for bot help

ansibullbot · 2022-11-11T02:16:30Z

Files identified in the description:

plugins/modules/redfish_command.py

If these files are incorrect, please update the component name section of the description or use the !component bot command.

click here for bot help

ansibullbot · 2023-02-23T03:22:26Z

cc @TSKushal
click here for bot help

ansibullbot · 2023-03-03T03:34:29Z

cc @jyundt
click here for bot help

…esolves ansible-collections#3042

ansibullbot added affects_2.9 bug This issue/PR relates to a bug module module needs_triage plugins plugin (any type) python3 remote_management labels Jul 21, 2021

ansibullbot removed the needs_triage label Jul 21, 2021

felixfontein removed the affects_2.9 label Apr 26, 2024

plumbis pushed a commit to plumbis/community.general that referenced this issue Aug 14, 2024

Remove required image_url and support multiple virtual media devices. R…

60e3fbb

…esolves ansible-collections#3042

plumbis pushed a commit to plumbis/community.general that referenced this issue Aug 14, 2024

Remove required image_url and support multiple virtual media devices. R…

78cdf23

…esolves ansible-collections#3042

plumbis pushed a commit to plumbis/community.general that referenced this issue Aug 14, 2024

Remove required image_url and support multiple virtual media devices. R…

a4469ea

…esolves ansible-collections#3042

plumbis linked a pull request Aug 14, 2024 that will close this issue

redfish mod utils: remove required image_url for Virtual Media #8765

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

VirtualMediaEject should not require image_url #3042

VirtualMediaEject should not require image_url #3042

smalleni commented Jul 21, 2021 •

edited

Loading

ansibullbot commented Jul 21, 2021

ansibullbot commented Jul 21, 2021

smalleni commented Jul 21, 2021 •

edited

Loading

mraineri commented Jul 21, 2021 •

edited

Loading

smalleni commented Jul 21, 2021 •

edited

Loading

mraineri commented Jul 22, 2021

smalleni commented Jul 22, 2021

mraineri commented Jul 22, 2021

smalleni commented Jul 30, 2021

mraineri commented Aug 6, 2021

ansibullbot commented Dec 17, 2021

ansibullbot commented Nov 3, 2022

ansibullbot commented Nov 11, 2022

ansibullbot commented Feb 23, 2023

ansibullbot commented Mar 3, 2023

VirtualMediaEject should not require image_url #3042

VirtualMediaEject should not require image_url #3042

Comments

smalleni commented Jul 21, 2021 • edited Loading

Summary

Issue Type

Component Name

Ansible Version

Configuration

OS / Environment

Steps to Reproduce

Expected Results

Actual Results

Code of Conduct

ansibullbot commented Jul 21, 2021

ansibullbot commented Jul 21, 2021

smalleni commented Jul 21, 2021 • edited Loading

mraineri commented Jul 21, 2021 • edited Loading

smalleni commented Jul 21, 2021 • edited Loading

mraineri commented Jul 22, 2021

smalleni commented Jul 22, 2021

mraineri commented Jul 22, 2021

smalleni commented Jul 30, 2021

mraineri commented Aug 6, 2021

ansibullbot commented Dec 17, 2021

ansibullbot commented Nov 3, 2022

ansibullbot commented Nov 11, 2022

ansibullbot commented Feb 23, 2023

ansibullbot commented Mar 3, 2023

smalleni commented Jul 21, 2021 •

edited

Loading

smalleni commented Jul 21, 2021 •

edited

Loading

mraineri commented Jul 21, 2021 •

edited

Loading

smalleni commented Jul 21, 2021 •

edited

Loading