blob: 0f8d402d8e4c5fe8cfa780d79396c7e47f8788f0 [file] [log] [blame]
Ed Tanous118b1c72018-09-13 13:45:51 -07001{
Ed Tanous118b1c72018-09-13 13:45:51 -07002 "$ref": "#/definitions/Volume",
Ed Tanouscb103132019-10-08 11:34:22 -07003 "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
4 "copyright": "Copyright 2016-2018 Storage Networking Industry Association (SNIA), USA. All rights reserved. For the full SNIA copyright policy, see http://www.snia.org/about/corporate_info/copyright",
Ed Tanous118b1c72018-09-13 13:45:51 -07005 "definitions": {
Ed Tanouscb103132019-10-08 11:34:22 -07006 "Actions": {
7 "additionalProperties": false,
Ed Tanous118b1c72018-09-13 13:45:51 -07008 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -07009 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
10 "description": "This property shall specify a valid odata or Redfish property.",
Ed Tanous118b1c72018-09-13 13:45:51 -070011 "type": [
12 "array",
13 "boolean",
Ed Tanouscb103132019-10-08 11:34:22 -070014 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -070015 "number",
16 "null",
17 "object",
18 "string"
Ed Tanouscb103132019-10-08 11:34:22 -070019 ]
Ed Tanous118b1c72018-09-13 13:45:51 -070020 }
21 },
Ed Tanous118b1c72018-09-13 13:45:51 -070022 "properties": {
Ed Tanouscb103132019-10-08 11:34:22 -070023 "#Volume.CheckConsistency": {
24 "$ref": "#/definitions/CheckConsistency"
Ed Tanous118b1c72018-09-13 13:45:51 -070025 },
Ed Tanouscb103132019-10-08 11:34:22 -070026 "#Volume.Initialize": {
27 "$ref": "#/definitions/Initialize"
28 },
29 "Oem": {
30 "$ref": "#/definitions/OemActions"
Ed Tanous118b1c72018-09-13 13:45:51 -070031 }
32 },
Ed Tanouscb103132019-10-08 11:34:22 -070033 "type": "object"
34 },
35 "CheckConsistency": {
36 "additionalProperties": false,
37 "description": "This action is used to force a check of the Volume's parity or redundant data to ensure it matches calculated values.",
38 "longDescription": "This defines the name of the custom action supported on this resource.",
39 "parameters": {},
40 "patternProperties": {
41 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
42 "description": "This property shall specify a valid odata or Redfish property.",
43 "type": [
44 "array",
45 "boolean",
46 "integer",
47 "number",
48 "null",
49 "object",
50 "string"
51 ]
52 }
53 },
54 "properties": {
55 "target": {
56 "description": "Link to invoke action",
57 "format": "uri",
58 "type": "string"
59 },
60 "title": {
61 "description": "Friendly action name",
62 "type": "string"
63 }
64 },
65 "type": "object"
Ed Tanous118b1c72018-09-13 13:45:51 -070066 },
67 "EncryptionTypes": {
Ed Tanous118b1c72018-09-13 13:45:51 -070068 "enum": [
69 "NativeDriveEncryption",
70 "ControllerAssisted",
71 "SoftwareAssisted"
72 ],
73 "enumDescriptions": {
Ed Tanous118b1c72018-09-13 13:45:51 -070074 "ControllerAssisted": "The volume is being encrypted by the storage controller entity.",
Ed Tanouscb103132019-10-08 11:34:22 -070075 "NativeDriveEncryption": "The volume is utilizing the native drive encryption capabilities of the drive hardware.",
Ed Tanous118b1c72018-09-13 13:45:51 -070076 "SoftwareAssisted": "The volume is being encrypted by software running on the system or the operating system."
Ed Tanouscb103132019-10-08 11:34:22 -070077 },
78 "type": "string"
Ed Tanous118b1c72018-09-13 13:45:51 -070079 },
Ed Tanouscb103132019-10-08 11:34:22 -070080 "Initialize": {
81 "additionalProperties": false,
82 "description": "This action is used to prepare the contents of the volume for use by the system. If InitializeType is not specified in the request body, the InitializeType should be Fast.",
83 "longDescription": "This defines the name of the custom action supported on this resource. If InitializeType is not specified in the request body, the InitializeType should be Fast.",
84 "parameters": {
85 "InitializeType": {
86 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Volume.json#/definitions/InitializeType",
87 "description": "The type of initialization to be performed.",
88 "longDescription": "This defines the property name for the action."
89 }
90 },
Ed Tanous118b1c72018-09-13 13:45:51 -070091 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -070092 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
93 "description": "This property shall specify a valid odata or Redfish property.",
Ed Tanous118b1c72018-09-13 13:45:51 -070094 "type": [
95 "array",
96 "boolean",
Ed Tanouscb103132019-10-08 11:34:22 -070097 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -070098 "number",
99 "null",
100 "object",
101 "string"
Ed Tanouscb103132019-10-08 11:34:22 -0700102 ]
Ed Tanous118b1c72018-09-13 13:45:51 -0700103 }
104 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700105 "properties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700106 "target": {
107 "description": "Link to invoke action",
108 "format": "uri",
109 "type": "string"
110 },
111 "title": {
112 "description": "Friendly action name",
113 "type": "string"
114 }
115 },
116 "type": "object"
117 },
118 "InitializeType": {
119 "enum": [
120 "Fast",
121 "Slow"
122 ],
123 "enumDescriptions": {
124 "Fast": "The volume is prepared for use quickly, typically by erasing just the beginning and end of the space so that partitioning can be performed.",
125 "Slow": "The volume is prepared for use slowly, typically by completely erasing the volume."
126 },
127 "type": "string"
128 },
129 "Links": {
130 "additionalProperties": false,
131 "description": "Add ability to manage spare capacity.",
132 "patternProperties": {
133 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
134 "description": "This property shall specify a valid odata or Redfish property.",
135 "type": [
136 "array",
137 "boolean",
138 "integer",
139 "number",
140 "null",
141 "object",
142 "string"
143 ]
144 }
145 },
146 "properties": {
147 "ClassOfService": {
148 "anyOf": [
149 {
150 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/ClassOfService.json#/definitions/ClassOfService"
151 },
152 {
153 "type": "null"
154 }
155 ],
156 "description": "The ClassOfService that this storage volume conforms to.",
157 "longDescription": "This property shall contain a reference to the ClassOfService that this storage volume conforms to.",
158 "readonly": true
159 },
160 "DedicatedSpareDrives": {
161 "description": "An array of references to the drives which are dedicated spares for this volume.",
162 "items": {
163 "$ref": "http://redfish.dmtf.org/schemas/v1/Drive.json#/definitions/Drive"
164 },
165 "longDescription": "The value of this property shall be a reference to the resources that this volume is associated with and shall reference resources of type Drive. This property shall only contain references to Drive entities which are currently assigned as a dedicated spare and are able to support this Volume.",
166 "readonly": true,
167 "type": "array"
168 },
169 "DedicatedSpareDrives@odata.count": {
170 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count"
171 },
172 "Drives": {
173 "description": "An array of references to the drives which contain this volume. This will reference Drives that either wholly or only partly contain this volume.",
174 "items": {
175 "$ref": "http://redfish.dmtf.org/schemas/v1/Drive.json#/definitions/Drive"
176 },
177 "longDescription": "The value of this property shall be a reference to the resources that this volume is associated with and shall reference resources of type Drive. This property shall only contain references to Drive entities which are currently members of the Volume, not hot spare Drives which are not currently a member of the volume.",
178 "readonly": true,
179 "type": "array"
180 },
181 "Drives@odata.count": {
182 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count"
183 },
184 "Oem": {
185 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
186 "description": "Oem extension object.",
187 "longDescription": "This object represents the Oem property. All values for resources described by this schema shall comply to the requirements as described in the Redfish specification."
188 },
189 "SpareResourceSets": {
190 "description": "An array of references to SpareResourceSets.",
191 "items": {
192 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/SpareResourceSet.json#/definitions/SpareResourceSet"
193 },
194 "longDescription": "Each referenced SpareResourceSet shall contain resources that may be utilized to replace the capacity provided by a failed resource having a compatible type.",
195 "readonly": false,
196 "type": "array"
197 },
198 "SpareResourceSets@odata.count": {
199 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count"
200 }
201 },
202 "type": "object"
203 },
204 "OemActions": {
205 "additionalProperties": true,
206 "patternProperties": {
207 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
208 "description": "This property shall specify a valid odata or Redfish property.",
209 "type": [
210 "array",
211 "boolean",
212 "integer",
213 "number",
214 "null",
215 "object",
216 "string"
217 ]
218 }
219 },
220 "properties": {},
221 "type": "object"
222 },
223 "Operation": {
224 "additionalProperties": false,
225 "patternProperties": {
226 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
227 "description": "This property shall specify a valid odata or Redfish property.",
228 "type": [
229 "array",
230 "boolean",
231 "integer",
232 "number",
233 "null",
234 "object",
235 "string"
236 ]
237 }
238 },
239 "properties": {
240 "AssociatedTask": {
241 "$ref": "http://redfish.dmtf.org/schemas/v1/Task.json#/definitions/Task",
242 "description": "A reference to the task associated with the operation if any.",
243 "readonly": true
244 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700245 "OperationName": {
Ed Tanouscb103132019-10-08 11:34:22 -0700246 "description": "The name of the operation.",
247 "readonly": true,
Ed Tanous118b1c72018-09-13 13:45:51 -0700248 "type": [
249 "string",
250 "null"
Ed Tanouscb103132019-10-08 11:34:22 -0700251 ]
Ed Tanous118b1c72018-09-13 13:45:51 -0700252 },
253 "PercentageComplete": {
Ed Tanouscb103132019-10-08 11:34:22 -0700254 "description": "The percentage of the operation that has been completed.",
255 "readonly": true,
Ed Tanous118b1c72018-09-13 13:45:51 -0700256 "type": [
Ed Tanouscb103132019-10-08 11:34:22 -0700257 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700258 "null"
Ed Tanouscb103132019-10-08 11:34:22 -0700259 ]
Ed Tanous118b1c72018-09-13 13:45:51 -0700260 }
261 },
Ed Tanouscb103132019-10-08 11:34:22 -0700262 "type": "object"
263 },
264 "RAIDType": {
265 "enum": [
266 "RAID0",
267 "RAID1",
268 "RAID3",
269 "RAID4",
270 "RAID5",
271 "RAID6",
272 "RAID10",
273 "RAID01",
274 "RAID6TP",
275 "RAID1E",
276 "RAID50",
277 "RAID60",
278 "RAID00",
279 "RAID10E",
280 "RAID1Triple",
281 "RAID10Triple"
282 ],
283 "enumDescriptions": {
284 "RAID0": "A placement policy where consecutive logical blocks of data are uniformly distributed across a set of independent storage devices without offering any form of redundancy.",
285 "RAID00": "A placement policy that creates a RAID 0 stripe set over two or more RAID 0 sets.",
286 "RAID01": "A data placement policy that creates a mirrored device (RAID 1) over a set of striped devices (RAID 0).",
287 "RAID1": "A placement policy where each logical block of data is stored on more than one independent storage device.",
288 "RAID10": "A placement policy that creates a striped device (RAID 0) over a set of mirrored devices (RAID 1).",
289 "RAID10E": "A placement policy that uses a RAID 0 stripe set over two or more RAID 10 sets.",
290 "RAID10Triple": "A placement policy that uses a striped device (RAID 0) over a set of triple mirrored devices (RAID 1Triple).",
291 "RAID1E": "A placement policy that uses a form of mirroring implemented over a set of independent storage devices where logical blocks are duplicated on a pair of independent storage devices so that data is uniformly distributed across the storage devices.",
292 "RAID1Triple": "A placement policy where each logical block of data is mirrored three times across a set of three independent storage devices.",
293 "RAID3": "A placement policy using parity-based protection where logical bytes of data are uniformly distributed across a set of independent storage devices and where the parity is stored on a dedicated independent storage device.",
294 "RAID4": "A placement policy using parity-based protection where logical blocks of data are uniformly distributed across a set of independent storage devices and where the parity is stored on a dedicated independent storage device.",
295 "RAID5": "A placement policy using parity-based protection for storing stripes of 'n' logical blocks of data and one logical block of parity across a set of 'n+1' independent storage devices where the parity and data blocks are interleaved across the storage devices.",
296 "RAID50": "A placement policy that uses a RAID 0 stripe set over two or more RAID 5 sets of independent storage devices.",
297 "RAID6": "A placement policy using parity-based protection for storing stripes of 'n' logical blocks of data and two logical blocks of independent parity across a set of 'n+2' independent storage devices where the parity and data blocks are interleaved across the storage devices.",
298 "RAID60": "A placement policy that uses a RAID 0 stripe set over two or more RAID 6 sets of independent storage devices.",
299 "RAID6TP": "A placement policy that uses parity-based protection for storing stripes of 'n' logical blocks of data and three logical blocks of independent parity across a set of 'n+3' independent storage devices where the parity and data blocks are interleaved across the storage devices. This is commonly referred to as Triple Parity RAID. Data stored using this form of RAID is able to survive any three independent storage device failures without data loss."
300 },
301 "enumLongDescriptions": {
302 "RAID0": "A placement policy where consecutive logical blocks of data are uniformly distributed across a set of independent storage devices without offering any form of redundancy. This is commonly referred to as data striping. This form of RAID will encounter data loss with the failure of any storage device in the set.",
303 "RAID00": "A placement policy that creates a RAID 0 stripe set over two or more RAID 0 sets. This is commonly referred to as RAID 0+0. This form of data layout is not fault tolerant; if any storage device fails there will be data loss.",
304 "RAID01": "A data placement policy that creates a mirrored device (RAID 1) over a set of striped devices (RAID 0). This is commonly referred to as RAID 0+1 or RAID 0/1. Data stored using this form of RAID is able to survive a single RAID 0 data set failure without data loss.",
305 "RAID1": "A placement policy where each logical block of data is stored on more than one independent storage device. This is commonly referred to as mirroring. Data stored using this form of RAID is able to survive a single storage device failure without data loss.",
306 "RAID10": "A placement policy that creates a striped device (RAID 0) over a set of mirrored devices (RAID 1). This is commonly referred to as RAID 1/0. Data stored using this form of RAID is able to survive storage device failures in each RAID 1 set without data loss.",
307 "RAID10E": "A placement policy that uses a RAID 0 stripe set over two or more RAID 10 sets. This is commonly referred to as Enhanced RAID 10. Data stored using this form of RAID is able to survive a single device failure within each nested RAID 1 set without data loss.",
308 "RAID10Triple": "A placement policy that uses a striped device (RAID 0) over a set of triple mirrored devices (RAID 1Triple). This form of RAID can survive up to two failures in each triple mirror set without data loss. ",
309 "RAID1E": "A placement policy that uses a form of mirroring implemented over a set of independent storage devices where logical blocks are duplicated on a pair of independent storage devices so that data is uniformly distributed across the storage devices. This is commonly referred to as RAID 1 Enhanced. Data stored using this form of RAID is able to survive a single storage device failure without data loss.",
310 "RAID1Triple": "A placement policy where each logical block of data is mirrored three times across a set of three independent storage devices. This is commonly referred to as three-way mirroring. This form of RAID can survive two device failures without data loss.",
311 "RAID3": "A placement policy using parity-based protection where logical bytes of data are uniformly distributed across a set of independent storage devices and where the parity is stored on a dedicated independent storage device. Data stored using this form of RAID is able to survive a single storage device failure without data loss. If the storage devices use rotating media, they are assumed to be rotationally synchronized, and the data stripe size should be no larger than the exported block size.",
312 "RAID4": "A placement policy using parity-based protection where logical blocks of data are uniformly distributed across a set of independent storage devices and where the parity is stored on a dedicated independent storage device. Data stored using this form of RAID is able to survive a single storage device failure without data loss.",
313 "RAID5": "A placement policy using parity-based protection for storing stripes of 'n' logical blocks of data and one logical block of parity across a set of 'n+1' independent storage devices where the parity and data blocks are interleaved across the storage devices. Data stored using this form of RAID is able to survive a single storage device failure without data loss.",
314 "RAID50": "A placement policy that uses a RAID 0 stripe set over two or more RAID 5 sets of independent storage devices. Data stored using this form of RAID is able to survive a single storage device failure within each RAID 5 set without data loss.",
315 "RAID6": "A placement policy using parity-based protection for storing stripes of 'n' logical blocks of data and two logical blocks of independent parity across a set of 'n+2' independent storage devices where the parity and data blocks are interleaved across the storage devices. Data stored using this form of RAID is able to survive any two independent storage device failures without data loss.",
316 "RAID60": "A placement policy that uses a RAID 0 stripe set over two or more RAID 6 sets of independent storage devices. Data stored using this form of RAID is able to survive two device failures within each RAID 6 set without data loss."
317 },
318 "type": "string"
319 },
320 "Volume": {
321 "additionalProperties": false,
322 "description": "Volume contains properties used to describe a volume, virtual disk, LUN, or other logical storage entity for any system.",
323 "longDescription": "This resource shall be used to represent a volume, virtual disk, logical disk, LUN, or other logical storage for a Redfish implementation.",
324 "patternProperties": {
325 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
326 "description": "This property shall specify a valid odata or Redfish property.",
327 "type": [
328 "array",
329 "boolean",
330 "integer",
331 "number",
332 "null",
333 "object",
334 "string"
335 ]
336 }
337 },
338 "properties": {
339 "@odata.context": {
340 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context"
341 },
342 "@odata.etag": {
343 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag"
344 },
345 "@odata.id": {
346 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id"
347 },
348 "@odata.type": {
349 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/type"
350 },
351 "AccessCapabilities": {
352 "description": "Supported IO access capabilities.",
353 "items": {
354 "anyOf": [
355 {
356 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/DataStorageLoSCapabilities.json#/definitions/StorageAccessCapability"
357 },
358 {
359 "type": "null"
360 }
361 ]
362 },
363 "longDescription": "Each entry shall specify a current storage access capability.",
364 "readonly": false,
365 "type": "array"
366 },
367 "Actions": {
368 "$ref": "#/definitions/Actions",
369 "description": "The available actions for this resource.",
370 "longDescription": "The Actions property shall contain the available actions for this resource."
371 },
372 "AllocatedPools": {
373 "anyOf": [
374 {
375 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/StoragePoolCollection.json#/definitions/StoragePoolCollection"
376 },
377 {
378 "type": "null"
379 }
380 ],
381 "description": "An array of references to StoragePools allocated from this Volume.",
382 "longDescription": "The value of this property shall contain references to all storage pools allocated from this volume.",
383 "readonly": true
384 },
385 "BlockSizeBytes": {
386 "description": "The size of the smallest addressable unit (Block) of this volume in bytes.",
387 "longDescription": "This property shall contain size of the smallest addressable unit of the associated volume.",
388 "readonly": true,
389 "type": [
390 "integer",
391 "null"
392 ],
393 "units": "By"
394 },
395 "Capacity": {
396 "anyOf": [
397 {
398 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Capacity.json#/definitions/Capacity"
399 },
400 {
401 "type": "null"
402 }
403 ],
404 "description": "Capacity utilization.",
405 "longDescription": "Information about the utilization of capacity allocated to this storage volume.",
406 "readonly": false
407 },
408 "CapacityBytes": {
409 "description": "The size in bytes of this Volume.",
410 "longDescription": "This property shall contain the size in bytes of the associated volume.",
411 "readonly": true,
412 "type": [
413 "integer",
414 "null"
415 ],
416 "units": "By"
417 },
418 "CapacitySources": {
419 "description": "An array of space allocations to this volume.",
420 "items": {
421 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Capacity.json#/definitions/CapacitySource"
422 },
423 "longDescription": "Fully or partially consumed storage from a source resource. Each entry provides capacity allocation information from a named source resource.",
424 "readonly": false,
425 "type": "array"
426 },
427 "CapacitySources@odata.count": {
428 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count"
429 },
430 "Description": {
431 "anyOf": [
432 {
433 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
434 },
435 {
436 "type": "null"
437 }
438 ],
439 "readonly": true
440 },
441 "Encrypted": {
442 "description": "Is this Volume encrypted.",
443 "longDescription": "This property shall contain a boolean indicator if the Volume is currently utilizing encryption or not.",
444 "readonly": false,
445 "type": [
446 "boolean",
447 "null"
448 ]
449 },
450 "EncryptionTypes": {
451 "description": "The types of encryption used by this Volume.",
452 "items": {
453 "$ref": "#/definitions/EncryptionTypes"
454 },
455 "longDescription": "This property shall contain the types of encryption used by this Volume.",
456 "readonly": false,
457 "type": "array"
458 },
459 "IOStatistics": {
460 "anyOf": [
461 {
462 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/IOStatistics.json#/definitions/IOStatistics"
463 },
464 {
465 "type": "null"
466 }
467 ],
468 "description": "Statistics for this volume.",
469 "longDescription": "The value shall represent IO statistics for this volume."
470 },
471 "Id": {
472 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
473 "readonly": true
474 },
475 "Identifiers": {
476 "description": "The Durable names for the volume.",
477 "items": {
478 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Identifier"
479 },
480 "longDescription": "This property shall contain a list of all known durable names for the associated volume.",
481 "type": "array"
482 },
483 "Links": {
484 "$ref": "#/definitions/Links",
485 "description": "Contains references to other resources that are related to this resource.",
486 "longDescription": "The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource."
487 },
488 "LowSpaceWarningThresholdPercents": {
489 "description": "Low space warning.",
490 "items": {
491 "type": [
492 "integer",
493 "null"
494 ]
495 },
496 "longDescription": "Each time the following value is less than one of the values in the array the LOW_SPACE_THRESHOLD_WARNING event shall be triggered: Across all CapacitySources entries, percent = (SUM(AllocatedBytes) - SUM(ConsumedBytes))/SUM(AllocatedBytes).",
497 "readonly": false,
498 "type": "array",
499 "units": "%"
500 },
501 "Manufacturer": {
502 "description": "The manufacturer or OEM of this storage volume.",
503 "longDescription": "This property shall contain a value that represents the manufacturer or implementer of the storage volume.",
504 "readonly": true,
505 "type": [
506 "string",
507 "null"
508 ]
509 },
510 "MaxBlockSizeBytes": {
511 "description": "Max Block size in bytes.",
512 "longDescription": "This property shall contain size of the largest addressable unit of this storage volume.",
513 "readonly": true,
514 "type": [
515 "integer",
516 "null"
517 ],
518 "units": "By"
519 },
520 "Model": {
521 "description": "The model number for this storage volume.",
522 "longDescription": "The value is assigned by the manufacturer and shall represents a specific storage volume implementation.",
523 "readonly": true,
524 "type": [
525 "string",
526 "null"
527 ]
528 },
529 "Name": {
530 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
531 "readonly": true
532 },
533 "Oem": {
534 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
535 "description": "This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.",
536 "longDescription": "The value of this string shall be of the format for the reserved word *Oem*."
537 },
538 "Operations": {
539 "description": "The operations currently running on the Volume.",
540 "items": {
541 "$ref": "#/definitions/Operation"
542 },
543 "longDescription": "This property shall contain a list of all currently running on the Volume.",
544 "type": "array"
545 },
546 "OptimumIOSizeBytes": {
547 "description": "The size in bytes of this Volume's optimum IO size.",
548 "longDescription": "This property shall contain the optimum IO size to use when performing IO on this volume. For logical disks, this is the stripe size. For physical disks, this describes the physical sector size.",
549 "readonly": true,
550 "type": [
551 "integer",
552 "null"
553 ],
554 "units": "By"
555 },
556 "RAIDType": {
557 "anyOf": [
558 {
559 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Volume.json#/definitions/RAIDType"
560 },
561 {
562 "type": "null"
563 }
564 ],
565 "description": "The RAID type of this volume.",
566 "longDescription": "This property shall contain the RAID type of the associated Volume.",
567 "readonly": true
568 },
569 "RecoverableCapacitySourceCount": {
570 "description": "Current number of capacity source resources that are available as replacements.",
571 "longDescription": "The value is the number of available capacity source resources currently available in the event that an equivalent capacity source resource fails.",
572 "readonly": false,
573 "type": [
574 "integer",
575 "null"
576 ]
577 },
578 "RemainingCapacityPercent": {
579 "description": "The percentage of the capacity remaining in the StoragePool.",
580 "longDescription": "If present, this value shall return {[(SUM(AllocatedBytes) - SUM(ConsumedBytes)]/SUM(AllocatedBytes)}*100 represented as an integer value.",
581 "readonly": true,
582 "type": [
583 "integer",
584 "null"
585 ]
586 },
587 "ReplicaInfo": {
588 "anyOf": [
589 {
590 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/StorageReplicaInfo.json#/definitions/ReplicaInfo"
591 },
592 {
593 "type": "null"
594 }
595 ],
596 "description": "Describes this storage volume in its role as a target replica.",
597 "longDescription": "This property shall describe the replica relationship between this storage volume and a corresponding source volume.",
598 "readonly": true
599 },
600 "ReplicaTargets": {
601 "description": "The resources that are target replicas of this source.",
602 "items": {
603 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/idRef"
604 },
605 "longDescription": "The value shall reference the target replicas that are sourced by this replica.",
606 "readonly": true,
607 "type": "array"
608 },
609 "ReplicaTargets@odata.count": {
610 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count"
611 },
612 "Status": {
613 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status"
614 },
615 "StorageGroups": {
616 "anyOf": [
617 {
618 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/StorageGroupCollection.json#/definitions/StorageGroupCollection"
619 },
620 {
621 "type": "null"
622 }
623 ],
624 "description": "An array of references to Storage Groups that includes this volume.",
625 "longDescription": "The value of this property shall contain references to all storage groups that include this volume.",
626 "readonly": true
627 },
628 "VolumeType": {
629 "anyOf": [
630 {
631 "$ref": "#/definitions/VolumeType"
632 },
633 {
634 "type": "null"
635 }
636 ],
637 "deprecated": "Deprecated in favor of explicit use of RAIDType.",
638 "description": "The type of this volume.",
639 "longDescription": "This property shall contain the type of the associated Volume.",
640 "readonly": true
641 }
642 },
643 "required": [
644 "@odata.id",
645 "@odata.type",
646 "Id",
647 "Name"
648 ],
649 "type": "object"
Ed Tanous118b1c72018-09-13 13:45:51 -0700650 },
651 "VolumeType": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700652 "enum": [
653 "RawDevice",
654 "NonRedundant",
655 "Mirrored",
656 "StripedWithParity",
657 "SpannedMirrors",
658 "SpannedStripesWithParity"
659 ],
660 "enumDescriptions": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700661 "Mirrored": "The volume is a mirrored device.",
Ed Tanouscb103132019-10-08 11:34:22 -0700662 "NonRedundant": "The volume is a non-redundant storage device.",
663 "RawDevice": "The volume is a raw physical device without any RAID or other virtualization applied.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700664 "SpannedMirrors": "The volume is a spanned set of mirrored devices.",
Ed Tanouscb103132019-10-08 11:34:22 -0700665 "SpannedStripesWithParity": "The volume is a spanned set of devices which uses parity to retain redundant information.",
666 "StripedWithParity": "The volume is a device which uses parity to retain redundant information."
Ed Tanous118b1c72018-09-13 13:45:51 -0700667 },
Ed Tanouscb103132019-10-08 11:34:22 -0700668 "type": "string"
Ed Tanous118b1c72018-09-13 13:45:51 -0700669 }
670 },
Ed Tanouscb103132019-10-08 11:34:22 -0700671 "owningEntity": "SNIA",
672 "title": "#Volume.v1_3_1.Volume"
673}