xref: /openbmc/bmcweb/redfish-core/schema/dmtf/csdl/ThermalMetrics_v1.xml (revision f2a8e57e)

<?xml version="1.0" encoding="UTF-8"?>
<!---->
<!--################################################################################       -->
<!--# Redfish Schema:  ThermalMetrics v1.3.2                                               -->
<!--#                                                                                      -->
<!--# For a detailed change log, see the README file contained in the DSP8010 bundle,      -->
<!--# available at http://www.dmtf.org/standards/redfish                                   -->
<!--# Copyright 2014-2024 DMTF.                                                            -->
<!--# For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright -->
<!--################################################################################       -->
<!---->
<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">

  <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Core.V1.xml">
    <edmx:Include Namespace="Org.OData.Core.V1" Alias="OData"/>
  </edmx:Reference>
  <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Capabilities.V1.xml">
    <edmx:Include Namespace="Org.OData.Capabilities.V1" Alias="Capabilities"/>
  </edmx:Reference>
  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
    <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
  </edmx:Reference>
  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml">
    <edmx:Include Namespace="Resource.v1_0_0"/>
  </edmx:Reference>
  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Sensor_v1.xml">
    <edmx:Include Namespace="Sensor"/>
  </edmx:Reference>

  <edmx:DataServices>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ThermalMetrics">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="Redfish.Language" String="en"/>

      <EntityType Name="ThermalMetrics" BaseType="Resource.v1_0_0.Resource" Abstract="true">
        <Annotation Term="OData.Description" String="The `ThermalMetrics` schema represents the thermal metrics of a chassis."/>
        <Annotation Term="OData.LongDescription" String="This resource shall represent the thermal metrics of a chassis for a Redfish implementation."/>
        <Annotation Term="OData.AdditionalProperties" Bool="false"/>
        <Annotation Term="Capabilities.InsertRestrictions">
          <Record>
            <PropertyValue Property="Insertable" Bool="false"/>
          </Record>
        </Annotation>
        <Annotation Term="Capabilities.UpdateRestrictions">
          <Record>
            <PropertyValue Property="Updatable" Bool="false"/>
          </Record>
        </Annotation>
        <Annotation Term="Capabilities.DeleteRestrictions">
          <Record>
            <PropertyValue Property="Deletable" Bool="false"/>
          </Record>
        </Annotation>
        <Annotation Term="Redfish.Uris">
          <Collection>
            <String>/redfish/v1/Chassis/{ChassisId}/ThermalSubsystem/ThermalMetrics</String>
          </Collection>
        </Annotation>
      </EntityType>

      <Action Name="ResetMetrics" IsBound="true">
        <Parameter Name="ThermalMetrics" Type="ThermalMetrics.v1_0_0.Actions"/>
        <Annotation Term="OData.Description" String="This action resets the summary metrics related to this equipment."/>
        <Annotation Term="OData.LongDescription" String="This action shall reset any time intervals or counted values for this equipment."/>
      </Action>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ThermalMetrics.v1_0_0">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="Redfish.Release" String="2020.4"/>

      <EntityType Name="ThermalMetrics" BaseType="ThermalMetrics.ThermalMetrics">
        <Property Name="TemperatureSummaryCelsius" Type="ThermalMetrics.v1_0_0.TemperatureSummary" Nullable="false">
          <Annotation Term="OData.Description" String="The summary temperature readings for this chassis."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the temperature sensor readings for this subsystem."/>
        </Property>
        <NavigationProperty Name="TemperatureReadingsCelsius" Type="Collection(Sensor.Sensor)">
          <Annotation Term="Redfish.ExcerptCopy" String="Array"/>
          <Annotation Term="OData.Description" String="The temperatures (in degree Celsius units) from all related sensors for this device."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the temperatures, in degree Celsius units, for this subsystem.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Temperature`."/>
        </NavigationProperty>
        <Property Name="Actions" Type="ThermalMetrics.v1_0_0.Actions" Nullable="false">
          <Annotation Term="OData.Description" String="The available actions for this resource."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this resource."/>
        </Property>
      </EntityType>

      <ComplexType Name="TemperatureSummary">
        <Annotation Term="OData.AdditionalProperties" Bool="false"/>
        <Annotation Term="OData.Description" String="The temperature readings for a subsystem."/>
        <Annotation Term="OData.LongDescription" String="This type shall contain properties that describe temperature sensor for a subsystem."/>
        <NavigationProperty Name="Internal" Type="Sensor.Sensor">
          <Annotation Term="Redfish.ExcerptCopy"/>
          <Annotation Term="OData.Description" String="The internal temperature (in degree Celsius units) of this subsystem."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the temperature, in degree Celsius units, for the internal temperature of this subsystem.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Temperature`."/>
        </NavigationProperty>
        <NavigationProperty Name="Intake" Type="Sensor.Sensor">
          <Annotation Term="Redfish.ExcerptCopy"/>
          <Annotation Term="OData.Description" String="The intake temperature (in degree Celsius units) of this subsystem."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the temperature, in degree Celsius units, for the intake temperature of this subsystem.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Temperature`."/>
        </NavigationProperty>
        <NavigationProperty Name="Exhaust" Type="Sensor.Sensor">
          <Annotation Term="Redfish.ExcerptCopy"/>
          <Annotation Term="OData.Description" String="The exhaust temperature (in degree Celsius units) of this subsystem."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the temperature, in degree Celsius units, for the exhaust temperature of this subsystem.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Temperature`."/>
        </NavigationProperty>
        <NavigationProperty Name="Ambient" Type="Sensor.Sensor">
          <Annotation Term="Redfish.ExcerptCopy"/>
          <Annotation Term="OData.Description" String="The ambient temperature (in degree Celsius units) of this subsystem."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the temperature, in degree Celsius units, for the ambient temperature of this subsystem.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Temperature`."/>
        </NavigationProperty>
      </ComplexType>

      <ComplexType Name="Actions">
        <Annotation Term="OData.AdditionalProperties" Bool="false"/>
        <Annotation Term="OData.Description" String="The available actions for this resource."/>
        <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
        <Property Name="Oem" Type="ThermalMetrics.v1_0_0.OemActions" Nullable="false">
          <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this resource."/>
        </Property>
      </ComplexType>

      <ComplexType Name="OemActions">
        <Annotation Term="OData.AdditionalProperties" Bool="true"/>
        <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
        <Annotation Term="OData.LongDescription" String="This type shall contain the available OEM-specific actions for this resource."/>
      </ComplexType>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ThermalMetrics.v1_0_1">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to update descriptions to tie excerpt property definitions to a specific type of `Sensor` or `Control` resource.  It was also created to correct various typographical errors."/>
      <EntityType Name="ThermalMetrics" BaseType="ThermalMetrics.v1_0_0.ThermalMetrics"/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ThermalMetrics.v1_0_2">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
      <EntityType Name="ThermalMetrics" BaseType="ThermalMetrics.v1_0_1.ThermalMetrics"/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ThermalMetrics.v1_0_3">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to force the regeneration of OpenAPI schemas to properly express nullable properties with external references.  It was also created to correct various typographical errors."/>
      <EntityType Name="ThermalMetrics" BaseType="ThermalMetrics.v1_0_2.ThermalMetrics"/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ThermalMetrics.v1_1_0">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="Redfish.Release" String="2022.3"/>

      <EntityType Name="ThermalMetrics" BaseType="ThermalMetrics.v1_0_1.ThermalMetrics">
        <Property Name="HeaterSummary" Type="ThermalMetrics.v1_1_0.HeaterSummary" Nullable="false">
          <Annotation Term="OData.Description" String="The summary of heater metrics for this chassis."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the summary of heater metrics for this subsystem."/>
        </Property>
      </EntityType>

      <ComplexType Name="HeaterSummary">
        <Annotation Term="OData.AdditionalProperties" Bool="false"/>
        <Annotation Term="OData.Description" String="The heater metrics summary for the subsystem."/>
        <Annotation Term="OData.LongDescription" String="This type shall contain properties that describe the heater metrics summary for the subsystem."/>
        <Property Name="TotalPrePowerOnHeatingTimeSeconds" Type="Edm.Int64">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The total number of seconds all the heaters in the thermal subsystem were active while the respective devices they heat were powered off."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the total number of seconds all the heaters in the thermal subsystem were active while the respective devices they heat were powered off."/>
        </Property>
        <Property Name="TotalRuntimeHeatingTimeSeconds" Type="Edm.Int64">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The total number of seconds all the heaters in the thermal subsystem were active while the respective devices they heat were powered on."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the total number of seconds all the heaters in the thermal subsystem were active while the respective devices they heat were powered on."/>
        </Property>
      </ComplexType>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ThermalMetrics.v1_1_1">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
      <EntityType Name="ThermalMetrics" BaseType="ThermalMetrics.v1_1_0.ThermalMetrics"/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ThermalMetrics.v1_1_2">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to force the regeneration of OpenAPI schemas to properly express nullable properties with external references.  It was also created to correct various typographical errors."/>
      <EntityType Name="ThermalMetrics" BaseType="ThermalMetrics.v1_1_1.ThermalMetrics"/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ThermalMetrics.v1_2_0">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="Redfish.Release" String="2023.1"/>

      <EntityType Name="ThermalMetrics" BaseType="ThermalMetrics.v1_1_0.ThermalMetrics">
        <NavigationProperty Name="DeltaPressurekPa" Type="Sensor.Sensor">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="Redfish.ExcerptCopy"/>
          <Annotation Term="OData.Description" String="The differential pressure (kPa)."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the pressure, in kilopascal units, for the difference in pressure between the air intake and the air exhaust of this chassis.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `PressurekPa`."/>
        </NavigationProperty>
        <NavigationProperty Name="AirFlowCubicMetersPerMinute" Type="Sensor.Sensor">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="Redfish.ExcerptCopy"/>
          <Annotation Term="OData.Description" String="The air flow through the chassis (m^3/min)."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the rate of air flow, in cubic meters per minute units, between the air intake and the air exhaust of this chassis.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `AirFlowCMM`."/>
        </NavigationProperty>
      </EntityType>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ThermalMetrics.v1_2_1">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
      <EntityType Name="ThermalMetrics" BaseType="ThermalMetrics.v1_2_0.ThermalMetrics"/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ThermalMetrics.v1_2_2">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to force the regeneration of OpenAPI schemas to properly express nullable properties with external references.  It was also created to correct various typographical errors."/>
      <EntityType Name="ThermalMetrics" BaseType="ThermalMetrics.v1_2_1.ThermalMetrics"/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ThermalMetrics.v1_3_0">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="Redfish.Release" String="2023.2"/>

      <EntityType Name="ThermalMetrics" BaseType="ThermalMetrics.v1_2_0.ThermalMetrics">
        <NavigationProperty Name="PowerWatts" Type="Sensor.Sensor">
          <Annotation Term="Redfish.ExcerptCopy" String="Power"/>
          <Annotation Term="OData.Description" String="Power consumption (W) of the thermal management subsystem."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the power, in watt units, for the thermal subsystem.  The value shall include the total power consumption of devices involved in thermal management of the chassis, such as fans, pumps, and heaters.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Power`."/>
        </NavigationProperty>
        <NavigationProperty Name="EnergykWh" Type="Sensor.Sensor">
          <Annotation Term="Redfish.ExcerptCopy" String="EnergykWh"/>
          <Annotation Term="OData.Description" String="Energy consumption (kWh) of the thermal management subsystem."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the total energy, in kilowatt-hour units, for the thermal subsystem.  The value shall include the total energy consumption of devices involved in thermal management of the chassis, such as fans, pumps, and heaters.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `EnergykWh`."/>
        </NavigationProperty>
      </EntityType>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ThermalMetrics.v1_3_1">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
      <EntityType Name="ThermalMetrics" BaseType="ThermalMetrics.v1_3_0.ThermalMetrics"/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ThermalMetrics.v1_3_2">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to force the regeneration of OpenAPI schemas to properly express nullable properties with external references.  It was also created to correct various typographical errors."/>
      <EntityType Name="ThermalMetrics" BaseType="ThermalMetrics.v1_3_1.ThermalMetrics"/>
    </Schema>

  </edmx:DataServices>
</edmx:Edmx>