1<?xml version="1.0" encoding="UTF-8"?> 2<!----> 3<!--################################################################################ --> 4<!--# Redfish Schema: NetworkAdapterMetrics v1.1.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-2024 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="NetworkAdapterMetrics"> 34 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 35 <Annotation Term="Redfish.Language" String="en"/> 36 37 <EntityType Name="NetworkAdapterMetrics" BaseType="Resource.v1_0_0.Resource" Abstract="true"> 38 <Annotation Term="OData.Description" String="The NetworkAdapterMetrics schema contains usage and health statistics for a network adapter."/> 39 <Annotation Term="OData.LongDescription" String="This resource shall represent the network metrics for a single network adapter in a Redfish implementation."/> 40 <Annotation Term="OData.AdditionalProperties" Bool="false"/> 41 <Annotation Term="Capabilities.InsertRestrictions"> 42 <Record> 43 <PropertyValue Property="Insertable" Bool="false"/> 44 </Record> 45 </Annotation> 46 <Annotation Term="Capabilities.UpdateRestrictions"> 47 <Record> 48 <PropertyValue Property="Updatable" Bool="false"/> 49 </Record> 50 </Annotation> 51 <Annotation Term="Capabilities.DeleteRestrictions"> 52 <Record> 53 <PropertyValue Property="Deletable" Bool="false"/> 54 </Record> 55 </Annotation> 56 <Annotation Term="Redfish.Uris"> 57 <Collection> 58 <String>/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/Metrics</String> 59 </Collection> 60 </Annotation> 61 </EntityType> 62 63 <Action Name="ResetMetrics" IsBound="true"> 64 <Parameter Name="NetworkAdapterMetrics" Type="NetworkAdapterMetrics.v1_0_0.Actions"/> 65 <Annotation Term="OData.Description" String="This action resets the summary metrics related to this device."/> 66 <Annotation Term="OData.LongDescription" String="This action shall reset any time intervals or counted values for this device."/> 67 <Annotation Term="Redfish.Revisions"> 68 <Collection> 69 <Record> 70 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/> 71 <PropertyValue Property="Version" String="v1_1_0"/> 72 </Record> 73 </Collection> 74 </Annotation> 75 </Action> 76 </Schema> 77 78 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="NetworkAdapterMetrics.v1_0_0"> 79 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 80 <Annotation Term="Redfish.Release" String="2021.1"/> 81 82 <EntityType Name="NetworkAdapterMetrics" BaseType="NetworkAdapterMetrics.NetworkAdapterMetrics"> 83 <Property Name="HostBusRXPercent" Type="Edm.Decimal"> 84 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 85 <Annotation Term="OData.Description" String="The host bus, such as PCIe, RX utilization as a percentage."/> 86 <Annotation Term="OData.LongDescription" String="This property shall contain the host bus, such as PCIe, RX utilization as a percentage, typically `0` to `100`, which is calculated by dividing the total bytes received by the theoretical max."/> 87 <Annotation Term="Validation.Minimum" Int="0"/> 88 <Annotation Term="Measures.Unit" String="%"/> 89 </Property> 90 <Property Name="HostBusTXPercent" Type="Edm.Decimal"> 91 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 92 <Annotation Term="OData.Description" String="The host bus, such as PCIe, TX utilization as a percentage."/> 93 <Annotation Term="OData.LongDescription" String="This property shall contain the host bus, such as PCIe, TX utilization as a percentage, typically `0` to `100`, which is calculated by dividing the total bytes transmitted by the theoretical max."/> 94 <Annotation Term="Validation.Minimum" Int="0"/> 95 <Annotation Term="Measures.Unit" String="%"/> 96 </Property> 97 <Property Name="CPUCorePercent" Type="Edm.Decimal"> 98 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 99 <Annotation Term="OData.Description" String="The device CPU core utilization as a percentage."/> 100 <Annotation Term="OData.LongDescription" String="This property shall contain the device CPU core utilization as a percentage, typically `0` to `100`."/> 101 <Annotation Term="Validation.Minimum" Int="0"/> 102 <Annotation Term="Measures.Unit" String="%"/> 103 </Property> 104 <Property Name="NCSIRXFrames" Type="Edm.Int64"> 105 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 106 <Annotation Term="OData.Description" String="The total number of NC-SI frames received since reset."/> 107 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of NC-SI frames received since reset, including both passthrough and non-passthrough traffic."/> 108 </Property> 109 <Property Name="NCSITXFrames" Type="Edm.Int64"> 110 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 111 <Annotation Term="OData.Description" String="The total number of NC-SI frames sent since reset."/> 112 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of NC-SI frames sent since reset, including both passthrough and non-passthrough traffic."/> 113 </Property> 114 <Property Name="NCSIRXBytes" Type="Edm.Int64"> 115 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 116 <Annotation Term="OData.Description" String="The total number of NC-SI bytes received since reset."/> 117 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of NC-SI bytes received since reset, including both passthrough and non-passthrough traffic."/> 118 <Annotation Term="Measures.Unit" String="By"/> 119 </Property> 120 <Property Name="NCSITXBytes" Type="Edm.Int64"> 121 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 122 <Annotation Term="OData.Description" String="The total number of NC-SI bytes sent since reset."/> 123 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of NC-SI bytes sent since reset, including both passthrough and non-passthrough traffic."/> 124 <Annotation Term="Measures.Unit" String="By"/> 125 </Property> 126 <Property Name="RXBytes" Type="Edm.Int64"> 127 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 128 <Annotation Term="OData.Description" String="The total number of bytes received since reset."/> 129 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of bytes received since reset, including host and remote management passthrough traffic, and inclusive of all protocol overhead."/> 130 <Annotation Term="Measures.Unit" String="By"/> 131 </Property> 132 <Property Name="RXMulticastFrames" Type="Edm.Int64"> 133 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 134 <Annotation Term="OData.Description" String="The total number of good multicast frames received since reset."/> 135 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of good multicast frames received since reset."/> 136 </Property> 137 <Property Name="RXUnicastFrames" Type="Edm.Int64"> 138 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 139 <Annotation Term="OData.Description" String="The total number of good unicast frames received since reset."/> 140 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of good unicast frames received since reset."/> 141 </Property> 142 <Property Name="TXBytes" Type="Edm.Int64"> 143 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 144 <Annotation Term="OData.Description" String="The total number of bytes transmitted since reset."/> 145 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of bytes transmitted since reset, including host and remote management passthrough traffic, and inclusive of all protocol overhead."/> 146 <Annotation Term="Measures.Unit" String="By"/> 147 </Property> 148 <Property Name="TXMulticastFrames" Type="Edm.Int64"> 149 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 150 <Annotation Term="OData.Description" String="The total number of good multicast frames transmitted since reset."/> 151 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of good multicast frames transmitted since reset."/> 152 </Property> 153 <Property Name="TXUnicastFrames" Type="Edm.Int64"> 154 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 155 <Annotation Term="OData.Description" String="The total number of good unicast frames transmitted since reset."/> 156 <Annotation Term="OData.LongDescription" String="This property shall contain the total number of good unicast frames transmitted since reset."/> 157 </Property> 158 <Property Name="Actions" Type="NetworkAdapterMetrics.v1_0_0.Actions" Nullable="false"> 159 <Annotation Term="OData.Description" String="The available actions for this resource."/> 160 <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this resource."/> 161 </Property> 162 </EntityType> 163 164 <ComplexType Name="Actions"> 165 <Annotation Term="OData.AdditionalProperties" Bool="false"/> 166 <Annotation Term="OData.Description" String="The available actions for this resource."/> 167 <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/> 168 <Property Name="Oem" Type="NetworkAdapterMetrics.v1_0_0.OemActions" Nullable="false"> 169 <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/> 170 <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this resource."/> 171 </Property> 172 </ComplexType> 173 174 <ComplexType Name="OemActions"> 175 <Annotation Term="OData.AdditionalProperties" Bool="true"/> 176 <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/> 177 <Annotation Term="OData.LongDescription" String="This type shall contain the available OEM-specific actions for this resource."/> 178 </ComplexType> 179 </Schema> 180 181 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="NetworkAdapterMetrics.v1_0_1"> 182 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 183 <Annotation Term="OData.Description" String="This version was created to clarify the range of possible values for properties with percent units."/> 184 <EntityType Name="NetworkAdapterMetrics" BaseType="NetworkAdapterMetrics.v1_0_0.NetworkAdapterMetrics"/> 185 </Schema> 186 187 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="NetworkAdapterMetrics.v1_0_2"> 188 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 189 <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."/> 190 <EntityType Name="NetworkAdapterMetrics" BaseType="NetworkAdapterMetrics.v1_0_1.NetworkAdapterMetrics"/> 191 </Schema> 192 193 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="NetworkAdapterMetrics.v1_1_0"> 194 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 195 <Annotation Term="Redfish.Release" String="2024.1"/> 196 <Annotation Term="OData.Description" String="This version was created to add the `ResetMetrics` action."/> 197 198 <EntityType Name="NetworkAdapterMetrics" BaseType="NetworkAdapterMetrics.v1_0_2.NetworkAdapterMetrics"/> 199 </Schema> 200 201 </edmx:DataServices> 202</edmx:Edmx> 203