xref: /openbmc/bmcweb/features/redfish/schema/dmtf/csdl/RouteEntry_v1.xml (revision d125652e8a30dfeaad88bbfa5b1e04a80610469c)
12bde4061SEd Tanous<?xml version="1.0" encoding="UTF-8"?>
22bde4061SEd Tanous<!---->
32bde4061SEd Tanous<!--################################################################################       -->
4f2a8e57eSGunnar Mills<!--# Redfish Schema:  RouteEntry v1.0.2                                                   -->
52bde4061SEd Tanous<!--#                                                                                      -->
62bde4061SEd Tanous<!--# For a detailed change log, see the README file contained in the DSP8010 bundle,      -->
72bde4061SEd Tanous<!--# available at http://www.dmtf.org/standards/redfish                                   -->
8*d125652eSGunnar Mills<!--# Copyright 2014-2025 DMTF.                                                            -->
92bde4061SEd Tanous<!--# For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright -->
102bde4061SEd Tanous<!--################################################################################       -->
112bde4061SEd Tanous<!---->
122bde4061SEd Tanous<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">
132bde4061SEd Tanous
142bde4061SEd Tanous  <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Core.V1.xml">
152bde4061SEd Tanous    <edmx:Include Namespace="Org.OData.Core.V1" Alias="OData"/>
162bde4061SEd Tanous  </edmx:Reference>
172bde4061SEd Tanous  <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Capabilities.V1.xml">
182bde4061SEd Tanous    <edmx:Include Namespace="Org.OData.Capabilities.V1" Alias="Capabilities"/>
192bde4061SEd Tanous  </edmx:Reference>
202bde4061SEd Tanous  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml">
212bde4061SEd Tanous    <edmx:Include Namespace="Resource"/>
222bde4061SEd Tanous    <edmx:Include Namespace="Resource.v1_0_0"/>
232bde4061SEd Tanous  </edmx:Reference>
242bde4061SEd Tanous  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
252bde4061SEd Tanous    <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
262bde4061SEd Tanous    <edmx:Include Namespace="Validation.v1_0_0" Alias="Validation"/>
272bde4061SEd Tanous  </edmx:Reference>
282bde4061SEd Tanous  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RouteSetEntryCollection_v1.xml">
292bde4061SEd Tanous    <edmx:Include Namespace="RouteSetEntryCollection"/>
302bde4061SEd Tanous  </edmx:Reference>
312bde4061SEd Tanous
322bde4061SEd Tanous  <edmx:DataServices>
332bde4061SEd Tanous
342bde4061SEd Tanous    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="RouteEntry">
352bde4061SEd Tanous      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
36f2a8e57eSGunnar Mills      <Annotation Term="Redfish.Language" String="en"/>
372bde4061SEd Tanous
382bde4061SEd Tanous      <EntityType Name="RouteEntry" BaseType="Resource.v1_0_0.Resource" Abstract="true">
39f2a8e57eSGunnar Mills        <Annotation Term="OData.Description" String="The `RouteEntry` schema describes the content of route entry rows.  Each route entry contains route sets that list the possible routes for the route entry."/>
40f2a8e57eSGunnar Mills        <Annotation Term="OData.LongDescription" String="This resource shall represent the content of route entry rows in the Redfish Specification."/>
412bde4061SEd Tanous        <Annotation Term="Capabilities.InsertRestrictions">
422bde4061SEd Tanous          <Record>
432bde4061SEd Tanous            <PropertyValue Property="Insertable" Bool="false"/>
442bde4061SEd Tanous          </Record>
452bde4061SEd Tanous        </Annotation>
462bde4061SEd Tanous        <Annotation Term="Capabilities.UpdateRestrictions">
472bde4061SEd Tanous          <Record>
482bde4061SEd Tanous            <PropertyValue Property="Updatable" Bool="true"/>
492bde4061SEd Tanous            <Annotation Term="OData.Description" String="The route entry can be updated to enable or disable it."/>
502bde4061SEd Tanous          </Record>
512bde4061SEd Tanous        </Annotation>
522bde4061SEd Tanous        <Annotation Term="Capabilities.DeleteRestrictions">
532bde4061SEd Tanous          <Record>
542bde4061SEd Tanous            <PropertyValue Property="Deletable" Bool="true"/>
552bde4061SEd Tanous          </Record>
562bde4061SEd Tanous        </Annotation>
572bde4061SEd Tanous        <Annotation Term="Redfish.Uris">
582bde4061SEd Tanous          <Collection>
592bde4061SEd Tanous            <String>/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/LPRT/{LPRTId}</String>
602bde4061SEd Tanous            <String>/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/MPRT/{MPRTId}</String>
612bde4061SEd Tanous            <String>/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/SSDT/{SSDTId}</String>
622bde4061SEd Tanous            <String>/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/MSDT/{MSDTId}</String>
632bde4061SEd Tanous            <String>/redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports/{PortId}/LPRT/{LPRTId}</String>
642bde4061SEd Tanous            <String>/redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports/{PortId}/MPRT/{MPRTId}</String>
652bde4061SEd Tanous            <String>/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/MSDT/{MSDTId}</String>
662bde4061SEd Tanous            <String>/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/SSDT/{SSDTId}</String>
672bde4061SEd Tanous            <String>/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/LPRT/{LPRTId}</String>
682bde4061SEd Tanous            <String>/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/MPRT/{MPRTId}</String>
692bde4061SEd Tanous            <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/MSDT/{MSDTId}</String>
702bde4061SEd Tanous            <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/SSDT/{SSDTId}</String>
712bde4061SEd Tanous            <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/LPRT/{LPRTId}</String>
722bde4061SEd Tanous            <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/MPRT/{MPRTId}</String>
732bde4061SEd Tanous            <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/MSDT/{MSDTId}</String>
742bde4061SEd Tanous            <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/SSDT/{SSDTId}</String>
752bde4061SEd Tanous            <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/LPRT/{LPRTId}</String>
762bde4061SEd Tanous            <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/MPRT/{MPRTId}</String>
772bde4061SEd Tanous            <String>/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/GenZ/LPRT/{LPRTId}</String>
782bde4061SEd Tanous            <String>/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/GenZ/MPRT/{MPRTId}</String>
792bde4061SEd Tanous            <String>/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/GenZ/SSDT/{SSDTId}</String>
802bde4061SEd Tanous            <String>/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/GenZ/MSDT/{MSDTId}</String>
812bde4061SEd Tanous            <String>/redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports/{PortId}/GenZ/LPRT/{LPRTId}</String>
822bde4061SEd Tanous            <String>/redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports/{PortId}/GenZ/MPRT/{MPRTId}</String>
832bde4061SEd Tanous            <String>/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/GenZ/MSDT/{MSDTId}</String>
842bde4061SEd Tanous            <String>/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/GenZ/SSDT/{SSDTId}</String>
852bde4061SEd Tanous            <String>/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/GenZ/LPRT/{LPRTId}</String>
862bde4061SEd Tanous            <String>/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/GenZ/MPRT/{MPRTId}</String>
872bde4061SEd Tanous            <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/GenZ/MSDT/{MSDTId}</String>
882bde4061SEd Tanous            <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/GenZ/SSDT/{SSDTId}</String>
892bde4061SEd Tanous            <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/GenZ/LPRT/{LPRTId}</String>
902bde4061SEd Tanous            <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/GenZ/MPRT/{MPRTId}</String>
912bde4061SEd Tanous            <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/GenZ/MSDT/{MSDTId}</String>
922bde4061SEd Tanous            <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/GenZ/SSDT/{SSDTId}</String>
932bde4061SEd Tanous            <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/GenZ/LPRT/{LPRTId}</String>
942bde4061SEd Tanous            <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/GenZ/MPRT/{MPRTId}</String>
952bde4061SEd Tanous          </Collection>
962bde4061SEd Tanous        </Annotation>
972bde4061SEd Tanous        <Annotation Term="Redfish.DeprecatedUris">
982bde4061SEd Tanous          <Collection>
992bde4061SEd Tanous            <String>/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/LPRT/{LPRTId}</String>
1002bde4061SEd Tanous            <String>/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/MPRT/{MPRTId}</String>
1012bde4061SEd Tanous            <String>/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/SSDT/{SSDTId}</String>
1022bde4061SEd Tanous            <String>/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/MSDT/{MSDTId}</String>
1032bde4061SEd Tanous            <String>/redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports/{PortId}/LPRT/{LPRTId}</String>
1042bde4061SEd Tanous            <String>/redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports/{PortId}/MPRT/{MPRTId}</String>
1052bde4061SEd Tanous            <String>/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/MSDT/{MSDTId}</String>
1062bde4061SEd Tanous            <String>/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/SSDT/{SSDTId}</String>
1072bde4061SEd Tanous            <String>/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/LPRT/{LPRTId}</String>
1082bde4061SEd Tanous            <String>/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/MPRT/{MPRTId}</String>
1092bde4061SEd Tanous            <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/MSDT/{MSDTId}</String>
1102bde4061SEd Tanous            <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/SSDT/{SSDTId}</String>
1112bde4061SEd Tanous            <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/LPRT/{LPRTId}</String>
1122bde4061SEd Tanous            <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/MPRT/{MPRTId}</String>
1132bde4061SEd Tanous            <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/MSDT/{MSDTId}</String>
1142bde4061SEd Tanous            <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/SSDT/{SSDTId}</String>
1152bde4061SEd Tanous            <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/LPRT/{LPRTId}</String>
1162bde4061SEd Tanous            <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/MPRT/{MPRTId}</String>
1172bde4061SEd Tanous          </Collection>
1182bde4061SEd Tanous        </Annotation>
1192bde4061SEd Tanous      </EntityType>
1202bde4061SEd Tanous    </Schema>
1212bde4061SEd Tanous
1222bde4061SEd Tanous    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="RouteEntry.v1_0_0">
1232bde4061SEd Tanous      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
1242bde4061SEd Tanous      <Annotation Term="Redfish.Release" String="2019.4"/>
1252bde4061SEd Tanous
1262bde4061SEd Tanous      <EntityType Name="RouteEntry" BaseType="RouteEntry.RouteEntry">
1272bde4061SEd Tanous        <NavigationProperty Name="RouteSet" Type="RouteSetEntryCollection.RouteSetEntryCollection" ContainsTarget="true" Nullable="false">
1282bde4061SEd Tanous          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
1292bde4061SEd Tanous          <Annotation Term="OData.Description" String="The link to the collection of route set entries associated with this route."/>
130f2a8e57eSGunnar Mills          <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource collection of type `RouteSetEntryCollection`."/>
1312bde4061SEd Tanous          <Annotation Term="OData.AutoExpandReferences"/>
1322bde4061SEd Tanous        </NavigationProperty>
1332bde4061SEd Tanous        <Property Name="RawEntryHex" Type="Edm.String" Nullable="false">
1342bde4061SEd Tanous          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
1352bde4061SEd Tanous          <Annotation Term="OData.Description" String="The raw data of route entry rows."/>
1362bde4061SEd Tanous          <Annotation Term="OData.LongDescription" String="This property shall contain a binary data that represents the content of route entry rows."/>
1372bde4061SEd Tanous          <Annotation Term="Validation.Pattern" String="^0[xX](([a-fA-F]|[0-9]){2}){8}$"/>
1382bde4061SEd Tanous        </Property>
1392bde4061SEd Tanous        <Property Name="MinimumHopCount" Type="Edm.Int64" Nullable="false">
1402bde4061SEd Tanous          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
1412bde4061SEd Tanous          <Annotation Term="OData.Description" String="The minimum number of hops."/>
1422bde4061SEd Tanous          <Annotation Term="OData.LongDescription" String="This property shall indicate the minimum hop count used to calculate the computed hop count."/>
1432bde4061SEd Tanous        </Property>
1442bde4061SEd Tanous        <Property Name="Actions" Type="RouteEntry.v1_0_0.Actions" Nullable="false">
145f2a8e57eSGunnar Mills          <Annotation Term="OData.Description" String="The available actions for this resource."/>
146f2a8e57eSGunnar Mills          <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this resource."/>
1472bde4061SEd Tanous        </Property>
1482bde4061SEd Tanous      </EntityType>
1492bde4061SEd Tanous
1502bde4061SEd Tanous      <ComplexType Name="Actions">
1512bde4061SEd Tanous        <Annotation Term="OData.AdditionalProperties" Bool="false"/>
152f2a8e57eSGunnar Mills        <Annotation Term="OData.Description" String="The available actions for this resource."/>
153f2a8e57eSGunnar Mills        <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
1542bde4061SEd Tanous        <Property Name="Oem" Type="RouteEntry.v1_0_0.OemActions" Nullable="false">
155f2a8e57eSGunnar Mills          <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
156f2a8e57eSGunnar Mills          <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this resource."/>
1572bde4061SEd Tanous        </Property>
1582bde4061SEd Tanous      </ComplexType>
1592bde4061SEd Tanous
1602bde4061SEd Tanous      <ComplexType Name="OemActions">
1612bde4061SEd Tanous        <Annotation Term="OData.AdditionalProperties" Bool="true"/>
162f2a8e57eSGunnar Mills        <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
163f2a8e57eSGunnar Mills        <Annotation Term="OData.LongDescription" String="This type shall contain the available OEM-specific actions for this resource."/>
1642bde4061SEd Tanous      </ComplexType>
1652bde4061SEd Tanous    </Schema>
1662bde4061SEd Tanous
1672bde4061SEd Tanous    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="RouteEntry.v1_0_1">
1682bde4061SEd Tanous      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
1692bde4061SEd Tanous      <Annotation Term="OData.Description" String="This version was created to specify 64-bit integers in OpenAPI."/>
1702bde4061SEd Tanous      <EntityType Name="RouteEntry" BaseType="RouteEntry.v1_0_0.RouteEntry"/>
1712bde4061SEd Tanous    </Schema>
1722bde4061SEd Tanous
173f2a8e57eSGunnar Mills    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="RouteEntry.v1_0_2">
174f2a8e57eSGunnar Mills      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
175f2a8e57eSGunnar Mills      <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."/>
176f2a8e57eSGunnar Mills      <EntityType Name="RouteEntry" BaseType="RouteEntry.v1_0_1.RouteEntry"/>
177f2a8e57eSGunnar Mills    </Schema>
178f2a8e57eSGunnar Mills
1792bde4061SEd Tanous  </edmx:DataServices>
1802bde4061SEd Tanous</edmx:Edmx>
181