Update iDRAC doc on Redfish vendor passthru interface
Change-Id: I6ebbfd5a4b42ad0c8321b59e2a07fcc9829115bd
This commit is contained in:
parent
d3dd6b29b2
commit
383afc2d89
|
@ -32,7 +32,8 @@ The ``idrac`` hardware type supports the following Ironic interfaces:
|
||||||
* `Management Interface`_: Boot device and firmware management
|
* `Management Interface`_: Boot device and firmware management
|
||||||
* Power Interface: Power management
|
* Power Interface: Power management
|
||||||
* `RAID Interface`_: RAID controller and disk management
|
* `RAID Interface`_: RAID controller and disk management
|
||||||
* `Vendor Interface`_: BIOS management
|
* `Vendor Interface`_: BIOS management (WSMAN) and eject virtual media
|
||||||
|
(Redfish)
|
||||||
|
|
||||||
Prerequisites
|
Prerequisites
|
||||||
-------------
|
-------------
|
||||||
|
@ -88,7 +89,7 @@ following configuration:
|
||||||
enabled_management_interfaces=idrac-redfish
|
enabled_management_interfaces=idrac-redfish
|
||||||
enabled_power_interfaces=idrac-redfish
|
enabled_power_interfaces=idrac-redfish
|
||||||
enabled_raid_interfaces=idrac-wsman
|
enabled_raid_interfaces=idrac-wsman
|
||||||
enabled_vendor_interfaces=idrac-wsman
|
enabled_vendor_interfaces=idrac-redfish
|
||||||
|
|
||||||
Below is the list of supported interface implementations in priority
|
Below is the list of supported interface implementations in priority
|
||||||
order:
|
order:
|
||||||
|
@ -108,7 +109,8 @@ Interface Supported Implementations
|
||||||
``raid`` ``idrac-wsman``, ``idrac``, ``no-raid``
|
``raid`` ``idrac-wsman``, ``idrac``, ``no-raid``
|
||||||
``rescue`` ``no-rescue``, ``agent``
|
``rescue`` ``no-rescue``, ``agent``
|
||||||
``storage`` ``noop``, ``cinder``, ``external``
|
``storage`` ``noop``, ``cinder``, ``external``
|
||||||
``vendor`` ``idrac-wsman``, ``idrac``, ``no-vendor``
|
``vendor`` ``idrac-wsman``, ``idrac``, ``idrac-redfish``,
|
||||||
|
``no-vendor``
|
||||||
================ ===================================================
|
================ ===================================================
|
||||||
|
|
||||||
.. NOTE::
|
.. NOTE::
|
||||||
|
@ -179,7 +181,7 @@ hardware type using Redfish for all interfaces:
|
||||||
--management-interface idrac-redfish \
|
--management-interface idrac-redfish \
|
||||||
--power-interface idrac-redfish \
|
--power-interface idrac-redfish \
|
||||||
--raid-interface no-raid \
|
--raid-interface no-raid \
|
||||||
--vendor-interface no-vendor
|
--vendor-interface idrac-redfish
|
||||||
|
|
||||||
The following command enrolls a bare metal node with the ``idrac``
|
The following command enrolls a bare metal node with the ``idrac``
|
||||||
hardware type assuming a mix of Redfish and WSMAN interfaces are used:
|
hardware type assuming a mix of Redfish and WSMAN interfaces are used:
|
||||||
|
@ -410,7 +412,10 @@ be used to fetch the information directly from the Dell bare metal:
|
||||||
Vendor Interface
|
Vendor Interface
|
||||||
================
|
================
|
||||||
|
|
||||||
Dell iDRAC BIOS management is available through the Ironic vendor
|
idrac-wsman
|
||||||
|
-----------
|
||||||
|
|
||||||
|
Dell iDRAC BIOS management is available through the Ironic WSMAN vendor
|
||||||
passthru interface.
|
passthru interface.
|
||||||
|
|
||||||
======================== ============ ======================================
|
======================== ============ ======================================
|
||||||
|
@ -452,7 +457,7 @@ Method Name HTTP Method Description
|
||||||
|
|
||||||
|
|
||||||
Examples
|
Examples
|
||||||
--------
|
^^^^^^^^
|
||||||
|
|
||||||
Get BIOS Config
|
Get BIOS Config
|
||||||
~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~
|
||||||
|
@ -574,7 +579,7 @@ The abandon command does not provide a response body.
|
||||||
|
|
||||||
|
|
||||||
Change Boot Mode
|
Change Boot Mode
|
||||||
----------------
|
^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
The boot mode of the iDRAC can be changed to:
|
The boot mode of the iDRAC can be changed to:
|
||||||
|
|
||||||
|
@ -605,7 +610,8 @@ The UEFI boot mode offers:
|
||||||
* Consolidated firmware user interface
|
* Consolidated firmware user interface
|
||||||
* Enhanced resource allocation for boot device firmware
|
* Enhanced resource allocation for boot device firmware
|
||||||
|
|
||||||
The boot mode can be changed via the vendor passthru interface as follows:
|
The boot mode can be changed via the WSMAN vendor passthru interface as
|
||||||
|
follows:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
|
@ -623,6 +629,22 @@ The boot mode can be changed via the vendor passthru interface as follows:
|
||||||
baremetal node passthru call <node> commit_bios_config \
|
baremetal node passthru call <node> commit_bios_config \
|
||||||
--arg "reboot=true"
|
--arg "reboot=true"
|
||||||
|
|
||||||
|
idrac-redfish
|
||||||
|
-------------
|
||||||
|
|
||||||
|
Through the ``idrac-redfish`` vendor passthru interface these methods are
|
||||||
|
available:
|
||||||
|
|
||||||
|
================ ============ ==============================================
|
||||||
|
Method Name HTTP Method Description
|
||||||
|
================ ============ ==============================================
|
||||||
|
``eject_media`` ``POST`` Eject a virtual media device. If no device is
|
||||||
|
provided then all attached devices will be
|
||||||
|
ejected. Optional argument: ``boot_device`` -
|
||||||
|
the boot device to eject, either, ``cd``,
|
||||||
|
``dvd``, ``usb`` or ``floppy``.
|
||||||
|
================ ============ ==============================================
|
||||||
|
|
||||||
Known Issues
|
Known Issues
|
||||||
============
|
============
|
||||||
|
|
||||||
|
@ -653,11 +675,12 @@ settings.
|
||||||
.. _Ironic_RAID: https://docs.openstack.org/ironic/latest/admin/raid.html
|
.. _Ironic_RAID: https://docs.openstack.org/ironic/latest/admin/raid.html
|
||||||
.. _iDRAC: https://www.dell.com/idracmanuals
|
.. _iDRAC: https://www.dell.com/idracmanuals
|
||||||
|
|
||||||
Vendor passthru timeout
|
WSMAN vendor passthru timeout
|
||||||
-----------------------
|
-----------------------------
|
||||||
|
|
||||||
When iDRAC is not ready and executing vendor passthru commands, they take more
|
When iDRAC is not ready and executing WSMAN vendor passthru commands, they take
|
||||||
time as waiting for iDRAC to become ready again and then time out, for example:
|
more time as waiting for iDRAC to become ready again and then time out,
|
||||||
|
for example:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
|
|
|
@ -72,7 +72,7 @@ class RedfishVendorPassthru(base.VendorInterface):
|
||||||
@METRICS.timer('RedfishVendorPassthru.eject_vmedia')
|
@METRICS.timer('RedfishVendorPassthru.eject_vmedia')
|
||||||
@base.passthru(['POST'],
|
@base.passthru(['POST'],
|
||||||
description=_("Eject a virtual media device. If no device "
|
description=_("Eject a virtual media device. If no device "
|
||||||
"is provided than all attached devices will "
|
"is provided then all attached devices will "
|
||||||
"be ejected. "
|
"be ejected. "
|
||||||
"Optional arguments: "
|
"Optional arguments: "
|
||||||
"'boot_device' - the boot device to eject, "
|
"'boot_device' - the boot device to eject, "
|
||||||
|
|
Loading…
Reference in New Issue