1{ 2 "$id": "http://redfish.dmtf.org/schemas/swordfish/v1/Volume.v1_10_0.json", 3 "$ref": "#/definitions/Volume", 4 "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json", 5 "copyright": "Copyright 2015-2023 Storage Networking Industry Association (SNIA), USA. All rights reserved.", 6 "definitions": { 7 "Actions": { 8 "additionalProperties": false, 9 "patternProperties": { 10 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 11 "description": "This property shall specify a valid odata or Redfish property.", 12 "type": [ 13 "array", 14 "boolean", 15 "integer", 16 "number", 17 "null", 18 "object", 19 "string" 20 ] 21 } 22 }, 23 "properties": { 24 "#Volume.AssignReplicaTarget": { 25 "$ref": "#/definitions/AssignReplicaTarget" 26 }, 27 "#Volume.ChangeRAIDLayout": { 28 "$ref": "#/definitions/ChangeRAIDLayout" 29 }, 30 "#Volume.CheckConsistency": { 31 "$ref": "#/definitions/CheckConsistency" 32 }, 33 "#Volume.CreateReplicaTarget": { 34 "$ref": "#/definitions/CreateReplicaTarget" 35 }, 36 "#Volume.ForceEnable": { 37 "$ref": "#/definitions/ForceEnable" 38 }, 39 "#Volume.Initialize": { 40 "$ref": "#/definitions/Initialize" 41 }, 42 "#Volume.RemoveReplicaRelationship": { 43 "$ref": "#/definitions/RemoveReplicaRelationship" 44 }, 45 "#Volume.ResumeReplication": { 46 "$ref": "#/definitions/ResumeReplication" 47 }, 48 "#Volume.ReverseReplicationRelationship": { 49 "$ref": "#/definitions/ReverseReplicationRelationship" 50 }, 51 "#Volume.SplitReplication": { 52 "$ref": "#/definitions/SplitReplication" 53 }, 54 "#Volume.SuspendReplication": { 55 "$ref": "#/definitions/SuspendReplication" 56 }, 57 "Oem": { 58 "$ref": "#/definitions/OemActions" 59 } 60 }, 61 "type": "object" 62 }, 63 "AssignReplicaTarget": { 64 "additionalProperties": false, 65 "description": "This action is used to establish a replication relationship by assigning an existing volume to serve as a target replica for an existing source volume.", 66 "longDescription": "This action shall be used to establish a replication relationship by assigning an existing volume to serve as a target replica for an existing source volume.", 67 "parameters": { 68 "ReplicaType": { 69 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/StorageReplicaInfo.json#/definitions/ReplicaType", 70 "description": "The type of replica relationship to be created.", 71 "longDescription": "This parameter shall contain the type of replica relationship to be created (e.g., Clone, Mirror, Snap).", 72 "requiredParameter": true 73 }, 74 "ReplicaUpdateMode": { 75 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/StorageReplicaInfo.json#/definitions/ReplicaUpdateMode", 76 "description": "The replica update mode (synchronous vs asynchronous).", 77 "longDescription": "This parameter shall specify the replica update mode.", 78 "requiredParameter": true 79 }, 80 "TargetVolume": { 81 "description": "The Uri to the existing target volume.", 82 "longDescription": "This parameter shall contain the Uri to the existing target volume.", 83 "requiredParameter": true, 84 "type": "string" 85 } 86 }, 87 "patternProperties": { 88 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 89 "description": "This property shall specify a valid odata or Redfish property.", 90 "type": [ 91 "array", 92 "boolean", 93 "integer", 94 "number", 95 "null", 96 "object", 97 "string" 98 ] 99 } 100 }, 101 "properties": { 102 "target": { 103 "description": "Link to invoke action", 104 "format": "uri-reference", 105 "type": "string" 106 }, 107 "title": { 108 "description": "Friendly action name", 109 "type": "string" 110 } 111 }, 112 "type": "object", 113 "versionAdded": "v1_4_0" 114 }, 115 "ChangeRAIDLayout": { 116 "additionalProperties": false, 117 "description": "Request system change the RAID layout of the volume.", 118 "longDescription": "This action shall request the system to change the RAID layout of the volume. Depending on the combination of the submitted parameters, this could be changing the RAID type, changing the span count, changing the number of drives used by the volume, or another configuration change supported by the system. Note that usage of this action while online may potentially cause data loss if the available capacity is reduced.", 119 "parameters": { 120 "Drives": { 121 "description": "An array of the drives to be used by the volume.", 122 "items": { 123 "$ref": "http://redfish.dmtf.org/schemas/v1/Drive.json#/definitions/Drive" 124 }, 125 "longDescription": "This parameter shall contain an array of the drives to be used by the volume.", 126 "type": "array" 127 }, 128 "MediaSpanCount": { 129 "description": "The requested number of media elements used per span in the secondary RAID for a hierarchical RAID type.", 130 "longDescription": "This parameter shall contain the requested number of media elements used per span in the secondary RAID for a hierarchical RAID type.", 131 "type": "integer" 132 }, 133 "RAIDType": { 134 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Volume.json#/definitions/RAIDType", 135 "description": "The requested RAID type for the volume.", 136 "longDescription": "This parameter shall contain the requested RAID type for the volume." 137 }, 138 "StripSizeBytes": { 139 "description": "The number of blocks (bytes) requested for new strip size.", 140 "longDescription": "This parameter shall contain the number of blocks (bytes) requested for the strip size.", 141 "type": "integer" 142 } 143 }, 144 "patternProperties": { 145 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 146 "description": "This property shall specify a valid odata or Redfish property.", 147 "type": [ 148 "array", 149 "boolean", 150 "integer", 151 "number", 152 "null", 153 "object", 154 "string" 155 ] 156 } 157 }, 158 "properties": { 159 "target": { 160 "description": "Link to invoke action", 161 "format": "uri-reference", 162 "type": "string" 163 }, 164 "title": { 165 "description": "Friendly action name", 166 "type": "string" 167 } 168 }, 169 "type": "object", 170 "versionAdded": "v1_5_0" 171 }, 172 "CheckConsistency": { 173 "additionalProperties": false, 174 "description": "This action is used to force a check of the Volume's parity or redundant data to ensure it matches calculated values.", 175 "longDescription": "This defines the name of the custom action supported on this resource.", 176 "parameters": {}, 177 "patternProperties": { 178 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 179 "description": "This property shall specify a valid odata or Redfish property.", 180 "type": [ 181 "array", 182 "boolean", 183 "integer", 184 "number", 185 "null", 186 "object", 187 "string" 188 ] 189 } 190 }, 191 "properties": { 192 "target": { 193 "description": "Link to invoke action", 194 "format": "uri-reference", 195 "type": "string" 196 }, 197 "title": { 198 "description": "Friendly action name", 199 "type": "string" 200 } 201 }, 202 "type": "object" 203 }, 204 "CreateReplicaTarget": { 205 "additionalProperties": false, 206 "description": "This action is used to create a new volume resource to provide expanded data protection through a replica relationship with the specified source volume.", 207 "longDescription": "This action shall be used to create a new volume resource to provide expanded data protection through a replica relationship with the specified source volume.", 208 "parameters": { 209 "ReplicaType": { 210 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/StorageReplicaInfo.json#/definitions/ReplicaType", 211 "description": "The type of replica relationship to be created.", 212 "longDescription": "This parameter shall contain the type of replica relationship to be created (e.g., Clone, Mirror, Snap).", 213 "requiredParameter": true 214 }, 215 "ReplicaUpdateMode": { 216 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/StorageReplicaInfo.json#/definitions/ReplicaUpdateMode", 217 "description": "The replica update mode (synchronous vs asynchronous).", 218 "longDescription": "This parameter shall specify the replica update mode.", 219 "requiredParameter": true 220 }, 221 "TargetStoragePool": { 222 "description": "The Uri to the existing target Storage Pool.", 223 "longDescription": "This parameter shall contain the Uri to the existing StoragePool in which to create the target volume.", 224 "requiredParameter": true, 225 "type": "string" 226 }, 227 "VolumeName": { 228 "description": "The Name for the new target volume.", 229 "longDescription": "This parameter shall contain the Name for the target volume.", 230 "type": "string" 231 } 232 }, 233 "patternProperties": { 234 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 235 "description": "This property shall specify a valid odata or Redfish property.", 236 "type": [ 237 "array", 238 "boolean", 239 "integer", 240 "number", 241 "null", 242 "object", 243 "string" 244 ] 245 } 246 }, 247 "properties": { 248 "target": { 249 "description": "Link to invoke action", 250 "format": "uri-reference", 251 "type": "string" 252 }, 253 "title": { 254 "description": "Friendly action name", 255 "type": "string" 256 } 257 }, 258 "type": "object", 259 "versionAdded": "v1_4_0" 260 }, 261 "ForceEnable": { 262 "additionalProperties": false, 263 "description": "Request system force the volume to an enabled state regardless of data loss.", 264 "longDescription": "This action shall request the system to force the volume to enabled state regardless of data loss scenarios.", 265 "parameters": {}, 266 "patternProperties": { 267 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 268 "description": "This property shall specify a valid odata or Redfish property.", 269 "type": [ 270 "array", 271 "boolean", 272 "integer", 273 "number", 274 "null", 275 "object", 276 "string" 277 ] 278 } 279 }, 280 "properties": { 281 "target": { 282 "description": "Link to invoke action", 283 "format": "uri-reference", 284 "type": "string" 285 }, 286 "title": { 287 "description": "Friendly action name", 288 "type": "string" 289 } 290 }, 291 "type": "object", 292 "versionAdded": "v1_5_0" 293 }, 294 "Initialize": { 295 "additionalProperties": false, 296 "description": "This action is used to prepare the contents of the volume for use by the system. If InitializeMethod is not specified in the request body, but the property InitializeMethod is specified, the property InitializeMethod value should be used. If neither is specified, the InitializeMethod should be Foreground.", 297 "longDescription": "This defines the name of the custom action supported on this resource. If InitializeMethod is not specified in the request body, but the property InitializeMethod is specified, the property InitializeMethod value should be used. If neither is specified, the InitializeMethod should be Foreground.", 298 "parameters": { 299 "InitializeMethod": { 300 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Volume.json#/definitions/InitializeMethod", 301 "description": "The type of initialization to be performed.", 302 "longDescription": "This defines the property name for the action." 303 }, 304 "InitializeType": { 305 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Volume.json#/definitions/InitializeType", 306 "deprecated": "Deprecated in favor of the InitializeMethod property.", 307 "description": "The type of initialization to be performed.", 308 "longDescription": "This defines the property name for the action." 309 } 310 }, 311 "patternProperties": { 312 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 313 "description": "This property shall specify a valid odata or Redfish property.", 314 "type": [ 315 "array", 316 "boolean", 317 "integer", 318 "number", 319 "null", 320 "object", 321 "string" 322 ] 323 } 324 }, 325 "properties": { 326 "target": { 327 "description": "Link to invoke action", 328 "format": "uri-reference", 329 "type": "string" 330 }, 331 "title": { 332 "description": "Friendly action name", 333 "type": "string" 334 } 335 }, 336 "type": "object", 337 "versionAdded": "v1_5_0" 338 }, 339 "LBAFormat": { 340 "additionalProperties": false, 341 "patternProperties": { 342 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 343 "description": "This property shall specify a valid odata or Redfish property.", 344 "type": [ 345 "array", 346 "boolean", 347 "integer", 348 "number", 349 "null", 350 "object", 351 "string" 352 ] 353 } 354 }, 355 "properties": { 356 "LBADataSizeBytes": { 357 "description": "The LBA data size in bytes.", 358 "longDescription": "This shall be the LBA data size reported in bytes.", 359 "readonly": true, 360 "type": [ 361 "integer", 362 "null" 363 ], 364 "versionAdded": "v1_9_0" 365 }, 366 "LBAFormatType": { 367 "anyOf": [ 368 { 369 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Volume.json#/definitions/LBAFormatType" 370 }, 371 { 372 "type": "null" 373 } 374 ], 375 "description": "The LBA format type.", 376 "longDescription": "This shall be the LBA format type. This property is intended for capabilities instrumentation.", 377 "readonly": true, 378 "versionAdded": "v1_9_0" 379 }, 380 "LBAMetadataSizeBytes": { 381 "description": "The LBA metadata size in bytes.", 382 "longDescription": "This shall be the LBA metadata size reported in bytes.", 383 "readonly": true, 384 "type": [ 385 "integer", 386 "null" 387 ], 388 "versionAdded": "v1_9_0" 389 }, 390 "RelativePerformance": { 391 "anyOf": [ 392 { 393 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Volume.json#/definitions/LBARelativePerformanceType" 394 }, 395 { 396 "type": "null" 397 } 398 ], 399 "description": "The LBA Relative Performance type.", 400 "longDescription": "This shall be the LBA Relative Performance type. This field indicates the relative performance of the LBA format indicated relative to other LBA formats supported by the controller. This property is intended for capabilities instrumentation.", 401 "readonly": true, 402 "versionAdded": "v1_9_0" 403 } 404 }, 405 "type": "object" 406 }, 407 "Links": { 408 "additionalProperties": false, 409 "description": "Add ability to manage spare capacity.", 410 "patternProperties": { 411 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 412 "description": "This property shall specify a valid odata or Redfish property.", 413 "type": [ 414 "array", 415 "boolean", 416 "integer", 417 "number", 418 "null", 419 "object", 420 "string" 421 ] 422 } 423 }, 424 "properties": { 425 "CacheDataVolumes": { 426 "description": "A pointer to the data volumes this volume serves as a cache volume.", 427 "items": { 428 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Volume.json#/definitions/Volume" 429 }, 430 "longDescription": "This shall be a pointer to the cache data volumes this volume serves as a cache volume. The corresponding VolumeUsage property shall be set to CacheOnly when this property is used.", 431 "readonly": true, 432 "type": "array", 433 "versionAdded": "v1_6_0" 434 }, 435 "CacheDataVolumes@odata.count": { 436 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" 437 }, 438 "CacheVolumeSource": { 439 "anyOf": [ 440 { 441 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Volume.json#/definitions/Volume" 442 }, 443 { 444 "type": "null" 445 } 446 ], 447 "description": "A pointer to the cache volume source for this volume.", 448 "longDescription": "This shall be a pointer to the cache volume source for this volume. The corresponding VolumeUsage property shall be set to Data when this property is used.", 449 "readonly": true, 450 "versionAdded": "v1_6_0" 451 }, 452 "ClassOfService": { 453 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/ClassOfService.json#/definitions/ClassOfService", 454 "description": "The ClassOfService that this storage volume conforms to.", 455 "longDescription": "This property shall contain a reference to the ClassOfService that this storage volume conforms to.", 456 "readonly": true, 457 "versionAdded": "v1_1_0" 458 }, 459 "ClientEndpoints": { 460 "description": "An array of references to the client Endpoints associated with this volume.", 461 "items": { 462 "$ref": "http://redfish.dmtf.org/schemas/v1/Endpoint.json#/definitions/Endpoint" 463 }, 464 "longDescription": "The value of this property shall be references to the client Endpoints this volume is associated with.", 465 "readonly": true, 466 "type": "array", 467 "versionAdded": "v1_4_0" 468 }, 469 "ClientEndpoints@odata.count": { 470 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" 471 }, 472 "ConsistencyGroups": { 473 "description": "An array of references to the ConsistencyGroups associated with this volume.", 474 "items": { 475 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/ConsistencyGroup.json#/definitions/ConsistencyGroup" 476 }, 477 "longDescription": "The value of this property shall be references to the ConsistencyGroups this volume is associated with.", 478 "readonly": true, 479 "type": "array", 480 "versionAdded": "v1_4_0" 481 }, 482 "ConsistencyGroups@odata.count": { 483 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" 484 }, 485 "Controllers": { 486 "description": "An array of the Controllers associated with this volume.", 487 "items": { 488 "$ref": "http://redfish.dmtf.org/schemas/v1/StorageController.json#/definitions/StorageController" 489 }, 490 "longDescription": "This parameter shall contain an array of the controllers (of type StorageController) associated with this volume. When the volume is of type NVMe, these may be both the physical and logical controller representations.", 491 "type": "array", 492 "versionAdded": "v1_9_0" 493 }, 494 "Controllers@odata.count": { 495 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" 496 }, 497 "DedicatedSpareDrives": { 498 "description": "An array of references to the drives which are dedicated spares for this volume.", 499 "items": { 500 "$ref": "http://redfish.dmtf.org/schemas/v1/Drive.json#/definitions/Drive" 501 }, 502 "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.", 503 "readonly": false, 504 "type": "array", 505 "versionAdded": "v1_2_0" 506 }, 507 "DedicatedSpareDrives@odata.count": { 508 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" 509 }, 510 "Drives": { 511 "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.", 512 "items": { 513 "$ref": "http://redfish.dmtf.org/schemas/v1/Drive.json#/definitions/Drive" 514 }, 515 "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.", 516 "readonly": true, 517 "type": "array" 518 }, 519 "Drives@odata.count": { 520 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" 521 }, 522 "JournalingMedia": { 523 "anyOf": [ 524 { 525 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Resource" 526 }, 527 { 528 "type": "null" 529 } 530 ], 531 "description": "A pointer to the Resource that serves as a journaling media for this volume.", 532 "longDescription": "This shall be a pointer to the journaling media used for this Volume to address the write hole issue. Valid when WriteHoleProtectionPolicy property is set to 'Journaling'.", 533 "readonly": false, 534 "versionAdded": "v1_5_0" 535 }, 536 "Oem": { 537 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", 538 "description": "The OEM extension property.", 539 "longDescription": "This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements." 540 }, 541 "OwningStorageResource": { 542 "$ref": "http://redfish.dmtf.org/schemas/v1/Storage.json#/definitions/Storage", 543 "description": "A pointer to the Storage resource that owns or contains this volume.", 544 "longDescription": "This shall be a pointer to the Storage resource that owns or contains this volume.", 545 "readonly": true, 546 "versionAdded": "v1_5_0" 547 }, 548 "OwningStorageService": { 549 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/StorageService.json#/definitions/StorageService", 550 "description": "A pointer to the StorageService that owns or contains this volume.", 551 "longDescription": "This shall be a pointer to the StorageService that owns or contains this volume.", 552 "readonly": true, 553 "versionAdded": "v1_4_0" 554 }, 555 "ServerEndpoints": { 556 "description": "An array of references to the server Endpoints associated with this volume.", 557 "items": { 558 "$ref": "http://redfish.dmtf.org/schemas/v1/Endpoint.json#/definitions/Endpoint" 559 }, 560 "longDescription": "The value of this property shall be references to the server Endpoints this volume is associated with.", 561 "readonly": true, 562 "type": "array", 563 "versionAdded": "v1_4_0" 564 }, 565 "ServerEndpoints@odata.count": { 566 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" 567 }, 568 "SpareResourceSets": { 569 "description": "An array of references to SpareResourceSets.", 570 "items": { 571 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/SpareResourceSet.json#/definitions/SpareResourceSet" 572 }, 573 "longDescription": "Each referenced SpareResourceSet shall contain resources that may be utilized to replace the capacity provided by a failed resource having a compatible type.", 574 "readonly": false, 575 "type": "array", 576 "versionAdded": "v1_3_0" 577 }, 578 "SpareResourceSets@odata.count": { 579 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" 580 }, 581 "StorageGroups": { 582 "description": "An array of references to the StorageGroups associated with this volume.", 583 "items": { 584 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/StorageGroup.json#/definitions/StorageGroup" 585 }, 586 "longDescription": "The value of this property shall be references to the StorageGroups this volume is associated with.", 587 "readonly": true, 588 "type": "array", 589 "versionAdded": "v1_4_0" 590 }, 591 "StorageGroups@odata.count": { 592 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" 593 } 594 }, 595 "type": "object" 596 }, 597 "NVMeNamespaceProperties": { 598 "additionalProperties": false, 599 "description": "This contains properties to use when Volume is used to describe an NVMe Namespace.", 600 "longDescription": "This contains properties to use when Volume is used to describe an NVMe Namespace.", 601 "patternProperties": { 602 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 603 "description": "This property shall specify a valid odata or Redfish property.", 604 "type": [ 605 "array", 606 "boolean", 607 "integer", 608 "number", 609 "null", 610 "object", 611 "string" 612 ] 613 } 614 }, 615 "properties": { 616 "FormattedLBASize": { 617 "description": "The LBA data size and metadata size combination that the namespace has been formatted with.", 618 "longDescription": "This property shall contain the LBA data size and metadata size combination that the namespace has been formatted with. This is a 4-bit data structure.", 619 "readonly": true, 620 "type": [ 621 "string", 622 "null" 623 ], 624 "versionAdded": "v1_5_0" 625 }, 626 "IsShareable": { 627 "description": "Indicates the namespace is shareable.", 628 "longDescription": "This property shall indicate whether the namespace is shareable.", 629 "readonly": false, 630 "type": [ 631 "boolean", 632 "null" 633 ], 634 "versionAdded": "v1_5_0" 635 }, 636 "LBAFormat": { 637 "anyOf": [ 638 { 639 "$ref": "#/definitions/LBAFormat" 640 }, 641 { 642 "type": "null" 643 } 644 ], 645 "description": "Describes the current LBA format ID and detailed properties.", 646 "longDescription": "This property shall describe the current LBA format ID and corresponding detailed properties, such as the LBA data size and metadata size. Use the LBAFormats property to describe namespace capabilities in a collection capabilities annotation.", 647 "versionAdded": "v1_9_0" 648 }, 649 "LBAFormats": { 650 "description": "Describes the LBA format IDs and detailed properties.", 651 "items": { 652 "anyOf": [ 653 { 654 "$ref": "#/definitions/LBAFormat" 655 }, 656 { 657 "type": "null" 658 } 659 ] 660 }, 661 "longDescription": "This property shall describe the LBA format IDs and corresponding detailed properties, such as the LBA data size and metadata size. This property is intended for use in a collection capabilities annotation. Use the LBAFormat property on an instance of a namespace.", 662 "type": "array", 663 "versionAdded": "v1_9_0" 664 }, 665 "LBAFormatsSupported": { 666 "description": "A list of the LBA format types supported for the namespace, or potential namespaces.", 667 "items": { 668 "anyOf": [ 669 { 670 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Volume.json#/definitions/LBAFormatType" 671 }, 672 { 673 "type": "null" 674 } 675 ] 676 }, 677 "longDescription": "This shall be a list of the LBA formats supported for the namespace, or potential namespaces.", 678 "readonly": true, 679 "type": "array", 680 "versionAdded": "v1_8_0" 681 }, 682 "MetadataTransferredAtEndOfDataLBA": { 683 "description": "This property indicates whether or not the metadata is transferred at the end of the LBA creating an extended data LBA.", 684 "longDescription": "This property shall indicate whether or not the metadata is transferred at the end of the LBA creating an extended data LBA.", 685 "readonly": true, 686 "type": [ 687 "boolean", 688 "null" 689 ], 690 "versionAdded": "v1_5_0" 691 }, 692 "NVMeVersion": { 693 "description": "The version of the NVMe Base Specification supported.", 694 "longDescription": "This property shall contain the version of the NVMe Base Specification supported.", 695 "readonly": true, 696 "type": [ 697 "string", 698 "null" 699 ], 700 "versionAdded": "v1_5_0" 701 }, 702 "NamespaceFeatures": { 703 "anyOf": [ 704 { 705 "$ref": "#/definitions/NamespaceFeatures" 706 }, 707 { 708 "type": "null" 709 } 710 ], 711 "description": "This property contains a set of Namespace Features.", 712 "longDescription": "This property shall contain a set of Namespace Features.", 713 "versionAdded": "v1_5_0" 714 }, 715 "NamespaceId": { 716 "description": "The NVMe Namespace Identifier for this namespace.", 717 "longDescription": "This property shall contain the NVMe Namespace Identifier for this namespace. This property shall be a hex value. Namespace identifiers are not durable and do not have meaning outside the scope of the NVMe subsystem. NSID 0x0, 0xFFFFFFFF, 0xFFFFFFFE are special purpose values.", 718 "pattern": "^0[xX](([a-fA-F]|[0-9])*)$", 719 "readonly": true, 720 "type": [ 721 "string", 722 "null" 723 ], 724 "versionAdded": "v1_5_0" 725 }, 726 "NamespaceType": { 727 "anyOf": [ 728 { 729 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Volume.json#/definitions/NamespaceType" 730 }, 731 { 732 "type": "null" 733 } 734 ], 735 "description": "Identifies the type of namespace.", 736 "longDescription": "This shall identify the type of namespace.", 737 "readonly": true, 738 "versionAdded": "v1_9_0" 739 }, 740 "NumberLBAFormats": { 741 "description": "The number of LBA data size and metadata size combinations supported by this namespace. The value of this property is between 0 and 16.", 742 "longDescription": "This property shall contain the number of LBA data size and metadata size combinations supported by this namespace. The value of this property is between 0 and 16. LBA formats with an index set beyond this value will not be supported.", 743 "minimum": 0, 744 "readonly": true, 745 "type": [ 746 "integer", 747 "null" 748 ], 749 "units": "By", 750 "versionAdded": "v1_5_0" 751 }, 752 "Type": { 753 "anyOf": [ 754 { 755 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Volume.json#/definitions/NamespaceType" 756 }, 757 { 758 "type": "null" 759 } 760 ], 761 "description": "Identifies the type of namespace.", 762 "longDescription": "This shall identify the type of namespace.", 763 "readonly": true, 764 "versionAdded": "v1_8_0" 765 } 766 }, 767 "type": "object" 768 }, 769 "NamespaceFeatures": { 770 "additionalProperties": false, 771 "patternProperties": { 772 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 773 "description": "This property shall specify a valid odata or Redfish property.", 774 "type": [ 775 "array", 776 "boolean", 777 "integer", 778 "number", 779 "null", 780 "object", 781 "string" 782 ] 783 } 784 }, 785 "properties": { 786 "SupportsAtomicTransactionSize": { 787 "description": "Indicates that the NVM fields for Namespace preferred write granularity (NPWG), write alignment (NPWA), deallocate granularity (NPDG), deallocate alignment (NPDA) and optimal write size (NOWS) are defined for this namespace and should be used by the host for I/O optimization.", 788 "longDescription": "This property shall indicate whether or not the NVM fields for Namespace preferred write granularity (NPWG), write alignment (NPWA), deallocate granularity (NPDG), deallocate alignment (NPDA) and optimal write size (NOWS) are defined for this namespace and should be used by the host for I/O optimization.", 789 "readonly": true, 790 "type": [ 791 "boolean", 792 "null" 793 ], 794 "versionAdded": "v1_5_0" 795 }, 796 "SupportsDeallocatedOrUnwrittenLBError": { 797 "description": "This property indicates that the controller supports deallocated or unwritten logical block error for this namespace.", 798 "longDescription": "This property shall indicate that the controller supports deallocated or unwritten logical block error for this namespace.", 799 "readonly": true, 800 "type": [ 801 "boolean", 802 "null" 803 ], 804 "versionAdded": "v1_5_0" 805 }, 806 "SupportsIOPerformanceHints": { 807 "description": "Indicates that the Namespace Atomic Write Unit Normal (NAWUN), Namespace Atomic Write Unit Power Fail (NAWUPF), and Namespace Atomic Compare and Write Unit (NACWU) fields are defined for this namespace and should be used by the host for this namespace instead of the controller-level properties AWUN, AWUPF, and ACWU.", 808 "longDescription": "This property shall indicate that the Namespace Atomic Write Unit Normal (NAWUN), Namespace Atomic Write Unit Power Fail (NAWUPF), and Namespace Atomic Compare and Write Unit (NACWU) fields are defined for this namespace and should be used by the host for this namespace instead of the controller-level properties AWUN, AWUPF, and ACWU.", 809 "readonly": true, 810 "type": [ 811 "boolean", 812 "null" 813 ], 814 "versionAdded": "v1_5_0" 815 }, 816 "SupportsNGUIDReuse": { 817 "description": "This property indicates that the namespace supports the use of an NGUID (namespace globally unique identifier) value.", 818 "longDescription": "This property shall indicate that the namespace supports the use of an NGUID (namespace globally unique identifier) value.", 819 "readonly": true, 820 "type": [ 821 "boolean", 822 "null" 823 ], 824 "versionAdded": "v1_5_0" 825 }, 826 "SupportsThinProvisioning": { 827 "description": "This property indicates whether or not the NVMe Namespace supports thin provisioning.", 828 "longDescription": "This property shall indicate whether or not the NVMe Namespace supports thin provisioning. Specifically, the namespace capacity reported may be less than the namespace size.", 829 "readonly": true, 830 "type": [ 831 "boolean", 832 "null" 833 ], 834 "versionAdded": "v1_5_0" 835 } 836 }, 837 "type": "object" 838 }, 839 "OemActions": { 840 "additionalProperties": true, 841 "patternProperties": { 842 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 843 "description": "This property shall specify a valid odata or Redfish property.", 844 "type": [ 845 "array", 846 "boolean", 847 "integer", 848 "number", 849 "null", 850 "object", 851 "string" 852 ] 853 } 854 }, 855 "properties": {}, 856 "type": "object" 857 }, 858 "Operation": { 859 "additionalProperties": false, 860 "patternProperties": { 861 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 862 "description": "This property shall specify a valid odata or Redfish property.", 863 "type": [ 864 "array", 865 "boolean", 866 "integer", 867 "number", 868 "null", 869 "object", 870 "string" 871 ] 872 } 873 }, 874 "properties": { 875 "AssociatedFeaturesRegistry": { 876 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/FeaturesRegistry.json#/definitions/FeaturesRegistry", 877 "description": "A reference to the task associated with the operation if any.", 878 "readonly": true 879 }, 880 "Operation": { 881 "anyOf": [ 882 { 883 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Volume.json#/definitions/OperationType" 884 }, 885 { 886 "type": "null" 887 } 888 ], 889 "description": "The type of the operation.", 890 "longDescription": "This property shall contain the type of the operation.", 891 "readonly": true, 892 "versionAdded": "v1_9_0" 893 }, 894 "OperationName": { 895 "deprecated": "This property is deprecated in favor of the Operation property using the Operation enum.", 896 "description": "The name of the operation.", 897 "readonly": true, 898 "type": [ 899 "string", 900 "null" 901 ], 902 "versionDeprecated": "v1_9_0" 903 }, 904 "PercentageComplete": { 905 "description": "The percentage of the operation that has been completed.", 906 "readonly": true, 907 "type": [ 908 "integer", 909 "null" 910 ] 911 } 912 }, 913 "type": "object" 914 }, 915 "RemoveReplicaRelationship": { 916 "additionalProperties": false, 917 "description": "This action is used to disable data synchronization between a source and target volume, remove the replication relationship, and optionally delete the target volume.", 918 "longDescription": "This action shall be used to disable data synchronization between a source and target volume, remove the replication relationship, and optionally delete the target volume.", 919 "parameters": { 920 "DeleteTargetVolume": { 921 "description": "Indicate whether or not to delete the target volume as part of the operation.", 922 "longDescription": "This parameter shall indicate whether or not to delete the target volume as part of the operation. If not defined, the system should use its default behavior.", 923 "type": "boolean" 924 }, 925 "TargetVolume": { 926 "description": "The Uri to the existing target volume.", 927 "longDescription": "This parameter shall contain the Uri to the existing target volume.", 928 "requiredParameter": true, 929 "type": "string" 930 } 931 }, 932 "patternProperties": { 933 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 934 "description": "This property shall specify a valid odata or Redfish property.", 935 "type": [ 936 "array", 937 "boolean", 938 "integer", 939 "number", 940 "null", 941 "object", 942 "string" 943 ] 944 } 945 }, 946 "properties": { 947 "target": { 948 "description": "Link to invoke action", 949 "format": "uri-reference", 950 "type": "string" 951 }, 952 "title": { 953 "description": "Friendly action name", 954 "type": "string" 955 } 956 }, 957 "type": "object", 958 "versionAdded": "v1_4_0" 959 }, 960 "ResumeReplication": { 961 "additionalProperties": false, 962 "description": "This action is used to resume the active data synchronization between a source and target volume, without otherwise altering the replication relationship.", 963 "longDescription": "This action shall be used to resume the active data synchronization between a source and target volume, without otherwise altering the replication relationship.", 964 "parameters": { 965 "TargetVolume": { 966 "description": "The Uri to the existing target volume.", 967 "longDescription": "This parameter shall contain the Uri to the existing target volume.", 968 "requiredParameter": true, 969 "type": "string" 970 } 971 }, 972 "patternProperties": { 973 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 974 "description": "This property shall specify a valid odata or Redfish property.", 975 "type": [ 976 "array", 977 "boolean", 978 "integer", 979 "number", 980 "null", 981 "object", 982 "string" 983 ] 984 } 985 }, 986 "properties": { 987 "target": { 988 "description": "Link to invoke action", 989 "format": "uri-reference", 990 "type": "string" 991 }, 992 "title": { 993 "description": "Friendly action name", 994 "type": "string" 995 } 996 }, 997 "type": "object", 998 "versionAdded": "v1_4_0" 999 }, 1000 "ReverseReplicationRelationship": { 1001 "additionalProperties": false, 1002 "description": "This action is used to reverse the replication relationship between a source and target volume.", 1003 "longDescription": "This action shall be used to reverse the replication relationship between a source and target volume.", 1004 "parameters": { 1005 "TargetVolume": { 1006 "description": "The Uri to the existing target volume.", 1007 "longDescription": "This parameter shall contain the Uri to the existing target volume.", 1008 "requiredParameter": true, 1009 "type": "string" 1010 } 1011 }, 1012 "patternProperties": { 1013 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 1014 "description": "This property shall specify a valid odata or Redfish property.", 1015 "type": [ 1016 "array", 1017 "boolean", 1018 "integer", 1019 "number", 1020 "null", 1021 "object", 1022 "string" 1023 ] 1024 } 1025 }, 1026 "properties": { 1027 "target": { 1028 "description": "Link to invoke action", 1029 "format": "uri-reference", 1030 "type": "string" 1031 }, 1032 "title": { 1033 "description": "Friendly action name", 1034 "type": "string" 1035 } 1036 }, 1037 "type": "object", 1038 "versionAdded": "v1_4_0" 1039 }, 1040 "SplitReplication": { 1041 "additionalProperties": false, 1042 "description": "This action is used to split the replication relationship and suspend data synchronization between a source and target volume.", 1043 "longDescription": "This action shall be used to split the replication relationship and suspend data synchronization between a source and target volume.", 1044 "parameters": { 1045 "TargetVolume": { 1046 "description": "The Uri to the existing target volume.", 1047 "longDescription": "This parameter shall contain the Uri to the existing target volume.", 1048 "requiredParameter": true, 1049 "type": "string" 1050 } 1051 }, 1052 "patternProperties": { 1053 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 1054 "description": "This property shall specify a valid odata or Redfish property.", 1055 "type": [ 1056 "array", 1057 "boolean", 1058 "integer", 1059 "number", 1060 "null", 1061 "object", 1062 "string" 1063 ] 1064 } 1065 }, 1066 "properties": { 1067 "target": { 1068 "description": "Link to invoke action", 1069 "format": "uri-reference", 1070 "type": "string" 1071 }, 1072 "title": { 1073 "description": "Friendly action name", 1074 "type": "string" 1075 } 1076 }, 1077 "type": "object", 1078 "versionAdded": "v1_4_0" 1079 }, 1080 "SuspendReplication": { 1081 "additionalProperties": false, 1082 "description": "This action is used to suspend active data synchronization between a source and target volume, without otherwise altering the replication relationship.", 1083 "longDescription": "This action shall be used to suspend active data synchronization between a source and target volume, without otherwise altering the replication relationship.", 1084 "parameters": { 1085 "TargetVolume": { 1086 "description": "The Uri to the existing target volume.", 1087 "longDescription": "This parameter shall contain the Uri to the existing target volume.", 1088 "requiredParameter": true, 1089 "type": "string" 1090 } 1091 }, 1092 "patternProperties": { 1093 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 1094 "description": "This property shall specify a valid odata or Redfish property.", 1095 "type": [ 1096 "array", 1097 "boolean", 1098 "integer", 1099 "number", 1100 "null", 1101 "object", 1102 "string" 1103 ] 1104 } 1105 }, 1106 "properties": { 1107 "target": { 1108 "description": "Link to invoke action", 1109 "format": "uri-reference", 1110 "type": "string" 1111 }, 1112 "title": { 1113 "description": "Friendly action name", 1114 "type": "string" 1115 } 1116 }, 1117 "type": "object", 1118 "versionAdded": "v1_4_0" 1119 }, 1120 "Volume": { 1121 "additionalProperties": false, 1122 "description": "Volume contains properties used to describe a volume, virtual disk, LUN, or other logical storage entity for any system.", 1123 "longDescription": "This resource shall be used to represent a volume, virtual disk, logical disk, LUN, or other logical storage for a Redfish implementation.", 1124 "patternProperties": { 1125 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 1126 "description": "This property shall specify a valid odata or Redfish property.", 1127 "type": [ 1128 "array", 1129 "boolean", 1130 "integer", 1131 "number", 1132 "null", 1133 "object", 1134 "string" 1135 ] 1136 } 1137 }, 1138 "properties": { 1139 "@odata.context": { 1140 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" 1141 }, 1142 "@odata.etag": { 1143 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" 1144 }, 1145 "@odata.id": { 1146 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" 1147 }, 1148 "@odata.type": { 1149 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type" 1150 }, 1151 "AccessCapabilities": { 1152 "description": "Supported IO access capabilities.", 1153 "items": { 1154 "anyOf": [ 1155 { 1156 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/DataStorageLoSCapabilities.json#/definitions/StorageAccessCapability" 1157 }, 1158 { 1159 "type": "null" 1160 } 1161 ] 1162 }, 1163 "longDescription": "Each entry shall specify a current storage access capability.", 1164 "readonly": false, 1165 "type": "array", 1166 "versionAdded": "v1_1_0" 1167 }, 1168 "Actions": { 1169 "$ref": "#/definitions/Actions", 1170 "description": "The available actions for this resource.", 1171 "longDescription": "The Actions property shall contain the available actions for this resource." 1172 }, 1173 "AllocatedPools": { 1174 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/StoragePoolCollection.json#/definitions/StoragePoolCollection", 1175 "description": "An array of references to StoragePools allocated from this Volume.", 1176 "longDescription": "The value of this property shall contain references to all storage pools allocated from this volume.", 1177 "readonly": true, 1178 "versionAdded": "v1_1_0" 1179 }, 1180 "BlockSizeBytes": { 1181 "description": "The size of the smallest addressable unit (Block) of this volume in bytes.", 1182 "longDescription": "This property shall contain size of the smallest addressable unit of the associated volume.", 1183 "readonly": true, 1184 "type": [ 1185 "integer", 1186 "null" 1187 ], 1188 "units": "By" 1189 }, 1190 "Capacity": { 1191 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Capacity.v1_0_0.json#/definitions/Capacity", 1192 "description": "Capacity utilization.", 1193 "longDescription": "Information about the utilization of capacity allocated to this storage volume.", 1194 "versionAdded": "v1_1_0" 1195 }, 1196 "CapacityBytes": { 1197 "description": "The size in bytes of this Volume.", 1198 "longDescription": "This property shall contain the size in bytes of the associated volume.", 1199 "readonly": false, 1200 "type": [ 1201 "integer", 1202 "null" 1203 ], 1204 "units": "By" 1205 }, 1206 "CapacitySources": { 1207 "autoExpand": true, 1208 "description": "An array of space allocations to this volume.", 1209 "items": { 1210 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Capacity.json#/definitions/CapacitySource" 1211 }, 1212 "longDescription": "Fully or partially consumed storage from a source resource. Each entry provides capacity allocation information from a named source resource.", 1213 "readonly": false, 1214 "type": "array", 1215 "versionAdded": "v1_1_0" 1216 }, 1217 "CapacitySources@odata.count": { 1218 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" 1219 }, 1220 "Compressed": { 1221 "description": "Indicator of whether or not the Volume has compression enabled.", 1222 "longDescription": "This property shall contain a boolean indicator if the Volume is currently utilizing compression or not.", 1223 "readonly": false, 1224 "type": [ 1225 "boolean", 1226 "null" 1227 ], 1228 "versionAdded": "v1_4_0" 1229 }, 1230 "Connections": { 1231 "description": "An array of references to Connections that includes this volume.", 1232 "items": { 1233 "$ref": "http://redfish.dmtf.org/schemas/v1/Connection.json#/definitions/Connection" 1234 }, 1235 "longDescription": "The value of this property shall contain references to all Connections that include this volume.", 1236 "readonly": true, 1237 "type": "array", 1238 "versionAdded": "v1_9_0" 1239 }, 1240 "Connections@odata.count": { 1241 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" 1242 }, 1243 "Deduplicated": { 1244 "description": "Indicator of whether or not the Volume has deduplication enabled.", 1245 "longDescription": "This property shall contain a boolean indicator if the Volume is currently utilizing deduplication or not.", 1246 "readonly": false, 1247 "type": [ 1248 "boolean", 1249 "null" 1250 ], 1251 "versionAdded": "v1_4_0" 1252 }, 1253 "Description": { 1254 "anyOf": [ 1255 { 1256 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description" 1257 }, 1258 { 1259 "type": "null" 1260 } 1261 ], 1262 "readonly": true 1263 }, 1264 "DisplayName": { 1265 "description": "A user-configurable string to name the volume.", 1266 "longDescription": "This property shall contain a user-configurable string to name the volume.", 1267 "readonly": false, 1268 "type": [ 1269 "string", 1270 "null" 1271 ], 1272 "versionAdded": "v1_4_0" 1273 }, 1274 "Encrypted": { 1275 "description": "Is this Volume encrypted.", 1276 "longDescription": "This property shall contain a boolean indicator if the Volume is currently utilizing encryption or not.", 1277 "readonly": false, 1278 "type": [ 1279 "boolean", 1280 "null" 1281 ] 1282 }, 1283 "EncryptionTypes": { 1284 "description": "The types of encryption used by this Volume.", 1285 "items": { 1286 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Volume.json#/definitions/EncryptionTypes" 1287 }, 1288 "longDescription": "This property shall contain the types of encryption used by this Volume.", 1289 "readonly": false, 1290 "type": "array" 1291 }, 1292 "IOPerfModeEnabled": { 1293 "description": "Indicates the IO performance mode setting for the volume.", 1294 "longDescription": "This property shall indicate whether IO performance mode is enabled for the volume.", 1295 "readonly": false, 1296 "type": [ 1297 "boolean", 1298 "null" 1299 ], 1300 "versionAdded": "v1_5_0" 1301 }, 1302 "IOStatistics": { 1303 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/IOStatistics.v1_0_1.json#/definitions/IOStatistics", 1304 "description": "Statistics for this volume.", 1305 "longDescription": "The value shall represent IO statistics for this volume.", 1306 "versionAdded": "v1_2_0" 1307 }, 1308 "Id": { 1309 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", 1310 "readonly": true 1311 }, 1312 "Identifiers": { 1313 "description": "The Durable names for the volume.", 1314 "items": { 1315 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Identifier" 1316 }, 1317 "longDescription": "This property shall contain a list of all known durable names for the associated volume.", 1318 "type": "array" 1319 }, 1320 "InitializeMethod": { 1321 "anyOf": [ 1322 { 1323 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Volume.json#/definitions/InitializeMethod" 1324 }, 1325 { 1326 "type": "null" 1327 } 1328 ], 1329 "description": "Indicates the Initialization Method used for this volume. If InitializeMethod is not specified, the InitializeMethod should be Foreground.", 1330 "longDescription": "This property shall indicate the initialization method used for this volume. If InitializeMethod is not specified, the InitializeMethod should be Foreground. This value reflects the most recently used Initialization Method, and may be changed using the Initialize Action.", 1331 "readonly": true, 1332 "versionAdded": "v1_6_0" 1333 }, 1334 "IsBootCapable": { 1335 "description": "This property indicates whether or not the Volume contains a boot image and is capable of booting.", 1336 "longDescription": "This property shall indicate whether or not the Volume contains a boot image and is capable of booting. This property may be settable by an admin or client with visibility into the contents of the volume. This property should only be set to true when VolumeUsage is either not specified, or when VolumeUsage is set to Data or SystemData.", 1337 "readonly": false, 1338 "type": [ 1339 "boolean", 1340 "null" 1341 ], 1342 "versionAdded": "v1_7_0" 1343 }, 1344 "Links": { 1345 "$ref": "#/definitions/Links", 1346 "description": "Contains references to other resources that are related to this resource.", 1347 "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." 1348 }, 1349 "LogicalUnitNumber": { 1350 "description": "Indicates the host-visible LogicalUnitNumber assigned to this Volume.", 1351 "longDescription": "This property shall contain host-visible LogicalUnitNumber assigned to this Volume. This property shall only be used when in a single connect configuration and no StorageGroup configuration is used.", 1352 "readonly": true, 1353 "type": [ 1354 "integer", 1355 "null" 1356 ], 1357 "versionAdded": "v1_4_0" 1358 }, 1359 "LowSpaceWarningThresholdPercents": { 1360 "description": "Low space warning.", 1361 "items": { 1362 "type": [ 1363 "integer", 1364 "null" 1365 ] 1366 }, 1367 "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).", 1368 "readonly": false, 1369 "type": "array", 1370 "units": "%", 1371 "versionAdded": "v1_1_0" 1372 }, 1373 "Manufacturer": { 1374 "description": "The manufacturer or OEM of this storage volume.", 1375 "longDescription": "This property shall contain a value that represents the manufacturer or implementer of the storage volume.", 1376 "readonly": true, 1377 "type": [ 1378 "string", 1379 "null" 1380 ], 1381 "versionAdded": "v1_1_0" 1382 }, 1383 "MaxBlockSizeBytes": { 1384 "description": "Max Block size in bytes.", 1385 "longDescription": "This property shall contain size of the largest addressable unit of this storage volume.", 1386 "readonly": true, 1387 "type": [ 1388 "integer", 1389 "null" 1390 ], 1391 "units": "By", 1392 "versionAdded": "v1_1_0" 1393 }, 1394 "MediaSpanCount": { 1395 "description": "Indicates the number of media elements used per span in the secondary RAID for a hierarchical RAID type.", 1396 "longDescription": "This property shall indicate the number of media elements used per span in the secondary RAID for a hierarchical RAID type.", 1397 "readonly": true, 1398 "type": [ 1399 "integer", 1400 "null" 1401 ], 1402 "versionAdded": "v1_4_0" 1403 }, 1404 "Metrics": { 1405 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/VolumeMetrics.json#/definitions/VolumeMetrics", 1406 "description": "The link to the metrics for this volume.", 1407 "longDescription": "This property shall contain a link to a resource of type VolumeMetrics that specifies the metrics for this volume. IO metrics are reported in the IOStatistics property.", 1408 "readonly": true, 1409 "versionAdded": "v1_9_0" 1410 }, 1411 "Model": { 1412 "description": "The model number for this storage volume.", 1413 "longDescription": "The value is assigned by the manufacturer and shall represents a specific storage volume implementation.", 1414 "readonly": true, 1415 "type": [ 1416 "string", 1417 "null" 1418 ], 1419 "versionAdded": "v1_1_0" 1420 }, 1421 "NVMeNamespaceProperties": { 1422 "anyOf": [ 1423 { 1424 "$ref": "#/definitions/NVMeNamespaceProperties" 1425 }, 1426 { 1427 "type": "null" 1428 } 1429 ], 1430 "description": "This property contains properties to use when Volume is used to describe an NVMe Namespace.", 1431 "longDescription": "This property shall contain properties to use when Volume is used to describe an NVMe Namespace.", 1432 "versionAdded": "v1_5_0" 1433 }, 1434 "Name": { 1435 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", 1436 "readonly": true 1437 }, 1438 "Oem": { 1439 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", 1440 "description": "The OEM extension property.", 1441 "longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements." 1442 }, 1443 "Operations": { 1444 "description": "The operations currently running on the Volume.", 1445 "items": { 1446 "$ref": "#/definitions/Operation" 1447 }, 1448 "longDescription": "This property shall contain a list of all currently running on the Volume.", 1449 "type": "array" 1450 }, 1451 "OptimumIOSizeBytes": { 1452 "description": "The size in bytes of this Volume's optimum IO size.", 1453 "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.", 1454 "readonly": true, 1455 "type": [ 1456 "integer", 1457 "null" 1458 ], 1459 "units": "By" 1460 }, 1461 "ProvisioningPolicy": { 1462 "anyOf": [ 1463 { 1464 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/DataStorageLoSCapabilities.json#/definitions/ProvisioningPolicy" 1465 }, 1466 { 1467 "type": "null" 1468 } 1469 ], 1470 "description": "This property specifies the volume's storage allocation, or provisioning policy.", 1471 "longDescription": "This property shall specify the volume's supported storage allocation policy.", 1472 "readonly": false, 1473 "versionAdded": "v1_4_0" 1474 }, 1475 "RAIDType": { 1476 "anyOf": [ 1477 { 1478 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Volume.json#/definitions/RAIDType" 1479 }, 1480 { 1481 "type": "null" 1482 } 1483 ], 1484 "description": "The RAID type of this volume.", 1485 "longDescription": "This property shall contain the RAID type of the associated Volume.", 1486 "readonly": true, 1487 "versionAdded": "v1_3_1" 1488 }, 1489 "ReadCachePolicy": { 1490 "anyOf": [ 1491 { 1492 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Volume.json#/definitions/ReadCachePolicyType" 1493 }, 1494 { 1495 "type": "null" 1496 } 1497 ], 1498 "description": "Indicates the read cache policy setting for the Volume.", 1499 "longDescription": "This property shall contain a boolean indicator of the read cache policy for the Volume.", 1500 "readonly": false, 1501 "versionAdded": "v1_4_0" 1502 }, 1503 "RecoverableCapacitySourceCount": { 1504 "description": "Current number of capacity source resources that are available as replacements.", 1505 "longDescription": "The value is the number of available capacity source resources currently available in the event that an equivalent capacity source resource fails.", 1506 "readonly": false, 1507 "type": [ 1508 "integer", 1509 "null" 1510 ], 1511 "versionAdded": "v1_3_0" 1512 }, 1513 "RemainingCapacityPercent": { 1514 "description": "The percentage of the capacity remaining in the Volume.", 1515 "longDescription": "If present, this value shall return {[(SUM(AllocatedBytes) - SUM(ConsumedBytes)]/SUM(AllocatedBytes)}*100 represented as an integer value.", 1516 "readonly": true, 1517 "type": [ 1518 "integer", 1519 "null" 1520 ], 1521 "versionAdded": "v1_2_0" 1522 }, 1523 "RemoteReplicaTargets": { 1524 "description": "URIs to the resources that are remote target replicas of this source.", 1525 "items": { 1526 "type": [ 1527 "string", 1528 "null" 1529 ] 1530 }, 1531 "longDescription": "The value shall reference the URIs to the remote target replicas that are sourced by this replica. Remote indicates that the replica is managed by a separate Swordfish service instance.", 1532 "readonly": true, 1533 "type": "array", 1534 "versionAdded": "v1_8_0" 1535 }, 1536 "ReplicaInfo": { 1537 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/StorageReplicaInfo.v1_4_0.json#/definitions/ReplicaInfo", 1538 "description": "Describes this storage volume in its role as a target replica.", 1539 "longDescription": "This property shall describe the replica relationship between this storage volume and a corresponding source volume.", 1540 "versionAdded": "v1_1_0" 1541 }, 1542 "ReplicaTargets": { 1543 "description": "The resources that are target replicas of this source.", 1544 "items": { 1545 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef" 1546 }, 1547 "longDescription": "The value shall reference the target replicas that are sourced by this replica.", 1548 "readonly": true, 1549 "type": "array", 1550 "versionAdded": "v1_3_0" 1551 }, 1552 "ReplicaTargets@odata.count": { 1553 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" 1554 }, 1555 "ReplicationEnabled": { 1556 "description": "Indicates whether or not replication is enabled on the volume.", 1557 "longDescription": "The property shall indicate whether or not replication is enabled on the volume. This property shall be consistent with the state reflected at the storage pool level.", 1558 "readonly": false, 1559 "type": [ 1560 "boolean", 1561 "null" 1562 ], 1563 "versionAdded": "v1_9_0" 1564 }, 1565 "Status": { 1566 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", 1567 "description": "The property contains the status of the Volume.", 1568 "longDescription": "The property shall contain the status of the Volume." 1569 }, 1570 "StorageGroups": { 1571 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/StorageGroupCollection.json#/definitions/StorageGroupCollection", 1572 "deprecated": "This property is deprecated in favor of the Connections property.", 1573 "description": "An array of references to Storage Groups that includes this volume.", 1574 "longDescription": "The value of this property shall contain references to all storage groups that include this volume.", 1575 "readonly": true, 1576 "versionAdded": "v1_1_0", 1577 "versionDeprecated": "v1_9_0" 1578 }, 1579 "StripSizeBytes": { 1580 "description": "The number of blocks (bytes) in a strip in a disk array that uses striped data mapping.", 1581 "longDescription": "The number of consecutively addressed virtual disk blocks (bytes) mapped to consecutively addressed blocks on a single member extent of a disk array. Synonym for stripe depth and chunk size.", 1582 "readonly": false, 1583 "type": [ 1584 "integer", 1585 "null" 1586 ], 1587 "units": "By", 1588 "versionAdded": "v1_4_0" 1589 }, 1590 "VolumeType": { 1591 "anyOf": [ 1592 { 1593 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Volume.json#/definitions/VolumeType" 1594 }, 1595 { 1596 "type": "null" 1597 } 1598 ], 1599 "deprecated": "Deprecated in favor of explicit use of RAIDType.", 1600 "description": "The type of this volume.", 1601 "longDescription": "This property shall contain the type of the associated Volume.", 1602 "readonly": true 1603 }, 1604 "VolumeUsage": { 1605 "anyOf": [ 1606 { 1607 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Volume.json#/definitions/VolumeUsageType" 1608 }, 1609 { 1610 "type": "null" 1611 } 1612 ], 1613 "description": "Indicates the Volume usage type setting for the Volume.", 1614 "longDescription": "This property shall contain the volume usage type for the Volume.", 1615 "readonly": true, 1616 "versionAdded": "v1_4_0" 1617 }, 1618 "WriteCachePolicy": { 1619 "anyOf": [ 1620 { 1621 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Volume.json#/definitions/WriteCachePolicyType" 1622 }, 1623 { 1624 "type": "null" 1625 } 1626 ], 1627 "description": "Indicates the write cache policy setting for the Volume.", 1628 "longDescription": "This property shall contain a boolean indicator of the write cache policy for the Volume.", 1629 "readonly": false, 1630 "versionAdded": "v1_4_0" 1631 }, 1632 "WriteCacheState": { 1633 "anyOf": [ 1634 { 1635 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Volume.json#/definitions/WriteCacheStateType" 1636 }, 1637 { 1638 "type": "null" 1639 } 1640 ], 1641 "description": "Indicates the WriteCacheState policy setting for the Volume.", 1642 "longDescription": "This property shall contain the WriteCacheState policy setting for the Volume.", 1643 "readonly": true, 1644 "versionAdded": "v1_4_0" 1645 }, 1646 "WriteHoleProtectionPolicy": { 1647 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Volume.json#/definitions/WriteHoleProtectionPolicyType", 1648 "description": "The policy that the RAID volume is using to address the write hole issue.", 1649 "longDescription": "This property specifies the policy that is enabled to address the write hole issue on the RAID volume. If no policy is enabled at the moment, this property shall be set to 'Off'.", 1650 "readonly": false, 1651 "versionAdded": "v1_4_0" 1652 } 1653 }, 1654 "required": [ 1655 "@odata.id", 1656 "@odata.type", 1657 "Id", 1658 "Name" 1659 ], 1660 "type": "object" 1661 } 1662 }, 1663 "owningEntity": "SNIA", 1664 "release": "1.2.6", 1665 "title": "#Volume.v1_10_0.Volume" 1666}