blob: 372bb4632ba7c40fe1d01643350d0169e103d474 [file] [log] [blame]
Ed Tanous118b1c72018-09-13 13:45:51 -07001{
Gunnar Millsa778c022020-05-12 12:20:36 -05002 "$id": "http://redfish.dmtf.org/schemas/v1/SecureBoot.v1_1_0.json",
Ed Tanous118b1c72018-09-13 13:45:51 -07003 "$ref": "#/definitions/SecureBoot",
Ed Tanous530520e2019-01-02 13:41:37 -08004 "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
Gunnar Millsa778c022020-05-12 12:20:36 -05005 "copyright": "Copyright 2014-2020 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
Ed Tanous118b1c72018-09-13 13:45:51 -07006 "definitions": {
7 "Actions": {
8 "additionalProperties": false,
Gunnar Millsa778c022020-05-12 12:20:36 -05009 "description": "The available actions for this resource.",
10 "longDescription": "This type shall contain the available actions for this resource.",
Ed Tanous118b1c72018-09-13 13:45:51 -070011 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -070012 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -070013 "description": "This property shall specify a valid odata or Redfish property.",
14 "type": [
15 "array",
16 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -080017 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -070018 "number",
19 "null",
20 "object",
21 "string"
22 ]
23 }
24 },
25 "properties": {
26 "#SecureBoot.ResetKeys": {
27 "$ref": "#/definitions/ResetKeys"
28 },
29 "Oem": {
Ed Tanous530520e2019-01-02 13:41:37 -080030 "$ref": "#/definitions/OemActions",
Gunnar Millsa778c022020-05-12 12:20:36 -050031 "description": "The available OEM-specific actions for this resource.",
32 "longDescription": "This property shall contain the available OEM-specific actions for this resource."
Ed Tanous118b1c72018-09-13 13:45:51 -070033 }
34 },
35 "type": "object"
36 },
37 "OemActions": {
38 "additionalProperties": true,
Gunnar Millsa778c022020-05-12 12:20:36 -050039 "description": "The available OEM-specific actions for this resource.",
40 "longDescription": "This type shall contain the available OEM-specific actions for this resource.",
Ed Tanous118b1c72018-09-13 13:45:51 -070041 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -070042 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -070043 "description": "This property shall specify a valid odata or Redfish property.",
44 "type": [
45 "array",
46 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -080047 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -070048 "number",
49 "null",
50 "object",
51 "string"
52 ]
53 }
54 },
55 "properties": {},
56 "type": "object"
57 },
58 "ResetKeys": {
59 "additionalProperties": false,
Gunnar Millsa778c022020-05-12 12:20:36 -050060 "description": "This action resets the UEFI Secure Boot keys.",
61 "longDescription": "This action shall reset the UEFI Secure Boot key databases. The `ResetAllKeysToDefault` value shall reset all UEFI Secure Boot key databases to their default values. The `DeleteAllKeys` value shall delete the content of all UEFI Secure Boot key databases. The `DeletePK` value shall delete the content of the PK Secure Boot key database.",
Ed Tanous118b1c72018-09-13 13:45:51 -070062 "parameters": {
63 "ResetKeysType": {
64 "$ref": "#/definitions/ResetKeysType",
Gunnar Millsa778c022020-05-12 12:20:36 -050065 "description": "The type of reset or delete to perform on the UEFI Secure Boot databases.",
66 "longDescription": "This parameter shall specify the type of reset or delete to perform on the UEFI Secure Boot databases.",
Ed Tanous118b1c72018-09-13 13:45:51 -070067 "requiredParameter": true
68 }
69 },
70 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -070071 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -070072 "description": "This property shall specify a valid odata or Redfish property.",
73 "type": [
74 "array",
75 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -080076 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -070077 "number",
78 "null",
79 "object",
80 "string"
81 ]
82 }
83 },
84 "properties": {
85 "target": {
86 "description": "Link to invoke action",
Ed Tanouscb103132019-10-08 11:34:22 -070087 "format": "uri-reference",
Ed Tanous118b1c72018-09-13 13:45:51 -070088 "type": "string"
89 },
90 "title": {
91 "description": "Friendly action name",
92 "type": "string"
93 }
94 },
95 "type": "object"
96 },
97 "ResetKeysType": {
98 "enum": [
99 "ResetAllKeysToDefault",
100 "DeleteAllKeys",
101 "DeletePK"
102 ],
103 "enumDescriptions": {
Gunnar Millsa778c022020-05-12 12:20:36 -0500104 "DeleteAllKeys": "Delete the contents of all UEFI Secure Boot key databases, including the PK key database. This puts the system in Setup Mode.",
105 "DeletePK": "Delete the contents of the PK UEFI Secure Boot database. This puts the system in Setup Mode.",
106 "ResetAllKeysToDefault": "Reset the contents of all UEFI Secure Boot key databases, including the PK key database, to the default values."
Ed Tanous118b1c72018-09-13 13:45:51 -0700107 },
108 "type": "string"
109 },
110 "SecureBoot": {
111 "additionalProperties": false,
Ed Tanouscb103132019-10-08 11:34:22 -0700112 "description": "The SecureBoot schema contains UEFI Secure Boot information and represents properties for managing the UEFI Secure Boot functionality of a system.",
Gunnar Millsa778c022020-05-12 12:20:36 -0500113 "longDescription": "This resource contains UEFI Secure Boot information for a Redfish implementation.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700114 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700115 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700116 "description": "This property shall specify a valid odata or Redfish property.",
117 "type": [
118 "array",
119 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800120 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700121 "number",
122 "null",
123 "object",
124 "string"
125 ]
126 }
127 },
128 "properties": {
129 "@odata.context": {
Ed Tanouscb103132019-10-08 11:34:22 -0700130 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
Ed Tanous530520e2019-01-02 13:41:37 -0800131 },
132 "@odata.etag": {
Ed Tanouscb103132019-10-08 11:34:22 -0700133 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
Ed Tanous118b1c72018-09-13 13:45:51 -0700134 },
135 "@odata.id": {
Ed Tanouscb103132019-10-08 11:34:22 -0700136 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
Ed Tanous118b1c72018-09-13 13:45:51 -0700137 },
138 "@odata.type": {
Ed Tanouscb103132019-10-08 11:34:22 -0700139 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
Ed Tanous118b1c72018-09-13 13:45:51 -0700140 },
141 "Actions": {
142 "$ref": "#/definitions/Actions",
Gunnar Millsa778c022020-05-12 12:20:36 -0500143 "description": "The available actions for this resource.",
144 "longDescription": "This property shall contain the available actions for this resource."
Ed Tanous118b1c72018-09-13 13:45:51 -0700145 },
146 "Description": {
147 "anyOf": [
148 {
149 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
150 },
151 {
152 "type": "null"
153 }
154 ],
155 "readonly": true
156 },
157 "Id": {
158 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
159 "readonly": true
160 },
161 "Name": {
162 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
163 "readonly": true
164 },
165 "Oem": {
166 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
Ed Tanouscb103132019-10-08 11:34:22 -0700167 "description": "The OEM extension property.",
168 "longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
Ed Tanous118b1c72018-09-13 13:45:51 -0700169 },
170 "SecureBootCurrentBoot": {
171 "anyOf": [
172 {
173 "$ref": "#/definitions/SecureBootCurrentBootType"
174 },
175 {
176 "type": "null"
177 }
178 ],
Gunnar Millsa778c022020-05-12 12:20:36 -0500179 "description": "The UEFI Secure Boot state during the current boot cycle.",
Ed Tanouscb103132019-10-08 11:34:22 -0700180 "longDescription": "This property shall indicate the UEFI Secure Boot state during the current boot cycle.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700181 "readonly": true
182 },
Gunnar Millsa778c022020-05-12 12:20:36 -0500183 "SecureBootDatabases": {
184 "$ref": "http://redfish.dmtf.org/schemas/v1/SecureBootDatabaseCollection.json#/definitions/SecureBootDatabaseCollection",
185 "description": "A link to the collection of UEFI Secure Boot databases.",
186 "longDescription": "The value of this property shall be a link to a resource collection of type SecureBootDatabaseCollection.",
187 "readonly": true,
188 "versionAdded": "v1_1_0"
189 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700190 "SecureBootEnable": {
Ed Tanouscb103132019-10-08 11:34:22 -0700191 "description": "An indication of whether UEFI Secure Boot is enabled.",
192 "longDescription": "This property shall indicate whether the UEFI Secure Boot takes effect on next boot. This property can be enabled in UEFI boot mode only.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700193 "readonly": false,
194 "type": [
195 "boolean",
196 "null"
197 ]
198 },
199 "SecureBootMode": {
200 "anyOf": [
201 {
202 "$ref": "#/definitions/SecureBootModeType"
203 },
204 {
205 "type": "null"
206 }
207 ],
Gunnar Millsa778c022020-05-12 12:20:36 -0500208 "description": "The current UEFI Secure Boot Mode.",
209 "longDescription": "This property shall contain the current UEFI Secure Boot mode, as defined in the UEFI Specification.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700210 "readonly": true
211 }
212 },
213 "required": [
Ed Tanous530520e2019-01-02 13:41:37 -0800214 "@odata.id",
215 "@odata.type",
Ed Tanous118b1c72018-09-13 13:45:51 -0700216 "Id",
217 "Name"
218 ],
219 "type": "object"
220 },
221 "SecureBootCurrentBootType": {
222 "enum": [
223 "Enabled",
224 "Disabled"
225 ],
226 "enumDescriptions": {
Gunnar Millsa778c022020-05-12 12:20:36 -0500227 "Disabled": "UEFI Secure Boot is currently disabled.",
228 "Enabled": "UEFI Secure Boot is currently enabled."
Ed Tanous118b1c72018-09-13 13:45:51 -0700229 },
230 "type": "string"
231 },
232 "SecureBootModeType": {
233 "enum": [
234 "SetupMode",
235 "UserMode",
236 "AuditMode",
237 "DeployedMode"
238 ],
239 "enumDescriptions": {
Gunnar Millsa778c022020-05-12 12:20:36 -0500240 "AuditMode": "UEFI Secure Boot is currently in Audit Mode.",
241 "DeployedMode": "UEFI Secure Boot is currently in Deployed Mode.",
242 "SetupMode": "UEFI Secure Boot is currently in Setup Mode.",
243 "UserMode": "UEFI Secure Boot is currently in User Mode."
Ed Tanous118b1c72018-09-13 13:45:51 -0700244 },
245 "type": "string"
246 }
247 },
Ed Tanous530520e2019-01-02 13:41:37 -0800248 "owningEntity": "DMTF",
Gunnar Millsa778c022020-05-12 12:20:36 -0500249 "release": "2020.1",
250 "title": "#SecureBoot.v1_1_0.SecureBoot"
Ed Tanous118b1c72018-09-13 13:45:51 -0700251}