ironic/api-ref/source/baremetal-api-v1-nodes-firmware.inc
Iury Gregory Melo Ferreira aecb581082 Firmware Interface
FirmwareInterface base
New Config options [default]
- enabled_firmware_interfaces
- default_firmware_interface

New FirmwareInterface base with update method
Implementations of FirmwareInterface
- FakeFirmware (fake)
- NoFirmware (no-firmware)

New entrypoint ironic.hardware.interfaces.firmware
* fake and no-firmware

Api Controllers
- Updated: driver/node/utils/versions
- Created: firmware

Unit tests
api-ref for Node Firmware

Fake and Noop implementation for FirmwareInterface

Change-Id: Ib3b9cb22099819f97d5eab1e3f1b670cb91cbb25
2023-07-11 07:39:15 -03:00

49 lines
1.1 KiB
ReStructuredText

.. -*- rst -*-
=====================
Node Firmware (nodes)
=====================
.. versionadded:: 1.84
Given a Node identifier (``uuid`` or ``name``), the API exposes the list of
all Firmware Components associated with that Node.
These endpoints do not allow modification of the Firmware Components; that
should be done by using ``clean steps``.
List all Firmware Components by Node
====================================
.. rest_method:: GET /v1/nodes/{node_ident}/firmware
Return a list of Firmware Components associated with ``node_ident``.
Normal response code: 200
Error codes: 404
Request
-------
.. rest_parameters:: parameters.yaml
- node_ident: node_ident
Response
--------
.. rest_parameters:: parameters.yaml
- firmware: firmware_components
- created_at: created_at
- updated_at: updated_at
- component: firmware_component
- initial_version: firmware_component_initial_version
- current_version: firmware_component_current_version
- last_version_flashed: firmware_component_last_version_flashed
**Example list of a Node's Firmware Components:**
.. literalinclude:: samples/node-firmware-components-list-response.json