diff options
author | Bob Fournier <bfournie@redhat.com> | 2021-06-01 11:00:24 -0400 |
---|---|---|
committer | Bob Fournier <bfournie@redhat.com> | 2021-07-13 21:56:57 -0400 |
commit | 58ca01c22ab3b33609ca1e98bd2489d871792f34 (patch) | |
tree | b6265e81522abeb04f998ec319a8facdab66fcb9 /doc/source/admin/drivers/redfish.rst | |
parent | e15440370cca1f1a998d3607910697c3129d040a (diff) | |
download | ironic-58ca01c22ab3b33609ca1e98bd2489d871792f34.tar.gz |
Add a section to redfish doc for BIOS registry fields
Move the descriptions of the BIOS registry fields in the API to
a new section in the Redfish documentation.
Change-Id: Ifedb4526113bb84ccc598e13f5767b71a60f5532
Diffstat (limited to 'doc/source/admin/drivers/redfish.rst')
-rw-r--r-- | doc/source/admin/drivers/redfish.rst | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/doc/source/admin/drivers/redfish.rst b/doc/source/admin/drivers/redfish.rst index 63f2e4bbe..24f0f11a1 100644 --- a/doc/source/admin/drivers/redfish.rst +++ b/doc/source/admin/drivers/redfish.rst @@ -478,7 +478,33 @@ In the following example, the JSON is specified directly on the command line:: firmware may result in devices in the server, or the server itself becoming inoperable. +Retrieving BIOS Settings +======================== + +When the :doc:`bios interface </admin/bios>` is set to ``redfish``, Ironic will +retrieve the node's BIOS settings as described in `BIOS Configuration`_. In +addition, via Sushy_, Ironic will get the BIOS Attribute Registry +(`BIOS Registry`_) from the node which is a schema providing details on the +settings. The following fields will be returned in the BIOS API +(``/v1/nodes/{node_ident}/bios``) along with the setting name and value: + +.. csv-table:: + :header: "Field", "Description" + :widths: 25, 120 + + "``attribute_type``", "The type of setting - ``Enumeration``, ``Integer``, ``String``, ``Boolean``, or ``Password``" + "``allowable_values``", "A list of allowable values when the attribute_type is ``Enumeration``" + "``lower_bound``", "The lowest allowed value when attribute_type is ``Integer``" + "``upper_bound``", "The highest allowed value when attribute_type is ``Integer``" + "``min_length``", "The shortest string length that the value can have when attribute_type is ``String``" + "``max_length``", "The longest string length that the value can have when attribute_type is ``String``" + "``read_only``", "The setting is ready only and cannot be modified" + "``unique``", "The setting is specific to this node" + "``reset_required``", "After changing this setting a node reboot is required" + .. _Redfish: http://redfish.dmtf.org/ .. _Sushy: https://opendev.org/openstack/sushy .. _TLS: https://en.wikipedia.org/wiki/Transport_Layer_Security .. _ESP: https://wiki.ubuntu.com/EFIBootLoaders#Booting_from_EFI +.. _`BIOS Registry`: https://redfish.dmtf.org/schemas/v1/AttributeRegistry.v1_3_5.json +.. _`BIOS Configuration`: https://docs.openstack.org/ironic/latest/admin/bios.html |