diff options
Diffstat (limited to 'static/redfish/v1/JsonSchemas/MemoryMetrics/MemoryMetrics.json')
| -rw-r--r-- | static/redfish/v1/JsonSchemas/MemoryMetrics/MemoryMetrics.json | 161 |
1 files changed, 88 insertions, 73 deletions
diff --git a/static/redfish/v1/JsonSchemas/MemoryMetrics/MemoryMetrics.json b/static/redfish/v1/JsonSchemas/MemoryMetrics/MemoryMetrics.json index 7b10854904..b0fcfbda34 100644 --- a/static/redfish/v1/JsonSchemas/MemoryMetrics/MemoryMetrics.json +++ b/static/redfish/v1/JsonSchemas/MemoryMetrics/MemoryMetrics.json @@ -1,14 +1,15 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/MemoryMetrics.v1_2_0.json", "$ref": "#/definitions/MemoryMetrics", "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json", - "copyright": "Copyright 2014-2018 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright", + "copyright": "Copyright 2014-2019 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright", "definitions": { "Actions": { "additionalProperties": false, - "description": "The available actions for this resource.", - "longDescription": "This type shall contain the available actions for this resource.", + "description": "The available actions for this Resource.", + "longDescription": "This type shall contain the available actions for this Resource.", "patternProperties": { - "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", @@ -27,18 +28,18 @@ }, "Oem": { "$ref": "#/definitions/OemActions", - "description": "This property contains the available OEM specific actions for this resource.", - "longDescription": "This property shall contain any additional OEM actions for this resource." + "description": "The available OEM-specific actions for this Resource.", + "longDescription": "This property shall contain the available OEM-specific actions for this Resource." } }, "type": "object" }, "AlarmTrips": { "additionalProperties": false, - "description": "Alarm trip information about the memory. These alarms are reset when the system resets. Note that if they are re-discovered they can be reasserted.", - "longDescription": "This type shall contain properties describing the types of alarms that have been raised by the memory. These alarams shall be reset when the system resets. Note that if they are re-discovered they can be reasserted.", + "description": "The alarm trip information about the memory. These alarms are reset when the system resets. Note that if they are re-discovered they can be reasserted.", + "longDescription": "This type shall contain properties that describe the types of alarms that have been raised by the memory. These alarms shall be reset when the system resets. Note that if they are re-discovered they can be reasserted.", "patternProperties": { - "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", @@ -53,8 +54,8 @@ }, "properties": { "AddressParityError": { - "description": "Address parity error detected status.", - "longDescription": "The value of this property shall be true if an Address Parity Error was detected which could not be corrected by retry.", + "description": "An indication of whether an address parity error was detected that a retry could not correct.", + "longDescription": "This property shall indicate whether an address parity error was detected that a retry could not correct.", "readonly": true, "type": [ "boolean", @@ -62,8 +63,8 @@ ] }, "CorrectableECCError": { - "description": "Correctable data error threshold crossing alarm trip detected status.", - "longDescription": "The value of this property shall be true if the correctable error threshold crossing alarm trip was detected.", + "description": "An indication of whether the correctable error threshold crossing alarm trip was detected.", + "longDescription": "This property shall indicate whether the correctable error threshold crossing alarm trip was detected.", "readonly": true, "type": [ "boolean", @@ -71,8 +72,8 @@ ] }, "SpareBlock": { - "description": "Spare block capacity crossing alarm trip detected status.", - "longDescription": "The value of this property shall be true if the spare block capacity crossing alarm trip was detected.", + "description": "An indication of whether the spare block capacity crossing alarm trip was detected.", + "longDescription": "This property shall indicate whether the spare block capacity crossing alarm trip was detected.", "readonly": true, "type": [ "boolean", @@ -80,8 +81,8 @@ ] }, "Temperature": { - "description": "Temperature threshold crossing alarm trip detected status.", - "longDescription": "The value of this property shall be true if a temperature threshold alarm trip was detected.", + "description": "An indication of whether a temperature threshold alarm trip was detected.", + "longDescription": "This property shall indicates whether a temperature threshold alarm trip was detected.", "readonly": true, "type": [ "boolean", @@ -89,8 +90,8 @@ ] }, "UncorrectableECCError": { - "description": "Uncorrectable data error threshold crossing alarm trip detected status.", - "longDescription": "The value of this property shall be true if the uncorrectable error threshold alarm trip was detected.", + "description": "An indication of whether the uncorrectable error threshold alarm trip was detected.", + "longDescription": "This property shall indicate whether the uncorrectable error threshold alarm trip was detected.", "readonly": true, "type": [ "boolean", @@ -102,11 +103,11 @@ }, "ClearCurrentPeriod": { "additionalProperties": false, - "description": "This sets the CurrentPeriod object values to zero.", - "longDescription": "This action shall set the CurrentPeriod object property values to zero.", + "description": "This action sets the CurrentPeriod property's values to 0.", + "longDescription": "This action shall set the CurrentPeriod property's values to 0.", "parameters": {}, "patternProperties": { - "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", @@ -122,7 +123,7 @@ "properties": { "target": { "description": "Link to invoke action", - "format": "uri", + "format": "uri-reference", "type": "string" }, "title": { @@ -134,10 +135,10 @@ }, "CurrentPeriod": { "additionalProperties": false, - "description": "This object contains the Memory metrics since last reset or ClearCurrentPeriod action.", - "longDescription": "This type shall describe the metrics of the memory since last time the ClearCurrentPeriod Action was performed or the system reset.", + "description": "The memory metrics since the last system reset or ClearCurrentPeriod action.", + "longDescription": "This type shall describe the memory metrics since last system reset or ClearCurrentPeriod action.", "patternProperties": { - "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", @@ -152,8 +153,8 @@ }, "properties": { "BlocksRead": { - "description": "Number of blocks read since reset.", - "longDescription": "The value of this property shall be number of blocks read since reset.", + "description": "The number of blocks read since reset.", + "longDescription": "This property shall contain the number of blocks read since reset. When this Resource is subordinate to the MemorySummary object, this property shall be the sum of BlocksRead over all memory.", "readonly": true, "type": [ "integer", @@ -161,8 +162,8 @@ ] }, "BlocksWritten": { - "description": "Number of blocks written since reset.", - "longDescription": "The value of this property shall be mumber of blocks written since reset.", + "description": "The number of blocks written since reset.", + "longDescription": "This property shall contain the number of blocks written since reset. When this Resource is subordinate to the MemorySummary object, this property shall be the sum of BlocksWritten over all memory.", "readonly": true, "type": [ "integer", @@ -174,10 +175,10 @@ }, "HealthData": { "additionalProperties": false, - "description": "This type describes the health information of the memory.", - "longDescription": "This type shall contain properties which describe the HealthData metrics for the current resource.", + "description": "The health information of the memory.", + "longDescription": "This type shall contain properties that describe the HealthData metrics for this Resource.", "patternProperties": { - "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", @@ -194,11 +195,11 @@ "AlarmTrips": { "$ref": "#/definitions/AlarmTrips", "description": "Alarm trip information about the memory.", - "longDescription": "This object shall contain properties describe the types of alarms that have been raised by the memory." + "longDescription": "This object shall contain properties describe the types of alarms that have been raised by the memory. When this Resource is subordinate to the MemorySummary object, this property shall indicate whether an alarm of a given type have been raised by any area of memory." }, "DataLossDetected": { - "description": "Data loss detection status.", - "longDescription": "The value of this property shall be data loss detection status, with true indicating data loss detected.", + "description": "An indication of whether data loss was detected.", + "longDescription": "This property shall indicate whether data loss was detected. When this Resource is subordinate to the MemorySummary object, this property shall indicate whether any data loss was detected in any area of memory.", "readonly": true, "type": [ "boolean", @@ -206,8 +207,8 @@ ] }, "LastShutdownSuccess": { - "description": "Status of last shutdown.", - "longDescription": "The value of this property shall be the status ofthe last shutdown, with true indicating success.", + "description": "An indication of whether the last shutdown succeeded.", + "longDescription": "This property shall indicate whether the last shutdown succeeded.", "readonly": true, "type": [ "boolean", @@ -215,8 +216,8 @@ ] }, "PerformanceDegraded": { - "description": "Performance degraded mode status.", - "longDescription": "The value of this property shall be performance degraded mode status, with true indicating perfomance degraded.", + "description": "An indication of whether performance has degraded.", + "longDescription": "This property shall indicate whether performance has degraded. When this Resource is subordinate to the MemorySummary object, this property shall indicate whether degraded performance mode status is detected in any area of memory.", "readonly": true, "type": [ "boolean", @@ -231,11 +232,12 @@ "number", "null" ], - "units": "%" + "units": "%", + "versionAdded": "v1_1_0" }, "RemainingSpareBlockPercentage": { - "description": "Remaining spare blocks in percentage.", - "longDescription": "The value of this property shall be the remaining spare blocks in percentage.", + "description": "The remaining spare blocks, as a percentage.", + "longDescription": "This property shall contain the remaining spare blocks as a percentage. When this Resource is subordinate to the MemorySummary object, this property shall be the RemainingSpareBlockPercentage over all memory.", "readonly": true, "type": [ "number", @@ -248,10 +250,10 @@ }, "LifeTime": { "additionalProperties": false, - "description": "This object contains the Memory metrics for the lifetime of the Memory.", - "longDescription": "This type shall describe the metrics of the memory since manufacturing.", + "description": "The memory metrics for the lifetime of the memory.", + "longDescription": "This type shall describe the memory metrics since manufacturing.", "patternProperties": { - "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", @@ -266,8 +268,8 @@ }, "properties": { "BlocksRead": { - "description": "Number of blocks read for the lifetime of the Memory.", - "longDescription": "The value of this property shall be number of blocks read for the lifetime of the Memory.", + "description": "The number of blocks read for the lifetime of the memory.", + "longDescription": "This property shall contain the number of blocks read for the lifetime of the Memory. When this Resource is subordinate to the MemorySummary object, this property shall be the sum of BlocksRead over all memory.", "readonly": true, "type": [ "integer", @@ -275,8 +277,8 @@ ] }, "BlocksWritten": { - "description": "Number of blocks written for the lifetime of the Memory.", - "longDescription": "The value of this property shall be number of blocks written for the lifetime of the Memory.", + "description": "The number of blocks written for the lifetime of the memory.", + "longDescription": "This property shall contain the number of blocks written for the lifetime of the Memory. When this Resource is subordinate to the MemorySummary object, this property shall be the sum of BlocksWritten over all memory.", "readonly": true, "type": [ "integer", @@ -288,10 +290,10 @@ }, "MemoryMetrics": { "additionalProperties": false, - "description": "MemoryMetrics contains usage and health statistics for a single Memory module or device instance.", - "longDescription": "This resource shall be used to represent the Memory Metrics for a single Memory device in a Redfish implementation.", + "description": "The usage and health statistics for a memory device or system memory summary.", + "longDescription": "The MemoryMetrics Schema shall contain the memory metrics for a memory device or system memory summary in a Redfish implementation.", "patternProperties": { - "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", @@ -306,25 +308,37 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" }, "@odata.type": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/type" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type" }, "Actions": { "$ref": "#/definitions/Actions", - "description": "The available actions for this resource.", - "longDescription": "The Actions property shall contain the available actions for this resource." + "description": "The available actions for this Resource.", + "longDescription": "This property shall contain the available actions for this Resource." + }, + "BandwidthPercent": { + "description": "The memory bandwidth utilization as a percentage.", + "longDescription": "This property shall contain memory bandwidth utilization as a percentage. When this Resource is subordinate to the MemorySummary object, this property shall be the memory bandwidth utilization over all memory as a percentage.", + "minimum": 0, + "readonly": true, + "type": [ + "number", + "null" + ], + "units": "%", + "versionAdded": "v1_2_0" }, "BlockSizeBytes": { - "description": "Block size in bytes.", - "longDescription": "The value of this property shall be the block size in bytes of all stucture elements.", + "description": "The block size, in bytes.", + "longDescription": "This property shall contain the block size, in bytes, of all stucture elements. When this Resource is subordinate to the MemorySummary object, this property is not applicable.", "readonly": true, "type": [ "integer", @@ -334,8 +348,8 @@ }, "CurrentPeriod": { "$ref": "#/definitions/CurrentPeriod", - "description": "This object contains the Memory metrics since last reset or ClearCurrentPeriod action.", - "longDescription": "This object shall contain properties which describe the CurrentPeriod metrics for the current resource." + "description": "The memory metrics since the last reset or ClearCurrentPeriod action.", + "longDescription": "This property shall contain properties that describe the memory metrics for the current period." }, "Description": { "anyOf": [ @@ -350,8 +364,8 @@ }, "HealthData": { "$ref": "#/definitions/HealthData", - "description": "This object describes the health information of the memory.", - "longDescription": "This object shall contain properties which describe the HealthData metrics for the current resource." + "description": "The health information of the memory.", + "longDescription": "This property shall contain properties that describe the health data memory metrics for the memory. When this Resource is subordinate to the MemorySummary object, this property is not applicable." }, "Id": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", @@ -359,8 +373,8 @@ }, "LifeTime": { "$ref": "#/definitions/LifeTime", - "description": "This object contains the Memory metrics for the lifetime of the Memory.", - "longDescription": "This object shall contain properties which describe the LifeTime metrics for the current resource." + "description": "The memory metrics for the lifetime of the memory.", + "longDescription": "This property shall contain properties that describe the memory metrics for the lifetime of the memory." }, "Name": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", @@ -368,8 +382,8 @@ }, "Oem": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", - "description": "This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.", - "longDescription": "The value of this string shall be of the format for the reserved word *Oem*." + "description": "The OEM extension property.", + "longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements." } }, "required": [ @@ -382,10 +396,10 @@ }, "OemActions": { "additionalProperties": true, - "description": "The available OEM specific actions for this resource.", - "longDescription": "This type shall contain any additional OEM actions for this resource.", + "description": "The available OEM-specific actions for this Resource.", + "longDescription": "This type shall contain the available OEM-specific actions for this Resource.", "patternProperties": { - "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", @@ -403,5 +417,6 @@ } }, "owningEntity": "DMTF", - "title": "#MemoryMetrics.v1_1_4.MemoryMetrics" + "release": "2019.2", + "title": "#MemoryMetrics.v1_2_0.MemoryMetrics" }
\ No newline at end of file |