static/redfish/v1/JsonSchemas/SecureBoot/index.json

{
    "$ref": "#/definitions/SecureBoot",
    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema.v1_3_0.json",
    "copyright": "Copyright 2014-2017 Distributed Management Task Force, Inc. (DMTF). For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
    "definitions": {
        "Actions": {
            "additionalProperties": false,
            "description": "The available actions for this resource.",
            "longDescription": "This type shall contain the available actions for this resource.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "#SecureBoot.ResetKeys": {
                    "$ref": "#/definitions/ResetKeys"
                },
                "Oem": {
                    "$ref": "#/definitions/OemActions"
                }
            },
            "type": "object"
        },
        "OemActions": {
            "additionalProperties": true,
            "description": "The available OEM specific actions for this resource.",
            "longDescription": "This type shall contain any additional OEM actions for this resource.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {},
            "type": "object"
        },
        "ResetKeys": {
            "additionalProperties": false,
            "description": "This action is used to reset the Secure Boot keys.",
            "longDescription": "This action shall perform a reset of the Secure Boot key databases. The ResetAllKeysToDefault value shall reset the UEFI Secure Boot key databases to their default values. The DeleteAllKeys value shall delete the content of the UEFI Secure Boot key databases. The DeletePK value shall delete the content of the PK Secure boot key.",
            "parameters": {
                "ResetKeysType": {
                    "$ref": "#/definitions/ResetKeysType",
                    "description": "The type of keys to reset or delete.",
                    "longDescription": "This parameter shall specify the type of keys to reset or delete.",
                    "requiredParameter": true
                }
            },
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "target": {
                    "description": "Link to invoke action",
                    "format": "uri",
                    "type": "string"
                },
                "title": {
                    "description": "Friendly action name",
                    "type": "string"
                }
            },
            "type": "object"
        },
        "ResetKeysType": {
            "enum": [
                "ResetAllKeysToDefault",
                "DeleteAllKeys",
                "DeletePK"
            ],
            "enumDescriptions": {
                "DeleteAllKeys": "Delete the content of all UEFI Secure Boot key databases (PK, KEK, DB, DBX). This puts the system in Setup Mode.",
                "DeletePK": "Delete the content of the PK UEFI Secure Boot database. This puts the system in Setup Mode.",
                "ResetAllKeysToDefault": "Reset the content of all UEFI Secure Boot key databases (PK, KEK, DB, DBX) to their default values."
            },
            "type": "string"
        },
        "SecureBoot": {
            "additionalProperties": false,
            "description": "This resource contains UEFI Secure Boot information. It represents properties for managing the UEFI Secure Boot functionality of a system.",
            "longDescription": "This resource shall be used to represent a UEFI Secure Boot resource for a Redfish implementation.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "@odata.context": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/context"
                },
                "@odata.id": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/id"
                },
                "@odata.type": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/type"
                },
                "Actions": {
                    "$ref": "#/definitions/Actions",
                    "description": "The available actions for this resource.",
                    "longDescription": "The Actions property shall contain the available actions for this resource."
                },
                "Description": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "readonly": true
                },
                "Id": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
                    "readonly": true
                },
                "Name": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
                    "readonly": true
                },
                "Oem": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
                    "description": "This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.",
                    "longDescription": "The value of this string shall be of the format for the reserved word *Oem*."
                },
                "SecureBootCurrentBoot": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/SecureBootCurrentBootType"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "Secure Boot state during the current boot cycle.",
                    "longDescription": "The value of this property shall indicate the UEFI Secure Boot state during the current boot cycle.",
                    "readonly": true
                },
                "SecureBootEnable": {
                    "description": "Enable or disable UEFI Secure Boot (takes effect on next boot).",
                    "longDescription": "Setting this property to true enables UEFI Secure Boot, and setting it to false disables it. This property can be enabled only in UEFI boot mode.",
                    "readonly": false,
                    "type": [
                        "boolean",
                        "null"
                    ]
                },
                "SecureBootMode": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/SecureBootModeType"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "Current Secure Boot Mode.",
                    "longDescription": "This property shall contain the current Secure Boot mode, as defined in the UEFI Specification.",
                    "readonly": true
                }
            },
            "required": [
                "Id",
                "Name"
            ],
            "type": "object"
        },
        "SecureBootCurrentBootType": {
            "enum": [
                "Enabled",
                "Disabled"
            ],
            "enumDescriptions": {
                "Disabled": "Secure Boot is currently disabled.",
                "Enabled": "Secure Boot is currently enabled."
            },
            "type": "string"
        },
        "SecureBootModeType": {
            "enum": [
                "SetupMode",
                "UserMode",
                "AuditMode",
                "DeployedMode"
            ],
            "enumDescriptions": {
                "AuditMode": "Secure Boot is currently in Audit Mode.",
                "DeployedMode": "Secure Boot is currently in Deployed Mode.",
                "SetupMode": "Secure Boot is currently in Setup Mode.",
                "UserMode": "Secure Boot is currently in User Mode."
            },
            "type": "string"
        }
    },
    "title": "#SecureBoot.v1_0_3.SecureBoot"
}