Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 3bf4e63296f0b69201904b03b2470543a7e0c627 / . / static / redfish / v1 / schema / PortMetrics_v1.xml
blob: 05d395b2930e841ed5c08931d35d7b1e9dc06487 [file] [log] [blame]
Gunnar Mills09b9d452020-02-11 13:27:39 -0600[diff] [blame]1<?xml version="1.0" encoding="UTF-8"?>
2<!---->
3<!--################################################################################ -->
4<!--# Redfish Schema: PortMetrics v1.0.0 -->
5<!--# -->
6<!--# For a detailed change log, see the README file contained in the DSP8010 bundle, -->
7<!--# available at http://www.dmtf.org/standards/redfish -->
8<!--# Copyright 2014-2019 DMTF. -->
9<!--# For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright -->
10<!--################################################################################ -->
11<!---->
12<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">
13
14 <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Core.V1.xml">
15 <edmx:Include Namespace="Org.OData.Core.V1" Alias="OData"/>
16 </edmx:Reference>
17 <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Capabilities.V1.xml">
18 <edmx:Include Namespace="Org.OData.Capabilities.V1" Alias="Capabilities"/>
19 </edmx:Reference>
20 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml">
21 <edmx:Include Namespace="Resource.v1_0_0"/>
22 </edmx:Reference>
23 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
24 <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
25 <edmx:Include Namespace="Validation.v1_0_0" Alias="Validation"/>
26 </edmx:Reference>
27
28 <edmx:DataServices>
29
30 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="PortMetrics">
31 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
32
33 <EntityType Name="PortMetrics" BaseType="Resource.v1_0_0.Resource" Abstract="true">
34 <Annotation Term="OData.Description" String="The usage and health statistics for a switch device or component port summary."/>
35 <Annotation Term="OData.LongDescription" String="The PortMetrics Schema shall contain the port metrics for a switch device or component port summary in a Redfish implementation."/>
36 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
37 <Annotation Term="Capabilities.InsertRestrictions">
38 <Record>
39 <PropertyValue Property="Insertable" Bool="false"/>
40 </Record>
41 </Annotation>
42 <Annotation Term="Capabilities.UpdateRestrictions">
43 <Record>
44 <PropertyValue Property="Updatable" Bool="false"/>
45 </Record>
46 </Annotation>
47 <Annotation Term="Capabilities.DeleteRestrictions">
48 <Record>
49 <PropertyValue Property="Deletable" Bool="false"/>
50 </Record>
51 </Annotation>
52 <Annotation Term="Redfish.Uris">
53 <Collection>
54 <String>/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/Metrics</String>
55 <String>/redfish/v1/Chassis/{ChassisId}/MediaControllers/{MediaControllerId}/Ports/{PortId}/Metrics</String>
56 <String>/redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports/{PortId}/Metrics</String>
57 <String>/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Ports/{PortId}/Metrics</String>
58 <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Ports/{PortId}/Metrics</String>
59 <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Ports/{PortId}/Metrics</String>
60 <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Ports/{PortId}/Metrics</String>
61 <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Ports/{PortId}/Metrics</String>
62 </Collection>
63 </Annotation>
64 </EntityType>
65 </Schema>
66
67 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="PortMetrics.v1_0_0">
68 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
69 <Annotation Term="Redfish.Release" String="2019.4"/>
70
71 <EntityType Name="PortMetrics" BaseType="PortMetrics.PortMetrics">
72 <Property Name="GenZ" Type="PortMetrics.v1_0_0.GenZ" Nullable="false">
73 <Annotation Term="OData.Description" String="The port metrics specific to Gen-Z ports."/>
74 <Annotation Term="OData.LongDescription" String="This property shall contain the port metrics specific to Gen-Z ports."/>
75 </Property>
76 <Property Name="Actions" Type="PortMetrics.v1_0_0.Actions" Nullable="false">
77 <Annotation Term="OData.Description" String="The available actions for this Resource."/>
78 <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this Resource."/>
79 </Property>
80 </EntityType>
81
82 <ComplexType Name="GenZ">
83 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
84 <Annotation Term="OData.Description" String="The port metrics for a Gen-Z interface."/>
85 <Annotation Term="OData.LongDescription" String="This type shall describe the Gen-Z related port metrics."/>
86 <Property Name="PacketCRCErrors" Type="Edm.Int64">
87 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
88 <Annotation Term="OData.Description" String="The total number of PCRC transient errors detected."/>
89 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of PCRC transient errors detected in received link-local and end-to-ent packets."/>
90 </Property>
91 <Property Name="EndToEndCRCErrors" Type="Edm.Int64">
92 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
93 <Annotation Term="OData.Description" String="The total number of ECRC transient errors detected."/>
94 <Annotation Term="OData.LongDescription" String="This property shall contain total number of ECRC transient errors detected in received link-local and end-to-end packets."/>
95 </Property>
96 <Property Name="RXStompedECRC" Type="Edm.Int64">
97 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
98 <Annotation Term="OData.Description" String="The total number of packets received with a stomped ECRC field."/>
99 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of packets that thsi interface received with a stomped ECRC field."/>
100 </Property>
101 <Property Name="TXStompedECRC" Type="Edm.Int64">
102 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
103 <Annotation Term="OData.Description" String="The total number of packets that this interface stomped the ECRC field."/>
104 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of packets that this interfaced stomped the ECRC field."/>
105 </Property>
106 <Property Name="NonCRCTransientErrors" Type="Edm.Int64">
107 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
108 <Annotation Term="OData.Description" String="The total number transient errors detected that are unrelated to CRC validation."/>
109 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of transient errors detected that are unrelated to CRC validation, which covers link-local and end-to-end packets, such as malformed Link Idle packets or PLA signal errors."/>
110 </Property>
111 <Property Name="LLRRecovery" Type="Edm.Int64">
112 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
113 <Annotation Term="OData.Description" String="The total number of times Link-Level Reliability (LLR) recovery has been initiated."/>
114 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of times Link-level Reliability (LLR) recovery has been initiated by this interface. This is not to be confused with the number of packets retransmitted due to initiating LLR recovery."/>
115 </Property>
116 <Property Name="MarkedECN" Type="Edm.Int64">
117 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
118 <Annotation Term="OData.Description" String="The number of packets with the Congestion ECN bit set."/>
119 <Annotation Term="OData.LongDescription" String="This property shall contain the number of packets that the component set the Congestion ECN bit prior to transmission through this interface."/>
120 </Property>
121 <Property Name="PacketDeadlineDiscards" Type="Edm.Int64">
122 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
123 <Annotation Term="OData.Description" String="The number of packets discarded due to the Congestion Deadline sub-field reaching zero."/>
124 <Annotation Term="OData.LongDescription" String="This property shall contain the number of packets discarded by this interface due to the Congestion Deadline sub-field reaching zero prior to packet transmission."/>
125 </Property>
126 <Property Name="AccessKeyViolations" Type="Edm.Int64">
127 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
128 <Annotation Term="OData.Description" String="The total number of Access Key Violations detected."/>
129 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of Access Key Violations detected for packets received or transmitted on this interface."/>
130 </Property>
131 <Property Name="LinkNTE" Type="Edm.Int64">
132 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
133 <Annotation Term="OData.Description" String="The total number of link-local non-transient errors detected."/>
134 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of link-local non-transient errors detected on this interface."/>
135 </Property>
136 <Property Name="ReceivedECN" Type="Edm.Int64">
137 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
138 <Annotation Term="OData.Description" String="The number of packets received on this interface with the Congestion ECN bit set."/>
139 <Annotation Term="OData.LongDescription" String="This property shall contain the number of packets received on this interface with the Congestion ECN bit set."/>
140 </Property>
141 </ComplexType>
142
143 <ComplexType Name="Actions">
144 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
145 <Annotation Term="OData.Description" String="The available actions for this Resource."/>
146 <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this Resource."/>
147 <Property Name="Oem" Type="PortMetrics.v1_0_0.OemActions" Nullable="false">
148 <Annotation Term="OData.Description" String="The available OEM-specific actions for this Resource."/>
149 <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this Resource."/>
150 </Property>
151 </ComplexType>
152
153 <ComplexType Name="OemActions">
154 <Annotation Term="OData.AdditionalProperties" Bool="true"/>
155 <Annotation Term="OData.Description" String="The available OEM-specific actions for this Resource."/>
156 <Annotation Term="OData.LongDescription" String="This type shall contain the available OEM-specific actions for this Resource."/>
157 </ComplexType>
158 </Schema>
159
160 </edmx:DataServices>
161</edmx:Edmx>