blob: c97026c15512f9643860bf085ce3a02cc74f637e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
.. -*- rst -*-
=================
Node Bios (nodes)
=================
.. versionadded:: 1.40
Given a Node identifier (``uuid`` or ``name``), the API exposes the list of
all Bios settings associated with that Node.
These endpoints do not allow modification of the Bios settings; that should be
done by using ``clean steps``.
List all Bios settings by Node
==============================
.. rest_method:: GET /v1/nodes/{node_ident}/bios
Return a list of Bios settings associated with ``node_ident``.
.. versionadded:: 1.74
Added additional fields from bios registry which can be retrieved using
``?detail=True`` (see detailed response below).
Added ``fields`` selector to query for particular fields.
Normal response code: 200
Error codes: 404
Request
-------
.. rest_parameters:: parameters.yaml
- node_ident: node_ident
- fields: fields
- detail: detail
Response
--------
.. rest_parameters:: parameters.yaml
- bios: bios_settings
- created_at: created_at
- updated_at: updated_at
- links: links
- name: bios_setting_name
- value: bios_setting_value
**Example list of a Node's Bios settings:**
.. literalinclude:: samples/node-bios-list-response.json
List detailed Bios settings by Node
===================================
.. rest_method:: GET /v1/nodes/{node_ident}/bios/?detail=True
Return a list of detailed Bios settings associated with ``node_ident``.
The detailed list includes the BIOS Attribute Registry information
retrieved via Redfish.
.. versionadded:: 1.74
Introduced
Normal response code: 200
Error codes: 404
Request
-------
.. rest_parameters:: parameters.yaml
- node_ident: node_ident
Response
--------
.. rest_parameters:: parameters.yaml
- bios: bios_settings
- created_at: created_at
- updated_at: updated_at
- links: links
- name: bios_setting_name
- value: bios_setting_value
- attribute_type: bios_setting_attribute_type
- allowable_values: bios_setting_allowable_values
- lower_bound: bios_setting_lower_bound
- max_length: bios_setting_max_length
- min_length: bios_setting_min_length
- read_only: bios_setting_read_only
- reset_required: bios_setting_reset_required
- unique: bios_setting_unique
- upper_bound: bios_setting_upper_bound
**Example list of a Node's Bios settings:**
.. literalinclude:: samples/node-bios-list-details-response.json
Show single Bios setting of a Node
==================================
.. rest_method:: GET /v1/nodes/{node_ident}/bios/{bios_setting}
Return the content of the specific bios ``bios_setting`` associated with
``node_ident``.
.. versionadded:: 1.74
Introduced fields from the BIOS registry.
Normal response code: 200
Error codes: 404
Request
-------
.. rest_parameters:: parameters.yaml
- node_ident: node_ident
- bios_setting: bios_setting
Response
--------
.. rest_parameters:: parameters.yaml
- <key>: d_bios_setting
- created_at: created_at
- updated_at: updated_at
- links: links
- name: bios_setting_name
- value: bios_setting_value
- attribute_type: bios_setting_attribute_type
- allowable_values: bios_setting_allowable_values
- lower_bound: bios_setting_lower_bound
- max_length: bios_setting_max_length
- min_length: bios_setting_min_length
- read_only: bios_setting_read_only
- reset_required: bios_setting_reset_required
- unique: bios_setting_unique
- upper_bound: bios_setting_upper_bound
**Example details of a Node's Bios setting details:**
.. literalinclude:: samples/node-bios-detail-response.json
|
