1 Foreword
The following files are part of the Redfish development effort:
- DSP0218 - Platform Level Data Model (PLDM) for Redfish Device Enablement Specification - Binary-encoded JSON (BEJ) and dictionary-based mapping of Redfish schemas and properties into PLDM messages.
- DSP0266 - Redfish Specification - Main Redfish Specification.
- DSP0268 - Redfish Data Model Specification - Normative descriptions and additional text for every schema defined in DSP8010 and example payloads for every resource.
- DSP0270 - Redfish Host Interface Specification - "In-band" or "OS-based" Redfish host interface.
- DSP0272 - Redfish Interoperability Profiles Specification - Structure and JSON document that is used to define and publish an interoperability profile that checks an implementation's conformance to a defined minimum set of functionality.
- DSP2043 - Redfish Mockups Bundle - Set of mockups that can be used as sample output from
GETs
from a Redfish service. Informative in nature, it was used to develop the schema. A person can set up an NGINX or similar server and configure it to output JSON format and then use this directory for demonstration purposes. - DSP2044 - Redfish White Paper - Non-normative document helping those new to Redfish understand how to interact with the Redfish service and understand common functions and tasks.
- DSP2046 - Redfish Resource and Schema Guide - Informative documentation regarding common Redfish resource properties and a listing of properties that can be found in each of the Redfish resources.
- DSP2053 - Redfish Property Guide - Informative documentation providing an index to individual property definitions across all Redfish schema.
- DSP2065 - Redfish Message Registry Guide - Informative documentation providing details regarding the messages defined in Redfish standard message registries.
- DSP8010 - Redfish Schema - Redfish schema definitions. These files are normative in nature and are normatively referenced by the Redfish Specification. The three schema formats are CSDL (OData Common Schema Definition Language format, which is in XML), JSON Schema, and OpenAPI schema. These schema definitions should be functionally equivalent, thus specifying the schema in two different languages.
- DSP8011 - Redfish Standard Registries - Redfish registry definitions. This bundle of Redfish registries includes message registries used for Redfish-defined messages including events and privilege maps.
- DSP8013 - Redfish Interoperability Profiles Bundle - Bundle of published Redfish interoperability profile documents and supporting schema and sample documents used for creating profiles.
2 Redfish Schema Bundle contents
This bundle contains the set of Redfish schema files. The contents of the folder are put into several folders. Each folder contains a complete set of Redfish schema files for a given schema language. The folders are:
Folder | Description |
---|---|
csdl |
OData Common Schema Definition Language formatted as XML files. The RedfishExtensions_v1.xml and Resource_v1.xml files contain core definitions of Redfish. |
dictionaries |
Redfish Device Enablement (RDE) dictionaries formatted as Binary-encoded JSON (BEJ) files. The annotation.bin and annotation.map files contain core annotation definitions of Redfish. |
json-schema |
JSON Schema formatted as JSON files. The redfish-schema.*.json and odata.*.json files contain supplementary information about the schema files. |
openapi |
OpenAPI formatted as YAML files. The openapi.yaml file contains the OpenAPI service document that describes all of the standard paths. |
In addition, the bundle includes several schema guide documents, generated from the contents of Redfish schema files and published separately by DMTF, as a convenience. These documents are updated for each Redfish schema bundle release.
File | Description |
---|---|
DSP2046_<ver>.PDF |
Redfish Resource and Schema Guide - Informative document presenting the contents of the Redfish schema in an easily consumed table format. Organized by schema name, the document shows a listing of properties that can be found in each of the Redfish resources. |
DSP2053_<ver>.PDF |
Redfish Property Guide - Informative document providing an alphabetic index to individual properties defined across all Redfish schema. |
DSP0268_<ver>.PDF |
Redfish Data Model Specification - Normative document presenting the contents of the Redfish schema in an easily consumed table format. Similar to DSP2046, the document is organized by schema name, but populates its tables using the normative text and descriptions from the schema files. |
3 ANNEX A (informative) Change log
3.1 Release 2022.3 (December 2022)
Schema name | Version | Description |
---|---|---|
Key | N/A | Added new URI patterns for Key resource subordinate to AggregationSource . |
KeyCollection | N/A | Added new URI patterns for Key resource subordinate to AggregationSource . |
Privileges | N/A | Typographic corrections in the AdministrateSystems and OperateSystems descriptions. |
Protocol | N/A | Added CXL protocol. |
Resource | N/A | Clarified expected behavior for the PowerCycle value for ResetType is to turn on the resource if it's already powered off. |
Sensor | N/A | Removed unused URI for Sensor resource directly under PowerEquipment . |
CXLLogicalDevice | 1.0.0 | Initial release. Resource that represents a CXL logical device within a PCIe device. |
Heater | 1.0.0 | Initial release. Resource that represents a heating unit for devices contained within a chassis. |
HeaterMetrics | 1.0.0 | Initial release. Resource that contains metrics for a heating unit. |
AccountService | 1.12.0 | Added MultiFactorAuth property. |
AggregationSource | 1.3.0 | Added GenerateSSHIdentityKeyPair and RemoveSSHIdentityKeyPair actions. Added SSHSettings and Status properties. |
Chassis | 1.22.0 | Added Processors property. Deprecated IntrusionSensorNumber in PhysicalSecurity . |
ComputerSystem | 1.20.0 | Added CachePolicy and CacheDuration to KMIPServers . |
ConnectionMethod | 1.1.0 | Added TunnelingProtocol property. |
Drive | 1.16.0 | Added SlotFormFactor , DriveFormFactor , and SlotCapableProtocols properties. Added ActiveSoftwareImage and SoftwareImages to Links . |
Endpoint | 1.8.0 | Added CXLDevice and Memory to EntityType . |
EventDestination | 1.13.0 | Added Kafka to Protocol . Added Severities property. |
EventService | 1.9.0 | Added Severities property. Added PasswordSet to SMTP . |
ExternalAccountProvider | 1.5.0 | Added MFABypass property to RoleMapping . |
FabricAdapter | 1.5.0 | Added Processors property. |
Job | 1.2.0 | Added Links property with CreatedResources property. |
Key | 1.2.0 | Added SSH property. |
License | 1.1.0 | Added TargetServices property. |
LicenseService | 1.1.0 | Added AuthorizedDevices and TargetServices parameters to the Install action. |
LogEntry | 1.14.0 | Added CXL to EntryType . Added OverflowErrorCount , FirstOverflowTimestamp , LastOverflowTimestamp , CXLEntryType , and Persistency properties. |
LogService | 1.4.0 | Added LogPurposes , OEMLogPurpose , Persistency , and Overflow properties. |
Manager | 1.17.0 | Added Version property. |
ManagerAccount | 1.10.0 | Added MFABypass property. |
ManagerDiagnosticData | 1.2.0 | Added ServiceRootUptimeSeconds property. |
Memory | 1.17.0 | Added FreezeSecurityState , ScanMedia , InjectPersistentPoison , SetMasterPassphrase , and DisableMasterPassphrase actions. Added PoisonListMaxMediaErrorRecords , CXL , VolatileSizeLimitMiB , NonVolatileSizeLimitMiB , SecurityStates , and HealthData properties. Added Endpoints and MemoryMediaSources to Links . Added HBME2 to MemoryType . |
MemoryChunks | 1.5.0 | Added MediaLocation and RequestedOperationalState properties. Added CXLLogicalDevices to Links . |
MemoryDomain | 1.5.0 | Added Status , MinMemoryChunkSizeMiB , MemoryChunkIncrementMiB , and MemorySizeMiB properties. Added FabricAdapters , PCIeFunctions , and CXLLogicalDevices to Links . |
MemoryMetrics | 1.6.0 | Added CorrectedVolatileErrorCount , CorrectedPersistentErrorCount , DirtyShutdownCount , and CXL properties. |
MessageRegistry | 1.6.0 | Added ReplacedBy and MapsToGeneralMessages properties. |
PCIeDevice | 1.11.0 | Added CXLDevice , StagedVersion , and CXLLogicalDevices properties. |
PCIeFunction | 1.5.0 | Added FunctionProtocol property. Added MemoryDomains and CXLLogicalDevice to Links . |
Port | 1.8.0 | Added ResetPPB action. Added RemotePortId and CXL properties. Added SystemName , SystemDescription , and SystemCapabilities to LLDPTransmit and LLDPReceive . Added PCIe to LinkNetworkTechnology . |
PortMetrics | 1.4.0 | Added CXL property. |
PowerDistribution | 1.3.0 | Added UserLabel property. |
Processor | 1.17.0 | Added PowerState property. Added FabricAdapters to Links . Added HBME2 and Cache to ProcessorMemoryType . |
Resource | 1.15.0 | Added GCXLID to DurableNameFormat . |
Session | 1.6.0 | Added Token property. |
ServiceRoot | 1.15.0 | Added ManagerProvidingService to Links . |
SoftwareInventory | 1.9.0 | Added VersionScheme property. |
Storage | 1.14.0 | Added HotspareActivationPolicy , EncryptionMode , and LocalEncryptionKeyIdentifier properties. Added EncryptionKeyIdentifier and CurrentEncryptionKey parameters to the SetEncryptionKey action. |
Switch | 1.8.0 | Added CXL property. |
Task | 1.7.0 | Added Links property with CreatedResources property. |
ThermalMetrics | 1.1.0 | Added HeaterSummary property. |
ThermalSubsystem | 1.1.0 | Added Heaters property. |
VirtualMedia | 1.6.0 | Added EjectPolicy and EjectTimeout properties. |
AccountService | 1.x.x | Errata release. Clarified the usage of OAuthServiceSigningKeys with token validation. |
Chassis | 1.x.x | Errata release. Updated the descriptions for Memory , MemoryDomains , and FabricAdapters to show the collections are used for fabric-related resource pools. Updated the descriptions for PhysicalSecurity to show how to build the property when there are multiple sensors. Clarified the usage of IntrusionSensor and IntrusionSensorReArm to show how clients clear the status based on the policy of the system. Updated the PowerState property to reference the common enumeration in the Resource schema. |
ComputerSystem | 1.x.x | Errata release. Updated the PowerState property to reference the common enumeration in the Resource schema. Corrected the BootSourceOverrideEnabled reference in the BootSourceOverrideTarget description. Clarified the behavior of UefiHttp when HttpBootUri is not configured. |
EventDestination | 1.x.x | Errata release. Clarified that VerifyCertificate is tied to Certificates and services can perform other certificate checks regardless of these properties. Updated the tokens used to describe the format of MessageIds and ExcludeMessageIds to match the Redfish Specification terminology. |
ExternalAccountProvider | 1.x.x | Errata release. Clarified the usage of OAuthServiceSigningKeys with token validation. |
Job | 1.x.x | Errata release. Clarified the usage of the Payload property to show it's to contain request payload information. |
License | 1.0.1 | Errata release. Clarified the usage of the Service and Capacity values in AuthorizationScope to describe the usage with aggregators. |
ManagerAccount | 1.x.x | Errata release. Updated the description for Certificates to provide more details for its usage. |
Outlet | 1.x.x | Errata release. Updated the PowerState parameter in the PowerControl action to reference the common enumeration in the Circuit schema. |
OutletGroup | 1.x.x | Errata release. Updated the PowerState parameter in the PowerControl action to reference the common enumeration in the Circuit schema. |
PCIeFunction | 1.x.x | Errata release. Clarified the byte ordering of properties that are hex-encoded strings. |
Processor | 1.x.x | Errata release. Updated description for Ports to allow fabric-related ports to be shown. |
ServiceRoot | 1.x.x | Errata release. Removed the upper limit on the MaxLevels property. |
Task | 1.x.x | Errata release. Clarified the usage of the Payload property to show it's to contain request payload information. |
UpdateService | 1.x.x | Errata release. Updated descriptions for non-resource URI properties to reference the URI rules in the Redfish Specification. Clarified that VerifyRemoteServerCertificate is tied to RemoteServerCertificates and services can perform other certificate checks regardless of these properties. |
VirtualMedia | 1.x.x | Errata release. Clarified that VerifyCertificate is tied to Certificates and services can perform other certificate checks regardless of these properties. |
(various files) | various | Errata release. Updated permissions for password-related properties to be specified as write-only. |
3.2 Release 2022.2 (August 2022)
Schema name | Version | Description |
---|---|---|
EthernetInterface | N/A | Updated capabilities to allow for users to add and remove EthernetInterface resources for creating VLANs and teams. |
EthernetInterfaceCollection | N/A | Updated capabilities to allow for users to add and remove EthernetInterface resources for creating VLANs and teams. |
EnvironmentMetrics | N/A | Corrected URI patterns to allow for metrics subordinate to any Port resource. |
FabricAdapter | N/A | Added missing URI patterns for FabricAdapter resources subordinate to ComputerSystem resources within a resource block. |
FabricAdapterCollection | N/A | Added missing URI patterns for FabricAdapter resources subordinate to ComputerSystem resources within a resource block. |
Port | N/A | Added missing URI patterns for Port resources subordinate to Processor resources and ComputerSystem resources within a resource block. |
PortCollection | N/A | Added missing URI patterns for Port resources subordinate to Processor resources and ComputerSystem resources within a resource block. |
PortMetrics | N/A | Corrected URI patterns to allow for metrics subordinate to any Port resource. |
Privileges | N/A | Added AdministrateSystems , OperateSystems , AdministrateStorage , and OperateStorageBackup privileges. |
RouteEntry | N/A | Added missing URI patterns for RouteEntry resources subordinate to ComputerSystem resources within a resource block. |
RouteEntryCollection | N/A | Added missing URI patterns for RouteEntry resources subordinate to ComputerSystem resources within a resource block. |
VCATEntry | N/A | Added missing URI patterns for RouteEntry resources subordinate to ComputerSystem resources within a resource block. |
VCATEntryCollection | N/A | Added missing URI patterns for RouteEntry resources subordinate to ComputerSystem resources within a resource block. |
SecurityPolicy | 1.0.0 | Initial release. Resource that provides a central point to configure the security policy of a manager. |
TrustedComponent | 1.0.0 | Initial release. Resource that represents a trusted device, such as a TPM. |
ActionInfo | 1.3.0 | Added AllowableNumbers and AllowablePattern to Parameters . |
Assembly | 1.4.0 | Added Replaceable to Assemblies . |
Battery | 1.2.0 | Added Replaceable property. |
Chassis | 1.21.0 | Added TrustedComponents , HotPluggable , Replaceable , and Version properties. |
Circuit | 1.7.0 | Added DC16V , DC12V , DC9V , DC5V , DC3_3V , and DC1_8V to NominalVoltageType . |
ComponentIntegrity | 1.2.0 | Added TPMGetSignedMeasurements action. Added NonceSizeBytesMaximum to TPM . |
ComputerSystem | 1.19.0 | Deprecated TrustedModules in favor of TrustedComponents in Links . Added Recovery to BootSource . |
Control | 1.2.0 | Added ResetToDefaults action. |
EnvironmentMetrics | 1.3.0 | Added ResetToDefaults action. |
EthernetInterface | 1.9.0 | Added TeamMode property. Added Ports and RelatedInterfaces to Links . |
FabricAdapter | 1.4.0 | Added LocationIndicatorActive property. |
Fan | 1.3.0 | Added Replaceable property. |
LogEntry | 1.13.0 | Added SpecificEventExistsInGroup property. |
Manager | 1.16.0 | Added SecurityPolicy , DedicatedNetworkPorts , and SharedNetworkPorts properties. |
ManagerDiagnosticData | 1.1.0 | Added UptimeSeconds , RestartCount , and RestartAfterFailureCount to TopProcesses . |
ManagerNetworkProtocol | 1.9.0 | Added NetworkSuppliedServers to NTP . |
Memory | 1.16.0 | Added ResetToDefaults action. |
MetricReport | 1.5.0 | Deprecated MetricDefinition in favor of MetricId . |
NetworkDeviceFunction | 1.9.0 | Added HTTP to BootMode . Added HTTPBoot property. |
PCIeDevice | 1.10.0 | Added Switch to Links . Added Retimer to DeviceType . |
PCIeFunction | 1.4.0 | Added Processor to Links . |
PowerSupply | 1.5.0 | Added DCRegulator to PowerSupplyType . Added OutputNominalVoltageType and Replaceable properties. |
Processor | 1.16.0 | Added Throttled , ThrottleCauses , Replaceable , ProcessorIndex , and Family properties. Added ResetToDefaults action. |
ProcessorMetrics | 1.6.0 | Added PowerLimitThrottleDuration and ThermalLimitThrottleDuration properties. |
Sensor | 1.6.0 | Added ResetToDefaults action. |
Session | 1.5.0 | Added Context property. |
SoftwareInventory | 1.8.0 | Added OSDistribution to AdditionalVersions . |
AccountService | 1.x.x | Errata release. Clarified that OAuthServiceSigningKeys and Issuer are configured by the client when the OAuth 2.0 mode is set to Offline . |
ComponentIntegrity | 1.x.x | Errata release. Updated the description for TargetComponentURI to allow it to reference a TrustedComponent resource for TPM devices. Clarified the nonce provided in the SPDMGetSignedMeasurements action is sent to the SPDM Responder in the 'GET_MEASUREMENTS' request. Added regular expression to ComponentIntegrityTypeVersion when ComponentIntegrityType is SPDM . |
ExternalAccountProvider | 1.x.x | Errata release. Clarified that OAuthServiceSigningKeys and Issuer are configured by the client when the OAuth 2.0 mode is set to Offline . |
Job | 1.x.x | Errata release. Added guidance for mapping values to JobStatus . |
MemoryChunks | 1.x.x | Errata release. Clarified the usage of InterleaveSets if not specified by the client. Added missing required term for AddressRangeType . |
MetricDefinition | 1.x.x | Errata release. Clarified that MetricProperties and CalculationParameters should not be present in the same resource instance. |
MetricReport | 1.x.x | Errata release. Clarified the usage of MetricId and MetricProperty . |
MetricReportDefinition | 1.x.x | Errata release. Clarified that MetricProperties and MetricId should not be present in the same object instance in the Metrics array. Clarified that calculations performed on metrics are optional. |
Port | 1.x.x | Errata release. Corrected regular expression patterns for LLDP transmit properties to allow for empty strings. Corrected the description for LLDP receive properties to state they should be omitted rather than be empty strings. |
Schedule | 1.x.x | Errata release. Clarified that RecurrenceInterval specifies the duration between intervals. |
Settings | 1.x.x | Errata release. Clarified the behavior of Immediate in @Redfish.SettingsApplyTime and @Redfish.OperationApplyTime to allow for side effects. |
Task | 1.x.x | Errata release. Added guidance for mapping values to TaskStatus . |
UpdateService | 1.x.x | Errata release. Updated the descriptions for the StartUpdate action to clarify that it's tied to usage with the operation apply time value OnStartUpdateRequest . Clarified that non-resource URIs should not contain URIs of Redfish resources. |
3.3 Release 2022.1 (April 2022)
Schema name | Version | Description |
---|---|---|
Certificate | N/A | Corrected URI patterns for certificates subordinate to KMIP configurations for systems. |
CircuitCollection | N/A | Corrected URI patterns for switchgear units. |
Processor | N/A | Updated URI patterns to allow for three levels of processors: package, core, and thread. |
ProcessorCollection | N/A | Updated URI patterns to allow for three levels of processors: package, core, and thread. |
Role | N/A | Corrected the resource capabilities to show the resource can be deleted. |
RoleCollection | N/A | Corrected the resource capabilities to show new members can be inserted. |
AccountService | 1.11.0 | Added SSHKeyAttribute to SearchSettings for LDAP. |
Battery | 1.1.0 | Added Links property. Added Memory and StorageControllers to Links . |
Certificate | 1.6.0 | Added DisplayString , DomainComponents , AdditionalCommonNames , and AdditionalOrganizationalUnits to Subject and Issuer . |
Chassis | 1.20.0 | Added FabricAdapters , PoweredByParent , ThermalManagedByParent , and ThermalDirection properties. Added PowerSupplies , Fans , and PowerDistribution to Links . Deprecated MediaControllers in favor of FabricAdapters . Deprecated PoweredBy and CooledBy in favor of hardened references to deterministic resource types. |
Circuit | 1.6.0 | Added AC100To127V to NominalVoltageType . |
CollectionCapabilities | 1.4.0 | Added RegisterResourceBlock to UseCase . |
ComponentIntegrity | 1.1.0 | Added SecurityVersionNumber to SPDM measurements. |
ComputerSystem | 1.18.0 | Added ManufacturingMode and Composition properties. Added LastBootTimeSeconds to BootProgress . |
Drive | 1.15.0 | Added SanitizationType and OverwritePasses to the SecureErase action. |
Endpoint | 1.7.0 | Added LocalPorts to Links . Deprecated Ports in Links in favor of ConnectedPorts and LocalPorts . |
ExternalAccountProvider | 1.4.0 | Added SSHKeyAttribute to SearchSettings for LDAP. |
EventDestination | 1.12.0 | Added ExcludeRegistryPrefixes and ExcludeMessageIds properties. Added SuspendSubscription action. Added DeliverBufferedEventDuration parameter to the ResumeSubscription action. |
EventService | 1.8.0 | Added ExcludeRegistryPrefix and ExcludeMessageId properties. |
FabricAdapter | 1.3.0 | Added FabricType and FabricTypeCapabilities properties. Added MemoryDomains to Links . |
Fan | 1.2.0 | Added Links property. Added CoolingChassis to Links . |
Job | 1.1.0 | Added EstimatedDuration property. |
Key | 1.1.0 | Added SSH to KeyType . Added UserDescription property. |
LogEntry | 1.12.0 | Added RelatedItem and RelatedLogEntries to Links . |
Manager | 1.15.0 | Added ServiceIdentification and AdditionalFirmwareVersions properties. |
ManagerAccount | 1.9.0 | Added Keys property. |
Manifest | 1.1.0 | Added RegisterResourceBlock stanza type. |
Memory | 1.15.0 | Added Batteries to Links . |
MemoryMetrics | 1.5.0 | Added IndeterminateCorrectableErrorCount and IndeterminateUncorrectableErrorCount to CurrentPeriod and LifeTime . |
MetricDefinition | 1.3.0 | Added LogicalContexts property. |
PortMetrics | 1.3.0 | Added PCIeErrors property. |
PowerSupply | 1.4.0 | Added PoweringChassis to Links . |
Processor | 1.15.0 | Added AdditionalFirmwareVersions property. |
ProcessorMetrics | 1.5.0 | Added CorrectableCoreErrorCount , UncorrectableCoreErrorCount , CorrectableOtherErrorCount , and UncorrectableOtherErrorCount properties. |
ServiceRoot | 1.14.0 | Added ServiceIdentification property. Added MultipleHTTPRequests to ProtocolFeaturesSupported . |
Session | 1.4.0 | Added CreatedTime property. |
SoftwareInventory | 1.7.0 | Added AdditionalVersions property. |
Storage | 1.13.0 | Deprecated StorageControllers the array property in favor of Controllers to represent storage controllers as their own resources. |
StorageController | 1.6.0 | Added Batteries to Links . |
Task | 1.6.0 | Added EstimatedDuration property. |
Certificate | 1.x.x | Errata release. Updated descriptions to reference attributes defined in RFC2985 and RFC5280. |
Chassis | 1.x.x | Errata release. Modified the permissions for EnvironmentalClass to be writable. |
Circuit | 1.x.x | Errata release. Added long descriptions for NominalVoltageType values to clarify usage for different devices. |
ComputerSystem | 1.x.x | Errata release. Removed redundant statements from the Reset action that are already described in the descriptions of the individual ResetType enumeration values. |
Endpoint | 1.x.x | Errata release. Clarified the description for ConnectedPorts in Links to show its usage is to reference the external port at the other end of the link. |
Event | 1.x.x | Errata release. Clarified the usage of OriginOfCondition for creation and deletion events. |
EventDestination | 1.x.x | Errata release. Clarified behavioral semantics of MessageIds and RegistryPrefixes to account for cases where both properties and others are used simultaneously. Clarified the behavior of OriginResources and ResourceTypes to match semantics used for other control properties. |
EventService | 1.x.x | Errata release. Corrected the property references in many of the boolean properties that indicate the support of a property in an EventDestination resource. |
LogEntry | 1.x.x | Errata release. Clarified the usage of OriginOfCondition for creation and deletion events. Clarified the tie between DiagnosticDataType and OEMDiagnosticDataType and AdditionalDataURI . |
LogService | 1.x.x. | Errata release. Added text to the CollectDiagnosticData action descriptions to specify that the new LogEntry will contain the AdditionalDataURI property. |
ManagerNetworkProtocol | 1.x.x | Errata release. Modified the permissions for EnterpriseSpecificMethod within SNMP to be writable. |
Port | 1.x.x | Errata release. Clarified the descriptions for AssociatedEndpoints , ConnectedSwitches , ConnectedSwitchPorts , and ConnectedPorts in Links to better describe their intended usage. |
PowerDistribution | 1.x.x | Errata release. Clarified the usage of the Chassis property in Links . |
Processor | 1.x.x. | Errata release. Clarified that SubProcessors contains sub-processors of the processor and not the system. |
ProcessorMetrics | 1.x.x | Errata release. Clarified that metrics under CurrentPeriod are cleared when the ClearCurrentPeriod action is issued. |
Redundancy | 1.4.1 | Errata release. Modified the permissions for RedundancyType within RedundantGroup to be writable. |
Resource | 1.x.x | Errata release. Clarified the patterns shown in the descriptions for the DurableNameFormat values are regular expression patterns. |
Session | 1.x.x | Errata release. Several typographic and consistency corrections. |
Switch | 1.5.2 | Errata release. Corrected the release label for version 1.5.x of the schema. |
3.4 Release 2021.4 (December 2021)
Schema name | Version | Description |
---|---|---|
ComponentIntegrity | 1.0.0 | Initial release. Resource that provides critical and pertinent security information about a specific device, system, software element, or other managed entity. |
ManagerDiagnosticData | 1.0.0 | Initial release. Resource that provides internal diagnostic data for a manager. |
RegisteredClient | 1.0.0 | Initial release. Resource that represents a client instance that is monitoring the service. |
ServiceConditions | 1.0.0 | Initial release. Resource that reports the conditions present in the service that require attention. |
Cable | 1.2.0 | Added CDFP and OSFP to CableType . |
Chassis | 1.19.0 | Deprecated Measurements in favor of reporting measurements in the ComponentIntegrity resource. |
Circuit | 1.5.0 | Added UnbalancedVoltagePercent , UnbalancedCurrentPercent , PowerControlLocked , ConfigurationLocked , and PowerStateInTransition properties. Added PowerCycle to PowerState parameter for PowerControl . |
ComputerSystem | 1.17.0 | Added OffloadedNetworkDeviceFunctions to Links . Deprecated Measurements in favor of reporting measurements in the ComponentIntegrity resource. |
Control | 1.1.0 | Added Pressure and FrequencyMHz to ControlType . |
Drive | 1.14.0 | Added NetworkDeviceFunctions to Links . Deprecated Measurements in favor of reporting measurements in the ComponentIntegrity resource. |
EnvironmentMetrics | 1.2.0 | Added AbsoluteHumidity and EnergyJoules properties. |
EthernetInterface | 1.8.0 | Deprecated Stateful and Stateless for OperatingMode in DHCPv6 in favor of Enabled . |
Fabric | 1.3.0 | Added UUID property. |
LogEntry | 1.11.0 | Added Originator and OriginatorType properties. |
Manager | 1.14.0 | Added ManagerDiagnosticData property. Deprecated Measurements in favor of reporting measurements in the ComponentIntegrity resource. |
Memory | 1.14.0 | Deprecated Measurements in favor of reporting measurements in the ComponentIntegrity resource. |
NetworkAdapter | 1.9.0 | Deprecated Measurements in favor of reporting measurements in the ComponentIntegrity resource. |
NetworkDeviceFunction | 1.8.0 | Deprecated PhysicalNetworkPortAssignment at the root of the resource in favor of PhysicalNetworkPortAssignment within Links . |
Outlet | 1.4.0 | Added PowerControlLocked , ConfigurationLocked , and PowerStateInTransition properties. Added PowerCycle to PowerState parameter for PowerControl . |
OutletGroup | 1.1.0 | Added PowerControlLocked , ConfigurationLocked , and PowerStateInTransition properties. Added PowerCycle to PowerState parameter for PowerControl . |
PCIeDevice | 1.9.0 | Added Slot property to describe slot capabilities. |
Port | 1.6.0 | Added InfiniBand property with AssociatedPortGUIDs , AssociatedNodeGUIDs , and AssociatedSystemGUIDs properties. |
PowerDistributionMetrics | 1.3.0 | Added AbsoluteHumidity property. |
PowerSupply | 1.3.0 | Added LineInputStatus property. |
Processor | 1.14.0 | Deprecated Measurements in favor of reporting measurements in the ComponentIntegrity resource. |
Resource | 1.14.0 | Added Resolution to Conditions . Added MACAddress to DurableNameFormat . |
Sensor | 1.5.0 | Added AbsoluteHumidity and PressurekPa to ReadingType . Added ApparentkVAh , ReactivekVARh , and PhaseAngleDegrees properties. |
ServiceRoot | 1.13.0 | Added ComponentIntegrity , RegisteredClients , and ServiceConditions properties. |
SoftwareInventory | 1.6.0 | Deprecated Measurement in favor of reporting measurements in the ComponentIntegrity resource. |
Storage | 1.12.0 | Deprecated Measurements in favor of reporting measurements in the ComponentIntegrity resource. |
StorageController | 1.5.0 | Deprecated Measurements in favor of reporting measurements in the ComponentIntegrity resource. |
Switch | 1.8.0 | Deprecated Measurements in favor of reporting measurements in the ComponentIntegrity resource. |
UpdateService | 1.11.0 | Added ForceUpdate to SimpleUpdate , multipart HTTP push updates, and HttpPushUriOptions . Added OnStartUpdateRequest to ApplyTime in HttpPushUriApplyTime . |
Battery | 1.0.1 | Errata release. Added normative ties to sensor and control excerpts to include requirements for the resource referenced by DataSourceUri . |
BatteryMetrics | 1.0.1 | Errata release. Added normative ties to sensor and control excerpts to include requirements for the resource referenced by DataSourceUri . |
Circuit | 1.x.x | Errata release. Added normative ties to sensor and control excerpts to include requirements for the resource referenced by DataSourceUri . |
Control | 1.0.1 | Errata release. Corrected usage of units in various descriptions for ControlType . |
EnvironmentMetrics | 1.x.x | Errata release. Added normative ties to sensor and control excerpts to include requirements for the resource referenced by DataSourceUri . |
EventDestination | 1.x.x | Errata release. Clarified default behavior of VerifyCertificate . |
Fan | 1.x.x | Errata release. Added normative ties to sensor and control excerpts to include requirements for the resource referenced by DataSourceUri . |
Memory | 1.13.1 | Errata release. Added normative ties to sensor and control excerpts to include requirements for the resource referenced by DataSourceUri . |
Outlet | 1.x.x | Errata release. Added normative ties to sensor and control excerpts to include requirements for the resource referenced by DataSourceUri . |
OutletGroup | 1.0.2 | Errata release. Added normative ties to sensor and control excerpts to include requirements for the resource referenced by DataSourceUri . |
PowerDistribution | 1.x.x | Errata release. Added normative ties to sensor and control excerpts to include requirements for the resource referenced by DataSourceUri . |
PowerDistributionMetrics | 1.x.x | Errata release. Added normative ties to sensor and control excerpts to include requirements for the resource referenced by DataSourceUri . |
PowerSupplyMetrics | 1.0.1 | Errata release. Added normative ties to sensor and control excerpts to include requirements for the resource referenced by DataSourceUri . |
Processor | 1.13.1 | Errata release. Added normative ties to sensor and control excerpts to include requirements for the resource referenced by DataSourceUri . |
ProcessorMetrics | 1.x.x | Errata release. Added normative ties to sensor and control excerpts to include requirements for the resource referenced by DataSourceUri . |
Resource | 1.x.x | Errata release. Clarified AltitudeMeters is the elevation above sea level. |
Sensor | 1.x.x | Errata release. Clarified Altitude is the elevation above sea level. Corrected usage of units in various descriptions for ReadingType . Corrected the minimum value for PowerFactor . |
Settings | 1.x.x | Errata release. Clarified the behavior of the MaintenanceWindowStartTime property when not initialized by a user. |
ThermalMetrics | 1.0.1 | Errata release. Added normative ties to sensor and control excerpts to include requirements for the resource referenced by DataSourceUri . |
UpdateService | 1.x.x | Errata release. Clarified default behavior of VerifyCertificate . |
VirtualMedia | 1.x.x | Errata release. Clarified default behavior of VerifyCertificate . |
3.5 Release 2021.3 (October 2021)
Schema name | Version | Description |
---|---|---|
Circuit | N/A | Added URIs for switchgear and electrical buses. |
Outlet | N/A | Added URIs for electrical buses. |
OutletGroup | N/A | Added URIs for power shelves and electrical buses. |
PhysicalContext | N/A | Added Pump physical context type. |
PowerDistribution | N/A | Added URIs for electrical buses. |
PowerDistributionMetrics | N/A | Added URIs for switchgear and electrical buses. |
License | 1.0.0 | Initial release. Resource that represents a license installed on a service. |
LicenseService | 1.0.0 | Initial release. Resource that allows clients to manage and install licenses on a service. |
SwitchMetrics | 1.0.0 | Initial release. Resource that represents the usage and health statistics for a switch. |
AggregationSource | 1.2.0 | Added AggregationType property. Added TrapCommunity to SNMP . Changed requirement for HostName to not be required if AggregationType contains NotificationsOnly . |
Cable | 1.1.0 | Added UserLabel property. |
Certificate | 1.5.0 | Added SPDM property with SlotId . |
Chassis | 1.18.0 | Added ElectricalSourceManagerURIs and ElectricalSourceNames . Added PowerOutlets to Links . |
Circuit | 1.4.0 | Added Bus to CircuitType . Added UserLabel , ElectricalSourceManagerURI , ElectricalSourceName , and ElectricalConsumerNames properties. Added SourceCircuit , PowerOutlet , and DistributionCircuits properties. |
FabricAdapter | 1.2.0 | Added PCIeDevices to Links . |
Facility | 1.3.0 | Added ElectricalBuses to Links . |
LogEntry | 1.10.0 | Added CPER and CPERSection to DiagnosticDataType . |
MessageRegistry | 1.5.0 | Added VersionAdded , Deprecated , and VersionDeprecated properties. |
Outlet | 1.3.0 | Added BusConnection to OutletType . Added UserLabel and ElectricalConsumerNames properties. Added DistributionCircuits , Chassis , and PowerSupplies to Links . |
PCIeDevice | 1.8.0 | Added common PCIeErrors object to be leveraged in other resources. |
PCIeSlots | 1.5.0 | Added Processors to Links for each slot. |
PowerDistribution | 1.2.0 | Added Bus to PowerEquipmentType . |
PowerDomain | 1.2.0 | Added ElectricalBuses to Links . |
PowerEquipment | 1.2.0 | Added ElectricalBuses property. |
PowerSupply | 1.2.0 | Added ElectricalSourceManagerURIs and ElectricalSourceNames . Added PowerOutlets to Links . |
ProcessorMetrics | 1.4.0 | Added PCIeErrors property. |
ServiceRoot | 1.12.0 | Added LicenseService property. |
StorageController | 1.4.0 | Added AllocatedSubmissionQueues and AllocatedCompletionQueues to NVMeControllerProperties . |
Switch | 1.7.0 | Added Metrics property. |
AddressPool | 1.x.x | Errata release. Clarified descriptions to various address range properties. |
ComputerSystem | 1.x.x | Errata release. Clarified BootOrder might require configuration with @Redfish.Settings . |
EventDestination | 1.x.x | Errata release. Clarified how to construct the value for Destination when the resource represents an SSE connection. |
ManagerAccount | 1.x.x | Errata release. Clarified AccountTypes describes the services the account is allowed to access on the manager. |
MetricDefinition | 1.x.x | Errata release. Several typographic and consistency corrections. |
3.6 Release 2021.2 (August 2021)
Schema name | Version | Description |
---|---|---|
PhysicalContext | N/A | Added Battery physical context type. |
AllowDeny | 1.0.0 | Initial release. Resource that contains address, port, and protocol allow-deny configuration settings for a network device. |
Battery | 1.0.0 | Initial release. Resource that represents a battery module contained in a chassis. |
BatteryMetrics | 1.0.0 | Initial release. Resource that contains metrics for a battery module. |
Cable | 1.0.0 | Initial release. Resource that represents a cable within an implementation and describes connectivity to other resources. |
Control | 1.0.0 | Initial release. Resource that contains information about a control point, including its set point, PID characteristics, and sensors that affect the control loop. |
Key | 1.0.0 | Initial release. Resource that represents a key or other type of secret. |
KeyPolicy | 1.0.0 | Initial release. Resource that contains usage restrictions for a key. |
KeyService | 1.0.0 | Initial release. Resource that contains a service to manage keys in a Redfish implementation. |
AccountService | 1.10.0 | Added OAuth2 property for configuring OAuth 2.0 authorization. Added OAuth2 to AccountProviderType . |
ActionInfo | 1.2.0 | Added ArraySizeMinimum and ArraySizeMaximum properties. |
AddressPool | 1.2.0 | Added Enabled and CIDR to BGPNeighbor . Added RouteDistinguisherAdministratorSubfield , RouteTargetAdministratorSubfield , and GatewayIPAddressRange to BGPEvpn . Added SystemMACRange to IPv4 . |
Certificate | 1.4.0 | Added PEMchain to CertificateType to support chain of PEM certificates. Added CertificateUsageTypes property. Added Issuer and Subjects in Links to report how certificates are chained. |
Chassis | 1.17.0 | Added Controls property. Added Cables to Links . |
Circuit | 1.3.0 | Added PowerLoadPercent property. |
ComputerSystem | 1.16.0 | Added IdlePowerSaver property. Added KeyManagement property with KMIPServers and KMIPCertificates properties. Added DPU to SystemType . Deprecated Status in ProcessorySummary and MemorySummary in favor of Status in the individual resources. |
Drive | 1.13.0 | Added Storage to Links . |
EnvironmentMetrics | 1.1.0 | Added PowerLoadPercent , DewPointCelsius , and PowerLimitWatts properties. |
EthernetInterface | 1.7.0 | Deprecated VLANs in favor of using multiple EthernetInterface resources to express additional VLANs. Deprecated NetworkDeviceFunction in favor of NetworkDeviceFunctions in Links . |
Event | 1.7.0 | Added LogEntry property. |
EventDestination | 1.11.0 | Added SendHeartbeat , HeartbeatIntervalMinutes , and ClientCertificates properties. |
ExternalAccountProvider | 1.3.0 | Added OAuth2Service property for configuring OAuth 2.0 authorization. Added OAuth2 and TACACSplus to AccountProviderType . |
FabricAdapter | 1.1.0 | Added Location property. |
Facility | 1.2.0 | Added PowerShelves to Links . |
LogService | 1.3.0 | Added LogEntriesETag parameter to the ClearLog action. Added AutoDSTEnabled property. |
Manager | 1.13.0 | Added Certificates and Measurements properties. |
ManagerNetworkProtocol | 1.8.0 | Added Proxy for configuring proxy settings on the manager. |
Memory | 1.13.0 | Added Log property for showing internal device logs. Added OperatingSpeedRangeMHz property. |
NetworkAdapter | 1.8.0 | Added Processors property. |
NetworkDeviceFunction | 1.7.0 | Added SAVIEnabled , Limits , and AllowDeny properties. Added EthernetInterfaces property to Ethernet for showing non-system related interfaces. Added OffloadSystem and OffloadProcessors to Links . Deprecated VLANs in favor of using multiple EthernetInterface resources to express additional VLANs. Deprecated EthernetInterface in favor of EthernetInterfaces in Links . |
NetworkDeviceFunctionMetrics | 1.1.0 | Added FibreChannel property. |
Outlet | 1.2.0 | Added PowerLoadPercent property. |
Port | 1.5.0 | Added WakeOnLANEnabled and EEEEnabled properties. Added Cables to Links . Added several new values to PortConnectionType for Fibre Channel ports. Deprecated SupportedEthernetCapabilities in favor of showing individual properties for the configured capabilities. |
PortMetrics | 1.2.0 | Added FibreChannel property. |
PowerDistribution | 1.1.0 | Added PowerShelf to PowerEquipmentType . Added PowerSupplies , PowerSupplyRedundancy , and MainsRedundancy properties. |
PowerDistributionMetrics | 1.2.0 | Added PowerLoadPercent property. |
PowerDomain | 1.1.0 | Added PowerShelves to Links . |
PowerEquipment | 1.1.0 | Added PowerShelves property. |
PowerSubsystem | 1.1.0 | Added Batteries property. |
Processor | 1.13.0 | Added Ports and OperatingSpeedRangeMHz properties. Added ECCModeEnabled to MemorySummary . Added NetworkDeviceFunctions to Links . |
ProcessorMetrics | 1.3.0 | Added CoreVoltage property. |
Resource | 1.13.0 | Added Embedded to LocationType . Added Suspend , Pause , and Resume to ResetType . Added Paused to PowerState . |
Sensor | 1.4.0 | Added SensorGroup , LowestReading , LowestReadingTime , AverageReading , AveragingInterval , AveragingIntervalAchieved , Calibration , and CalibrationTime properties. Added AssociatedControls to Links . Added EnergyWh and ChargeAh to ReadingType . |
ServiceRoot | 1.11.0 | Added KeyService and Cables properties. |
SoftwareInventory | 1.5.0 | Added MeasurementIndex to MeasurementBlock . |
Storage | 1.11.0 | Added ResetToDefaults action. Added HostingStorageSystems to Links . |
StorageController | 1.3.0 | Added NetworkDeviceFunctions to Links . |
Triggers | 1.2.0 | Added MetricIds property. |
UpdateService | 1.10.0 | Added ClientCertificates property. |
VirtualMedia | 1.5.0 | Added ClientCertificates property. |
VLanNetworkInterface | 1.3.0 | Deprecated the resource representation of VLanNetworkInterface in favor of using multiple EthernetInterface resources to express additional VLANs. Added Tagged property to common VLAN object. |
AccountService | 1.x.x | Errata release. Improved the resource description to indicate that there are scenarios where services may ignore certain policies to prevent denial of service or other types of lockouts. |
ActionInfo | 1.x.x | Errata release. Clarified that AllowableValues , MinimumValue , and MaximumValue describe constraints on array members for array parameters. |
Drive | 1.x.x | Errata release. Changed permissions of HotSpareType to be read-write. Specified the Dedicated value for HotSpareType is not allowed in client requests. |
Endpoint | 1.x.x | Errata release. Corrected a typographical error in the SubsystemId long description. |
EventDestination | 1.x.x | Errata release. Clarified the usage of SyslogFilters . |
EventService | 1.x.x | Errata release. Clarified the behavior of the service when ServiceEnabled contains false . |
LogService | 1.x.x | Errata release. Clarified the ordering of DateTime and DateTimeLocalOffset when both are modified in a single request. Several typographic and consistency corrections. |
Manager | 1.x.x | Errata release. Clarified the ordering of DateTime and DateTimeLocalOffset when both are modified in a single request. |
Port | 1.x.x | Errata release. Corrected the permissions of LinkStatus to be read-only. |
PortMetrics | 1.x.x | Errata release. Several typographic and consistency corrections. |
Processor | 1.x.x | Errata release. Clarified the usage of TotalMemorySizeMiB in MemorySummary . |
ProcessorMetrics | 1.x.x | Errata release. Clarified usage of BandwidthPercent to show it applies to all types of processors and not just CPUs. |
Resource | 1.x.x | Errata release. Corrected description of LocationType to remove duplicative statements. |
Sensor | 1.x.x | Errata release. Several typographic and consistency corrections. Clarified usage of Synthesized when multiple sensors are used to calculate the reading. |
VirtualMedia | 1.x.x | Errata release. Clarified usage of the Image parameter in the InsertMedia action and the Image property in the resource to show that relative URIs are allowed for media local to the service. |
3.7 Release 2021.1 (April 2021)
Schema name | Version | Description |
---|---|---|
Endpoint | N/A | Added URI patterns to allow for endpoints to be subordinate to storage and storage services. |
EndpointCollection | N/A | Added URI patterns to allow for endpoints to be subordinate to storage and storage services. |
EnvironmentMetrics | N/A | Corrected URI patterns for instances where subordinate to resource blocks. |
PhysicalContext | N/A | Added Board and Transceiver physical context types. |
Privileges | N/A | Added ConfigureCompositionInfrastructure privilege. |
Protocol | N/A | Added NVLink , DisplayPort , HDMI , VGA , and DVI protocols. |
CompositionReservation | 1.0.0 | Initial release. Resource that represents reservation information related to the Compose action. |
GraphicsController | 1.0.0 | Initial release. Resource that represents a controller that can be used to drive displays. |
Manifest | 1.0.0 | Initial release. An object that describes a set of requests to be fulfilled. |
NetworkAdapterMetrics | 1.0.0 | Initial release. Resource that represents the usage and health statistics for a network adapter. |
NetworkDeviceFunctionMetrics | 1.0.0 | Initial release. Resource that represents the usage and health statistics for a network device function. |
USBController | 1.0.0 | Initial release. Resource that represents a USB controller. |
AccountService | 1.9.0 | Added PasswordExpirationDays property. |
Bios | 1.2.0 | Added ResetBiosToDefaultsPending property. |
Certificate | 1.3.0 | Added SerialNumber , Fingerprint , FingerprintHashAlgorithm , and SignatureAlgorithm properties. |
Chassis | 1.16.0 | Added SparePartNumber property. |
CollectionCapabilities | 1.3.0 | Added ResourceBlockComposition and ResourceBlockConstrainedComposition to UseCase . |
CompositionService | 1.2.0 | Added Compose action. Added ActivePool , FreePool , CompositionReservations , and ReservationDuration properties. |
ComputerSystem | 1.15.0 | Added SetupEntered to LastState within BootProgress . Added PowerMode , GraphicsControllers , and USBControllers properties. Added StopBootOnFault to Boot . Added ThreadingEnabled to ProcessorSummary . |
Connection | 1.1.0 | Added MemoryChunkInfo and ConnectionKeys properties. |
Endpoint | 1.6.0 | Added StorageSubsystem to EntityType . Added Zones to Links . Deprecated AccessKey and RegionKey in favor of new properties in Connection . |
Fan | 1.1.0 | Added PowerWatts property. |
LogEntry | 1.9.0 | Added ServiceProviderNotified and Resolution properties. |
Manager | 1.12.0 | Added USBPorts property. |
ManagerAccount | 1.8.0 | Added AccountExpiration and HostBootstrapAccount properties. |
MediaController | 1.2.0 | Added EnvironmentMetrics property. |
Memory | 1.12.0 | Added Enabled property. |
MetricDefinition | 1.2.0 | Added String to MetricType . |
NetworkAdapter | 1.7.0 | Added Metrics , EnvironmentMetrics , and LLDPEnabled properties. |
NetworkDeviceFunction | 1.6.0 | Added Metrics property. |
PCIeDevice | 1.7.0 | Added ReadyToRemove and EnvironmentMetrics properties. |
PCIeFunction | 1.3.0 | Added Enabled property. |
Port | 1.4.0 | Added FunctionMinBandwidth , FunctionMaxBandwidth , SFP , and EnvironmentMetrics properties. Added AssociatedMACAddresses , LLDPEnabled , LLDPTransmit , and LLDPReceive to Ethernet . Added AssociatedWorldWideNames to FibreChannel . |
PortMetrics | 1.1.0 | Added RXBytes , TXBytes , RXErrors , TXErrors , Networking , Transceivers , and SAS properties. |
PowerDistributionMetrics | 1.2.0 | Added TemperatureCelsius and HumidityPercent properties. |
PowerSupply | 1.1.0 | Added Version and ProductionDate properties. |
Processor | 1.12.0 | Added Enabled property. Added GraphicsController to Links . |
Resource | 1.12.0 | Deprecated NSID in favor of NGUID within DurableNameFormat . |
ResourceBlock | 1.4.0 | Added IndependentResource to ResourceBlockType . Added Pool and Client properties. Added ConsumingResourceBlocks and SupplyingResourceBlocks to Links . |
Sensor | 1.3.0 | Added Links property. |
ServiceRoot | 1.10.0 | Added NVMeDomains property. |
StorageController | 1.2.0 | Added EnvironmentMetrics property. Added SupportsReservations to NVMeControllerAttributes . |
Switch | 1.6.0 | Added Enabled and EnvironmentMetrics properties. |
TaskService | 1.2.0 | Added TaskAutoDeleteTimeoutMinutes property. |
UpdateService | 1.9.0 | Added RemoteServerCertificates and VerifyRemoteServerCertificate properties. |
VirtualMedia | 1.4.0 | Added Status , Certificates , and VerifyCertificate properties. |
Bios | 1.x.x | Errata release. Clarified that the ResetBios action might clear pending values in a settings resource. |
Certificate | 1.2.3 | Errata release. Clarified that UefiSignatureOwner applies to all UEFI-managed certificates. |
ComputerSystem | 1.x.x | Errata release. Clarified the behavior of AliasBootOrder with regards to handling multiple boot devices that map to the same alias. Clarified behavior of BootSourceOverrideTarget and AliasBootOrder to tie in virtual devices. |
Endpoint | 1.x.x | Errata release. Updated descriptions for the EntityType values to contain normative language consistent with other enumerations. |
Manager | 1.x.x | Errata release. Clarified that RemoteAccountService is for any type of remote manager and not just a Redfish manager. |
NetworkDeviceFunction | 1.x.x | Errata release. Added missing patterns for WWN properties. |
Port | 1.x.x | Errata release. Clarified that speed properties also include protocol overhead. Added missing patterns for WWN properties. |
PowerDistributionMetrics | 1.0.1 | Errata release. Updated descriptions for PowerWatts and EnergykWh to be consistent with other metrics resources. |
Resource | 1.x.x | Errata release. Added patterns to descriptions for DurableNameFormat . Clarified descriptions in PartLocation . |
SecureBootDatabase | 1.0.1 | Errata release. Corrected capitalization of PKDefault in the description for DatabaseId . |
Triggers | 1.1.4 | Errata release. Clarified that MetricType is not used for event-based triggers. |
(various files) | various | Errata release. Several typographic and consistency corrections. Reverted change for using "might" in favor of "may" in normative text. "May" is the appropriate term to use. |
3.8 Release 2020.4 (December 2020)
Schema name | Version | Description |
---|---|---|
Assembly | N/A | Added URI patterns for StorageController resources. Corrected existing URI patterns for StorageController objects withing Storage resources. |
MemoryMetrics | N/A | Added URI patterns for memory metrics to be represented for the memory summary of a processor. |
Port | N/A | Added URI patterns for ports to be represented within the StorageController resource. |
PortCollection | N/A | Added URI patterns for ports to be represented within the StorageController resource. |
RouteEntryCollection | N/A | Corrected spelling of "Fabric" in URI patterns. |
RouteSetEntryCollection | N/A | Corrected spelling of "Fabric" in URI patterns. |
EnvironmentMetrics | 1.0.0 | Initial release. Resource that contains environmental information for a device, such as temperature readings. |
Fan | 1.0.0 | Initial release. Resource that contains information for a fan within a chassis. Replaces Fans array within the Thermal resource. |
PowerSubsystem | 1.0.0 | Initial release. Resource that contains power related information within a chassis. Replaces the Power resource. |
PowerSupply | 1.0.0 | Initial release. Resource that contains information for a power supply within a chassis. Replaces PowerSupplies array within the Power resource. |
PowerSupplyMetrics | 1.0.0 | Initial release. Resource that contains metrics related information for a power supply within a chassis. |
ThermalMetrics | 1.0.0 | Initial release. Resource that contains thermal related metrics for a chassis. |
ThermalSubsystem | 1.0.0 | Initial release. Resource that contains thermal related information within a chassis. Replaces the Thermal resource. |
AccountService | 1.8.0 | Added RestrictedPrivileges , RestrictedOemPrivileges , SupportedAccountTypes , and SupportedOEMAccountTypes properties. Added TACACSplus property for configuring external authentication via TACACS+. Added Priority property to external account providers. |
AggregationSource | 1.1.0 | Added SNMP property for configuring SNMP aggregation sources. |
Chassis | 1.15.0 | Added Certificates , Measurements , PowerSubsystem , ThermalSubsystem , and EnvironmentMetrics properties. Deprecated Power and Thermal in favor of the new PowerSubsystem , ThermalSubsystem , and EnvironmentMetrics properties. |
Circuit | 1.2.0 | Added DC48 to NominalVoltageType . |
ComputerSystem | 1.14.0 | Added Certificates and Measurements properties. Added TrustedModuleRequiredToBoot to Boot . Added CoreCount to ProcessorySummary . |
Drive | 1.12.0 | Added Certificates , Measurements , and EnvironmentMetrics properties. |
EventDestination | 1.10.0 | Added AuthenticationKeySet and EncryptionKeySet properties. Added HMAC128_SHA224 , HMAC192_SHA256 , HMAC256_SHA384 , and HMAC384_SHA512 to SNMPAuthenticationProtocols . Added RetryForeverWithBackoff to DeliveryRetryPolicy . |
ExternalAccountProvider | 1.2.0 | Added TACACSplusService property for configuring external authentication via TACACS+. Added Priority property. |
Facility | 1.1.0 | Added EnvironmentMetrics and AmbientMetrics properties. |
LogEntry | 1.8.0 | Added Resolved property. |
Manager | 1.11.0 | Added Location , LocationIndicatorActive , and SparePartNumber properties. |
ManagerAccount | 1.7.0 | Added StrictAccountTypes property. Added HMAC128_SHA224 , HMAC192_SHA256 , HMAC256_SHA384 , and HMAC384_SHA512 to SNMPAuthenticationProtocols . Extended AccountTypes enumeration to add HostConsole , ManagerConsole , IPMI , KVMIP , VirtualMedia , and WebUI . |
Memory | 1.11.0 | Added SparePartNumber , Model , Certificates , Measurements , and EnvironmentMetrics properties. Added Processors to Links . Added HBM3 , GDDR , GDDR2 , GDDR3 , GDDR4 , GDDR5 , GDDR5X , GDDR6 , DDR5 , and OEM to MemoryDeviceType . |
MetricReportDefinition | 1.4.0 | Added Oem to Metrics . |
NetworkAdapter | 1.6.0 | Added Certificates and Measurements properties. |
NetworkPort | 1.4.0 | Deprecated schema in favor of Port schema. |
PCIeDevice | 1.6.0 | Added SparePartNumber property. |
PhysicalContext | N/A | Added TrustedModule physical context type. |
Power | 1.7.0 | Deprecated schema in favor of new PowerSubsystem schema. |
Processor | 1.11.0 | Added MemorySummary , SparePartNumber , Certificates , Measurements , and EnvironmentMetrics properties. Added Memory to Links . |
ProcessorMetrics | 1.2.0 | Added CacheMetrics property. Added ClearCurrentPeriod for clearing the CurrentPeriod property within CacheMetrics . Deprecated temperature related properties in favor of the EnvironmentMetrics resource. |
Redundancy | 1.4.0 | Added RedundantGroup definition to migrate away from using the ReferenceableMember definition for redundancy. |
Resource | 1.11.0 | Added Conditions property to Status for showing details about what needs attention in a given resource. |
Role | 1.3.0 | Added Restricted and AlternateRoleId properties. |
Sensor | 1.2.0 | Added RelatedItem , SpeedRPM , and DeviceName properties. Added UpperCautionUser , UpperCriticalUser , LowerCautionUser , and LowerCriticalUser to Thresholds . |
SoftwareInventory | 1.4.0 | Added Measurement property. Added MeasurementBlock definition for containing SPDM-related measurement information. |
Storage | 1.10.0 | Added Certificates and Measurements to StorageControllers . |
StorageController | 1.1.0 | Added Certificates and Measurements properties. |
Switch | 1.5.0 | Added Certificates and Measurements properties. |
TelemetryService | 1.3.0 | Added ClearMetricReports , ResetMetricReportDefinitionsToDefaults , and ResetTriggersToDefaults actions. |
Thermal | 1.7.0 | Deprecated schema in favor of new ThermalSubsystem schema. |
VLanNetworkInterface | 1.2.0 | Added VLANPriority property. |
Zone | 1.6.0 | Added ZoneOfResourceBlocks to ZoneType . |
Event | 1.x.x | Errata release. Updated descriptions to reference the "MessageId format" clause in the specification. Fixed description of EventId to be consistent with the specification. |
EventDestination | 1.x.x | Errata release. Clarified the descriptions for EventFormatType to specify the relationship with the Protocol property. Removed requirement for DeliveryRetryPolicy to have a default value if not specified. |
Memory | 1.x.x | Errata release. Removed the term "DC" from the description of the IntelOptane memory type. |
Message | 1.x.x | Errata release. Updated descriptions to reference the "MessageId format" clause in the specification. |
MessageRegistry | 1.x.x | Errata release. Clarified that Severity and MessageSeverity can be replaced in events and messages by a value determined by the service. |
MetricReport | 1.x.x | Errata release. Clarified behavior for when a metric report is deleted. |
NetworkDeviceFunction | 1.x.x | Errata release. Corrected the description for the iSCSI value for BootMode to allow for Ethernet devices. |
PCIeSlots | 1.4.1 | Errata release. Corrected the placement of the LocationIndicatorActive to be within a given slot. |
(various files) | various | Errata release. Several typographic and consistency corrections. Removed non-normative term "must" from long descriptions. Regenerated several schemas to mark integer properties as 64-bit in OpenAPI definitions. |
3.9 Release 2020.3 (August 2020)
Schema name | Version | Description |
---|---|---|
Connection | 1.0.0 | Initial release. A resource to describe the access permissions endpoints, or groups of endpoints, have with other resources in the service. |
StorageController | 1.0.0 | Initial release. A resource to describe a storage controller. |
Port | N/A | Added URI patterns for ports to be represented within network interfaces and network adapters. |
PortCollection | N/A | Added URI patterns for ports to be represented within network interfaces and network adapters. |
VirtualMedia | N/A | Added URI patterns for virtual medial to be represented within a computer system. |
VirtualMediaCollection | N/A | Added URI patterns for virtual medial to be represented within a computer system. |
AddressPool | 1.1.0 | Added Ethernet property. |
Assembly | 1.3.0 | Added LocationIndicatorActive and Location properties. |
Chassis | 1.14.0 | Added LocationIndicatorActive and Drives properties. Deprecated IndicatorLED in favor of LocationIndicatorActive . |
Circuit | 1.1.0 | Added LocationIndicatorActive property. Deprecated IndicatorLED in favor of LocationIndicatorActive . |
ComputerSystem | 1.13.0 | Added LocationIndicatorActive , BootProgress , SerialConsole , GraphicalConsole , VirtualMediaConfig , VirtualMedia , PowerOnDelaySeconds , PowerOffDelaySeconds , and PowerCycleDelaySeconds properties. Deprecated IndicatorLED in favor of LocationIndicatorActive . |
Drive | 1.11.0 | Added LocationIndicatorActive property. Deprecated IndicatorLED in favor of LocationIndicatorActive . |
Endpoint | 1.5.0 | Added Manager to EntityType . Added Connections to Links . |
EndpointGroup | 1.3.0 | Initial transition from SNIA. Deprecated AccessState in favor of AccessState in Connection . Deprecated Endpoints in favor of Endpoints in Links . Deprecated Client and Server in favor of Initiator and Target . Added Connections to Links . |
Event | 1.6.0 | Added SpecificEventExistsInGroup property. |
EventDestination | 1.9.0 | Added Certificates , VerifyCertificate , SyslogFilters , OEMProtocol , and OEMSubscriptionType properties. Added syslog related values to Protocol and SubscriptionType . |
Fabric | 1.2.0 | Added Connections and EndpointGroups properties. |
HostInterface | 1.3.0 | Added CredentialBootstrapping property. Added CredentialBootstrappingRole to Links . Deprecated KernelAuthRoleId , KernelAuthEnabled , FirmwareAuthRoleId , FirmwareAuthEnabled , KernelAuthRole , and FirmwareAuthRole in favor of new credential bootstrapping properties. |
LogEntry | 1.7.0 | Added AdditionalDataSizeBytes , AdditionalDataURI , DiagnosticDataType , OEMDiagnosticDataType properties. |
LogService | 1.2.0 | Added CollectDiagnosticData action. Added SyslogFilters property. |
Manager | 1.10.0 | Added TimeZoneName property. Deprecated VirtualMedia and SerialConsole properties in favor of those added to ComputerSystem . |
Memory | 1.10.0 | Added LocationIndicatorActive property. |
MemoryChunks | 1.4.0 | Added DisplayName property. |
MemoryMetrics | 1.4.0 | Added CorrectableECCErrorCount and UncorrectableECCErrorCount properties to CurrentPeriod and LifeTime . |
MetricDefinition | 1.1.0 | Added OEM to CalculationAlgorithm . Added OEMCalculationAlgorithm property. |
NetworkAdapter | 1.5.0 | Deprecated NetworkPorts in favor of Ports to leverage the common Port schema. |
NetworkDeviceFunction | 1.5.0 | Added InfiniBand property. Deprecated AssignablePhysicalPorts and PhysicalPortAssignment in favor of AssignablePhysicalNetworkPorts and PhysicalNetworkPortAssignment to leverage the common Port schema. Added MTUSizeMaximum property to Ethernet . |
NetworkInterface | 1.2.0 | Deprecated NetworkPorts in favor of Ports to leverage the common Port schema. |
NetworkPort | 1.3.0 | Added Starting and Training values to LinkStatus . |
Outlet | 1.1.0 | Added LocationIndicatorActive property. Deprecated IndicatorLED in favor of LocationIndicatorActive . |
PCIeDevice | 1.5.0 | Added UUID property. |
PCIeSlots | 1.4.0 | Added LocationIndicatorActive property. |
Port | 1.3.0 | Added LocationIndicatorActive , MaxFrameSize , LinkConfiguration , FibreChannel , and Ethernet properties. |
Processor | 1.10.0 | Added LocationIndicatorActive , BaseSpeedMHz , SpeedLimitMHz , and SpeedLocked properties. Added ProtectedIdentificationNumber to ProcessorId . |
Protocol | N/A | Added Ethernet and InfiniBand protocols. |
Resource | 1.10.0 | Added NGUID to DurableNameFormat . |
ServiceRoot | 1.9.0 | Added Storage property. |
Session | 1.3.0 | Added ClientOriginIPAddress property. |
SimpleStorage | 1.3.0 | Added Storage to Links . |
Storage | 1.9.0 | Added URI pattern to allow for storage instances to be beneath service root. Added Controllers and Identifiers properties. Added SimpleStorage and StorageServices to Links . |
Switch | 1.4.0 | Added LocationIndicatorActive , CurrentBandwidthGbps , and MaxBandwidthGbps properties. Added PCIeDevice property to Links . Deprecated IndicatorLED in favor of LocationIndicatorActive . |
Task | 1.5.0 | Added SubTasks property. |
Zone | 1.5.0 | Added AddEndpoint and RemoveEndpoint actions. |
AddressPool | 1.0.1 | Errata release. Several typographic and consistency corrections. |
AccountService | 1.x.x | Errata release. Clarified that MinPasswordLength and MaxPasswordLength do not apply to external accounts. Fixed permissions for MinPasswordLength and MaxPasswordLength to be writable. Clarified that AuthFailureLoggingThreshold applies per account. |
AttributeRegistry | 1.x.x | Errata release. Clarified the evaluation order for Dependencies containing multiple logic expressions. |
Chassis | 1.x.x | Errata release. Added recommendation for using @Redfish.AllowableValues for ResetType for compatibility with older clients. |
ComputerSystem | 1.x.x | Errata release. Removed restriction in the UefiTargetBootSourceOverride to allow for Continuous to be used with UefiTarget . Clarified that ProcessorySummary only contains processors that execute system code. Added recommendation for using @Redfish.AllowableValues for ResetType for compatibility with older clients. |
EthernetInterface | 1.x.x | Errata release. Clarified several descriptions to state the difference between IP addresses that are currently in use versus addresses that are requested to be assigned. |
Event | 1.x.x | Errata release. Clarified that Severity and MessageSeverity in responses can be service-defined and not come from a message registry. |
IPAddresses | 1.x.x | Errata release. Clarified the description of the IPv4 Gateway property to show that there should only be one gateway per interface if multiple addresses are allowed. |
Job | 1.0.5 | Errata release. Clarified that steps of jobs cannot have their own steps. |
LogEntry | 1.x.x | Errata release. Corrected the description for SensorNumber to show that it only applies for entries of type SEL . |
Manager | 1.x.x | Errata release. Added recommendation for using @Redfish.AllowableValues for ResetType for compatibility with older clients. |
ManagerAccount | 1.x.x | Errata release. Corrected the description for EncryptionKey . |
ManagerNetworkProtocol | 1.x.x | Errata release. Clarified the SNMP AuthenticationProtocol property does not apply when EncryptionProtocol contains the value Account and instead is determined based on the settings of individual accounts. Clarified usage of VirtualMedia and KVMIP properties that they apply to all systems managed by the manager. |
Memory | 1.x.x | Errata release. Clarified various descriptions to show properties are for the memory device. |
Message | 1.x.x | Errata release. Clarified that Resolution , Severity , and MessageSeverity in responses can be service-defined and not come from a message registry. |
MessageRegistry | 1.x.x | Errata release. Clarified that Resolution , Severity , and MessageSeverity in responses can be service-defined and not come from a message registry. |
MetricDefinition | 1.0.5 | Errata release. Clarified CalculationParameters to show it should be used when ImplementationType is Synthesized or Calculated . |
MetricReportDefinition | 1.x.x | Errata release. Corrected permissions for ReportActions , ReportUpdates , MetricId , and properties in Wildcards to be writable. |
OperatingConfig | 1.0.1 | Errata release. Clarified the description for BaseSpeedMHz to show it's the nominal speed. |
Port | 1.2.2 | Errata release. Clarified the descriptions for Starting and Training . |
Resource | 1.9.3 | Errata release. Added long descriptions to all reset type values. |
Settings | 1.x.x | Errata release. Clarified usage of the SupportedApplyTimes property to state that having a single member is valid for conveying a non-configurable apply time. |
Signature | 1.0.1 | Errata release. Several typographic and consistency corrections. |
UpdateService | 1.x.x | Errata release. Clarified the descriptions of FirmwareInventory and SoftwareInventory to explain the types of members to find in their respective collections. Clarified that TransferProtocol in SimpleUpdate is ignored if the scheme is provided in the URI. |
(various files) | various | Errata release. Corrected permissions and update capabilities for several resources. |
3.10 Release 2020.2 (April 2020)
Schema name | Version | Description |
---|---|---|
Aggregate | 1.0.0 | Initial release. A resource to groupings of other resources in order to consolidate operations for large sets of resources. |
AggregationService | 1.0.0 | Initial release. A resource to control how a service can access southbound interfaces for aggregating interfaces and manage sets of resources. |
AggregationSource | 1.0.0 | Initial release. A resource that describes the address and credentials required by an aggregator when interfacing with southbound services. |
ConnectionMethod | 1.0.0 | Initial release. A resource that describes the method used by an aggregator to interface with a southbound service. |
OperatingConfig | 1.0.0 | Initial release. A resource that contains configuration settings that can be applied to a given processor. |
ComputerSystem | 1.12.0 | Added LastResetTime property. |
Drive | 1.10.0 | Added ReadyToRemove property. |
Event | 1.5.0 | Added MessageSeverity property. Deprecated Severity in favor of MessageSeverity . |
EventService | 1.7.0 | Deprecated Login enumeration in SMTPAuthenticationMethods in favor of Plain . |
Manager | 1.9.0 | Added LastResetTime property. Added ManagedBy and ManagerForManagers properties to Links . |
MediaController | 1.1.0 | Added UUID property. |
MetricReport | 1.4.0 | Added Context property. |
NetworkAdapter | 1.4.0 | Added Location and Identifiers properties for the overall network adapter. |
Processor | 1.9.0 | Deprecated FirmwareVersion in FPGA in favor of FirmwareVersion at the root of the resource. Added TurboState , BaseSpeedPriorityState , HighSpeedCoreIDs , OperatingConfigs , and AppliedOperatingConfig properties. |
ServiceRoot | 1.8.0 | Added AggregationService property. |
AccountService | 1.x.x | Errata release. Clarified the description for AuthFailureLoggingThreshold . |
ComputerSystem | 1.x.x | Errata release. Removed confusing text in the long description for BootSourceOverrideEnable that mentioned a general restriction with regards to Continuous and UEFI. |
NetworkAdapter | 1.x.x | Errata release. Clarified the Location and Identifiers properties inside Controllers are for the controller and not the overall adapter. |
(various files) | various | Errata release. Several typographic and consistency corrections. |
3.11 Release 2020.1 (March 2020)
Schema name | Version | Description |
---|---|---|
Chassis | N/A | Updated capabilities to allow for deleting Chassis resources. |
ChassisCollection | N/A | Updated capabilities to allow for creating Chassis resources. |
PCIeDevice | N/A | Added URI patterns for PCIe devices to be represented within resource blocks. |
PCIeDeviceCollection | N/A | Added URI patterns for PCIe devices to be represented within resource blocks. |
PCIeFunction | N/A | Added URI patterns for PCIe functions to be represented within resource blocks. |
PCIeFunctionCollection | N/A | Added URI patterns for PCIe functions to be represented within resource blocks. |
SecureBootDatabase | 1.0.0 | Initial release. A resource to manage UEFI Secure Boot databases. |
Signature | 1.0.0 | Initial release. A resource to describe a signature or hash. |
Certificate | 1.2.0 | Added UefiSignatureOwner property. |
Chassis | 1.12.0 | Added MaxPowerWatts and MinPowerWatts properties. |
ComputerSystem | 1.11.0 | Added AutomaticRetryConfig , AutomaticRetryAttempts , and RemainingAutomaticRetryAttempts to Boot . |
EthernetInterface | 1.6.0 | Added EthernetInterfaceType property. Added NetworkDeviceFunction to Links . |
EventDestination | 1.8.0 | Added IncludeOriginOfCondition property. |
EventService | 1.5.0 | Added IncludeOriginOfConditionSupported property. |
LogEntry | 1.6.0 | Added Modified property. |
Manager | 1.8.0 | Added ResetToDefaults action. |
ManagerAccount | 1.6.0 | Added PasswordExpiration property. |
ManagerNetworkProtocol | 1.6.0 | Added ArchitectureId to EngineId . |
MemoryMetrics | 1.3.0 | Added OperatingSpeedMHz property. |
MessageRegistry | 1.4.0 | Added MessageSeverity property. Deprecated Severity in favor of MessageSeverity . |
NetworkDeviceFunction | 1.4.0 | Added EthernetInterface to Links . |
PCIeSlots | 1.3.0 | Added U2 value to PCIeSlotType . |
Processor | 1.8.0 | Added SystemInterface , OperatingSpeedMHz , and MinSpeedMHz properties. Added AMBA , CCIX , and CXL values to the interface type enumeration. |
ProcessorMetrics | 1.1.0 | Added OperatingSpeedMHz property. Deprecated AverageFrequencyMHz in favor of OperatingSpeedMHz . |
SecureBoot | 1.1.0 | Added SecureBootDatabases property. |
ServiceRoot | 1.7.0 | Added DeepOperations property. |
SoftwareInventory | 1.3.0 | Added WriteProtected property. |
Event | 1.x.x | Errata release. Updated description for OriginOfCondition to show that a subscriber can request the full resource for the origin of the event to be included in the event itself. |
ManagerAccount | 1.x.x | Errata release. Corrected formats for AuthenticationKey and EncryptionKey within SNMP to support patterns defined in RFC3414. |
ManagerNetworkProtocol | 1.x.x | Errata release. Clarified EnterpriseSpecificMethod is tied to the "type 2 format" of the RFC3411-defined snmpEngineID. Made PrivateEnterpriseId and EnterpriseSpecificMethod read-only. |
MemoryMetrics | 1.x.x | Errata release. Corrected description of HealthData to allow its usage with regards to being metrics for a memory summary. |
MetricReportDefinition | 1.x.x | Errata release. Clarified that ReportUpdates and ReportActions should be ignored when MetricReportDefinitionType is OnRequest . Clarified behavior of some properties when a metric report stops. Clarified ReportTimespan is the maximum time span the report can cover. |
SecureBoot | 1.x.x | Errata release. Updated descriptions as needed to reference UEFI Secure Boot databases. |
TaskService | 1.x.x | Errata release. Clarified LifeCycleEventOnTaskStateChange to reference the Task Event Message Registry for task events. |
(various files) | various | Errata release. Several typographic and consistency corrections. |
3.12 Release 2019.4 (December 2019)
Schema name | Version | Description |
---|---|---|
(un-versioned JSON Schema) | N/A | Removed down-revision errata schema references from anyOf arrays in un-versioned JSON Schema files to significantly improve schema tool performance and avoid known and addressed schema errata. |
AddressPool | 1.0.0 | Initial release. A resource to describe pools for addressable memory for a fabric. |
Circuit | 1.0.0 | Initial release. A resource to describe an electrical circuit in power equipment. |
FabricAdapter | 1.0.0 | Initial release. A resource to describe an adapter for fabric connectivity. |
Facility | 1.0.0 | Initial release. A resource to describe a room, floor, building, or site containing equipment. |
MediaController | 1.0.0 | Initial release. A resource to describe a media controller. |
Outlet | 1.0.0 | Initial release. A resource to describe an electrical outlet in power equipment. |
OutletGroup | 1.0.0 | Initial release. A resource to describe a group of electrical outlets in power equipment. |
PortMetrics | 1.0.0 | Initial release. A resource to collect metrics associated with a port. |
PowerDistribution | 1.0.0 | Initial release. A resource to describe a power distribution component or unit, such as a floor PDU, rack PDU, transfer switch, or switchgear. |
PowerDistributionMetrics | 1.0.0 | Initial release. A resource to collect metrics for a power distribution component or unit. |
PowerDomain | 1.0.0 | Initial release. A resource to show power equipment within the same domain. |
PowerEquipment | 1.0.0 | Initial release. A resource to show the power equipment being tracked by a service. |
RouteEntry | 1.0.0 | Initial release. A resource to report and configure a set of routes for a switch or port. |
RouteSetEntry | 1.0.0 | Initial release. A resource to report and configure a specific route in a route entry for a switch or port. |
VCATEntry | 1.0.0 | Initial release. A resource to report and configure a Virtual Action Table entry. |
AccountService | 1.7.0 | Added PasswordSet to LDAP and ActiveDirectory . |
Chassis | 1.11.0 | Added MediaControllers , Memory , and MemoryDomains properties. Added Facility to Links . |
ComputerSystem | 1.10.0 | Added Appliance , BareMetalServer , VirtualMachineServer , and ContainerServer values to HostingRoles . Added FabricAdapters property. |
Drive | 1.9.0 | Added Multipath property. |
Endpoint | 1.4.0 | Added GenZ property. Added MediaController , MemoryChunk , Switch , and FabricBridge values to EntityType . |
Fabric | 1.1.0 | Added AddressPools property. |
Manager | 1.7.0 | Added Manufacturer , SerialNumber , and PartNumber properties. |
ManagerAccount | 1.5.0 | Added AuthenticationKeySet and EncryptionKeySet properties to SNMP . |
Memory | 1.9.0 | Deprecated DeviceLocation ; Location should be used in its place. |
MemoryChunks | 1.3.0 | Added AddressRangeOffsetMiB and Links properties. |
MemoryDomain | 1.3.0 | Added Links property. |
MetricReport | 1.3.0 | Deprecated ReportSequence based on client feedback with usage of SSE id . |
PCIeSlots | 1.2.0 | Added OCP3Small and OCP3Large values for SlotType . |
Port | 1.2.0 | Added PortMedium , LinkNetworkTechnology , InterfaceEnabled , SignalDetected , LinkTransitionIndicator , ActiveWidth , LinkState , LinkStatus , GenZ , and Metrics properties. |
Processor | 1.7.0 | Added SerialNumber , PartNumber , Version , and FirmwareVersion properties. |
Protocol | N/A | Added MultiProtocol and GenZ protocols. |
Resource | 1.9.0 | Added Qualified value to State . |
Sensor | 1.1.0 | Added CrestFactor , THDPercent , LifetimeReading , SensingInterval , ReadingTime , and Implementation . |
ServiceRoot | 1.6.0 | Added PowerEquipment and Facilities properties. |
Switch | 1.3.0 | Added SupportedProtocols and UUID properties. Added Endpoints to Links . Updated description for SwitchType to guide users to use SupportedProtocols for multi-protocol switches. |
TelemetryService | 1.2.0 | Added ServiceEnabled property. |
Thermal | 1.6.0 | Added UpperThresholdUser and LowerThresholdUser to Temperatures . |
UpdateService | 1.8.0 | Added Oem to UpdateParameters . |
Zone | 1.4.0 | Added ZoneType and DefaultRoutingEnabled properties. Added AddressPools , ContainedByZones , and ContainsZones to Links . |
Assembly | 1.x.x | Errata release. Clarified Version property to state it refers to the version of hardware. |
ComputerSystem | 1.x.x | Errata release. Corrected description for UefiTargetBootSourceOverride to remove erroneous mention of @Redfish.AllowableValues . |
IPAddress | 1.x.x | Errata release. Corrected minimum term on PrefixLength . |
LogEntry | 1.x.x | Errata release. Clarified several references to the IPMI Specification to show a specific version of the specification. |
ManagerAccount | 1.x.x | Errata release. Removed incorrect clause that tied Enabled and Locked together. |
PCIeSlots | 1.x.x | Errata release. Corrected typo in the description for Location . |
Processor | 1.x.x | Errata release. Corrected typos in several property descriptions. |
Resource | N/A | Errata release. Extended InTest state to mention capturing information . |
Sensor | 1.0.4 | Errata release. Corrected action to reset metrics to be named ResetMetrics . |
Task | 1.x.x | Errata release. Clarified the behavioral aspects of HidePayload and Payload . |
3.13 Release 2019.3 (October 2019)
Schema name | Version | Description |
---|---|---|
ComputerSystem | 1.9.0 | Added HttpBootUri to Boot . |
Drive | 1.8.0 | Added StoragePools to Links . |
EventDestination | 1.7.0 | Added properties to support SMTP and SNMP event delivery. |
EventService | 1.5.0 | Added properties to support SMTP event delivery. |
LogEntry | 1.5.0 | Added GeneratorId property. |
ManagerAccount | 1.4.0 | Added properties to support access to SNMP services. |
ManagerNetworkProtocol | 1.5.0 | Added properties to support SNMP services. |
Power | 1.6.0 | Added PowerSupplyReset action. |
Privileges | N/A | Added NoAuth privilege. |
Processor | 1.6.0 | Added Reset action. |
Protocol | N/A | Added TCP , UDP , and TFTP protocols. |
Settings | 1.3.0 | Added OnStartUpdateRequest to the OperationApplyTime enumeration. |
Storage | 1.8.0 | Added FileSystems , StoragePools , StorageGroups , EndpointGroups , and ConsistencyGroups properties. |
UpdateSerivice | 1.7.0 | Added StartUpdate action. |
LogEntry | 1.x.x | Errata release. Modified description of MessageId to include the Event Type/Event Direction byte in the string for SEL type entries. |
Privileges | N/A | Errata release. Clarified the description for ConfigureSelf to show that it's also used for users to log out of their own sessions. |
Processor | 1.x.x | Errata release. Removed CPUID term from the IdentificationRegisters description in order to not be tied to x86 processors. |
Resource | 1.8.3 | Errata release. Removed Excerpt annotation from common Name property. |
Sensor | 1.0.3 | Errata release. Corrected units for ApparentVA and ReactiveVAR properties. Fixed several Excerpt annotations. |
3.14 Release 2019.2 (August 2019)
Schema name | Version | Description |
---|---|---|
AccountService | 1.6.0 | Added LocalFirst to the LocalAccountAuth enumeration. |
Bios | 1.1.0 | Added SoftwareImages and ActiveSoftwareImage properties to Links . |
Chassis | 1.10.0 | Deprecated PCIeDevices array inside Links in favor of new PCIeDevices resource collection. |
CollectionCapabilities | 1.2.0 | Added MaxMembers property. |
ComputerSystem | 1.8.0 | Added Metrics property to MemorySummary . |
Drive | 1.7.0 | Added WriteCacheEnabled property. Added Reset action. |
EventDestination | 1.6.0 | Added DeliveryRetryPolicy , Status , and MetricReportDefinitions properties. Added ResumeSubscription action. |
EventService | 1.4.0 | Added SubordinateResources property to SSEFilterPropertiesSupported . |
Manager | 1.6.0 | Added SoftwareImages and ActiveSoftwareImage properties to Links . |
Memory | 1.8.0 | Added Reset action. |
MemoryMetrics | 1.2.0 | Added BandwidthPercent property. |
MetricReport | 1.2.0 | Added Oem property to MetricValues . |
MetricReportDefinition | 1.3.0 | Added ReportTimespan property. |
NetworkAdapter | 1.3.0 | Added Identifiers property to Controllers . |
PCIeDevice | 1.4.0 | Deprecated PCIeFunctions array inside Links in favor of new PCIeFunctions resource collection. |
Switch | 1.2.0 | Added FirmwareVersion property. |
UpdateService | 1.6.0 | Added MultipartHttpPushUri property for performing an update using HTTP multipart forms with additional semantics specified in the Redfish Specification. |
Assembly | 1.x.x | Errata release. Clarified that the BinaryDataUri reference is accessed using Redfish protocol semantics. |
AccountService | 1.x.x | Errata release. Clarified that the LDAPService property should only be used in the context of LDAP services. |
EthernetInterface | 1.x.x | Errata release. Fixed several properties to allow for null so that services can advertise the size of configurable arrays. Clarified the description of the SpeedMbps property to state that it's writable only when AutoNeg is false. |
Event | 1.x.x | Errata release. Clarified the description of EventId to give guidance on its usage. Added semantics of when EventGroupId is 0. |
EventService | 1.x.x | Errata release. Fixed parameters in SubmitTestEvent so that only MessageId is required. Added language to DeliveryRetryAttempts to show how it ties to the DeliveryRetryPolicy property in EventDestination. |
ExternalAccountProvider | 1.x.x | Errata release. Clarified that the LDAPService property should only be used in the context of LDAP services. |
Job | 1.x.x | Errata release. Fixed EndTime property to not allow for null . |
JsonSchemaFile | 1.x.x | Errata release. Clarified that the Uri and ArchiveUri references are accessed using Redfish protocol semantics. |
MessageRegistry | 1.x.x | Errata release. Fixed several descriptions to call out "registry" instead of "schema". |
MessageRegistryFile | 1.x.x | Errata release. Clarified that the Uri and ArchiveUri references are accessed using Redfish protocol semantics. |
MetricReportDefinition | 1.x.x | Errata release. Corrected descriptions in the CalculationAlgorithmEnum enum. |
NetworkDeviceFunction | 1.x.x | Errata release. Added missing regex pattern for MAC address properties. |
PCIeSlots | 1.1.1 | Errata release. Corrected the location of the HotPluggable property. |
ProcessorMetrics | 1.0.2 | Errata release. Clarified descriptions of several properties to explain the usage when the resource represents a summary of processors. |
Task | 1.x.x | Errata release. Fixed EndTime property to not allow for null . |
UpdateService | 1.x.x | Errata release. Clarified description of ImageURI parameter to reference RFC3986. Clarified descriptions of various properties to replace "firmware" with "software". |
(various files) | various | Errata release. Fixed several password related properties to be null in all responses regardless of the operation. Removed @odata.id , @odata.context , and @odata.etag properties from registry resources. |
(all files) | various | Errata release. Descriptions in all schemas were updated for consistency in language and terminology. Any functional changes made that are not listed in this change log are unintentional and will be treated as errata. |
3.15 Release 2019.1 (April 2019)
Schema name | Version | Description |
---|---|---|
AccountService | 1.5.0 | Added AccountLockoutResetAfterEnabled property. Deprecated AccountProviderType property in LDAP and ActiveDirectory . |
Certificate | 1.1.0 | Added Renew and Rekey actions. |
ComputerSystem | 1.7.0 | Added Certificates property to Boot . Added Metrics property to ProcessorySummary . |
Drive | 1.6.0 | Added PCIeFunctions property to Links . |
EthernetInterface | 1.5.0 | Added FallbackAddress property to DHCPv4 . |
Event | 1.4.0 | Added Other to EventType enum. |
EventDestination | 1.5.0 | Deprecated EventTypes property and made it not required. |
EventService | 1.3.0 | Added EventGroupId parameter to SubmitTestEvent . Deprecated EventTypesForSubscription property. Deprecated EventType property in SSEFilterPropertiesSupported . Deprecated EventType parameter in SubmitTestEvent . |
ManagerAccount | 1.3.0 | Added PasswordChangeRequired property. |
MessageRegistry | 1.3.0 | Added LongDescription , ArgDescriptions , and ArgLongDescriptions properties to Messages . |
MetricReportDefinition | 1.2.0 | Added MetricReportDefinitionEnabled , SuppressRepeatedMetricValue , and MetricReportHeartbeatInterval properties. Added Triggers to Links . |
PCIeSlots | 1.1.0 | Added HotPluggable property. |
PhysicalContext | N/A | Added PowerSubsystem and Rectifier physical context types. |
Processor | 1.5.0 | Added TotalEnabledCores property. |
Session | 1.2.0 | Added SessionType and OemSessionType properties. |
Storage | 1.7.0 | Added Ports , ControllerRates , and PCIeFunctions to StorageControllers . |
Triggers | 1.1.0 | Added EventTriggers property. Added MetricReportDefinitions to Links . Added RedfishMetricReport to TriggerActionEnum . |
UpdateService | 1.5.0 | Added MaxImageSizeBytes property. |
Zone | 1.3.0 | Added ExternalAccessibility property. |
AccountService | 1.x.x | Errata release. Clarified descriptions within LDAPSearchSettings . |
Endpoint | 1.x.x | Errata release. Clarified the descriptions for EntityRole . |
EthernetInterface | 1.4.2 | Errata release. Corrected StaticNameServers to allow for null values. |
Event | 1.x.x | Errata release. Removed @odata.id and @odata.etag properties from JSON Schema. |
EventDestination | 1.x.x | Errata release. Modified rules around usage of HttpHeaders in a GET response to allow for an empty array. Clarified the descriptions for EventTypes and ResourceTypes . |
ExternalAccountProvider | 1.x.x | Errata release. Clarified descriptions within LDAPSearchSettings . |
Message | 1.0.7 | Errata release. Clarified the description for MessageArgs . |
Port | 1.x.x | Errata release. Clarified the descriptions for PortId , AssociatedEndpoints , and ConnectedSwitches . Clarified the description of the overall resource. |
Resource | 1.x.x | Errata release. Corrected regex pattern for properties inside of Oem to match requirements in the specification. Clarified the description for MemberId . |
Sensor | 1.0.1 | Errata release. Corrected the descriptions and units definition for energy reading types of kWh and corrected UCUM unit definition to kW.h . |
UpdateService | 1.x.x | Errata release. Clarified HttpPushUri description to include a recommendation of using HTTP status 411 when the request does not include the Content-Length header. |
(various files) | various | Errata release. Regenerating JSON Schema to use uri-reference instead of uri as the format for properties that represent URIs. Fixed many properties that allowed for null , but were not intended for it. |
3.16 Release 2018.3 (December 2018)
Schema name | Version | Description |
---|---|---|
AccelerationFunction | 1.0.0 | Initial release. A resource to describe an acceleration function within a Redfish implementation. |
AccelerationFunctionCollection | 1.0.0 | Initial release. A collection of acceleration functions. |
AccountService | 1.4.0 | Added Certificates property to LDAP and ActiveDirectory objects. |
AttributeRegistry | 1.3.0 | Added Oem property to Attributes and Menus . Added Hidden property to Menus . |
Certificate | 1.0.0 | Initial release. A resource to describe a certificate within a Redfish implementation. |
CertificateCollection | 1.0.0 | Initial release. A collection of certificates. |
CertificateLocations | 1.0.0 | Initial release. A resource to describe certificate locations within a Redfish implementation. |
CertificateService | 1.0.0 | Initial release. A resource to describe a certificate service within a Redfish implementation. |
Chassis | 1.9.0 | Added Sensors and EnvironmentalClass properties. |
ComputerSystem | 1.6.0 | Added AliasBootOrder , BootOrderPropertySelection , and PowerRestorePolicy properties. Added AddResourceBlock and RemoveResourceBlock actions. |
Endpoint | 1.3.0 | Added AccelerationFunction to the EntityType enum. |
ExternalAccountProvider | 1.1.0 | Added Certificates property. |
ManagerAccount | 1.2.0 | Added Certificates property. |
ManagerNetworkProtocol | 1.4.0 | Added Certificates property to HTTPS object. |
Memory | 1.7.0 | Added Intel3DXPoint to the MemoryMedia enum. Added HBM and HBM2 to the MemoryDeviceType enum. Added Die to the BaseModuleType enum. Deprecated Unlocked and Frozen enums in SecurityStates , as well as the SecurityStates property in favor of the new SecurityState , ConfigurationLocked , ConfigurationLockCapable , DataLockCapable , and PassphraseLockLimit properties. |
MetricReport | 1.1.0 | Added Timestamp property for the overall MetricReport. |
MetricReportDefinition | 1.1.0 | Deprecated Keys property within Wildcards in favor of Values property to align with other schemas. |
PhysicalContext | N/A | Added CPUSubsystem , GPUSubsystem , FPGA , Accelerator , MemorySubsystem , CoolingSubsystem , Motor , Transformer , ACUtilityInput , ACStaticBypassInput , ACMaintenanceBypassInput , DCBus , ACOutput , and ACInput physical context types. Updated Intake and Exhaust descriptions to allow for calculated values over a region. Added PhysicalSubContext definition. |
Processor | 1.4.0 | Added TDPWatts , MaxTDPWatts , AccelerationFunctions , and Metrics properties. Added various other properties to support reporting and management of FPGAs. Added Power to ProcessorArchitecture . Added PowerISA to InstructionSet . |
ProcessorMetrics | 1.0.0 | Initial release. A resource to describe processor metrics within a Redfish implementation. |
ResourceBlock | 1.3.0 | Added ResourceBlockLimits term. Added Drives property. |
Sensor | 1.0.0 | Initial release. A resource to describe a sensor within a Redfish implementation. |
SensorCollection | 1.0.0 | Initial release. A collection of sensor resources. |
ServiceRoot | 1.5.0 | Added Vendor , ResourceBlocks , and CertificateService properties. |
Storage | 1.6.0 | Added SupportedRAIDTypes to StorageControllers . |
Task | 1.4.0 | Added PercentComplete property. |
TelemetryService | 1.1.0 | Deprecated MetricReportValues parameter in SubmitTestMetricReport action in favor of the GeneratedMetricReportValues parameter in order to match the MetricValues definition of a MetricReport. |
UpdateService | 1.4.0 | Added Username and Password parameters to SimpleUpdate . Added HttpPushUriOptions and HttpPushUriOptionsBusy properties. |
VirtualMedia | 1.3.0 | Added UserName , Password , TransferProtocolType , and TransferMethod properties. Added UserName , Password , TransferProtocolType , and TransferMethod parameters to InsertMedia action. |
AttributeRegistry | 1.x.x | Errata release. Clarified the description for ValueName . Add missing required terms for AttributeName and ValueName . |
Bios | 1.0.5 | Errata release. Clarified the description for Attributes . |
Drive | 1.x.x | Errata release. Modified references to Volume to point to the Swordfish definition. |
Job | 1.0.1 | Errata release. Added missing units annotation on PercentComplete . |
JsonSchemaFile | 1.x.x | Errata release. Removed strict normative wording about the format of the schema file name in favor of pointing to the specification for the acceptable format. |
MetricDefinition | 1.0.1 | Errata release. Updated descriptions for Wildcards to match other schemas. |
MetricReport | 1.0.1 | Errata release. Clarified Timestamp property description within a MetricValue . |
MetricReportDefinition | 1.0.1 | Errata release. Updated descriptions for Wildcards to match other schemas. |
Power | 1.x.x | Errata release. Clarified the description for PowerMetrics . |
Redundancy | 1.x.x | Errata release. Removed Required term on MaxNumSupported . |
ServiceRoot | 1.x.x | Errata release. Allow Product property to be null. |
Storage | 1.x.x | Errata release. Modified references to Volume to point to the Swordfish definition. |
Triggers | 1.0.1 | Errata release. Updated descriptions for Wildcards to match other schemas. Fixed description for the RedfishEvent enum. |
UpdateService | 1.x.x | Errata release. Clarified HttpPushUri to indicate a client requires the same privileges as if performing operations on the UpdateService. |
(various files) | various | Errata release. Added Revisions and Release annotation to various schema elements as needed. |
3.17 Release 2018.2 (August 2018)
Schema name | Version | Description |
---|---|---|
Job | 1.0.0 | Initial release. A resource to describe a job within a Redfish implementation. |
JobCollection | 1.0.0 | Initial release. A collection of jobs. |
JobService | 1.0.0 | Initial release. Entry point for managing jobs within a Redfish implementation. |
MetricDefinition | 1.0.0 | Initial release. Metadata that defines a metric (measurement point). |
MetricDefinitionCollection | 1.0.0 | Initial release. A collection of metric definitions. |
MetricReport | 1.0.0 | Initial release. A set of reported metric values. |
MetricReportCollection | 1.0.0 | Initial release. A collection of metric reports. |
MetricReportDefinition | 1.0.0 | Initial release. Metadata that defines how metric reports are constructed. |
MetricReportDefinitionCollection | 1.0.0 | Initial release. A collection of metric report definitions. |
PCIeSlots | 1.0.0 | Initial release. Contains details on PCIe slots. |
TelemetryService | 1.0.0 | Initial release. Entry point for managing a Redfish telemetry service. |
Triggers | 1.0.0 | Initial release. Specifies triggers which apply to metrics. |
TriggersCollection | 1.0.0 | Initial release. A collection of triggers. |
ActionInfo | 1.1.0 | Added MinimumValue and MaximumValue properties. |
Assembly | 1.2.0 | Added SerialNumber and PhysicalContext properties. |
Chassis | 1.8.0 | Added PCIeSlots link. |
CollectionCapabilities | 1.1.0 | Added ComputerSystemConstrainedComposition enum. |
CompositionService | 1.1.0 | Added AllowOverprovisioning and AllowZoneAffinity properties. |
Drive | 1.5.0 | Added HotspareReplacementMode property. |
Endpoint | 1.2.0 | Deprecated PciFunctionNumber and PciClassCode inside ConnectedEntity in favor of FunctionNumber and ClassCode inside of PciId . |
Event | 1.3.0 | Deprecated EventType in favor of new subscription properties. Added MetricReport as an EventType. Added EventGroupId to EventRecord . |
EventDestination | 1.4.0 | Added RegistryPrefixes , ResourceTypes , SubordinateResources , and EventFormatType properties. |
EventService | 1.2.0 | Added RegistryPrefixes , ResourceTypes , SubordinateResourcesSupported , and EventFormatTypes properties. Added SSEFilterPropertiesSupported object. |
HostInterface | 1.2.0 | Added AuthNoneRoleId and AuthNoneRole properties. |
LogEntry | 1.4.0 | Deprecated EventType . Added EventGroupId property. |
Manager | 1.5.0 | Added RemoteRedfishServiceUri and RemoteAccountService properties. |
ManagerNetworkProtocol | 1.3.0 | Added DHCPv6 , RDP , and RFB properties. |
Memory | 1.6.0 | Added OverwriteUnit action. Added IntelOptane to the MemoryType enum. |
MessageRegistry | 1.2.0 | Added ClearingLogic property. |
NetworkAdapter | 1.2.0 | Added NPAR property to control NIC Partitioning. Added PCIeInterface object. |
NetworkDeviceFunction | 1.3.0 | Added VLAN and VLANs properties to the Ethernet object. Added FibreChannelId to FibreChannel object. Deprecated PhysicalPortAssignment at the root of the payload in favor of PhysicalPortAssignment inside Links . |
NetworkPort | 1.2.0 | Added properties to support Fibre Channel devices. Deprecated LinkSpeedMbps in favor of CapableLinkSpeedMbps . |
PCIeDevice | 1.3.0 | Added PCIeInterface object and definition for referencing from other schema. |
Protocol | N/A | Added I2C protocol type. |
Resource | 1.7.0 | Deprecated the Location string in PostalAddress in favor of AdditionalInfo . Added AdditionalInfo in Placement . Added Contacts array in Location . |
ResourceBlock | 1.2.0 | Added Expansion to the ResourceBlockType enum. Added Unavailable to the CompositionState enum. |
Schedule | 1.2.0 | Initial transition from SNIA. Added Every enumeration to DayOfWeek and MonthOfYear . Updated several properties to use Duration and DateTimeOffset types. |
ServiceRoot | 1.4.0 | Added ExcerptQuery and OnlyMemberQuery to ProtocolFeaturesSupported . Added JobService and TelemetryService properties. |
Storage | 1.5.0 | Added CacheSummary and PCIeInterface objects to StorageController . |
Task | 1.3.0 | Added Payload and HidePayload properties. |
Thermal | 1.5.0 | Added SensorNumber to Fan . |
UpdateService | 1.3.0 | Deprecated NSF TransferProtocolType in favor of NFS . |
Assembly | 1.x.x | Errata release. Added clause about using 00:00:00Z in the ProductionDate property as the time of day value if it's unknown. |
AttributeRegistry | 1.x.x | Errata release. Fixed typo in the description for GrayOut . Relaxed patterns allowed for ValueName , MenuName , and MenuPath properties. |
Bios | 1.x.x | Errata release. Clarified behavior around the ResetBios action. |
BootOption | 1.x.x | Errata release. Clarified the description of the Alias property. |
ComputerSystem | 1.x.x | Errata release. Added missing units annotation to TotalSystemMemoryGiB . Corrected descriptions for the Boot properties since the scope of Boot has grown over time. |
Drive | 1.x.x | Errata release. Added missing units annotation to PredictedMediaLifeLeftPercent and PercentageComplete . |
EthernetInterface | 1.4.1 | Errata release. Fixed type definition of IPv6StaticDefaultGateways to not require PrefixLength . |
EventService | 1.x.x | Errata release. Added clarification to OriginOfCondition parameter for SubmitTestEvent to highlight that it's a string and not a reference object. |
IPAddresses | 1.0.7 | Errata release. Fixed type definition of IPv6GatewayStaticAddress to not require PrefixLength . |
LogEntry | 1.x.x | Errata release. Fixed typo in the description for EntryType . Clarified description and long description in several properties. |
ManagerNetworkProtocol | 1.x.x | Errata release. Clarified description of DHCP to show it's for DHCPv4. |
Memory | 1.x.x | Errata release. Added missing units annotation to many properties in the schema. Added references to NIST standards for what each type of erase action follows. |
MemoryChunks | 1.x.x | Errata release. Added missing units annotation to MemoryChunkSizeMiB , OffsetMiB , and SizeMiB . |
MemoryMetrics | 1.x.x | Errata release. Added missing units annotation to HealthData and PredictedMediaLifeLeftPercent . |
MessageRegistryFile | 1.x.x | Errata release. Clarified Registry property to show that this is used for other types of registries. |
NetworkPort | 1.x.x | Errata release. Added missing units annotation to LinkSpeedMbps , MinBWAllocPercent , and MaxBWAllocPercent . |
PrivilegeRegistry | 1.x.x | Errata release. Fixed permissions term on PrivilegesUsed , OEMPrivilegesUsed , Entity , Targets , and Privilege . |
Processor | 1.x.x | Errata release. Added missing units annotation to MaxSpeedMHz . |
Protocol | N/A | Errata release. Removed Vendor Proprietary wording from PCIe description. |
Resource | 1.x.x | Errata release. Added missing required term on Name in ResourceCollection . Fixed the description for the PartLocation property inside of Location . |
Resource | 1.6.1 | Errata release. Fixed permissions of Longitude , Latitude , and AltitudeMeters properties. |
SessionService | 1.x.x | Errata release. Clarified the long description of ServiceEnabled . |
SoftwareInventory | 1.x.x | Errata release. Added clause about using 00:00:00Z in the ReleaseDate property as the time of day value if it's unknown. |
Storage | 1.x.x | Errata release. Clarified the description for SpeedGbps . |
UpdateService | 1.x.x | Errata release. Clarified the long descriptions for Targets , HttpPushUriTargets , and HttpPushUriTargetsBusy . |
(all files) | various | Errata release. Added missing required annotation on Members properties in resource collections. Added missing Members@odata.nextLink property to resource collections. Corrected some cases in JSON Schema where the type integer should have been used instead of number . Added @odata.id , @odata.type , and @odata.context as required properties in JSON Schema. Added description and long description terms to all schema elements where missing. Added Capabilities and Uris annotations on all resources. |
3.18 Release 2018.1 (April 2018)
Schema name | Version | Description |
---|---|---|
ExternalAccountProvider | 1.0.0 | Initial release. Contains additional external account provider information for managers. |
ExternalAccountProviderCollection | 1.0.0 | Initial release. Collection of external account providers. |
AccountService | 1.3.0 | Added support for LDAP and Active Directory external account providers. Added ExternalAccountProviders collection to support additional providers or multiple LDAP/AD instances. |
Assembly | 1.1.0 | Added Status to AssemblyData . |
AttributeRegistry | 1.2.0 | Added ResetRequired , UefiDevicePath , UefiKeywordName , and UefiNamespaceId attributes. |
Chassis | 1.7.0 | Added UUID property and Switches links. |
Drive | 1.4.0 | Deprecated Location array in favor of singular PhysicalLocation property. |
EventDestination | 1.3.0 | Added SubscriptionType to allow for SSE support. |
EventService | 1.1.0 | Added ServerSentEventUri to support Server-Sent Eventing (SSE). |
Manager | 1.4.0 | Added AutoDSTEnabled property and Switches links. |
Memory | 1.5.0 | Deprecated poorly-named PassphraseState in Regions object and added PassphraseEnabled to replace it. |
PCIeFunction | 1.2.0 | Added NetworkDeviceFunctions links. |
Processor | 1.3.0 | Added SubProcessors collection; added Core and Thread processor types. |
Protocol | N/A | Added OEM protocol type. |
ResourceBlock | 1.1.0 | Added properties to support sharing capabilities. |
Settings | 1.2.0 | Added OperationApplyTimeSupport and MaintenanceWindow objects to provide more deterministic behavior for the application of Settings-based data. |
SoftwareInventory | 1.2.0 | Added Manufacturer and ReleaseDate properties. |
Task | 1.2.0 | Added TaskMonitor property. |
AttributeRegistry | 1.x.x | Errata release. Fixed regex patterns for various properties. |
EventService | 1.0.7 | Errata release. Fixed permissions on DeliveryRetryAttempts and DeliveryRetryIntervalSeconds properties. |
HostInterface | 1.x.x | Errata release. Description clarifications. |
ManagerAccount | 1.x.x | Errata release. Clarified the RoleId property description by stating its relation to RoleId in the Role resource. |
MemoryChunks | 1.2.1 | Errata release. Description clarifications. |
Memory | 1.4.1 | Errata release. Description clarifications. |
UpdateService | 1.x.x | Errata release. Regenerated JSON schema to pick up action parameters added in previous release. |
3.19 Release 2017.3 (November 2017)
Schema name | Version | Description |
---|---|---|
Assembly | 1.0.0 | Initial release. Contains manufacturing and assembly information for a piece of equipment. |
BootOption | 1.0.0 | Initial release. Contains information about a boot option contained within a system. |
BootOptionCollection | 1.0.0 | Initial release. A collection of boot options. |
Protocol | 1.0.0 | Initial release. Supporting schema file to hold definition of the common Protocol property. |
Chassis | 1.6.0 | Added link to Assembly resource. Added StorageEnclosure to ChassisType . |
ComputerSystem | 1.5.0 | Added support for managing the boot order (Boot Options). Added SubModel to describe product model variations. Added action for SetDefaultBootOrder . Added LogicalProcessorCount to ProcessorSummary . Added links for ConsumingComputerSystems and SupplyingComputerSystems . |
Drive | 1.3.0 | Added link to Assembly resource. |
Endpoint | 1.1.0 | Added IPTransportDetails object. |
EthernetInterface | 1.4.0 | Added multiple objects to allow for full configuration of DHCPv4 and DHCPv6. Added IPv4StaticAddresses to provide mechanism for specifying static IP addresses regardless of DHCP settings. Added StaticNameServers and StatelessAddressAutoConfig objects to support their configuration. |
LogEntry | 1.3.0 | Added OemLogEntryCode and OemSensorType properties to allow for legacy IPMI OEM definitions. |
LogService | 1.1.0 | Added LogEntryType to describe the content type of a log. |
Memory | 1.4.0 | Added VolatileSizeMib , NonVolatileSizeMiB , CacheSizeMiB , LogicalSizeMiB properties. Added Location object. |
MemoryChunks | 1.2.0 | Added Status object. |
NetworkAdapter | 1.1.0 | Added Assembly link. Added Location object to Controllers object. |
NetworkDeviceFunction | 1.2.0 | Added Endpoints to Links object. |
PCIeDevice | 1.2.0 | Added Assembly link. |
PhysicalContext | 1.3.0 | Added additional enumerations for PhysicalContext . |
Port | 1.1.0 | Added Location object. |
Power | 1.5.0 | Added PowerInputWatts , PowerOutputWatts , and EffciencyPercent properties, Location object, and Assembly link to PowerSupply object. |
Processor | 1.2.0 | Added Assembly link. |
Redundancy | 1.3.0 | Added NotRedundant enumeration to Mode . Changed Mode to be writable. Removed duplicate description text that appears in the enumeration definitions. |
Resource | 1.6.0 | Added Latitude , Longitude and AltitudeMeters to Location object. Added NQN and NSID to DurableNameFormat . |
ServiceRoot | 1.3.0 | Added Product property for general product identification. Added ProtocolFeaturesSupported object to allow for discovery of supported optional Redfish protocol features. |
Storage | 1.4.0 | Added Assembly link. |
Switch | 1.1.0 | Added Location object. |
Thermal | 1.4.0 | Added Assembly links to Fan objects. Added DeltaReadingCelsius , DeltaPhysicalContext , MaxAllowableOperatingValue , MinAllowableOperatingValue , AdjustedMaxAllowableOperatingValue , and AdjustedMinAllowableOperatingValue to Temperatures object. |
VirtualMedia | 1.2.0 | Added InsertMedia and EjectMedia actions to provide standardized means for using virtual media features. Changed Image , Inserted , and WriteProtected to be writable. |
Zone | 1.2.0 | Added Identifiers property. |
Bios | 1.0.3 | Errata release. Corrected parameter descriptions in actions. |
Chassis | 1.x.x | Errata release. Corrected parameter descriptions in actions. |
ComputerSystem | 1.x.x | Errata release. Corrected parameter descriptions in actions. Added descriptions for SystemType enumerations. |
Drive | 1.x.x | Errata release. Migrated definition of Operations object to the Drive schema. Corrected parameter descriptions in actions. |
Endpoint | 1.0.3 | Errata release. Added schema annotations to prevent additional property definitions in ConnectedEntity and PciId definitions. |
EthernetInterface | 1.x.x | Errata release. Changed internal schema references to IPAddresses and VLanNetworkInterface to use abstract base types. |
Event | 1.x.x | Errata release. Changed internal schema location for EventType definitions. |
EventDestination | 1.x.x | Errata release. Changed internal schema location for EventType definitions. |
EventService | 1.0.6 | Errata release. Corrected parameter descriptions in actions. |
Fabric | 1.0.3 | Errata release. Changed internal schema location for FabricType definitions. |
IPAddresses | 1.0.6 | Errata release. Changed internal schema references for IPAddresses and VLanNetworkInterface to use abstract base types. Corrected PrefixLength in IPv6StaticAddresses to be a read-write property. |
LogEntry | 1.2.1 | Errata release. Changed internal schema location for EventType definitions. Added descriptions to all enumerations. |
LogService | 1.0.5 | Errata release. Corrected parameter descriptions in actions. |
Manager | 1.x.x | Errata release. Corrected parameter descriptions in actions. |
Memory | 1.x.x | Errata release. Corrected description of OperatingSpeedMHz to reflect changes in memory device reporting (value may be in MHz or MT/s, but will match published specifications in either case). Corrected parameters in actions to show they are mandatory. |
MemoryMetrics | 1.x.x | Errata release. Corrected description of AlarmTrips regarding behavior upon system reset. |
NetworkDeviceFunction | 1.x.x | Errata release. Clarified descriptions InitiatorName , PrimaryTargetName , and SecondaryTargetName properties in the iSCSIBoot object. |
PCIeFunction | 1.x.x | Errata release. Changed internal schema references to StorageController to use abstract base types. |
PhysicalContext | 1.x.x | Errata release. Changed internal schema location for PhysicalContext definition. |
Port | 1.0.3 | Errata release. Changed internal schema location for PortProtocol definitions. Corrected parameter descriptions in actions. |
Power | 1.x.x | Errata release. Changed internal schema references to PhysicalContext and IndicatorLED definitions. |
PrivilegeRegistry | 1.x.x | Errata release. Changed internal schema references to PrivilegeType definitions. |
Privileges | 1.x.x | Errata release. Changed internal schema location for PrivilegeType . |
Resource | 1.x.x | Errata release. Changed internal schema location for numerous definitions. |
Role | 1.x.x | Errata release. Changed internal schema references to PrivilegeType definitions. |
SecureBoot | 1.0.3 | Errata release. Corrected parameters in actions to show they are mandatory. |
Storage | 1.x.x | Errata release. Corrected parameters in actions to show they are mandatory. Changed internal schema references to Identifier and Protocol definitions. |
Switch | 1.0.3 | Errata release. Changed internal schema references to IndicatorLED , PowerState , and Protocol definitions. Corrected descriptions of actions. |
TaskService | 1.x.x | Errata release. Updated description of LifeCycleEventOnTaskStateChange to remove obsolete terminology. |
VLanNetworkInterface | 1.x.x | Errata release. Changed internal schema definition for VLAN . |
3.20 Release 2017.2 (August 2017)
Schema name | Version | Description |
---|---|---|
Memory | 1.3.0 | Deprecated FunctionClasses . Added memory module-centric identification properties ModuleManufacturerID , ModuleProductID , MemorySubsystemControllerManufacturerID , and MemorySubsystemControllerProductID . Deprecated the PCIe-centric identification properties VendorID , DeviceID , SubsystemVendorID , and SubsystemDeviceID . |
PhysicalContext | 1.2.0 | Added Chassis and Fan as enumerations to PhysicalContext . |
Power | 1.4.0 | Added PhysicalContext to the PowerControl object. |
Resource | 1.5.0 | Added several objects and properties to Location to enable reporting of physical locations at the building, room and intra-chassis levels. Deprecated Info and InfoFormat in favor of the new, structured Location properties. |
Role | 1.2.0 | Added RoleId property to enable references from ManagerAccount resources. |
Settings | 1.1.0 | Added SupportedApplyTimes to allow control over the application of Settings to a resource. This includes support for specifying maintenance windows. |
Storage | 1.3.0 | Added common Name property to StorageController object. |
AccountService | 1.x.x | Errata release. Added clarifications to ServiceEnabled usage. |
Chassis | 1.x.x | Errata release. Added clarifications to IndicatorLED usage. |
ComputerSystem | 1.x.x | Errata release. Added clarifications to IndicatorLED usage. |
EventDestination | 1.x.x | Errata release. Added clarifications to OriginResources and MessageId usage. |
EventService | 1.x.x | Errata release. Added clarifications to DeliveryRetryAttempts usage. |
Manager | 1.x.x | Errata release. Corrected enumeration descriptions for CommandShell . |
ManagerAccount | 1.x.x | Errata release. Added clarifications to RoleId usage. |
Power | 1.x.x | Errata release. Removed the errant auto-expand annotation within Redundancy . |
Resource | 1.x.x | Errata release. Added clarifications to IndicatorLED usage. |
SerialInterface | 1.x.x | Errata release. Removed errant periods in enumeration strings. |
SessionService | 1.x.x | Errata release. Added clarifications to ServiceEnabled usage. |
Thermal | 1.x.x | Errata release. Removed the errant auto-expand annotation within Redundancy . |
3.21 Release 2017.1 (April 2017)
Schema name | Version | Description |
---|---|---|
CollectionCapabilities | 1.0.0 | Initial release. Describes the capabilities of a collection in terms of how a client is able to create new resources within the collection. |
CompositionService | 1.0.0 | Initial release. Describes a composition service used to create systems from available resources or resource blocks. It includes the properties of the service as well as links to the actual resources available for composition. |
ResourceBlock | 1.0.0 | Initial release. Represents a resource block, its components, and any affinity to a composed device. |
ResourceBlockCollection | 1.0.0 | Initial release. A collection of resource blocks. |
Chassis | 1.5.0 | Added array of links to ResourceBlock resources. |
ComputerSystem | 1.4.0 | Added TotalSystemPersistentMemoryGiB to MemorySummary . Added array of links to ResourceBlock resources. |
Drive | 1.2.0 | Added link to Chassis resource. |
EthernetInterface | 1.3.0 | Added link to Chassis resource. |
Memory | 1.2.0 | Added properties for describing and allocating memory regions. |
PhysicalContext | 1.1.0 | Added Memory as an enumeration value. |
Resource | 1.4.0 | Added PowerCycle as an enumeration value for ResetType . Modified descriptions of ResetType to remove system-centric text. Corrected the validation pattern for properties using the UUID format (only JSON Schema versions). |
ServiceRoot | 1.2.0 | Added link to CompositionService resource. |
Storage | 1.2.0 | Added FCP and FICON as enumeration values for Protocol . |
UpdateService | 1.2.0 | Added HttpPushUriTargets and HttpPushUriTargetsBusy properties and Targets optional parameter (for SimpleUpdate ) to allow selection of a particular target device or devices. |
Endpoint | 1.0.2 | Errata release. Corrected validation pattern on PCI ID-related properties. Removed unnecessary schema reference inclusions from CSDL schema. |
EventDestination | 1.x.x | Errata release. Marked Context property as required instead of required on create. Service is required to provide the Context (may be NULL), but clients are not required to specify a context when creating a new Event Destination. |
PCIeFunction | 1.0.2 | Errata release. Corrected validation pattern on PCI ID-related properties. |
(many) | various | Minor release. Added Actions and OemActions objects to allow for OEM extensions. |
(many) | various | Errata release. Corrected integer type properties in CSDL schemas to Int64 (from Int16 or Int32) for consistency. Added missing descriptions in Complex Type definitions. Added Actions and OemActions objects to allow for OEM extensions. Corrected Links and Members properties (Collection schemas) in all schemas to be non-nullable. |
3.22 Release 2016.3 (December 2016)
Schema name | Version | Description |
---|---|---|
HostInterface | 1.0.0 | Initial release. Contains properties for describing and configuring a Redfish host interface. |
HostInterfaceCollection | 1.0.0 | Initial release. Collection of Redfish host interfaces. |
NetworkAdapter | 1.0.0 | Initial release. Describes general-purpose network adapters. |
NetworkAdapterCollection | 1.0.0 | Initial release. Collection of network adapters. |
NetworkInterface | 1.0.0 | Initial release. Provides linkages between network adapters, network ports, and network device functions. |
NetworkInterfaceCollection | 1.0.0 | Initial release. Collection of network interfaces. |
NetworkDeviceFunction | 1.0.0 | Initial release. Describes a logical interface exposed by a network adapter. |
NetworkDeviceFunctionCollection | 1.0.0 | Initial release. Collection of network device functions. |
NetworkPort | 1.0.0 | Initial release. Describes a discrete physical port capable of connecting to a network. |
NetworkPortCollection | 1.0.0 | Initial release. Collection of network ports. |
PrivilegeRegistry | 1.0.0 | Initial release. Schema for definition of HTTP operation-to-privilege mapping. |
AccountService | 1.1.0 | Added link to PrivilegeRegistry resource. |
Chassis | 1.4.0 | Added RackGroup to ChassisType enumeration. Added link to NetworkAdapterCollection resource. Added HeightMm , WidthMm , DepthMm , and WeightKg properties. Added array of links to PCIeDevice resources. |
ComputerSystem | 1.3.0 | Added link to NetworkDeviceCollection resource. Added FirmwareVersion2 and InterfaceTypeSelection to TrustedModules object. |
EthernetInterface | 1.2.0 | Added link to HostInterface resource to support Redfish Host Interface Specification. |
Manager | 1.3.0 | Added link to HostInterfaceCollection resource. |
ManagerNetworkProtocol | 1.1.0 | Added DHCP protocol object. |
Memory | 1.1.0 | Added Status object. |
MemoryDomain | 1.1.0 | Added AllowsMirroring and AllowsSparing properties. |
Resource | 1.3.0 | Added PostalAddress and Placement objects to Location , each containing numerous properties for detailed location information. |
SoftwareInventory | 1.1.0 | Added SoftwareId , LowestSupportedVersion , UefiDevicePaths and RelatedItem properties. |
Thermal | 1.2.0 | Added Manufacture , Model , SerialNumber , PartNumber , SparePartNumber and IndicatorLED to Fan object. |
UpdateService | 1.1.0 | Added HttpPushUri property. |
(all files) | various | Errata release. Added explicit permissions annotations to all properties to clearly show which properties are read-write vs. read-only. Corrected Permission annotation with invalid enumeration references. Removed permissions annotation from embedded objects (permissions now on every property). Removed permission annotations from CSDL Type definitions to avoid conflicts with property definitions. Corrected all property descriptions to always end with a period. |
ComputerSystem | 1.0.4 | Errata release. Corrected CSDL Type of TotalSystemMemoryGiB from Edm.Int64 to Decimal . |
ComputerSystem | 1.1.2 | Errata release. Corrected CSDL Type of TotalSystemMemoryGiB from Edm.Int64 to Decimal . |
ComputerSystem | 1.2.1 | Errata release. Corrected CSDL Type of TotalSystemMemoryGiB from Edm.Int64 to Decimal . |
Port | 1.0.1 | Corrected CSDL Type of CurrentSpeedGbps and MaxSpeedGbps from Edm.Int64 to Decimal . |
Power | 1.2.1 | Corrected descriptions for voltage-related properties and changed sensor descriptions to avoid use of term "current", instead referring to "present value". |
Power | 1.1.1 | Corrected descriptions for voltage-related properties and changed sensor descriptions to avoid use of term "current", instead referring to "present value". |
Power | 1.0.3 | Corrected descriptions for voltage-related properties and changed sensor descriptions to avoid use of term "current", instead referring to "present value". |
ServiceRoot | 1.1.1 | Added missing EntityContainer for ServiceContainer in CSDL schema. |
3.23 Release 2016.2 (August 2016)
Schema name | Version | Description |
---|---|---|
(all files) | various | Corrected Reference URI links to OData v4 (errata 3) and added Capabilities annotations to CSDL files. |
ActionInfo | 1.0.0 | Initial release. Action info describes the parameters and other information necessary to perform a Redfish action to a particular action target. |
Endpoint | 1.0.0 | Initial release. An endpoint is an entity that sends or receives protocol defined messages over a transport. |
EndpointCollection | 1.0.0 | Initial release. Collection of endpoints. |
Fabric | 1.0.0 | Initial release. A fabric consists of one or more switches and may include endpoints and zones. |
FabricCollection | 1.0.0 | Initial release. Collection of fabric resources. |
MemoryChunks | 1.0.0 | Initial release. Describes a memory chunk and memory interleave sets. |
MemoryChunksCollection | 1.0.0 | Initial release. Collection of memory chunks. |
MemoryDomain | 1.0.0 | Initial release. Memory domains are used to indicate to the client which memory (DIMMs) can be grouped together in memory chunks to form interleave sets or otherwise grouped together. |
MemoryDomainCollection | 1.0.0 | Initial release. Collection of memory domains. |
PCIeDevice | 1.0.0 | Initial release. Describes a PCIe device attached to a system. |
PCIeFunction | 1.0.0 | Initial release. Describes a PCIe function. |
Port | 1.0.0 | Initial release. Describes a port of a switch. |
PortCollection | 1.0.0 | Initial release. Collection of ports. |
SoftwareInventory | 1.0.0 | Initial release. Describes an inventory of software components. |
SoftwareInventoryCollection | 1.0.0 | Initial release. Collection of software components. |
Switch | 1.0.0 | Initial release. Describes a simple fabric switch. |
SwitchCollection | 1.0.0 | Initial release. Collection of switches. |
UpdateService | 1.0.0 | Initial release. Describes the Redfish update service. |
VolumeCollection | 1.0.0 | Initial release. Collection of volumes. |
Zone | 1.0.0 | Initial release. Describes a simple fabric zone. |
ZoneCollection | 1.0.0 | Initial release. Collection of zones. |
Chassis | 1.3.0 | Added IPBasedDrive to ChassisType enumerations. |
ComputerSystem | 1.2.0 | Added HostedServices and HostingRoles properties. Added MemoryDomains , PCIeDevices , PCIFunctions , and Endpoints links. Added RemoteDrive enumeration to BootSourceOverrideTarget . |
Drive | 1.1.0 | Added Operations property and Endpoints link. |
EthernetInterface | 1.1.0 | Added LinkStatus property and Endpoints link. |
EventDestination | 1.1.0 | Added OriginResources and MessageIds properties. |
LogEntry | 1.1.0 | Added EventType , EventId , and EventTimeStamp properties. |
Manager | 1.2.0 | Added PowerState property. |
MemoryMetrics | 1.1.0 | Added PredictedMediaLifeLeftPercent property to the HealthData object. |
Power | 1.2.0 | Added IndicatorLED property to PowerSupply object. |
Redundancy | 1.1.0 | Added RedundancyEnabled property. |
Resource | 1.2.0 | Added Deferring , Quiesced , and Updating to State enumerations. |
ServiceRoot | 1.1.0 | Added links to Fabrics , StorageSystems , StorageServices and UpdateService . |
SessionService | 1.1.0 | Added OEM action capabilities. |
Storage | 1.1.0 | Added Links object and Endpoints link. |
ComputerSystem | 1.1.1 | Errata release. Clarified description of ComputerSystem and the UUID property. |
ComputerSystem | 1.0.3 | Errata release. Clarified description of ComputerSystem and the UUID property. |
Drive | 1.0.1 | Errata release. Added Unencrypted enumeration to EncryptionStatus and deprecated misspelled enumeration. |
Event | 1.1.1 | Errata release. Deprecated Context property in favor of the Event-specific Context contained within each Event. |
Event | 1.0.3 | Errata release. Deprecated Context property in favor of the Event-specific Context contained within each Event. |
IPAddresses | 1.0.3 | Errata release. Corrected validation patterns for IPv4Address and SubnetMask . Added validation pattern for Gateway . |
Message | 1.0.3 | Errata release. Corrected MessageId to mark it as a required property. |
Resource | 1.1.1 | Errata release. Removed errant ReferenceableMember entity type. |
ServiceRoot | 1.0.3 | Corrected validation pattern annotation for RedfishVersion . |
Storage | 1.0.1 | Corrected type definition of the Volumes link. |
Volume | 1.0.1 | Corrected description of VolumeType . |
3.24 Release 2016.1 (March 2016)
Schema name | Version | Description |
---|---|---|
AttributeRegistry | 1.0.0 | Initial release. A set of key-value pairs that are specific to a particular implementation or product, such that creating standardized property names would be impractical. This schema describes the structure of a registry, and also includes mechanisms for building user interfaces (menus) allowing consistent navigation of the contents. |
Bios | 1.0.0 | Initial release. Contains properties surrounding a BIOS attribute registry, where the system-specific BIOS attributes are described, and the actions needed to perform changes to BIOS settings, which typically require a system reset to apply. |
Drive | 1.0.0 | Initial release. Contains properties describing a single physical drive for any system, along with links to associated volumes. |
Memory | 1.0.0 | Initial release. Describes a memory module or similar memory device as part of a system. |
MemoryCollection | 1.0.0 | Initial release. A collection of memory devices. |
MemoryMetrics | 1.0.0 | Initial release. Contains usage and health statistics for a single memory module or device instance. |
SecureBoot | 1.0.0 | Initial release. UEFI Secure Boot information. It represents properties for managing the UEFI Secure Boot functionality of a system. |
Storage | 1.0.0 | Initial release. A storage subsystem and its respective properties. A storage subsystem represents a set of storage controllers, physical or virtual, and the resources such as volumes that can be accessed from that subsystem. |
StorageCollection | 1.0.0 | Initial release. A collection of storage instances. |
Volume | 1.0.0 | Initial release. Contains properties used to describe a volume, virtual disk, LUN, or other logical storage entity for any system. |
(all files) | 1.0.2 | Errata release of all schema files to adjust file naming conventions. CSDL schema files now have the major version appended to the end of the schema name (e.g., Chassis_v1), and json-schema files include the major/minor/errata version number (matching the namespace definitions in the schema as they did previously) in the filename, but are now prefaced with a "v" and with underscore separators (e.g., Chassis.v1_0_2.json) to match the corrected namespace naming rules. Added long descriptions to Links and Actions objects throughout. Added unit, minimum, and maximum annotations throughout. Defined all unversioned resources in CSDL as abstract . Corrected all string properties with enumerations to allow use of null (nullable). Marked all Links and other NavigationProperty elements and embedded objects (ComplexType elements) as non-nullable. Improved schema description text, updated RFC references, and white space consistency throughout. |
(all Collections) | n/a | Corrected URI of the schema locations to the /schemas/v1 repository instead of the /schema location, which contains only the latest version of each schema. Corrected missing anyOf structure to allow idRef references to collections. |
(all files) | various | Copies of all previously-released Redfish json-schema files have been created to follow the corrected json-schema filename format (v1_n_n instead of 1.n.n). The internal schema name references were updated to match this style, but otherwise the files are identical to their originally released content. |
Chassis | 1.2.0 | Added ManagersInChassis , Drives , and Storage to Links . |
Chassis | 1.1.2 | Errata release (see 1.0.2 errata description above). Corrected description for ManagedBy link. Deprecated Unknown enumeration value for IndicatorLED . |
ComputerSystem | 1.1.0 | Added Bios , Memory , Storage , and SecureBoot properties. Added MemoryMirroring to the MemorySummary object. Added TrustedModule object. Added BootSourceOverrideMode to Boot object. Added SDCard and UefiHttp enumerations to BootSourceOverrideTarget in Boot object. |
ComputerSystem | 1.0.2 | Errata release (see 1.0.2 errata description above). Deprecated Unknown enumeration value for IndicatorLED . |
Event | 1.1.0 | Added Context property. |
EventService | 1.0.2 | Errata release (see 1.0.2 errata description above). Corrected unit annotations to use UCUM unit definitions. |
JsonSchemaFile | 1.0.2 | Errata release (see 1.0.2 errata description above). Corrected text in Schema property descriptions to reference @odata.type instead of Type . |
Manager | 1.1.0 | Added ManagerInChassis to Links . |
Manager | 1.0.2 | Errata release (see 1.0.2 errata description above). Corrected descriptions for ServiceEntryPointUUID to correctly match the intent of the property. |
ManagerNetworkProtocol | 1.0.2 | Errata release (see 1.0.2 errata description above). Corrected read-write permissions on all embedded objects. Corrected unit annotations to use UCUM unit definitions. |
Power | 1.1.0 | Added InputRanges array and Manufacturer to PowerSupplies object. Added enumerations to the LineInputVoltageType property in PowerSupplies that promote better interoperability and deprecated others whose terminology differs in meaning among vendors. |
Power | 1.0.2 | Errata release (see 1.0.2 errata description above). Corrected read-write permissions on all embedded objects. Corrected unit annotations to use UCUM unit definitions. |
Resource | 1.1.0 | Added Identifier object, Location object and IndicatorLED definitions for use throughout the Redfish data model. Added UnavailableOffline enumeration to State in Status object. |
Resource | 1.0.2 | Errata release (see 1.0.2 errata description above). Corrected missing required annotation on Id property. Added Pattern Redfish annotation for Oem property names. |
SessionService | 1.0.2 | Errata release (see 1.0.2 errata description above). Added unit annotations. |
SimpleStorage | 1.1.0 | Added CapacityBytes to Devices object. |
SimpleStorage | 1.0.2 | Errata release (see 1.0.2 errata description above). Corrected unit annotations to use UCUM unit definitions. |
Thermal | 1.1.0 | Added Name to Fan object. Deprecated inconsistent FanName in Fan . |
Thermal | 1.0.2 | Errata release (see 1.0.2 errata description above). Corrected read-write permissions on all embedded objects. Corrected unit annotations to use UCUM unit definitions. |
3.25 Release 1.1 (November 2015)
Schema name | Version | Description |
---|---|---|
Chassis | 1.1.0 | Added PhysicalSecurity object for intrusion detection sensor support. |
3.26 Release 1.0.1 (September 2015)
Schema name | Version | Description |
---|---|---|
Thermal | 1.0.1 | Errata release. Renamed Fan ReadingRPM property to Reading as it was determined that the initial definition was too limiting. Added Fan property ReadingUnits to allow for either RPM or percent-based fan readings. Corrected spelling errors throughout. Any future property name changes will result in a major version change to the schema file. |
Chassis | 1.0.1 | Errata release. Added missing PowerState property intended for inclusion in v1.0.0. Corrected long description text of CooledBy . Clarified long description of Reset action. |
ComputerSystem | 1.0.1 | Errata release. Changed enumeration values of PowerState to reflect a better set of real-world use cases. Corrected annotation name in long description of UefiTargetBootSourceOverride . |
Manager | 1.0.1 | Errata release. Corrected long description text for both ManagerForChassis and ManagerForSystem . |
Power | 1.0.1 | Errata release. Corrected long description text for IntervalInMin . |
VLanNetworkInterface | 1.0.1 | Errata release. Corrected maximum VLAN ID value. |
3.27 Release 1.0 (August 2015)
Schema name | Version | Description |
---|---|---|
(all files) | 1.0.0 | Initial release. |