diff options
author | AppaRao Puli <apparao.puli@linux.intel.com> | 2019-10-18 14:46:08 +0300 |
---|---|---|
committer | AppaRao Puli <apparao.puli@linux.intel.com> | 2019-10-30 21:23:12 +0300 |
commit | a6349918ad2c88533c6d09bb876812375a19f2c4 (patch) | |
tree | 3d77485f6d35b097cbf656ddd3c49bbe2884c660 /static/redfish/v1 | |
parent | 52efa5d69092219f41e1634163a3e4fa598c596c (diff) | |
download | bmcweb-a6349918ad2c88533c6d09bb876812375a19f2c4.tar.xz |
Added OemComputerSystems and properties for provisioning
- Added OemComputerSystems Schema for provisioning properties
- Added "ProvisioningStatus" Oem property with EnumType
1) NotProvisioned
2) ProvisionedButNotLocked
3) ProvisionedAndLocked
Intel secures platform firmware components using Intel PFR mechanism.
This may differ for other Oem's(non-intel platforms) but the properties
like Provisioned, Locked states should be of generic as per NIST SP
800-193. Added build time flag to enable/disable PFR supported platforms.
Tested:
- By default provisioning feature is OFF, using GET method on below URI
verified Oem Property and observed no such property. This is default
behaviour on upstream.
URI: /redfish/v1/Systems/system
Response: No "Oem" property.
- Enabled provisioning feature in Intel platforms and Verified using Systems
URI. Ran the redfish validator tool and no new issues found due to this
change.
URI: /redfish/v1/Systems/system
RESPONSE:
.....
"Oem": {
"OpenBmc": {
"FirmwareProvisioning": {
"ProvisioningStatus": "NotProvisioned"
}
}
}
.....
Signed-off-by: AppaRao Puli <apparao.puli@linux.intel.com>
Change-Id: I674e6075263f4fa2962637d3add47393a1ff0c0b
Diffstat (limited to 'static/redfish/v1')
-rw-r--r-- | static/redfish/v1/$metadata/index.xml | 2 | ||||
-rw-r--r-- | static/redfish/v1/JsonSchemas/OemComputerSystem/index.json | 111 | ||||
-rw-r--r-- | static/redfish/v1/schema/OemComputerSystem_v1.xml | 68 |
3 files changed, 181 insertions, 0 deletions
diff --git a/static/redfish/v1/$metadata/index.xml b/static/redfish/v1/$metadata/index.xml index 48090d46f7..73833652d7 100644 --- a/static/redfish/v1/$metadata/index.xml +++ b/static/redfish/v1/$metadata/index.xml @@ -1877,5 +1877,7 @@ </edmx:Reference> <edmx:Reference Uri="/redfish/v1/schema/Crashdump_v1.xml"> <edmx:Include Namespace="Crashdump.v1_0_0"/> + <edmx:Reference Uri="/redfish/v1/schema/OemComputerSystem_v1.xml"> + <edmx:Include Namespace="OemComputerSystem"/> </edmx:Reference> </edmx:Edmx> diff --git a/static/redfish/v1/JsonSchemas/OemComputerSystem/index.json b/static/redfish/v1/JsonSchemas/OemComputerSystem/index.json new file mode 100644 index 0000000000..1423af5e89 --- /dev/null +++ b/static/redfish/v1/JsonSchemas/OemComputerSystem/index.json @@ -0,0 +1,111 @@ +{ + "$id": "http://redfish.dmtf.org/schemas/v1/OemComputerSystem.json", + "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json", + "copyright": "Copyright 2014-2019 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright", + "definitions": { + "FirmwareProvisioning": { + "additionalProperties": false, + "description": "Configuration data for platform firmware provisioning.", + "patternProperties": { + "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { + "description": "This property shall specify a valid odata or Redfish property.", + "type": [ + "array", + "boolean", + "integer", + "number", + "null", + "object", + "string" + ] + } + }, + "properties": { + "ProvisioningStatus": { + "anyOf": [ + { + "$ref": "#/definitions/FirmwareProvisioningStatus" + }, + { + "type": "null" + } + ], + "description": "This indicates platform firmware provisioning state.", + "longDescription": "The value of this property indicating provisioning status of platform firmware.", + "readonly": true + } + }, + "type": "object" + }, + "FirmwareProvisioningStatus": { + "enum": [ + "NotProvisioned", + "ProvisionedButNotLocked", + "ProvisionedAndLocked" + ], + "enumDescriptions": { + "NotProvisioned": "Platform firmware is not provisioned.", + "ProvisionedAndLocked": "Platform firmware is provisioned and locked.", + "ProvisionedButNotLocked": "Platform firmware is provisioned but not locked." + }, + "enumLongDescriptions": { + "NotProvisioned": "Platform firmware is not provisioned.", + "ProvisionedAndLocked": "Platform firmware is provisioned and locked. So re-provisioning is not allowed in this state.", + "ProvisionedButNotLocked": "Platform firmware is provisioned but not locked. So re-provisioning is allowed in this state." + }, + "type": "string" + }, + "Oem": { + "additionalProperties": true, + "description": "OemComputerSystem Oem properties.", + "patternProperties": { + "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { + "description": "This property shall specify a valid odata or Redfish property.", + "type": [ + "array", + "boolean", + "integer", + "number", + "null", + "object", + "string" + ] + } + }, + "properties": { + "OpenBmc": { + "anyOf": [ + { + "$ref": "#/definitions/OpenBmc" + }, + { + "type": "null" + } + ] + } + }, + "type": "object" + }, + "OpenBmc": { + "additionalProperties": true, + "description": "Oem properties for OpenBmc.", + "patternProperties": { + "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { + "description": "This property shall specify a valid odata or Redfish property.", + "type": [ + "array", + "boolean", + "integer", + "number", + "null", + "object", + "string" + ] + } + }, + "properties": {}, + "type": "object" + } + }, + "title": "#OemComputerSystem" +} diff --git a/static/redfish/v1/schema/OemComputerSystem_v1.xml b/static/redfish/v1/schema/OemComputerSystem_v1.xml new file mode 100644 index 0000000000..6588f0ac54 --- /dev/null +++ b/static/redfish/v1/schema/OemComputerSystem_v1.xml @@ -0,0 +1,68 @@ +<?xml version="1.0" encoding="UTF-8"?> +<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0"> + <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Core.V1.xml"> + <edmx:Include Namespace="Org.OData.Core.V1" Alias="OData" /> + </edmx:Reference> + <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml"> + <edmx:Include Namespace="Validation.v1_0_0" Alias="Validation"/> + <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/> + </edmx:Reference> + <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/ComputerSystem_v1.xml"> + <edmx:Include Namespace="ComputerSystem"/> + <edmx:Include Namespace="ComputerSystem.v1_4_0"/> + </edmx:Reference> + <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml"> + <edmx:Include Namespace="Resource"/> + <edmx:Include Namespace="Resource.v1_0_0"/> + </edmx:Reference> + + <edmx:DataServices> + <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="OemComputerSystem"> + <ComplexType Name="Oem" BaseType="Resource.OemObject"> + <Annotation Term="OData.AdditionalProperties" Bool="true" /> + <Annotation Term="OData.Description" String="OemComputerSystem Oem properties." /> + <Annotation Term="OData.AutoExpand"/> + <Property Name="OpenBmc" Type="OemComputerSystem.OpenBmc"/> + </ComplexType> + + <ComplexType Name="OpenBmc" BaseType="Resource.OemObject"> + <Annotation Term="OData.AdditionalProperties" Bool="true" /> + <Annotation Term="OData.Description" String="Oem properties for OpenBmc." /> + <Annotation Term="Redfish.DynamicPropertyPatterns"> + <Collection> + <NavigationProperty Type="OemComputerSystem.FirmwareProvisioning"> + <Annotation Term="OData.AutoExpand"/> + <PropertyValue Property="Pattern" String="[A-Za-z0-9_.:]+" /> + <PropertyValue Property="Type" String="OemComputerSystem.FirmwareProvisioning" /> + </NavigationProperty> + </Collection> + </Annotation> + </ComplexType> + + <ComplexType Name="FirmwareProvisioning" BaseType="Resource.OemObject"> + <Annotation Term="OData.AdditionalProperties" Bool="false" /> + <Annotation Term="OData.Description" String="Configuration data for platform firmware provisioning." /> + <Property Name="ProvisioningStatus" Type="OemComputerSystem.FirmwareProvisioningStatus"> + <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> + <Annotation Term="OData.Description" String="This indicates platform firmware provisioning state."/> + <Annotation Term="OData.LongDescription" String="The value of this property indicating provisioning status of platform firmware."/> + </Property> + </ComplexType> + + <EnumType Name="FirmwareProvisioningStatus"> + <Member Name="NotProvisioned"> + <Annotation Term="OData.Description" String="Platform firmware is not provisioned."/> + <Annotation Term="OData.LongDescription" String="Platform firmware is not provisioned."/> + </Member> + <Member Name="ProvisionedButNotLocked"> + <Annotation Term="OData.Description" String="Platform firmware is provisioned but not locked."/> + <Annotation Term="OData.LongDescription" String="Platform firmware is provisioned but not locked. So re-provisioning is allowed in this state."/> + </Member> + <Member Name="ProvisionedAndLocked"> + <Annotation Term="OData.Description" String="Platform firmware is provisioned and locked."/> + <Annotation Term="OData.LongDescription" String="Platform firmware is provisioned and locked. So re-provisioning is not allowed in this state."/> + </Member> + </EnumType> + </Schema> + </edmx:DataServices> +</edmx:Edmx> |