xref: /openbmc/bmcweb/features/redfish/schema/dmtf/csdl/SwitchMetrics_v1.xml (revision d125652e8a30dfeaad88bbfa5b1e04a80610469c)

<?xml version="1.0" encoding="UTF-8"?>
<!---->
<!--################################################################################       -->
<!--# Redfish Schema:  SwitchMetrics v1.0.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-2025 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://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Measures.V1.xml">
    <edmx:Include Namespace="Org.OData.Measures.V1" Alias="Measures"/>
  </edmx:Reference>
  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
    <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
    <edmx:Include Namespace="Validation.v1_0_0" Alias="Validation"/>
  </edmx:Reference>
  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml">
    <edmx:Include Namespace="Resource"/>
    <edmx:Include Namespace="Resource.v1_0_0"/>
  </edmx:Reference>
  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/PCIeDevice_v1.xml">
    <edmx:Include Namespace="PCIeDevice"/>
  </edmx:Reference>

  <edmx:DataServices>

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

      <EntityType Name="SwitchMetrics" BaseType="Resource.v1_0_0.Resource" Abstract="true">
        <Annotation Term="OData.Description" String="The `SwitchMetrics` schema contains usage and health statistics for a switch device."/>
        <Annotation Term="OData.LongDescription" String="This resource shall represent the metrics for a switch device in 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/Fabrics/{FabricId}/Switches/{SwitchId}/SwitchMetrics</String>
          </Collection>
        </Annotation>
      </EntityType>

      <Action Name="ClearCurrentPeriod" IsBound="true">
        <Parameter Name="SwitchMetrics" Type="SwitchMetrics.v1_0_0.Actions"/>
        <Annotation Term="OData.Description" String="This action sets the `CurrentPeriod` property's values to 0."/>
        <Annotation Term="OData.LongDescription" String="This action shall set the `CurrentPeriod` property's values to 0."/>
      </Action>
    </Schema>

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

      <EntityType Name="SwitchMetrics" BaseType="SwitchMetrics.SwitchMetrics">
        <Property Name="PCIeErrors" Type="PCIeDevice.PCIeErrors" Nullable="false">
          <Annotation Term="OData.Description" String="The PCIe errors associated with this switch."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the PCIe errors associated with this switch."/>
        </Property>
        <Property Name="InternalMemoryMetrics" Type="SwitchMetrics.v1_0_0.InternalMemoryMetrics" Nullable="false">
          <Annotation Term="OData.Description" String="The memory metrics for a switch."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain properties that describe the memory metrics for a switch."/>
        </Property>
        <Property Name="Actions" Type="SwitchMetrics.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="InternalMemoryMetrics">
        <Annotation Term="OData.AdditionalProperties" Bool="false"/>
        <Annotation Term="OData.Description" String="The memory metrics for a switch."/>
        <Annotation Term="OData.LongDescription" String="This property shall contain properties that describe the memory metrics for a switch."/>
        <Property Name="CurrentPeriod" Type="SwitchMetrics.v1_0_0.CurrentPeriod" Nullable="false">
          <Annotation Term="OData.Description" String="The memory metrics since the last reset for this switch."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain properties that describe the metrics for the current period of memory for this switch."/>
        </Property>
        <Property Name="LifeTime" Type="SwitchMetrics.v1_0_0.LifeTime" Nullable="false">
          <Annotation Term="OData.Description" String="The memory metrics for the lifetime of this switch."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain properties that describe the metrics for the lifetime of memory for this switch."/>
        </Property>
      </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="SwitchMetrics.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>

      <ComplexType Name="CurrentPeriod">
        <Annotation Term="OData.AdditionalProperties" Bool="false"/>
        <Annotation Term="OData.Description" String="The memory metrics since the last switch reset or `ClearCurrentPeriod` action for a switch."/>
        <Annotation Term="OData.LongDescription" String="This type shall describe the memory metrics since the last reset or `ClearCurrentPeriod` action for a switch."/>
        <Property Name="CorrectableECCErrorCount" Type="Edm.Int64">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The number of correctable errors of memory since reset."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the number of correctable errors of memory since reset."/>
        </Property>
        <Property Name="UncorrectableECCErrorCount" Type="Edm.Int64">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The number of uncorrectable errors of memory since reset."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the number of uncorrectable errors of memory since reset."/>
        </Property>
      </ComplexType>

      <ComplexType Name="LifeTime">
        <Annotation Term="OData.AdditionalProperties" Bool="false"/>
        <Annotation Term="OData.Description" String="The memory metrics for the lifetime for a switch."/>
        <Annotation Term="OData.LongDescription" String="This type shall describe the memory metrics since manufacturing for a switch."/>
        <Property Name="CorrectableECCErrorCount" Type="Edm.Int64">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The number of correctable errors for the lifetime of the memory."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the number of correctable errors for the lifetime of memory."/>
        </Property>
        <Property Name="UncorrectableECCErrorCount" Type="Edm.Int64">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The number of uncorrectable errors for the lifetime of the memory."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the number of uncorrectable errors for the lifetime of memory."/>
        </Property>
      </ComplexType>
    </Schema>

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

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="SwitchMetrics.v1_0_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="SwitchMetrics" BaseType="SwitchMetrics.v1_0_1.SwitchMetrics"/>
    </Schema>

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