1<?xml version="1.0" encoding="UTF-8"?> 2<!----> 3<!--################################################################################ --> 4<!--# Redfish Schema: NetworkDeviceFunctionMetrics v1.1.2 --> 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-2023 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://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Measures.V1.xml"> 21 <edmx:Include Namespace="Org.OData.Measures.V1" Alias="Measures"/> 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 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml"> 28 <edmx:Include Namespace="Resource.v1_0_0"/> 29 </edmx:Reference> 30 31 <edmx:DataServices> 32 33 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="NetworkDeviceFunctionMetrics"> 34 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 35 36 <EntityType Name="NetworkDeviceFunctionMetrics" BaseType="Resource.v1_0_0.Resource" Abstract="true"> 37 <Annotation Term="OData.Description" String="The NetworkDeviceFunctionMetrics schema contains usage and health statistics for a network function of a network adapter."/> 38 <Annotation Term="OData.LongDescription" String="This resource shall represent the network metrics for a single network function of a network adapter in a Redfish implementation."/> 39 <Annotation Term="OData.AdditionalProperties" Bool="false"/> 40 <Annotation Term="Capabilities.InsertRestrictions"> 41 <Record> 42 <PropertyValue Property="Insertable" Bool="false"/> 43 </Record> 44 </Annotation> 45 <Annotation Term="Capabilities.UpdateRestrictions"> 46 <Record> 47 <PropertyValue Property="Updatable" Bool="false"/> 48 </Record> 49 </Annotation> 50 <Annotation Term="Capabilities.DeleteRestrictions"> 51 <Record> 52 <PropertyValue Property="Deletable" Bool="false"/> 53 </Record> 54 </Annotation> 55 <Annotation Term="Redfish.Uris"> 56 <Collection> 57 <String>/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/NetworkDeviceFunctions/{NetworkDeviceFunctionId}/Metrics</String> 58 </Collection> 59 </Annotation> 60 </EntityType> 61 </Schema> 62 63 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="NetworkDeviceFunctionMetrics.v1_0_0"> 64 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 65 <Annotation Term="Redfish.Release" String="2021.1"/> 66 67 <EntityType Name="NetworkDeviceFunctionMetrics" BaseType="NetworkDeviceFunctionMetrics.NetworkDeviceFunctionMetrics"> 68 <Property Name="Ethernet" Type="NetworkDeviceFunctionMetrics.v1_0_0.Ethernet" Nullable="false"> 69 <Annotation Term="OData.Description" String="The network function metrics specific to Ethernet adapters."/> 70 <Annotation Term="OData.LongDescription" String="This property shall contain network function metrics specific to Ethernet adapters."/> 71 </Property> 72 <Property Name="TXAvgQueueDepthPercent" Type="Edm.Decimal"> 73 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 74 <Annotation Term="OData.Description" String="The average TX queue depth as the percentage."/> 75 <Annotation Term="OData.LongDescription" String="This property shall contain the average TX queue depth as a percentage, typically `0` to `100`."/> 76 <Annotation Term="Validation.Minimum" Int="0"/> 77 <Annotation Term="Measures.Unit" String="%"/> 78 </Property> 79 <Property Name="RXAvgQueueDepthPercent" Type="Edm.Decimal"> 80 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 81 <Annotation Term="OData.Description" String="The average RX queue depth as the percentage."/> 82 <Annotation Term="OData.LongDescription" String="This property shall contain the average RX queue depth as a percentage, typically `0` to `100`."/> 83 <Annotation Term="Validation.Minimum" Int="0"/> 84 <Annotation Term="Measures.Unit" String="%"/> 85 </Property> 86 <Property Name="RXFrames" Type="Edm.Int64"> 87 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 88 <Annotation Term="OData.Description" String="The total number of frames received on a network function."/> 89 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of frames received on a network function."/> 90 </Property> 91 <Property Name="RXBytes" Type="Edm.Int64"> 92 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 93 <Annotation Term="OData.Description" String="The total number of bytes received on a network function."/> 94 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of bytes received on a network function, inclusive of all protocol overhead."/> 95 <Annotation Term="Measures.Unit" String="By"/> 96 </Property> 97 <Property Name="RXUnicastFrames" Type="Edm.Int64"> 98 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 99 <Annotation Term="OData.Description" String="The total number of good unicast frames received on a network function since reset."/> 100 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of good unicast frames received on a network function since reset."/> 101 </Property> 102 <Property Name="RXMulticastFrames" Type="Edm.Int64"> 103 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 104 <Annotation Term="OData.Description" String="The total number of good multicast frames received on a network function since reset."/> 105 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of good multicast frames received on a network function since reset, including host and remote management passthrough traffic."/> 106 </Property> 107 <Property Name="TXFrames" Type="Edm.Int64"> 108 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 109 <Annotation Term="OData.Description" String="The total number of frames sent on a network function."/> 110 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of frames sent on a network function."/> 111 </Property> 112 <Property Name="TXBytes" Type="Edm.Int64"> 113 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 114 <Annotation Term="OData.Description" String="The total number of bytes sent on a network function."/> 115 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of bytes sent on a network function, inclusive of all protocol overhead."/> 116 <Annotation Term="Measures.Unit" String="By"/> 117 </Property> 118 <Property Name="TXUnicastFrames" Type="Edm.Int64"> 119 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 120 <Annotation Term="OData.Description" String="The total number of good unicast frames transmitted on a network function since reset."/> 121 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of good unicast frames transmitted on a network function since reset, including host and remote management passthrough traffic."/> 122 </Property> 123 <Property Name="TXMulticastFrames" Type="Edm.Int64"> 124 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 125 <Annotation Term="OData.Description" String="The total number of good multicast frames transmitted on a network function since reset."/> 126 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of good multicast frames transmitted on a network function since reset, including host and remote management passthrough traffic."/> 127 </Property> 128 <Property Name="TXQueuesEmpty" Type="Edm.Boolean"> 129 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 130 <Annotation Term="OData.Description" String="Whether all TX queues for a network function are empty."/> 131 <Annotation Term="OData.LongDescription" String="This property shall indicate whether all TX queues for a network function are empty."/> 132 </Property> 133 <Property Name="RXQueuesEmpty" Type="Edm.Boolean"> 134 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 135 <Annotation Term="OData.Description" String="Whether nothing is in a network function's RX queues to DMA."/> 136 <Annotation Term="OData.LongDescription" String="This property shall indicate whether nothing is in a network function's RX queues to DMA."/> 137 </Property> 138 <Property Name="TXQueuesFull" Type="Edm.Int64"> 139 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 140 <Annotation Term="OData.Description" String="The number of TX queues that are full."/> 141 <Annotation Term="OData.LongDescription" String="This property shall contain the number of TX queues that are full."/> 142 </Property> 143 <Property Name="RXQueuesFull" Type="Edm.Int64"> 144 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 145 <Annotation Term="OData.Description" String="The number of RX queues that are full."/> 146 <Annotation Term="OData.LongDescription" String="This property shall contain the number of RX queues that are full."/> 147 </Property> 148 <Property Name="Actions" Type="NetworkDeviceFunctionMetrics.v1_0_0.Actions" Nullable="false"> 149 <Annotation Term="OData.Description" String="The available actions for this resource."/> 150 <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this resource."/> 151 </Property> 152 </EntityType> 153 154 <ComplexType Name="Ethernet"> 155 <Annotation Term="OData.AdditionalProperties" Bool="false"/> 156 <Annotation Term="OData.Description" String="The network function metrics for an Ethernet interface."/> 157 <Annotation Term="OData.LongDescription" String="This type shall describe the Ethernet-related network function metrics."/> 158 <Property Name="NumOffloadedIPv4Conns" Type="Edm.Int64"> 159 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 160 <Annotation Term="OData.Description" String="The total number of offloaded TCP/IPv4 connections."/> 161 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of offloaded TCP/IPv4 connections."/> 162 </Property> 163 <Property Name="NumOffloadedIPv6Conns" Type="Edm.Int64"> 164 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 165 <Annotation Term="OData.Description" String="The total number of offloaded TCP/IPv6 connections."/> 166 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of offloaded TCP/IPv6 connections."/> 167 </Property> 168 </ComplexType> 169 170 <ComplexType Name="Actions"> 171 <Annotation Term="OData.AdditionalProperties" Bool="false"/> 172 <Annotation Term="OData.Description" String="The available actions for this resource."/> 173 <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/> 174 <Property Name="Oem" Type="NetworkDeviceFunctionMetrics.v1_0_0.OemActions" Nullable="false"> 175 <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/> 176 <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this resource."/> 177 </Property> 178 </ComplexType> 179 180 <ComplexType Name="OemActions"> 181 <Annotation Term="OData.AdditionalProperties" Bool="true"/> 182 <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/> 183 <Annotation Term="OData.LongDescription" String="This type shall contain the available OEM-specific actions for this resource."/> 184 </ComplexType> 185 </Schema> 186 187 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="NetworkDeviceFunctionMetrics.v1_0_1"> 188 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 189 <Annotation Term="OData.Description" String="This version was created to clarify the range of possible values for properties with percent units."/> 190 <EntityType Name="NetworkDeviceFunctionMetrics" BaseType="NetworkDeviceFunctionMetrics.v1_0_0.NetworkDeviceFunctionMetrics"/> 191 </Schema> 192 193 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="NetworkDeviceFunctionMetrics.v1_0_2"> 194 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 195 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/> 196 <EntityType Name="NetworkDeviceFunctionMetrics" BaseType="NetworkDeviceFunctionMetrics.v1_0_1.NetworkDeviceFunctionMetrics"/> 197 </Schema> 198 199 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="NetworkDeviceFunctionMetrics.v1_1_0"> 200 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 201 <Annotation Term="Redfish.Release" String="2021.2"/> 202 <Annotation Term="OData.Description" String="This version was created to add FibreChannel function metrics."/> 203 204 <EntityType Name="NetworkDeviceFunctionMetrics" BaseType="NetworkDeviceFunctionMetrics.v1_0_0.NetworkDeviceFunctionMetrics"> 205 <Property Name="FibreChannel" Type="NetworkDeviceFunctionMetrics.v1_1_0.FibreChannel" Nullable="false"> 206 <Annotation Term="OData.Description" String="The network function metrics specific to Fibre Channel adapters."/> 207 <Annotation Term="OData.LongDescription" String="This property shall contain network function metrics specific to Fibre Channel adapters."/> 208 </Property> 209 </EntityType> 210 211 <ComplexType Name="FibreChannel"> 212 <Annotation Term="OData.AdditionalProperties" Bool="false"/> 213 <Annotation Term="OData.Description" String="The network function metrics for a Fibre Channel interface."/> 214 <Annotation Term="OData.LongDescription" String="This type shall describe the Fibre Channel-related network function metrics."/> 215 <Property Name="RXSequences" Type="Edm.Int64"> 216 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 217 <Annotation Term="OData.Description" String="The total number of Fibre Channel sequences received."/> 218 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of Fibre Channel sequences received."/> 219 </Property> 220 <Property Name="TXSequences" Type="Edm.Int64"> 221 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 222 <Annotation Term="OData.Description" String="The total number of Fibre Channel sequences transmitted."/> 223 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of Fibre Channel sequences transmitted."/> 224 </Property> 225 <Property Name="TXExchanges" Type="Edm.Int64"> 226 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 227 <Annotation Term="OData.Description" String="The total number of Fibre Channel exchanges transmitted."/> 228 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of Fibre Channel exchanges transmitted."/> 229 </Property> 230 <Property Name="RXExchanges" Type="Edm.Int64"> 231 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 232 <Annotation Term="OData.Description" String="The total number of Fibre Channel exchanges received."/> 233 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of Fibre Channel exchanges received."/> 234 </Property> 235 <Property Name="PortLoginRequests" Type="Edm.Int64"> 236 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 237 <Annotation Term="OData.Description" String="The total number of port login (PLOGI) requests transmitted."/> 238 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of PLOGI requests sent by this function."/> 239 </Property> 240 <Property Name="PortLoginAccepts" Type="Edm.Int64"> 241 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 242 <Annotation Term="OData.Description" String="The total number of port login (PLOGI) accept (ACC) responses."/> 243 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of PLOGI ACC responses received by this Fibre Channel function."/> 244 </Property> 245 <Property Name="PortLoginRejects" Type="Edm.Int64"> 246 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 247 <Annotation Term="OData.Description" String="The total number of port login (PLOGI) reject (RJT) responses."/> 248 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of PLOGI RJT responses received by this Fibre Channel function."/> 249 </Property> 250 <Property Name="RXPeerCongestionFPINs" Type="Edm.Int64"> 251 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 252 <Annotation Term="OData.Description" String="The total number of Peer Congestion Fabric Performance Impact Notifications (FPINs) received."/> 253 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of Peer Congestion FPINs received by this Fibre Channel function."/> 254 </Property> 255 <Property Name="TXPeerCongestionFPINs" Type="Edm.Int64"> 256 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 257 <Annotation Term="OData.Description" String="The total number of Peer Congestion Fabric Performance Impact Notifications (FPINs) sent."/> 258 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of Peer Congestion FPINs sent by this Fibre Channel function."/> 259 </Property> 260 <Property Name="RXCongestionFPINs" Type="Edm.Int64"> 261 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 262 <Annotation Term="OData.Description" String="The total number of Congestion Fabric Performance Impact Notifications (FPINs) received."/> 263 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of Congestion FPINs received by this Fibre Channel function."/> 264 </Property> 265 <Property Name="TXCongestionFPINs" Type="Edm.Int64"> 266 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 267 <Annotation Term="OData.Description" String="The total number of Congestion Fabric Performance Impact Notifications (FPINs) sent."/> 268 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of Congestion FPINs sent by this Fibre Channel function."/> 269 </Property> 270 <Property Name="RXLinkIntegrityFPINs" Type="Edm.Int64"> 271 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 272 <Annotation Term="OData.Description" String="The total number of Link Integrity Fabric Performance Impact Notifications (FPINs) received."/> 273 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of Link Integrity FPINs received by this Fibre Channel function."/> 274 </Property> 275 <Property Name="TXLinkIntegrityFPINs" Type="Edm.Int64"> 276 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 277 <Annotation Term="OData.Description" String="The total number of Link Integrity Fabric Performance Impact Notifications (FPINs) sent."/> 278 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of Link Integrity FPINs sent by this Fibre Channel function."/> 279 </Property> 280 <Property Name="RXDeliveryFPINs" Type="Edm.Int64"> 281 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 282 <Annotation Term="OData.Description" String="The total number of Delivery Fabric Performance Impact Notifications (FPINs) received."/> 283 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of Delivery FPINs received by this Fibre Channel function."/> 284 </Property> 285 <Property Name="TXDeliveryFPINs" Type="Edm.Int64"> 286 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 287 <Annotation Term="OData.Description" String="The total number of Delivery Fabric Performance Impact Notifications (FPINs) sent."/> 288 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of Delivery FPINs sent by this Fibre Channel function."/> 289 </Property> 290 </ComplexType> 291 </Schema> 292 293 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="NetworkDeviceFunctionMetrics.v1_1_1"> 294 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 295 <Annotation Term="OData.Description" String="This version was created to clarify the range of possible values for properties with percent units."/> 296 <EntityType Name="NetworkDeviceFunctionMetrics" BaseType="NetworkDeviceFunctionMetrics.v1_1_0.NetworkDeviceFunctionMetrics"/> 297 </Schema> 298 299 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="NetworkDeviceFunctionMetrics.v1_1_2"> 300 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 301 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/> 302 <EntityType Name="NetworkDeviceFunctionMetrics" BaseType="NetworkDeviceFunctionMetrics.v1_1_1.NetworkDeviceFunctionMetrics"/> 303 </Schema> 304 305 </edmx:DataServices> 306</edmx:Edmx> 307