Move to 2020.1
Make changes to update_schemas.py needed for the move and run
update_schemas.py.
Need 1.3.6 or later version of Redfish-Service-Validator.
CI uses the master branch of Redfish-Service-Validator, which has
this fix.
Redfish-Service-Validators before 1.3.6 will incorrectly throw errors in
message registries like (Task Event Message Registry)
/redfish/v1/Registries/TaskEvent/TaskEvent and (Base Message Registry)
/redfish/v1/Registries/Base/Base.
For more information:
https://redfishforum.com/thread/323/validator-errors-when-moving-release
This does introduce some "warnDeprecated" due to "Severity" becoming
Deprecated in MessageRegistry v1_4_0. Since all bmcweb Registries are
<v1_4_0, not a real problem. Redfish has no Base Message Registry and
Task Event Message Registry available to move to something that
uses MessageRegistry v1_4_0. Will take up with Redfish.
2020.1 includes new features like AutoRebot (Boot -> AutomaticRetry),
factory reset (ResetToDefaults action), and Modified Event Log property
which are in OpenBMC's D-Bus interfaces today.
Tested: Built bmcweb, loaded on a Witherspoon, and ran
the validator. Validator passed.
See new schemas:
curl -k https://${bmc}/redfish/v1/JsonSchemas/SecureBootDatabase
{
"@odata.context": "/redfish/v1/$metadata#JsonSchemaFile.JsonSchemaFile",
"@odata.id": "/redfish/v1/JsonSchemas/SecureBootDatabase",
"@odata.type": "#JsonSchemaFile.v1_0_2.JsonSchemaFile",
"Name": "SecureBootDatabase Schema File",
Change-Id: If30fcc50276aea44d8a77ed547ee0cbd72e4cf1a
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
diff --git a/static/redfish/v1/schema/SecureBoot_v1.xml b/static/redfish/v1/schema/SecureBoot_v1.xml
index b0e3042..de9f1be 100644
--- a/static/redfish/v1/schema/SecureBoot_v1.xml
+++ b/static/redfish/v1/schema/SecureBoot_v1.xml
@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="UTF-8"?>
<!---->
<!--################################################################################ -->
-<!--# Redfish Schema: SecureBoot v1.0.6 -->
+<!--# Redfish Schema: SecureBoot v1.1.0 -->
<!--# -->
<!--# For a detailed change log, see the README file contained in the DSP8010 bundle, -->
<!--# available at http://www.dmtf.org/standards/redfish -->
-<!--# Copyright 2014-2019 DMTF. -->
+<!--# Copyright 2014-2020 DMTF. -->
<!--# For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright -->
<!--################################################################################ -->
<!---->
@@ -23,6 +23,9 @@
<edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
<edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
</edmx:Reference>
+ <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/SecureBootDatabaseCollection_v1.xml">
+ <edmx:Include Namespace="SecureBootDatabaseCollection"/>
+ </edmx:Reference>
<edmx:DataServices>
@@ -31,7 +34,7 @@
<EntityType Name="SecureBoot" BaseType="Resource.v1_0_0.Resource" Abstract="true">
<Annotation Term="OData.Description" String="The SecureBoot schema contains UEFI Secure Boot information and represents properties for managing the UEFI Secure Boot functionality of a system."/>
- <Annotation Term="OData.LongDescription" String="This Resource contains a UEFI Secure Boot Resource for a Redfish implementation."/>
+ <Annotation Term="OData.LongDescription" String="This resource contains UEFI Secure Boot information for a Redfish implementation."/>
<Annotation Term="Capabilities.InsertRestrictions">
<Record>
<PropertyValue Property="Insertable" Bool="false"/>
@@ -58,15 +61,14 @@
</EntityType>
<Action Name="ResetKeys" IsBound="true">
+ <Annotation Term="OData.Description" String="This action resets the UEFI Secure Boot keys."/>
+ <Annotation Term="OData.LongDescription" String="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."/>
<Parameter Name="SecureBoot" Type="SecureBoot.v1_0_0.Actions"/>
<Parameter Name="ResetKeysType" Type="SecureBoot.v1_0_0.ResetKeysType" Nullable="false">
- <Annotation Term="OData.Description" String="The type of keys to reset or delete."/>
- <Annotation Term="OData.LongDescription" String="This parameter shall specify the type of keys to reset or delete."/>
+ <Annotation Term="OData.Description" String="The type of reset or delete to perform on the UEFI Secure Boot databases."/>
+ <Annotation Term="OData.LongDescription" String="This parameter shall specify the type of reset or delete to perform on the UEFI Secure Boot databases."/>
</Parameter>
- <Annotation Term="OData.Description" String="This action resets the Secure Boot keys."/>
- <Annotation Term="OData.LongDescription" String="This action shall 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."/>
</Action>
-
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="SecureBoot.v1_0_0">
@@ -81,72 +83,71 @@
</Property>
<Property Name="SecureBootCurrentBoot" Type="SecureBoot.v1_0_0.SecureBootCurrentBootType">
<Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
- <Annotation Term="OData.Description" String="Secure Boot state during the current boot cycle."/>
+ <Annotation Term="OData.Description" String="The UEFI Secure Boot state during the current boot cycle."/>
<Annotation Term="OData.LongDescription" String="This property shall indicate the UEFI Secure Boot state during the current boot cycle."/>
</Property>
<Property Name="SecureBootMode" Type="SecureBoot.v1_0_0.SecureBootModeType">
<Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
- <Annotation Term="OData.Description" String="Current Secure Boot Mode."/>
- <Annotation Term="OData.LongDescription" String="This property shall contain the current Secure Boot mode, as defined in the UEFI Specification."/>
+ <Annotation Term="OData.Description" String="The current UEFI Secure Boot Mode."/>
+ <Annotation Term="OData.LongDescription" String="This property shall contain the current UEFI Secure Boot mode, as defined in the UEFI Specification."/>
</Property>
<Property Name="Actions" Type="SecureBoot.v1_0_0.Actions" Nullable="false">
- <Annotation Term="OData.Description" String="The available actions for this Resource."/>
- <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this Resource."/>
+ <Annotation Term="OData.Description" String="The available actions for this resource."/>
+ <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this resource."/>
</Property>
</EntityType>
<EnumType Name="SecureBootCurrentBootType">
<Member Name="Enabled">
- <Annotation Term="OData.Description" String="Secure Boot is currently enabled."/>
+ <Annotation Term="OData.Description" String="UEFI Secure Boot is currently enabled."/>
</Member>
<Member Name="Disabled">
- <Annotation Term="OData.Description" String="Secure Boot is currently disabled."/>
+ <Annotation Term="OData.Description" String="UEFI Secure Boot is currently disabled."/>
</Member>
</EnumType>
<EnumType Name="SecureBootModeType">
<Member Name="SetupMode">
- <Annotation Term="OData.Description" String="Secure Boot is currently in Setup Mode."/>
+ <Annotation Term="OData.Description" String="UEFI Secure Boot is currently in Setup Mode."/>
</Member>
<Member Name="UserMode">
- <Annotation Term="OData.Description" String="Secure Boot is currently in User Mode."/>
+ <Annotation Term="OData.Description" String="UEFI Secure Boot is currently in User Mode."/>
</Member>
<Member Name="AuditMode">
- <Annotation Term="OData.Description" String="Secure Boot is currently in Audit Mode."/>
+ <Annotation Term="OData.Description" String="UEFI Secure Boot is currently in Audit Mode."/>
</Member>
<Member Name="DeployedMode">
- <Annotation Term="OData.Description" String="Secure Boot is currently in Deployed Mode."/>
+ <Annotation Term="OData.Description" String="UEFI Secure Boot is currently in Deployed Mode."/>
</Member>
</EnumType>
<EnumType Name="ResetKeysType">
<Member Name="ResetAllKeysToDefault">
- <Annotation Term="OData.Description" String="Reset the content of all UEFI Secure Boot key databases (PK, KEK, DB, DBX) to their default values."/>
+ <Annotation Term="OData.Description" String="Reset the contents of all UEFI Secure Boot key databases, including the PK key database, to the default values."/>
</Member>
<Member Name="DeleteAllKeys">
- <Annotation Term="OData.Description" String="Delete the content of all UEFI Secure Boot key databases (PK, KEK, DB, DBX). This puts the system in Setup Mode."/>
+ <Annotation Term="OData.Description" String="Delete the contents of all UEFI Secure Boot key databases, including the PK key database. This puts the system in Setup Mode."/>
</Member>
<Member Name="DeletePK">
- <Annotation Term="OData.Description" String="Delete the content of the PK UEFI Secure Boot database. This puts the system in Setup Mode."/>
+ <Annotation Term="OData.Description" String="Delete the contents of the PK UEFI Secure Boot database. This puts the system in Setup Mode."/>
</Member>
</EnumType>
<ComplexType Name="Actions">
<Annotation Term="OData.AdditionalProperties" Bool="false"/>
- <Annotation Term="OData.Description" String="The available actions for this Resource."/>
- <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this Resource."/>
+ <Annotation Term="OData.Description" String="The available actions for this resource."/>
+ <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
<Property Name="Oem" Type="SecureBoot.v1_0_0.OemActions" Nullable="false">
- <Annotation Term="OData.Description" String="The available OEM-specific actions for this Resource."/>
- <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this Resource."/>
+ <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
+ <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this resource."/>
</Property>
</ComplexType>
<ComplexType Name="OemActions">
<Annotation Term="OData.AdditionalProperties" Bool="true"/>
- <Annotation Term="OData.Description" String="The available OEM-specific actions for this Resource."/>
- <Annotation Term="OData.LongDescription" String="This type shall contain the available OEM-specific actions for this Resource."/>
+ <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
+ <Annotation Term="OData.LongDescription" String="This type shall contain the available OEM-specific actions for this resource."/>
</ComplexType>
-
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="SecureBoot.v1_0_1">
@@ -185,5 +186,25 @@
<EntityType Name="SecureBoot" BaseType="SecureBoot.v1_0_5.SecureBoot"/>
</Schema>
+ <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="SecureBoot.v1_0_7">
+ <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
+ <Annotation Term="OData.Description" String="This version was created to update descriptions as needed to reference UEFI Secure Boot databases."/>
+ <EntityType Name="SecureBoot" BaseType="SecureBoot.v1_0_6.SecureBoot"/>
+ </Schema>
+
+ <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="SecureBoot.v1_1_0">
+ <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
+ <Annotation Term="Redfish.Release" String="2020.1"/>
+
+ <EntityType Name="SecureBoot" BaseType="SecureBoot.v1_0_7.SecureBoot">
+ <NavigationProperty Name="SecureBootDatabases" Type="SecureBootDatabaseCollection.SecureBootDatabaseCollection" ContainsTarget="true" Nullable="false">
+ <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
+ <Annotation Term="OData.Description" String="A link to the collection of UEFI Secure Boot databases."/>
+ <Annotation Term="OData.LongDescription" String="The value of this property shall be a link to a resource collection of type SecureBootDatabaseCollection."/>
+ <Annotation Term="OData.AutoExpandReferences"/>
+ </NavigationProperty>
+ </EntityType>
+ </Schema>
+
</edmx:DataServices>
</edmx:Edmx>