xref: /openbmc/bmcweb/features/redfish/schema/dmtf/json-schema/StorageMetrics.v1_0_0.json (revision 9b46bc0b4c0c58c426e9bfb5a7d90250862ca9d2)
1{
2    "$id": "http://redfish.dmtf.org/schemas/v1/StorageMetrics.v1_0_0.json",
3    "$ref": "#/definitions/StorageMetrics",
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                "Oem": {
27                    "$ref": "#/definitions/OemActions",
28                    "description": "The available OEM-specific actions for this resource.",
29                    "longDescription": "This property shall contain the available OEM-specific actions for this resource."
30                }
31            },
32            "type": "object"
33        },
34        "OemActions": {
35            "additionalProperties": true,
36            "description": "The available OEM-specific actions for this resource.",
37            "longDescription": "This type shall contain the available OEM-specific actions for this resource.",
38            "patternProperties": {
39                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
40                    "description": "This property shall specify a valid odata or Redfish property.",
41                    "type": [
42                        "array",
43                        "boolean",
44                        "integer",
45                        "number",
46                        "null",
47                        "object",
48                        "string"
49                    ]
50                }
51            },
52            "properties": {},
53            "type": "object"
54        },
55        "StorageMetrics": {
56            "additionalProperties": false,
57            "description": "The usage and health statistics for a storage subsystem.",
58            "longDescription": "The `StorageMetrics` schema shall contain the usage and health statistics for a storage subsystem in a Redfish implementation.",
59            "patternProperties": {
60                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
61                    "description": "This property shall specify a valid odata or Redfish property.",
62                    "type": [
63                        "array",
64                        "boolean",
65                        "integer",
66                        "number",
67                        "null",
68                        "object",
69                        "string"
70                    ]
71                }
72            },
73            "properties": {
74                "@odata.context": {
75                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
76                },
77                "@odata.etag": {
78                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
79                },
80                "@odata.id": {
81                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
82                },
83                "@odata.type": {
84                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
85                },
86                "Actions": {
87                    "$ref": "#/definitions/Actions",
88                    "description": "The available actions for this resource.",
89                    "longDescription": "This property shall contain the available actions for this resource."
90                },
91                "CompressionSavingsBytes": {
92                    "description": "Current compression savings on the storage system in bytes.",
93                    "longDescription": "The value shall represent the current compression savings on the storage system in bytes.",
94                    "readonly": true,
95                    "type": [
96                        "integer",
97                        "null"
98                    ],
99                    "units": "By"
100                },
101                "DeduplicationSavingsBytes": {
102                    "description": "Current deduplication savings on the storage system in bytes.",
103                    "longDescription": "The value shall represent the current deduplication savings on the storage system in bytes.",
104                    "readonly": true,
105                    "type": [
106                        "integer",
107                        "null"
108                    ],
109                    "units": "By"
110                },
111                "Description": {
112                    "anyOf": [
113                        {
114                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
115                        },
116                        {
117                            "type": "null"
118                        }
119                    ],
120                    "readonly": true
121                },
122                "IOStatistics": {
123                    "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/IOStatistics.json#/definitions/IOStatistics",
124                    "description": "Statistics for this storage system.",
125                    "longDescription": "The value shall contain the I/O statistics for this storage system."
126                },
127                "Id": {
128                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
129                    "readonly": true
130                },
131                "Name": {
132                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
133                    "readonly": true
134                },
135                "Oem": {
136                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
137                    "description": "The OEM extension property.",
138                    "longDescription": "This property shall contain the OEM extensions.  All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
139                },
140                "StateChangeCount": {
141                    "description": "The number of state changes for this storage subsystem.",
142                    "longDescription": "This property shall contain the number of times the `State` property within the `Status` property of the parent `Storage` resource changed.",
143                    "readonly": true,
144                    "type": [
145                        "number",
146                        "null"
147                    ]
148                },
149                "ThinProvisioningSavingsBytes": {
150                    "description": "Current thin provisioning savings on the storage system in bytes.",
151                    "longDescription": "The value shall represent the current thin provisioning savings on the storage system in bytes.",
152                    "readonly": true,
153                    "type": [
154                        "integer",
155                        "null"
156                    ],
157                    "units": "By"
158                }
159            },
160            "required": [
161                "@odata.id",
162                "@odata.type",
163                "Id",
164                "Name"
165            ],
166            "type": "object"
167        }
168    },
169    "language": "en",
170    "owningEntity": "DMTF",
171    "release": "2024.4",
172    "title": "#StorageMetrics.v1_0_0.StorageMetrics"
173}