1{ 2 "$id": "http://redfish.dmtf.org/schemas/v1/NetworkAdapterMetrics.v1_1_0.json", 3 "$ref": "#/definitions/NetworkAdapterMetrics", 4 "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json", 5 "copyright": "Copyright 2014-2024 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright", 6 "definitions": { 7 "Actions": { 8 "additionalProperties": false, 9 "description": "The available actions for this resource.", 10 "longDescription": "This type shall contain the available actions for this resource.", 11 "patternProperties": { 12 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 13 "description": "This property shall specify a valid odata or Redfish property.", 14 "type": [ 15 "array", 16 "boolean", 17 "integer", 18 "number", 19 "null", 20 "object", 21 "string" 22 ] 23 } 24 }, 25 "properties": { 26 "#NetworkAdapterMetrics.ResetMetrics": { 27 "$ref": "#/definitions/ResetMetrics" 28 }, 29 "Oem": { 30 "$ref": "#/definitions/OemActions", 31 "description": "The available OEM-specific actions for this resource.", 32 "longDescription": "This property shall contain the available OEM-specific actions for this resource." 33 } 34 }, 35 "type": "object" 36 }, 37 "NetworkAdapterMetrics": { 38 "additionalProperties": false, 39 "description": "The NetworkAdapterMetrics schema contains usage and health statistics for a network adapter.", 40 "longDescription": "This resource shall represent the network metrics for a single network adapter in a Redfish implementation.", 41 "patternProperties": { 42 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 43 "description": "This property shall specify a valid odata or Redfish property.", 44 "type": [ 45 "array", 46 "boolean", 47 "integer", 48 "number", 49 "null", 50 "object", 51 "string" 52 ] 53 } 54 }, 55 "properties": { 56 "@odata.context": { 57 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" 58 }, 59 "@odata.etag": { 60 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" 61 }, 62 "@odata.id": { 63 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" 64 }, 65 "@odata.type": { 66 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type" 67 }, 68 "Actions": { 69 "$ref": "#/definitions/Actions", 70 "description": "The available actions for this resource.", 71 "longDescription": "This property shall contain the available actions for this resource." 72 }, 73 "CPUCorePercent": { 74 "description": "The device CPU core utilization as a percentage.", 75 "longDescription": "This property shall contain the device CPU core utilization as a percentage, typically `0` to `100`.", 76 "minimum": 0, 77 "readonly": true, 78 "type": [ 79 "number", 80 "null" 81 ], 82 "units": "%" 83 }, 84 "Description": { 85 "anyOf": [ 86 { 87 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description" 88 }, 89 { 90 "type": "null" 91 } 92 ], 93 "readonly": true 94 }, 95 "HostBusRXPercent": { 96 "description": "The host bus, such as PCIe, RX utilization as a percentage.", 97 "longDescription": "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.", 98 "minimum": 0, 99 "readonly": true, 100 "type": [ 101 "number", 102 "null" 103 ], 104 "units": "%" 105 }, 106 "HostBusTXPercent": { 107 "description": "The host bus, such as PCIe, TX utilization as a percentage.", 108 "longDescription": "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.", 109 "minimum": 0, 110 "readonly": true, 111 "type": [ 112 "number", 113 "null" 114 ], 115 "units": "%" 116 }, 117 "Id": { 118 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", 119 "readonly": true 120 }, 121 "NCSIRXBytes": { 122 "description": "The total number of NC-SI bytes received since reset.", 123 "longDescription": "This property shall contain the total number of NC-SI bytes received since reset, including both passthrough and non-passthrough traffic.", 124 "readonly": true, 125 "type": [ 126 "integer", 127 "null" 128 ], 129 "units": "By" 130 }, 131 "NCSIRXFrames": { 132 "description": "The total number of NC-SI frames received since reset.", 133 "longDescription": "This property shall contain the total number of NC-SI frames received since reset, including both passthrough and non-passthrough traffic.", 134 "readonly": true, 135 "type": [ 136 "integer", 137 "null" 138 ] 139 }, 140 "NCSITXBytes": { 141 "description": "The total number of NC-SI bytes sent since reset.", 142 "longDescription": "This property shall contain the total number of NC-SI bytes sent since reset, including both passthrough and non-passthrough traffic.", 143 "readonly": true, 144 "type": [ 145 "integer", 146 "null" 147 ], 148 "units": "By" 149 }, 150 "NCSITXFrames": { 151 "description": "The total number of NC-SI frames sent since reset.", 152 "longDescription": "This property shall contain the total number of NC-SI frames sent since reset, including both passthrough and non-passthrough traffic.", 153 "readonly": true, 154 "type": [ 155 "integer", 156 "null" 157 ] 158 }, 159 "Name": { 160 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", 161 "readonly": true 162 }, 163 "Oem": { 164 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", 165 "description": "The OEM extension property.", 166 "longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements." 167 }, 168 "RXBytes": { 169 "description": "The total number of bytes received since reset.", 170 "longDescription": "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.", 171 "readonly": true, 172 "type": [ 173 "integer", 174 "null" 175 ], 176 "units": "By" 177 }, 178 "RXMulticastFrames": { 179 "description": "The total number of good multicast frames received since reset.", 180 "longDescription": "This property shall contain the total number of good multicast frames received since reset.", 181 "readonly": true, 182 "type": [ 183 "integer", 184 "null" 185 ] 186 }, 187 "RXUnicastFrames": { 188 "description": "The total number of good unicast frames received since reset.", 189 "longDescription": "This property shall contain the total number of good unicast frames received since reset.", 190 "readonly": true, 191 "type": [ 192 "integer", 193 "null" 194 ] 195 }, 196 "TXBytes": { 197 "description": "The total number of bytes transmitted since reset.", 198 "longDescription": "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.", 199 "readonly": true, 200 "type": [ 201 "integer", 202 "null" 203 ], 204 "units": "By" 205 }, 206 "TXMulticastFrames": { 207 "description": "The total number of good multicast frames transmitted since reset.", 208 "longDescription": "This property shall contain the total number of good multicast frames transmitted since reset.", 209 "readonly": true, 210 "type": [ 211 "integer", 212 "null" 213 ] 214 }, 215 "TXUnicastFrames": { 216 "description": "The total number of good unicast frames transmitted since reset.", 217 "longDescription": "This property shall contain the total number of good unicast frames transmitted since reset.", 218 "readonly": true, 219 "type": [ 220 "integer", 221 "null" 222 ] 223 } 224 }, 225 "required": [ 226 "@odata.id", 227 "@odata.type", 228 "Id", 229 "Name" 230 ], 231 "type": "object" 232 }, 233 "OemActions": { 234 "additionalProperties": true, 235 "description": "The available OEM-specific actions for this resource.", 236 "longDescription": "This type shall contain the available OEM-specific actions for this resource.", 237 "patternProperties": { 238 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 239 "description": "This property shall specify a valid odata or Redfish property.", 240 "type": [ 241 "array", 242 "boolean", 243 "integer", 244 "number", 245 "null", 246 "object", 247 "string" 248 ] 249 } 250 }, 251 "properties": {}, 252 "type": "object" 253 }, 254 "ResetMetrics": { 255 "additionalProperties": false, 256 "description": "This action resets the summary metrics related to this device.", 257 "longDescription": "This action shall reset any time intervals or counted values for this device.", 258 "parameters": {}, 259 "patternProperties": { 260 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 261 "description": "This property shall specify a valid odata or Redfish property.", 262 "type": [ 263 "array", 264 "boolean", 265 "integer", 266 "number", 267 "null", 268 "object", 269 "string" 270 ] 271 } 272 }, 273 "properties": { 274 "target": { 275 "description": "Link to invoke action", 276 "format": "uri-reference", 277 "type": "string" 278 }, 279 "title": { 280 "description": "Friendly action name", 281 "type": "string" 282 } 283 }, 284 "type": "object", 285 "versionAdded": "v1_1_0" 286 } 287 }, 288 "language": "en", 289 "owningEntity": "DMTF", 290 "release": "2024.1", 291 "title": "#NetworkAdapterMetrics.v1_1_0.NetworkAdapterMetrics" 292}