Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 83ff9ab6a5ef4af27ec47df9dad54d160df49f04 / . / static / redfish / v1 / JsonSchemas / Bios / Bios.json
blob: de2936acf1a2fe0fc9e8fd5cdf309d362b4799a2 [file] [log] [blame]
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]1{
2 "$ref": "#/definitions/Bios",
3 "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema.v1_3_0.json",
4 "copyright": "Copyright 2014-2017 Distributed Management Task Force, Inc. (DMTF). For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
5 "definitions": {
6 "Actions": {
7 "additionalProperties": false,
8 "description": "The available actions for this resource.",
9 "longDescription": "This type shall contain the available actions for this resource.",
10 "patternProperties": {
11 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
12 "description": "This property shall specify a valid odata or Redfish property.",
13 "type": [
14 "array",
15 "boolean",
16 "number",
17 "null",
18 "object",
19 "string"
20 ]
21 }
22 },
23 "properties": {
24 "#Bios.ChangePassword": {
25 "$ref": "#/definitions/ChangePassword"
26 },
27 "#Bios.ResetBios": {
28 "$ref": "#/definitions/ResetBios"
29 },
30 "Oem": {
31 "$ref": "#/definitions/OemActions"
32 }
33 },
34 "type": "object"
35 },
36 "Attributes": {
37 "additionalProperties": false,
38 "description": "The manufacturer/provider-specific list of BIOS attributes.",
39 "longDescription": "This type shall describe BIOS Attribute settings as additional properties in this object, and can be looked up in the Attribute Registry by their AttributeName.",
40 "patternProperties": {
41 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
42 "description": "This property shall specify a valid odata or Redfish property.",
43 "type": [
44 "array",
45 "boolean",
46 "number",
47 "null",
48 "object",
49 "string"
50 ]
51 },
52 "^[A-Za-z][A-Za-z0-9_]+$": {
53 "type": [
54 "string",
55 "boolean",
56 "number",
57 "null"
58 ]
59 }
60 },
61 "properties": {},
62 "type": "object"
63 },
64 "Bios": {
65 "additionalProperties": true,
66 "description": "The Bios schema contains properties related to the BIOS Attribute Registry. The Attribute Registry describes the system-specific BIOS attributes and Actions for changing to BIOS settings. Changes to the BIOS typically require a system reset before they take effect.",
67 "longDescription": "This resource shall be used to represent BIOS attributes for a Redfish implementation.",
68 "patternProperties": {
69 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
70 "description": "This property shall specify a valid odata or Redfish property.",
71 "type": [
72 "array",
73 "boolean",
74 "number",
75 "null",
76 "object",
77 "string"
78 ]
79 }
80 },
81 "properties": {
82 "@odata.context": {
83 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/context"
84 },
85 "@odata.id": {
86 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/id"
87 },
88 "@odata.type": {
89 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/type"
90 },
91 "Actions": {
92 "$ref": "#/definitions/Actions",
93 "description": "The available actions for this resource.",
94 "longDescription": "The Actions property shall contain the available actions for this resource."
95 },
96 "AttributeRegistry": {
97 "description": "The Resource ID of the Attribute Registry that has the system-specific information about a BIOS resource.",
98 "longDescription": "The reference to the Attribute Registry that lists the metadata describing the BIOS attribute settings in this resource.",
99 "readonly": true,
100 "type": [
101 "string",
102 "null"
103 ]
104 },
105 "Attributes": {
106 "$ref": "#/definitions/Attributes",
107 "description": "The list of BIOS attributes specific to the manufacturer or provider.",
108 "longDescription": "BIOS Attribute settings appear as additional properties in this object, and can be looked up in the Attribute Registry by their AttributeName."
109 },
110 "Description": {
111 "anyOf": [
112 {
113 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
114 },
115 {
116 "type": "null"
117 }
118 ],
119 "readonly": true
120 },
121 "Id": {
122 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
123 "readonly": true
124 },
125 "Name": {
126 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
127 "readonly": true
128 },
129 "Oem": {
130 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
131 "description": "This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.",
132 "longDescription": "The value of this string shall be of the format for the reserved word *Oem*."
133 }
134 },
135 "required": [
136 "Id",
137 "Name"
138 ],
139 "type": "object"
140 },
141 "ChangePassword": {
142 "additionalProperties": false,
143 "description": "This action is used to change the BIOS passwords.",
144 "longDescription": "This action shall perform a change of the selected BIOS password.",
145 "parameters": {
146 "NewPassword": {
147 "description": "The value of the new BIOS password.",
148 "longDescription": "This parameter shall define the value of the new BIOS password.",
149 "requiredParameter": true,
150 "type": "string"
151 },
152 "OldPassword": {
153 "description": "The value of the existing password.",
154 "longDescription": "This parameter shall define the value of the existing BIOS password that is about to be changed.",
155 "requiredParameter": true,
156 "type": "string"
157 },
158 "PasswordName": {
159 "description": "The name of the BIOS password to change.",
160 "longDescription": "This parameter shall define the BIOS password name to change. For instance, this could be the AdminPassword or UserPassword.",
161 "requiredParameter": true,
162 "type": "string"
163 }
164 },
165 "patternProperties": {
166 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
167 "description": "This property shall specify a valid odata or Redfish property.",
168 "type": [
169 "array",
170 "boolean",
171 "number",
172 "null",
173 "object",
174 "string"
175 ]
176 }
177 },
178 "properties": {
179 "target": {
180 "description": "Link to invoke action",
181 "format": "uri",
182 "type": "string"
183 },
184 "title": {
185 "description": "Friendly action name",
186 "type": "string"
187 }
188 },
189 "type": "object"
190 },
191 "OemActions": {
192 "additionalProperties": true,
193 "description": "The available OEM specific actions for this resource.",
194 "longDescription": "This type shall contain any additional OEM actions for this resource.",
195 "patternProperties": {
196 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
197 "description": "This property shall specify a valid odata or Redfish property.",
198 "type": [
199 "array",
200 "boolean",
201 "number",
202 "null",
203 "object",
204 "string"
205 ]
206 }
207 },
208 "properties": {},
209 "type": "object"
210 },
211 "ResetBios": {
212 "additionalProperties": false,
213 "description": "This action is used to reset the BIOS attributes to default.",
214 "longDescription": "This action shall perform a reset of the BIOS attributes to teir default values.",
215 "parameters": {},
216 "patternProperties": {
217 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
218 "description": "This property shall specify a valid odata or Redfish property.",
219 "type": [
220 "array",
221 "boolean",
222 "number",
223 "null",
224 "object",
225 "string"
226 ]
227 }
228 },
229 "properties": {
230 "target": {
231 "description": "Link to invoke action",
232 "format": "uri",
233 "type": "string"
234 },
235 "title": {
236 "description": "Friendly action name",
237 "type": "string"
238 }
239 },
240 "type": "object"
241 }
242 },
243 "title": "#Bios.v1_0_3.Bios"
244}