path: root/static/redfish/v1/JsonSchemas/Volume/Volume.json

{
    "$id": "http://redfish.dmtf.org/schemas/swordfish/v1/Volume.v1_4_0.json",
    "$ref": "#/definitions/Volume",
    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
    "copyright": "Copyright 2016-2019 Storage Networking Industry Association (SNIA), USA. All rights reserved. For the full SNIA copyright policy, see http://www.snia.org/about/corporate_info/copyright",
    "definitions": {
        "Actions": {
            "additionalProperties": false,
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "#Volume.AssignReplicaTarget": {
                    "$ref": "#/definitions/AssignReplicaTarget"
                },
                "#Volume.CheckConsistency": {
                    "$ref": "#/definitions/CheckConsistency"
                },
                "#Volume.CreateReplicaTarget": {
                    "$ref": "#/definitions/CreateReplicaTarget"
                },
                "#Volume.Initialize": {
                    "$ref": "#/definitions/Initialize"
                },
                "#Volume.RemoveReplicaRelationship": {
                    "$ref": "#/definitions/RemoveReplicaRelationship"
                },
                "#Volume.ResumeReplication": {
                    "$ref": "#/definitions/ResumeReplication"
                },
                "#Volume.ReverseReplicationRelationship": {
                    "$ref": "#/definitions/ReverseReplicationRelationship"
                },
                "#Volume.SplitReplication": {
                    "$ref": "#/definitions/SplitReplication"
                },
                "#Volume.SuspendReplication": {
                    "$ref": "#/definitions/SuspendReplication"
                },
                "Oem": {
                    "$ref": "#/definitions/OemActions"
                }
            },
            "type": "object"
        },
        "AssignReplicaTarget": {
            "additionalProperties": false,
            "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.",
            "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.",
            "parameters": {
                "ReplicaType": {
                    "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/StorageReplicaInfo.json#/definitions/ReplicaType",
                    "description": "The type of replica relationship to be created.",
                    "longDescription": "This parameter shall contain the type of replica relationship to be created (e.g., Clone, Mirror, Snap).",
                    "requiredParameter": true
                },
                "ReplicaUpdateMode": {
                    "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/StorageReplicaInfo.json#/definitions/ReplicaUpdateMode",
                    "description": "The replica update mode (synchronous vs asynchronous).",
                    "longDescription": "This parameter shall specify the replica update mode.",
                    "requiredParameter": true
                },
                "TargetVolume": {
                    "description": "The Uri to the existing target volume.",
                    "longDescription": "This parameter shall contain the Uri to the existing target volume.",
                    "requiredParameter": true,
                    "type": "string"
                }
            },
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "target": {
                    "description": "Link to invoke action",
                    "format": "uri-reference",
                    "type": "string"
                },
                "title": {
                    "description": "Friendly action name",
                    "type": "string"
                }
            },
            "type": "object"
        },
        "CheckConsistency": {
            "additionalProperties": false,
            "description": "This action is used to force a check of the Volume's parity or redundant data to ensure it matches calculated values.",
            "longDescription": "This defines the name of the custom action supported on this resource.",
            "parameters": {},
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "target": {
                    "description": "Link to invoke action",
                    "format": "uri-reference",
                    "type": "string"
                },
                "title": {
                    "description": "Friendly action name",
                    "type": "string"
                }
            },
            "type": "object"
        },
        "CreateReplicaTarget": {
            "additionalProperties": false,
            "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.",
            "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.",
            "parameters": {
                "ReplicaType": {
                    "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/StorageReplicaInfo.json#/definitions/ReplicaType",
                    "description": "The type of replica relationship to be created.",
                    "longDescription": "This parameter shall contain the type of replica relationship to be created (e.g., Clone, Mirror, Snap).",
                    "requiredParameter": true
                },
                "ReplicaUpdateMode": {
                    "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/StorageReplicaInfo.json#/definitions/ReplicaUpdateMode",
                    "description": "The replica update mode (synchronous vs asynchronous).",
                    "longDescription": "This parameter shall specify the replica update mode.",
                    "requiredParameter": true
                },
                "TargetStoragePool": {
                    "description": "The Uri to the existing target Storage Pool.",
                    "longDescription": "This parameter shall contain the Uri to the existing StoragePool in which to create the target volume.",
                    "requiredParameter": true,
                    "type": "string"
                },
                "VolumeName": {
                    "description": "The Name for the new target volume.",
                    "longDescription": "This parameter shall contain the Name for the target volume.",
                    "type": "string"
                }
            },
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "target": {
                    "description": "Link to invoke action",
                    "format": "uri-reference",
                    "type": "string"
                },
                "title": {
                    "description": "Friendly action name",
                    "type": "string"
                }
            },
            "type": "object"
        },
        "EncryptionTypes": {
            "enum": [
                "NativeDriveEncryption",
                "ControllerAssisted",
                "SoftwareAssisted"
            ],
            "enumDescriptions": {
                "ControllerAssisted": "The volume is being encrypted by the storage controller entity.",
                "NativeDriveEncryption": "The volume is utilizing the native drive encryption capabilities of the drive hardware.",
                "SoftwareAssisted": "The volume is being encrypted by software running on the system or the operating system."
            },
            "type": "string"
        },
        "Initialize": {
            "additionalProperties": false,
            "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.",
            "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.",
            "parameters": {
                "InitializeType": {
                    "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Volume.json#/definitions/InitializeType",
                    "description": "The type of initialization to be performed.",
                    "longDescription": "This defines the property name for the action."
                }
            },
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "target": {
                    "description": "Link to invoke action",
                    "format": "uri-reference",
                    "type": "string"
                },
                "title": {
                    "description": "Friendly action name",
                    "type": "string"
                }
            },
            "type": "object"
        },
        "Links": {
            "additionalProperties": false,
            "description": "Add ability to manage spare capacity.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "ClassOfService": {
                    "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/ClassOfService.json#/definitions/ClassOfService",
                    "description": "The ClassOfService that this storage volume conforms to.",
                    "longDescription": "This property shall contain a reference to the ClassOfService that this storage volume conforms to.",
                    "readonly": true,
                    "versionAdded": "v1_1_0"
                },
                "ClientEndpoints": {
                    "description": "An array of references to the client Endpoints associated with this volume.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/v1/Endpoint.json#/definitions/Endpoint"
                    },
                    "longDescription": "The value of this property shall be references to the client Endpoints this volume is associated with.",
                    "readonly": true,
                    "type": "array",
                    "versionAdded": "v1_4_0"
                },
                "ClientEndpoints@odata.count": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count"
                },
                "ConsistencyGroups": {
                    "description": "An array of references to the ConsistencyGroups associated with this volume.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/ConsistencyGroup.json#/definitions/ConsistencyGroup"
                    },
                    "longDescription": "The value of this property shall be references to the ConsistencyGroups this volume is associated with.",
                    "readonly": true,
                    "type": "array",
                    "versionAdded": "v1_4_0"
                },
                "ConsistencyGroups@odata.count": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count"
                },
                "DedicatedSpareDrives": {
                    "description": "An array of references to the drives which are dedicated spares for this volume.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/v1/Drive.json#/definitions/Drive"
                    },
                    "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.",
                    "readonly": true,
                    "type": "array",
                    "versionAdded": "v1_2_0"
                },
                "DedicatedSpareDrives@odata.count": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count"
                },
                "Drives": {
                    "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.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/v1/Drive.json#/definitions/Drive"
                    },
                    "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.",
                    "readonly": true,
                    "type": "array"
                },
                "Drives@odata.count": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count"
                },
                "Oem": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
                    "description": "Oem extension object.",
                    "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."
                },
                "OwningStorageService": {
                    "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/StorageService.json#/definitions/StorageService",
                    "description": "A pointer to the StorageService that owns or contains this volume.",
                    "longDescription": "This shall be a pointer to the StorageService that owns or contains this volume.",
                    "readonly": true,
                    "versionAdded": "v1_4_0"
                },
                "ServerEndpoints": {
                    "description": "An array of references to the server Endpoints associated with this volume.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/v1/Endpoint.json#/definitions/Endpoint"
                    },
                    "longDescription": "The value of this property shall be references to the server Endpoints this volume is associated with.",
                    "readonly": true,
                    "type": "array",
                    "versionAdded": "v1_4_0"
                },
                "ServerEndpoints@odata.count": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count"
                },
                "SpareResourceSets": {
                    "description": "An array of references to SpareResourceSets.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/SpareResourceSet.json#/definitions/SpareResourceSet"
                    },
                    "longDescription": "Each referenced SpareResourceSet shall contain resources that may be utilized to replace the capacity provided by a failed resource having a compatible type.",
                    "readonly": false,
                    "type": "array",
                    "versionAdded": "v1_3_0"
                },
                "SpareResourceSets@odata.count": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count"
                },
                "StorageGroups": {
                    "description": "An array of references to the StorageGroups associated with this volume.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/StorageGroup.json#/definitions/StorageGroup"
                    },
                    "longDescription": "The value of this property shall be references to the StorageGroups this volume is associated with.",
                    "readonly": true,
                    "type": "array",
                    "versionAdded": "v1_4_0"
                },
                "StorageGroups@odata.count": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count"
                }
            },
            "type": "object"
        },
        "OemActions": {
            "additionalProperties": true,
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {},
            "type": "object"
        },
        "Operation": {
            "additionalProperties": false,
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "AssociatedTask": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Task.json#/definitions/Task",
                    "description": "A reference to the task associated with the operation if any.",
                    "readonly": true
                },
                "OperationName": {
                    "description": "The name of the operation.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "PercentageComplete": {
                    "description": "The percentage of the operation that has been completed.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ]
                }
            },
            "type": "object"
        },
        "ReadCachePolicyType": {
            "enum": [
                "ReadAhead",
                "AdaptiveReadAhead",
                "Off"
            ],
            "enumDescriptions": {
                "AdaptiveReadAhead": "A caching technique in which the controller dynamically determines whether to pre-fetch data anticipating future read requests, based on previous cache hit ratio.",
                "Off": "The read cache is disabled.",
                "ReadAhead": "A caching technique in which the controller pre-fetches data anticipating future read requests."
            },
            "type": "string"
        },
        "RemoveReplicaRelationship": {
            "additionalProperties": false,
            "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.",
            "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.",
            "parameters": {
                "DeleteTargetVolume": {
                    "description": "Indicate whether or not to delete the target volume as part of the operation.",
                    "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.",
                    "type": "boolean"
                },
                "TargetVolume": {
                    "description": "The Uri to the existing target volume.",
                    "longDescription": "This parameter shall contain the Uri to the existing target volume.",
                    "requiredParameter": true,
                    "type": "string"
                }
            },
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "target": {
                    "description": "Link to invoke action",
                    "format": "uri-reference",
                    "type": "string"
                },
                "title": {
                    "description": "Friendly action name",
                    "type": "string"
                }
            },
            "type": "object"
        },
        "ResumeReplication": {
            "additionalProperties": false,
            "description": "This action is used to resume the active data synchronization between a source and target volume, without otherwise altering the replication relationship.",
            "longDescription": "This action shall be used to resume the active data synchronization between a source and target volume, without otherwise altering the replication relationship.",
            "parameters": {
                "TargetVolume": {
                    "description": "The Uri to the existing target volume.",
                    "longDescription": "This parameter shall contain the Uri to the existing target volume.",
                    "requiredParameter": true,
                    "type": "string"
                }
            },
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "target": {
                    "description": "Link to invoke action",
                    "format": "uri-reference",
                    "type": "string"
                },
                "title": {
                    "description": "Friendly action name",
                    "type": "string"
                }
            },
            "type": "object"
        },
        "ReverseReplicationRelationship": {
            "additionalProperties": false,
            "description": "This action is used to reverse the replication relationship between a source and target volume.",
            "longDescription": "This action shall be used to reverse the replication relationship between a source and target volume.",
            "parameters": {
                "TargetVolume": {
                    "description": "The Uri to the existing target volume.",
                    "longDescription": "This parameter shall contain the Uri to the existing target volume.",
                    "requiredParameter": true,
                    "type": "string"
                }
            },
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "target": {
                    "description": "Link to invoke action",
                    "format": "uri-reference",
                    "type": "string"
                },
                "title": {
                    "description": "Friendly action name",
                    "type": "string"
                }
            },
            "type": "object"
        },
        "SplitReplication": {
            "additionalProperties": false,
            "description": "This action is used to split the replication relationship and suspend data synchronization between a source and target volume.",
            "longDescription": "This action shall be used to split the replication relationship and suspend data synchronization between a source and target volume.",
            "parameters": {
                "TargetVolume": {
                    "description": "The Uri to the existing target volume.",
                    "longDescription": "This parameter shall contain the Uri to the existing target volume.",
                    "requiredParameter": true,
                    "type": "string"
                }
            },
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "target": {
                    "description": "Link to invoke action",
                    "format": "uri-reference",
                    "type": "string"
                },
                "title": {
                    "description": "Friendly action name",
                    "type": "string"
                }
            },
            "type": "object"
        },
        "SuspendReplication": {
            "additionalProperties": false,
            "description": "This action is used to suspend active data synchronization between a source and target volume, without otherwise altering the replication relationship.",
            "longDescription": "This action shall be used to suspend active data synchronization between a source and target volume, without otherwise altering the replication relationship.",
            "parameters": {
                "TargetVolume": {
                    "description": "The Uri to the existing target volume.",
                    "longDescription": "This parameter shall contain the Uri to the existing target volume.",
                    "requiredParameter": true,
                    "type": "string"
                }
            },
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "target": {
                    "description": "Link to invoke action",
                    "format": "uri-reference",
                    "type": "string"
                },
                "title": {
                    "description": "Friendly action name",
                    "type": "string"
                }
            },
            "type": "object"
        },
        "Volume": {
            "additionalProperties": false,
            "description": "Volume contains properties used to describe a volume, virtual disk, LUN, or other logical storage entity for any system.",
            "longDescription": "This resource shall be used to represent a volume, virtual disk, logical disk, LUN, or other logical storage for a Redfish implementation.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "@odata.context": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context"
                },
                "@odata.etag": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag"
                },
                "@odata.id": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id"
                },
                "@odata.type": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/type"
                },
                "AccessCapabilities": {
                    "description": "Supported IO access capabilities.",
                    "items": {
                        "anyOf": [
                            {
                                "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/DataStorageLoSCapabilities.json#/definitions/StorageAccessCapability"
                            },
                            {
                                "type": "null"
                            }
                        ]
                    },
                    "longDescription": "Each entry shall specify a current storage access capability.",
                    "readonly": false,
                    "type": "array",
                    "versionAdded": "v1_1_0"
                },
                "Actions": {
                    "$ref": "#/definitions/Actions",
                    "description": "The available actions for this resource.",
                    "longDescription": "The Actions property shall contain the available actions for this resource."
                },
                "AllocatedPools": {
                    "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/StoragePoolCollection.json#/definitions/StoragePoolCollection",
                    "description": "An array of references to StoragePools allocated from this Volume.",
                    "longDescription": "The value of this property shall contain references to all storage pools allocated from this volume.",
                    "readonly": true,
                    "versionAdded": "v1_1_0"
                },
                "BlockSizeBytes": {
                    "description": "The size of the smallest addressable unit (Block) of this volume in bytes.",
                    "longDescription": "This property shall contain size of the smallest addressable unit of the associated volume.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "units": "By"
                },
                "Capacity": {
                    "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Capacity.v1_0_0.json#/definitions/Capacity",
                    "description": "Capacity utilization.",
                    "longDescription": "Information about the utilization of capacity allocated to this storage volume.",
                    "versionAdded": "v1_1_0"
                },
                "CapacityBytes": {
                    "description": "The size in bytes of this Volume.",
                    "longDescription": "This property shall contain the size in bytes of the associated volume.",
                    "readonly": false,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "units": "By"
                },
                "CapacitySources": {
                    "autoExpand": true,
                    "description": "An array of space allocations to this volume.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Capacity.json#/definitions/CapacitySource"
                    },
                    "longDescription": "Fully or partially consumed storage from a source resource. Each entry provides capacity allocation information from a named source resource.",
                    "readonly": false,
                    "type": "array",
                    "versionAdded": "v1_1_0"
                },
                "CapacitySources@odata.count": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count"
                },
                "Compressed": {
                    "description": "Indicator of whether or not the Volume has compression enabled.",
                    "longDescription": "This property shall contain a boolean indicator if the Volume is currently utilizing compression or not.",
                    "readonly": false,
                    "type": [
                        "boolean",
                        "null"
                    ],
                    "versionAdded": "v1_4_0"
                },
                "Deduplicated": {
                    "description": "Indicator of whether or not the Volume has deduplication enabled.",
                    "longDescription": "This property shall contain a boolean indicator if the Volume is currently utilizing deduplication or not.",
                    "readonly": false,
                    "type": [
                        "boolean",
                        "null"
                    ],
                    "versionAdded": "v1_4_0"
                },
                "Description": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "readonly": true
                },
                "DisplayName": {
                    "description": "A user-configurable string to name the volume.",
                    "longDescription": "This property shall contain a user-configurable string to name the volume.",
                    "readonly": false,
                    "type": [
                        "string",
                        "null"
                    ],
                    "versionAdded": "v1_4_0"
                },
                "Encrypted": {
                    "description": "Is this Volume encrypted.",
                    "longDescription": "This property shall contain a boolean indicator if the Volume is currently utilizing encryption or not.",
                    "readonly": false,
                    "type": [
                        "boolean",
                        "null"
                    ]
                },
                "EncryptionTypes": {
                    "description": "The types of encryption used by this Volume.",
                    "items": {
                        "$ref": "#/definitions/EncryptionTypes"
                    },
                    "longDescription": "This property shall contain the types of encryption used by this Volume.",
                    "readonly": false,
                    "type": "array"
                },
                "IOStatistics": {
                    "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/IOStatistics.json#/definitions/IOStatistics",
                    "description": "Statistics for this volume.",
                    "longDescription": "The value shall represent IO statistics for this volume.",
                    "versionAdded": "v1_2_0"
                },
                "Id": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
                    "readonly": true
                },
                "Identifiers": {
                    "description": "The Durable names for the volume.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Identifier"
                    },
                    "longDescription": "This property shall contain a list of all known durable names for the associated volume.",
                    "type": "array"
                },
                "Links": {
                    "$ref": "#/definitions/Links",
                    "description": "Contains references to other resources that are related to this resource.",
                    "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."
                },
                "LogicalUnitNumber": {
                    "description": "Indicates the host-visible LogicalUnitNumber assigned to this Volume.",
                    "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.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "versionAdded": "v1_4_0"
                },
                "LowSpaceWarningThresholdPercents": {
                    "description": "Low space warning.",
                    "items": {
                        "type": [
                            "integer",
                            "null"
                        ]
                    },
                    "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).",
                    "readonly": false,
                    "type": "array",
                    "units": "%",
                    "versionAdded": "v1_1_0"
                },
                "Manufacturer": {
                    "description": "The manufacturer or OEM of this storage volume.",
                    "longDescription": "This property shall contain a value that represents the manufacturer or implementer of the storage volume.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ],
                    "versionAdded": "v1_1_0"
                },
                "MaxBlockSizeBytes": {
                    "description": "Max Block size in bytes.",
                    "longDescription": "This property shall contain size of the largest addressable unit of this storage volume.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "units": "By",
                    "versionAdded": "v1_1_0"
                },
                "MediaSpanCount": {
                    "description": "Indicates the number of media elements used per span in the secondary RAID for a hierarchical RAID type.",
                    "longDescription": "This property shall indicate the number of media elements used per span in the secondary RAID for a hierarchical RAID type.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "versionAdded": "v1_4_0"
                },
                "Model": {
                    "description": "The model number for this storage volume.",
                    "longDescription": "The value is assigned by the manufacturer and shall represents a specific storage volume implementation.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ],
                    "versionAdded": "v1_1_0"
                },
                "Name": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
                    "readonly": true
                },
                "Oem": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
                    "description": "This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.",
                    "longDescription": "The value of this string shall be of the format for the reserved word *Oem*."
                },
                "Operations": {
                    "description": "The operations currently running on the Volume.",
                    "items": {
                        "$ref": "#/definitions/Operation"
                    },
                    "longDescription": "This property shall contain a list of all currently running on the Volume.",
                    "type": "array"
                },
                "OptimumIOSizeBytes": {
                    "description": "The size in bytes of this Volume's optimum IO size.",
                    "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.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "units": "By"
                },
                "ProvisioningPolicy": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/DataStorageLoSCapabilities.json#/definitions/ProvisioningPolicy"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "This property specifies the volume's storage allocation, or provisioning policy.",
                    "longDescription": "This property shall specify the volume's supported storage allocation policy.",
                    "readonly": false,
                    "versionAdded": "v1_4_0"
                },
                "RAIDType": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Volume.json#/definitions/RAIDType"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The RAID type of this volume.",
                    "longDescription": "This property shall contain the RAID type of the associated Volume.",
                    "readonly": true,
                    "versionAdded": "v1_3_1"
                },
                "ReadCachePolicy": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/ReadCachePolicyType"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "Indicates the read cache policy setting for the Volume.",
                    "longDescription": "This property shall contain a boolean indicator of the read cache policy for the Volume.",
                    "readonly": false,
                    "versionAdded": "v1_4_0"
                },
                "RecoverableCapacitySourceCount": {
                    "description": "Current number of capacity source resources that are available as replacements.",
                    "longDescription": "The value is the number of available capacity source resources currently available in the event that an equivalent capacity source resource fails.",
                    "readonly": false,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "versionAdded": "v1_3_0"
                },
                "RemainingCapacityPercent": {
                    "description": "The percentage of the capacity remaining in the Volume.",
                    "longDescription": "If present, this value shall return  {[(SUM(AllocatedBytes) - SUM(ConsumedBytes)]/SUM(AllocatedBytes)}*100 represented as an integer value.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "versionAdded": "v1_2_0"
                },
                "ReplicaInfo": {
                    "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/StorageReplicaInfo.v1_2_0.json#/definitions/ReplicaInfo",
                    "description": "Describes this storage volume in its role as a target replica.",
                    "longDescription": "This property shall describe the replica relationship between this storage volume and a corresponding source volume.",
                    "versionAdded": "v1_1_0"
                },
                "ReplicaTargets": {
                    "description": "The resources that are target replicas of this source.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/idRef"
                    },
                    "longDescription": "The value shall reference the target replicas that are sourced by this replica.",
                    "readonly": true,
                    "type": "array",
                    "versionAdded": "v1_3_0"
                },
                "ReplicaTargets@odata.count": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count"
                },
                "Status": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
                    "description": "The property contains the status of the Volume.",
                    "longDescription": "The property shall contain the status of the Volume."
                },
                "StorageGroups": {
                    "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/StorageGroupCollection.json#/definitions/StorageGroupCollection",
                    "description": "An array of references to Storage Groups that includes this volume.",
                    "longDescription": "The value of this property shall contain references to all storage groups that include this volume.",
                    "readonly": true,
                    "versionAdded": "v1_1_0"
                },
                "StripSizeBytes": {
                    "description": "The number of blocks (bytes) in a strip in a disk array that uses striped data mapping.",
                    "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.",
                    "readonly": false,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "units": "By",
                    "versionAdded": "v1_4_0"
                },
                "VolumeType": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/VolumeType"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "deprecated": "Deprecated in favor of explicit use of RAIDType.",
                    "description": "The type of this volume.",
                    "longDescription": "This property shall contain the type of the associated Volume.",
                    "readonly": true
                },
                "VolumeUsage": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/VolumeUsageType"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "Indicates the Volume usage type setting for the Volume.",
                    "longDescription": "This property shall contain the volume usage type for the Volume.",
                    "readonly": true,
                    "versionAdded": "v1_4_0"
                },
                "WriteCachePolicy": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/WriteCachePolicyType"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "Indicates the write cache policy setting for the Volume.",
                    "longDescription": "This property shall contain a boolean indicator of the write cache policy for the Volume.",
                    "readonly": false,
                    "versionAdded": "v1_4_0"
                },
                "WriteCacheState": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/WriteCacheStateType"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "Indicates the WriteCacheState policy setting for the Volume.",
                    "longDescription": "This property shall contain the WriteCacheState policy setting for the Volume.",
                    "readonly": true,
                    "versionAdded": "v1_4_0"
                },
                "WriteHoleProtectionPolicy": {
                    "$ref": "#/definitions/WriteHoleProtectionPolicyType",
                    "description": "The policy that the RAID volume is using to address the write hole issue.",
                    "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'.",
                    "readonly": false,
                    "versionAdded": "v1_4_0"
                }
            },
            "required": [
                "@odata.id",
                "@odata.type",
                "Id",
                "Name"
            ],
            "type": "object"
        },
        "VolumeType": {
            "enum": [
                "RawDevice",
                "NonRedundant",
                "Mirrored",
                "StripedWithParity",
                "SpannedMirrors",
                "SpannedStripesWithParity"
            ],
            "enumDescriptions": {
                "Mirrored": "The volume is a mirrored device.",
                "NonRedundant": "The volume is a non-redundant storage device.",
                "RawDevice": "The volume is a raw physical device without any RAID or other virtualization applied.",
                "SpannedMirrors": "The volume is a spanned set of mirrored devices.",
                "SpannedStripesWithParity": "The volume is a spanned set of devices which uses parity to retain redundant information.",
                "StripedWithParity": "The volume is a device which uses parity to retain redundant information."
            },
            "type": "string"
        },
        "VolumeUsageType": {
            "enum": [
                "Data",
                "SystemData",
                "CacheOnly",
                "SystemReserve",
                "ReplicationReserve"
            ],
            "enumDescriptions": {
                "CacheOnly": "The volume is allocated for use as a non-consumable cache only volume.",
                "Data": "The volume is allocated for use as a consumable data volume.",
                "ReplicationReserve": "The volume is allocated for use as a non-consumable reserved volume for replication use.",
                "SystemData": "The volume is allocated for use as a consumable data volume reserved for system use.",
                "SystemReserve": "The volume is allocated for use as a non-consumable system reserved volume."
            },
            "enumLongDescriptions": {
                "CacheOnly": "The volume shall be allocated for use as a non-consumable cache only volume.",
                "Data": "The volume shall be allocated for use as a consumable data volume.",
                "ReplicationReserve": "The volume shall be allocated for use as a non-consumable reserved volume for replication use.",
                "SystemData": "The volume shall be allocated for use as a consumable data volume reserved for system use.",
                "SystemReserve": "The volume shall be allocated for use as a non-consumable system reserved volume."
            },
            "type": "string"
        },
        "WriteCachePolicyType": {
            "enum": [
                "WriteThrough",
                "ProtectedWriteBack",
                "UnprotectedWriteBack"
            ],
            "enumDescriptions": {
                "ProtectedWriteBack": "A caching technique in which the completion of a write request is signaled as soon as the data is in cache, and actual writing to non-volatile media is guaranteed to occur at a later time.",
                "UnprotectedWriteBack": "A caching technique in which the completion of a write request is signaled as soon as the data is in cache; actual writing to non-volatile media is not guaranteed to occur at a later time.",
                "WriteThrough": "A caching technique in which the completion of a write request is not signaled until data is safely stored on non-volatile media."
            },
            "enumLongDescriptions": {
                "ProtectedWriteBack": "A caching technique in which the completion of a write request is signaled as soon as the data is in cache, and actual writing to non-volatile media is guaranteed to occur at a later time.",
                "UnprotectedWriteBack": "A caching technique in which the completion of a write request is signaled as soon as the data is in cache; actual writing to non-volatile media is not guaranteed to occur at a later time.",
                "WriteThrough": "A caching technique in which the completion of a write request is not signaled until data is safely stored on non-volatile media."
            },
            "type": "string"
        },
        "WriteCacheStateType": {
            "enum": [
                "Unprotected",
                "Protected",
                "Degraded"
            ],
            "enumDescriptions": {
                "Degraded": "Indicates an issue with the cache state in which the cache space is diminished or disabled due to a failure or an outside influence such as a discharged battery.",
                "Protected": "Indicates that the cache state type in use generally protects write requests on non-volatile media.",
                "Unprotected": "Indicates that the cache state type in use generally does not protect write requests on non-volatile media."
            },
            "enumLongDescriptions": {
                "Degraded": "Indicates an issue with the cache state in which the cache space is diminished or disabled due to a failure or an outside influence such as a discharged battery.",
                "Protected": "Indicates that the cache state type in use generally protects write requests on non-volatile media.",
                "Unprotected": "Indicates that the cache state type in use generally does not protect write requests on non-volatile media."
            },
            "type": "string"
        },
        "WriteHoleProtectionPolicyType": {
            "enum": [
                "Off",
                "Journaling",
                "DistributedLog",
                "Oem"
            ],
            "enumDescriptions": {
                "DistributedLog": "The policy that distributes additional log among the volume's capacity sources to address write hole issue.",
                "Journaling": "The policy that uses separate block device for write-ahead logging to adddress write hole issue.",
                "Oem": "The policy that is Oem specific.",
                "Off": "The volume is not using any policy to address the write hole issue."
            },
            "enumLongDescriptions": {
                "DistributedLog": "The policy that distributes additional log (e.q. cheksum of the parity) among the volume's capacity sources to address write hole issue. Additional data is used to detect data corruption on the volume.",
                "Journaling": "The policy that uses separate block device for write-ahead logging to adddress write hole issue. All write operations on the RAID volume are first logged on dedicated journaling device that is not part of the volume.",
                "Oem": "The policy that is Oem specific. The mechanism details are unknown unless provided separatly by the Oem.",
                "Off": "The support for addressing the write hole issue is disabled. The volume is not performing any additional activities to close the RAID write hole."
            },
            "type": "string"
        }
    },
    "owningEntity": "SNIA",
    "title": "#Volume.v1_4_0.Volume"
}