xref: /openbmc/bmcweb/features/redfish/schema/dmtf/json-schema/StorageController.v1_9_1.json (revision d125652e8a30dfeaad88bbfa5b1e04a80610469c)

{
    "$id": "http://redfish.dmtf.org/schemas/v1/StorageController.v1_9_1.json",
    "$ref": "#/definitions/StorageController",
    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
    "copyright": "Copyright 2014-2025 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
    "definitions": {
        "ANAAccessState": {
            "enum": [
                "Optimized",
                "NonOptimized",
                "Inaccessible",
                "PersistentLoss"
            ],
            "enumDescriptions": {
                "Inaccessible": "Namespaces in this group are inaccessible.  Commands are not able to access user data of namespaces in the ANA group.",
                "NonOptimized": "Commands processed by a controller that reports this state for an ANA group provide non-optimized access characteristics, such as lower performance or non-optimal use of subsystem resources, to any namespace in the ANA group.",
                "Optimized": "Commands processed by a controller provide optimized access to any namespace in the ANA group.",
                "PersistentLoss": "The group is persistently inaccessible.  Commands are persistently not able to access user data of namespaces in the ANA group."
            },
            "type": "string"
        },
        "ANACharacteristics": {
            "additionalProperties": false,
            "description": "The ANA characteristics and volume information for a storage controller.",
            "longDescription": "This type shall contain the ANA characteristics and volume information for a storage controller.",
            "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": {
                "AccessState": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/ANAAccessState"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "Reported ANA access state.",
                    "longDescription": "This property shall contain the reported ANA access state.",
                    "readonly": true
                },
                "Volume": {
                    "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Volume.json#/definitions/Volume",
                    "description": "The specified volume.",
                    "longDescription": "This property shall contain a link to a resource of type `Volume`.",
                    "readonly": true
                }
            },
            "type": "object"
        },
        "Actions": {
            "additionalProperties": false,
            "description": "The available actions for this resource.",
            "longDescription": "This type shall contain the available actions for this resource.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "#StorageController.AttachNamespaces": {
                    "$ref": "#/definitions/AttachNamespaces"
                },
                "#StorageController.DetachNamespaces": {
                    "$ref": "#/definitions/DetachNamespaces"
                },
                "#StorageController.SecurityReceive": {
                    "$ref": "#/definitions/SecurityReceive"
                },
                "#StorageController.SecuritySend": {
                    "$ref": "#/definitions/SecuritySend"
                },
                "Oem": {
                    "$ref": "#/definitions/OemActions",
                    "description": "The available OEM-specific actions for this resource.",
                    "longDescription": "This property shall contain the available OEM-specific actions for this resource."
                }
            },
            "type": "object"
        },
        "AttachDetachNamespacesResponse": {
            "additionalProperties": false,
            "description": "The response body for the `AttachNamespaces` and `DetachNamespaces` actions.",
            "longDescription": "This type shall contain the properties found in the response body for the `AttachNamespaces` and `DetachNamespaces` actions.",
            "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": {
                "AttachedVolumes": {
                    "description": "An array of links to volumes that are attached to this controller instance.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Volume.json#/definitions/Volume"
                    },
                    "longDescription": "This property shall contain an array of links to resources of type `Volume` that are attached to this instance of storage controller.",
                    "readonly": true,
                    "type": "array",
                    "versionAdded": "v1_7_0"
                },
                "AttachedVolumes@odata.count": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
                }
            },
            "required": [
                "AttachedVolumes"
            ],
            "type": "object"
        },
        "AttachNamespaces": {
            "actionResponse": {
                "$ref": "#/definitions/AttachDetachNamespacesResponse"
            },
            "additionalProperties": false,
            "description": "This action attaches referenced namespaces to the storage controller.  Attached namespaces are added to the `AttachedVolumes` property in `Links`.",
            "longDescription": "This action shall attach referenced namespaces to the storage controller.  Services shall add the attached namespaces to the `AttachedVolumes` property in `Links`.",
            "parameters": {
                "Namespaces": {
                    "description": "The namespaces to attach to the storage controller.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Volume.json#/definitions/Volume"
                    },
                    "longDescription": "This parameter shall contain an array of links to resources of type `Volume` that represent the namespaces to attach to the storage controller.",
                    "requiredParameter": true,
                    "type": "array"
                }
            },
            "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",
            "versionAdded": "v1_7_0"
        },
        "CacheSummary": {
            "additionalProperties": false,
            "description": "This type describes the cache memory of the storage controller in general detail.",
            "longDescription": "This type shall contain properties that describe the cache memory for a storage controller.",
            "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": {
                "PersistentCacheSizeMiB": {
                    "description": "The portion of the cache memory that is persistent, measured in MiB.",
                    "longDescription": "This property shall contain the amount of cache memory that is persistent as measured in mebibytes.  This size shall be less than or equal to the `TotalCacheSizeMiB`.",
                    "minimum": 0,
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "units": "MiBy"
                },
                "Status": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
                    "description": "The status and health of the resource and its subordinate or dependent resources.",
                    "longDescription": "This property shall contain any status or health properties of the resource."
                },
                "TotalCacheSizeMiB": {
                    "description": "The total configured cache memory, measured in MiB.",
                    "longDescription": "This property shall contain the amount of configured cache memory as measured in mebibytes.",
                    "minimum": 0,
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "units": "MiBy"
                }
            },
            "required": [
                "TotalCacheSizeMiB"
            ],
            "type": "object"
        },
        "DetachNamespaces": {
            "actionResponse": {
                "$ref": "#/definitions/AttachDetachNamespacesResponse"
            },
            "additionalProperties": false,
            "description": "This action detaches referenced namespaces from the storage controller.  Detached namespaces are removed from the `AttachedVolumes` property in `Links`.",
            "longDescription": "This action shall detach referenced namespaces from the storage controller.  Services shall remove the detached namespaces from the `AttachedVolumes` property in `Links`.",
            "parameters": {
                "Namespaces": {
                    "description": "The namespaces to detach from the storage controller.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Volume.json#/definitions/Volume"
                    },
                    "longDescription": "This parameter shall contain an array of links to resources of type `Volume` that represent the namespaces to detach from the storage controller.",
                    "requiredParameter": true,
                    "type": "array"
                }
            },
            "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",
            "versionAdded": "v1_7_0"
        },
        "Links": {
            "additionalProperties": false,
            "description": "The links to other resources that are related to this resource.",
            "longDescription": "This Redfish Specification-described type shall contain links to resources that are related to but are not contained by, or subordinate to, this resource.",
            "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": {
                "AttachedVolumes": {
                    "description": "An array of links to volumes that are attached to this controller instance.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Volume.json#/definitions/Volume"
                    },
                    "longDescription": "This property shall contain an array of links to resources of type `Volume` that are attached to this instance of storage controller.",
                    "readonly": true,
                    "type": "array"
                },
                "AttachedVolumes@odata.count": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
                },
                "Batteries": {
                    "description": "The batteries that provide power to this storage controller during a power-loss event.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/v1/Battery.json#/definitions/Battery"
                    },
                    "longDescription": "This property shall contain an array of links to resources of type `Battery` that represent the batteries that provide power to this storage controller during a power-loss event, such as with battery-backed RAID controllers.  This property shall not be present if the batteries power the containing chassis as a whole rather than the individual storage controller.",
                    "readonly": true,
                    "type": "array",
                    "versionAdded": "v1_6_0"
                },
                "Batteries@odata.count": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
                },
                "Endpoints": {
                    "description": "An array of links to the endpoints that connect to this controller.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/v1/Endpoint.json#/definitions/Endpoint"
                    },
                    "longDescription": "This property shall contain an array of links to resources of type `Endpoint` with which this controller is associated.",
                    "readonly": true,
                    "type": "array"
                },
                "Endpoints@odata.count": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
                },
                "NVMeDiscoveredSubsystems": {
                    "description": "The NVMe subsystems discovered by this discovery controller.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/v1/Storage.json#/definitions/Storage"
                    },
                    "longDescription": "This property shall contain an array of links to resources of type `Storage` that represent the NVMe subsystems discovered by this discovery controller.  This property shall only be present if `ControllerType` in `NVMeControllerProperties` contains `Discovery`.",
                    "readonly": true,
                    "type": "array",
                    "versionAdded": "v1_7_0"
                },
                "NVMeDiscoveredSubsystems@odata.count": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
                },
                "NetworkDeviceFunctions": {
                    "description": "The network device functions that provide connectivity to this controller.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/v1/NetworkDeviceFunction.json#/definitions/NetworkDeviceFunction"
                    },
                    "longDescription": "This property shall contain an array of links to resources of type `NetworkDeviceFunction` that represent the devices that provide connectivity to this controller.",
                    "readonly": true,
                    "type": "array",
                    "versionAdded": "v1_3_0"
                },
                "NetworkDeviceFunctions@odata.count": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
                },
                "Oem": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
                    "description": "The OEM extension property.",
                    "longDescription": "This property shall contain the OEM extensions.  All values for properties contained in this object shall conform to the Redfish Specification-described requirements."
                },
                "PCIeFunctions": {
                    "description": "An array of links to the PCIe functions that the storage controller produces.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeFunction.json#/definitions/PCIeFunction"
                    },
                    "longDescription": "This property shall contain an array of links to resources of type `PCIeFunction` that represent the PCIe functions associated with this resource.",
                    "readonly": true,
                    "type": "array"
                },
                "PCIeFunctions@odata.count": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
                }
            },
            "type": "object"
        },
        "NVMeControllerAttributes": {
            "additionalProperties": false,
            "description": "The NVMe controller attributes for a storage controller.",
            "longDescription": "This type shall contain NVMe controller attributes for a storage controller.",
            "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": {
                "ReportsNamespaceGranularity": {
                    "description": "Indicates whether or not the controller supports reporting of Namespace Granularity.",
                    "longDescription": "This property shall indicate whether or not the controller supports reporting of Namespace Granularity.",
                    "readonly": true,
                    "type": [
                        "boolean",
                        "null"
                    ]
                },
                "ReportsUUIDList": {
                    "description": "Indicates whether or not the controller supports reporting of a UUID list.",
                    "longDescription": "This property shall indicate whether or not the controller supports reporting of a UUID list.",
                    "readonly": true,
                    "type": [
                        "boolean",
                        "null"
                    ]
                },
                "Supports128BitHostId": {
                    "description": "Indicates whether or not the controller supports a 128-bit Host Identifier.",
                    "longDescription": "This property shall indicate whether or not the controller supports a 128-bit Host Identifier.",
                    "readonly": true,
                    "type": [
                        "boolean",
                        "null"
                    ]
                },
                "SupportsEnduranceGroups": {
                    "description": "Indicates whether or not the controller supports Endurance Groups.",
                    "longDescription": "This property shall indicate whether or not the controller supports Endurance Groups.",
                    "readonly": true,
                    "type": [
                        "boolean",
                        "null"
                    ]
                },
                "SupportsExceedingPowerOfNonOperationalState": {
                    "description": "Indicates whether or not the controller supports exceeding Power of Non-Operational State in order to execute controller-initiated background operations in a non-operational power state.",
                    "longDescription": "This property shall indicate whether or not the controller supports exceeding Power of Non-Operational State in order to execute controller-initiated background operations in a non-operational power state.",
                    "readonly": true,
                    "type": [
                        "boolean",
                        "null"
                    ]
                },
                "SupportsNVMSets": {
                    "description": "Indicates whether or not the controller supports NVM Sets.",
                    "longDescription": "This property shall indicate whether or not the controller supports NVM Sets.",
                    "readonly": true,
                    "type": [
                        "boolean",
                        "null"
                    ]
                },
                "SupportsPredictableLatencyMode": {
                    "description": "Indicates whether or not the controller supports Predictable Latency Mode.",
                    "longDescription": "This property shall indicate whether or not the controller supports Predictable Latency Mode.",
                    "readonly": true,
                    "type": [
                        "boolean",
                        "null"
                    ]
                },
                "SupportsReadRecoveryLevels": {
                    "description": "Indicates whether or not the controller supports Read Recovery Levels.",
                    "longDescription": "This property shall indicate whether or not the controller supports Read Recovery Levels.",
                    "readonly": true,
                    "type": [
                        "boolean",
                        "null"
                    ]
                },
                "SupportsReservations": {
                    "description": "Indicates if the controller supports reservations.",
                    "longDescription": "This property shall indicate if the controller supports reservations.",
                    "readonly": true,
                    "type": [
                        "boolean",
                        "null"
                    ],
                    "versionAdded": "v1_2_0"
                },
                "SupportsSQAssociations": {
                    "description": "Indicates whether or not the controller supports SQ Associations.",
                    "longDescription": "This property shall indicate whether or not the controller supports SQ Associations.",
                    "readonly": true,
                    "type": [
                        "boolean",
                        "null"
                    ]
                },
                "SupportsTrafficBasedKeepAlive": {
                    "description": "Indicates whether or not the controller supports restarting the Keep Alive Timer if traffic is processed from an admin command or I/O during a Keep Alive Timeout interval.",
                    "longDescription": "This property shall indicate whether or not the controller supports restarting the Keep Alive Timer if traffic is processed from an admin command or I/O during a Keep Alive Timeout interval.",
                    "readonly": true,
                    "type": [
                        "boolean",
                        "null"
                    ]
                }
            },
            "type": "object"
        },
        "NVMeControllerProperties": {
            "additionalProperties": false,
            "description": "NVMe-related properties for a storage controller.",
            "longDescription": "This type shall contain NVMe-related properties for a storage controller.",
            "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": {
                "ANACharacteristics": {
                    "description": "The ANA characteristics and volume information.",
                    "items": {
                        "anyOf": [
                            {
                                "$ref": "#/definitions/ANACharacteristics"
                            },
                            {
                                "type": "null"
                            }
                        ]
                    },
                    "longDescription": "This property shall contain the ANA characteristics and volume information.",
                    "type": "array"
                },
                "AllocatedCompletionQueues": {
                    "description": "The number of I/O completion queues allocated to this NVMe I/O controller.",
                    "longDescription": "This property shall contain the number of I/O completion queues allocated to this NVMe I/O controller.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "versionAdded": "v1_4_0"
                },
                "AllocatedSubmissionQueues": {
                    "description": "The number of I/O submission queues allocated to this NVMe I/O controller.",
                    "longDescription": "This property shall contain the number of I/O submission queues allocated to this NVMe I/O controller.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "versionAdded": "v1_4_0"
                },
                "ControllerType": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/NVMeControllerType"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The type of NVMe controller.",
                    "longDescription": "This property shall contain the type of NVMe controller.",
                    "readonly": true
                },
                "DiscoveryTransportServiceId": {
                    "description": "The NVMe discovery transport service identifier for the discovery controller.",
                    "longDescription": "This property shall contain the NVMe discovery transport service identifier for the discovery controller.  This property shall only be present if `ControllerType` contains `Discovery`.  For NVMe/TCP, the default value should be `8009`.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "versionAdded": "v1_9_0"
                },
                "MaxAttachedNamespaces": {
                    "description": "The maximum number of attached namespaces allowed by this NVMe I/O controller.",
                    "longDescription": "This property shall contain the maximum number of attached namespaces allowed by this NVMe I/O controller.",
                    "minimum": 0,
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "versionAdded": "v1_8_0"
                },
                "MaxQueueSize": {
                    "description": "The maximum individual queue size that an NVMe I/O controller supports.",
                    "longDescription": "This property shall contain the maximum individual queue entry size supported per queue.  This is a zero-based value, where the minimum value is one, indicating two entries.  For PCIe, this applies to both submission and completion queues.  For NVMe-oF, this applies only to submission queues.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ]
                },
                "NVMeControllerAttributes": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/NVMeControllerAttributes"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The NVMe controller attributes.",
                    "longDescription": "This property shall contain NVMe controller attributes."
                },
                "NVMeSMARTCriticalWarnings": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/NVMeSMARTCriticalWarnings"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The NVMe SMART Critical Warnings for this storage controller.  This property contains possible triggers for the predictive drive failure warning for the corresponding drive.",
                    "longDescription": "This property shall contain the NVMe SMART Critical Warnings for this storage controller.  This property can contain possible triggers for the predictive drive failure warning for the corresponding drive."
                },
                "NVMeVersion": {
                    "description": "The version of the NVMe Base Specification supported.",
                    "longDescription": "This property shall contain the version of the NVMe Base Specification supported.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ]
                }
            },
            "type": "object"
        },
        "NVMeControllerType": {
            "enum": [
                "Admin",
                "Discovery",
                "IO"
            ],
            "enumDescriptions": {
                "Admin": "The NVMe controller is an admin controller.",
                "Discovery": "The NVMe controller is a discovery controller.",
                "IO": "The NVMe controller is an I/O controller."
            },
            "type": "string"
        },
        "NVMeSMARTCriticalWarnings": {
            "additionalProperties": false,
            "description": "The NVMe SMART Critical Warnings for a storage controller.",
            "longDescription": "This type shall contain the NVMe SMART Critical Warnings for a storage controller.",
            "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": {
                "MediaInReadOnly": {
                    "description": "Indicates the media has been placed in read-only mode.",
                    "longDescription": "This property shall indicate the media has been placed in read-only mode.  This is not set when the read-only condition of the media is a result of a change in the write protection state of a namespace.",
                    "readonly": true,
                    "type": [
                        "boolean",
                        "null"
                    ]
                },
                "OverallSubsystemDegraded": {
                    "description": "Indicates that the NVM subsystem reliability has been compromised.",
                    "longDescription": "This property shall indicate that the NVM subsystem reliability has been compromised.",
                    "readonly": true,
                    "type": [
                        "boolean",
                        "null"
                    ]
                },
                "PMRUnreliable": {
                    "description": "The Persistent Memory Region has become unreliable.",
                    "longDescription": "This property shall indicate that the Persistent Memory Region has become unreliable.  PCIe memory reads can return invalid data or generate poisoned PCIe TLP(s).  Persistent Memory Region memory writes might not update memory or might update memory with undefined data.  The Persistent Memory Region might also have become non-persistent.",
                    "readonly": true,
                    "type": [
                        "boolean",
                        "null"
                    ]
                },
                "PowerBackupFailed": {
                    "description": "Indicates that the volatile memory backup device has failed.",
                    "longDescription": "This property shall indicate that the volatile memory backup device has failed.",
                    "readonly": true,
                    "type": [
                        "boolean",
                        "null"
                    ]
                },
                "SpareCapacityWornOut": {
                    "description": "Indicates that the available spare capacity has fallen below the threshold.",
                    "longDescription": "This property shall indicate that the available spare capacity has fallen below the threshold.",
                    "readonly": true,
                    "type": [
                        "boolean",
                        "null"
                    ]
                }
            },
            "type": "object"
        },
        "OemActions": {
            "additionalProperties": true,
            "description": "The available OEM-specific actions for this resource.",
            "longDescription": "This type shall contain the available OEM-specific actions for this resource.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {},
            "type": "object"
        },
        "Rates": {
            "additionalProperties": false,
            "description": "This type describes the various controller rates used for processes such as volume rebuild or consistency checks.",
            "longDescription": "This type shall contain all the rate settings available on the controller.",
            "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": {
                "ConsistencyCheckRatePercent": {
                    "description": "The percentage of controller resources used for performing a data consistency check on volumes.",
                    "longDescription": "This property shall contain the percentage, `0` to `100`, of controller resources used for checking data consistency on volumes.",
                    "maximum": 100,
                    "minimum": 0,
                    "readonly": false,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "units": "%"
                },
                "RebuildRatePercent": {
                    "description": "The percentage of controller resources used for rebuilding/repairing volumes.",
                    "longDescription": "This property shall contain the percentage, `0` to `100`, of controller resources used for rebuilding volumes.",
                    "maximum": 100,
                    "minimum": 0,
                    "readonly": false,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "units": "%"
                },
                "TransformationRatePercent": {
                    "description": "The percentage of controller resources used for transforming volumes from one configuration to another.",
                    "longDescription": "This property shall contain the percentage, `0` to `100`, of controller resources used for transforming volumes.",
                    "maximum": 100,
                    "minimum": 0,
                    "readonly": false,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "units": "%"
                }
            },
            "type": "object"
        },
        "SecurityReceive": {
            "actionResponse": {
                "$ref": "#/definitions/SecurityReceiveResponse"
            },
            "additionalProperties": false,
            "description": "This action transfers security protocol data from the controller.  The data transferred from the controller contains the status and data result of one or more `SecuritySend` action requests that were previously submitted to the controller.",
            "longDescription": "This action shall transfer security protocol data from the controller.  The contents of the request are specified by the 'SECURITY PROTOCOL IN command' section of the SPC-5 Specification.",
            "parameters": {
                "AllocationLength": {
                    "description": "Allocated size for received data.",
                    "longDescription": "This parameter shall contain the allocated size of the received data, which imposes a maximum length of the data.  The response may contain padding to meet this length.",
                    "requiredParameter": true,
                    "type": "integer"
                },
                "SecurityProtocol": {
                    "description": "The security protocol number.",
                    "longDescription": "This parameter shall contain the numeric identifier of the security protocol, as defined by the 'SECURITY PROTOCOL field in SECURITY PROTOCOL IN command' table of the SPC-5 Specification, and possibly extended by transport-specific standards.  Services shall only accept the values `0`, `1`, or `2`.",
                    "requiredParameter": true,
                    "type": "integer"
                },
                "SecurityProtocolSpecific": {
                    "description": "The security protocol-specific parameter.",
                    "longDescription": "This parameter shall contain the security protocol-specific data for the transfer operation.  The value is defined by the protocol specified by the SecurityProtocolSpecific parameter.",
                    "requiredParameter": true,
                    "type": "integer"
                }
            },
            "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",
            "versionAdded": "v1_7_0"
        },
        "SecurityReceiveResponse": {
            "additionalProperties": false,
            "description": "The security data transferred from a controller.",
            "longDescription": "This object shall contain the security data transferred from a controller.",
            "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": {
                "Data": {
                    "description": "The Base64-encoded security protocol data.",
                    "longDescription": "This property shall contain a Base64-encoded string, with padding characters, of the security protocol data transferred from a controller.",
                    "readonly": true,
                    "type": "string",
                    "versionAdded": "v1_7_0"
                }
            },
            "type": "object"
        },
        "SecuritySend": {
            "additionalProperties": false,
            "description": "This action transfers security protocol data to the controller.  The data transferred to the controller contains security protocol-specific commands to be performed by the controller.",
            "longDescription": "This action shall transfer security protocol data to the controller.  The contents of the request are specified by the 'SECURITY PROTOCOL OUT command' section of the SPC-5 Specification.",
            "parameters": {
                "Data": {
                    "description": "The data to transfer.",
                    "longDescription": "This parameter shall contain a Base64-encoded string, with padding characters, of the security protocol data to transfer.",
                    "requiredParameter": true,
                    "type": "string"
                },
                "SecurityProtocol": {
                    "description": "The security protocol number.",
                    "longDescription": "This parameter shall contain the numeric identifier of the security protocol, as defined by the 'SECURITY PROTOCOL field in SECURITY PROTOCOL OUT command' table of the SPC-5 Specification, and possibly extended by transport-specific standards.  Services shall only accept the values `1` or `2`.",
                    "requiredParameter": true,
                    "type": "integer"
                },
                "SecurityProtocolSpecific": {
                    "description": "The security protocol-specific parameter.",
                    "longDescription": "This parameter shall contain the security protocol-specific data for the transfer operation.  The value is defined by the protocol specified by the SecurityProtocolSpecific parameter.",
                    "requiredParameter": true,
                    "type": "integer"
                }
            },
            "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",
            "versionAdded": "v1_7_0"
        },
        "StorageController": {
            "additionalProperties": false,
            "description": "The `StorageController` schema describes a storage controller and its properties.  A storage controller represents a physical or virtual storage device that produces volumes.",
            "longDescription": "This resource shall represent a storage controller in the Redfish Specification.",
            "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.json#/definitions/context"
                },
                "@odata.etag": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
                },
                "@odata.id": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
                },
                "@odata.type": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
                },
                "Actions": {
                    "$ref": "#/definitions/Actions",
                    "description": "The available actions for this resource.",
                    "longDescription": "This property shall contain the available actions for this resource."
                },
                "Assembly": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Assembly.json#/definitions/Assembly",
                    "description": "The link to the assembly associated with this storage controller.",
                    "longDescription": "This property shall contain a link to a resource of type `Assembly`.",
                    "readonly": true
                },
                "AssetTag": {
                    "description": "The user-assigned asset tag for this storage controller.",
                    "longDescription": "This property shall track the storage controller for inventory purposes.",
                    "readonly": false,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "CacheSummary": {
                    "$ref": "#/definitions/CacheSummary",
                    "description": "The cache memory of the storage controller in general detail.",
                    "longDescription": "This property shall contain properties that describe the cache memory for this resource."
                },
                "Certificates": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/CertificateCollection.json#/definitions/CertificateCollection",
                    "description": "The link to a collection of certificates for device identity and attestation.",
                    "longDescription": "This property shall contain a link to a resource collection of type `CertificateCollection` that contains certificates for device identity and attestation.",
                    "readonly": true,
                    "versionAdded": "v1_1_0"
                },
                "ControllerRates": {
                    "$ref": "#/definitions/Rates",
                    "description": "This property describes the various controller rates used for processes such as volume rebuild or consistency checks.",
                    "longDescription": "This object shall contain all the rate settings available on the controller."
                },
                "Description": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "readonly": true
                },
                "EnvironmentMetrics": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/EnvironmentMetrics.json#/definitions/EnvironmentMetrics",
                    "description": "The link to the environment metrics for this storage controller.",
                    "longDescription": "This property shall contain a link to a resource of type `EnvironmentMetrics` that represents the environment metrics for this storage controller.",
                    "readonly": true,
                    "versionAdded": "v1_2_0"
                },
                "FirmwareVersion": {
                    "description": "The firmware version of this storage controller.",
                    "longDescription": "This property shall contain the firmware version as defined by the manufacturer for the associated storage controller.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "Id": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
                    "readonly": true
                },
                "Identifiers": {
                    "description": "The durable names for the storage controller.",
                    "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 storage controller.",
                    "type": "array"
                },
                "Links": {
                    "$ref": "#/definitions/Links",
                    "description": "The links to other resources that are related to this resource.",
                    "longDescription": "This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource."
                },
                "Location": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Location",
                    "description": "The location of the storage controller.",
                    "longDescription": "This property shall contain the location information of the associated storage controller."
                },
                "Manufacturer": {
                    "description": "The manufacturer of this storage controller.",
                    "longDescription": "This property shall contain the name of the organization responsible for producing the storage controller.  This organization may be the entity from which the storage controller is purchased, but this is not necessarily true.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "Measurements": {
                    "deprecated": "This property has been deprecated in favor of the `ComponentIntegrity` resource.",
                    "description": "An array of DSP0274-defined measurement blocks.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/v1/SoftwareInventory.json#/definitions/MeasurementBlock"
                    },
                    "longDescription": "This property shall contain an array of DSP0274-defined measurement blocks.",
                    "type": "array",
                    "versionAdded": "v1_1_0",
                    "versionDeprecated": "v1_5_0"
                },
                "Metrics": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/StorageControllerMetrics.json#/definitions/StorageControllerMetrics"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The link to the metrics associated with this storage controller.",
                    "longDescription": "This property shall contain a link to the metrics associated with this storage controller.",
                    "readonly": true,
                    "versionAdded": "v1_7_0"
                },
                "Model": {
                    "description": "The model number for the storage controller.",
                    "longDescription": "This property shall contain the name by which the manufacturer generally refers to the storage controller.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "NVMeControllerProperties": {
                    "$ref": "#/definitions/NVMeControllerProperties",
                    "description": "The NVMe-related properties for this storage controller.",
                    "longDescription": "This property shall contain NVMe-related properties for this storage controller."
                },
                "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": "The OEM extension property.",
                    "longDescription": "This property shall contain the OEM extensions.  All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
                },
                "PCIeInterface": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeDevice.json#/definitions/PCIeInterface",
                    "description": "The PCIe interface details for this controller.",
                    "longDescription": "This property shall contain details on the PCIe interface that connects this PCIe-based controller to its host."
                },
                "PartNumber": {
                    "description": "The part number for this storage controller.",
                    "longDescription": "This property shall contain a part number assigned by the organization that is responsible for producing or manufacturing the storage controller.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "Ports": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/PortCollection.json#/definitions/PortCollection",
                    "description": "The link to the collection of ports that exist on the storage controller.",
                    "longDescription": "This property shall contain a link to a resource collection of type `PortCollection`.",
                    "readonly": true
                },
                "SKU": {
                    "description": "The SKU for this storage controller.",
                    "longDescription": "This property shall contain the stock-keeping unit number for this storage controller.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "SerialNumber": {
                    "description": "The serial number for this storage controller.",
                    "longDescription": "This property shall contain a manufacturer-allocated number that identifies the storage controller.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "SpeedGbps": {
                    "description": "The maximum speed of the storage controller's device interface.",
                    "longDescription": "This property shall represent the maximum supported speed of the storage bus interface, in Gbit/s.  The specified interface connects the controller to the storage devices, not the controller to a host.  For example, SAS bus not PCIe host bus.",
                    "minimum": 0,
                    "readonly": true,
                    "type": [
                        "number",
                        "null"
                    ],
                    "units": "Gbit/s"
                },
                "Status": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
                    "description": "The status and health of the resource and its subordinate or dependent resources.",
                    "longDescription": "This property shall contain any status or health properties of the resource."
                },
                "SupportedControllerProtocols": {
                    "description": "The supported set of protocols for communicating with this storage controller.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/v1/Protocol.json#/definitions/Protocol"
                    },
                    "longDescription": "This property shall contain the supported set of protocols for communicating with this storage controller.",
                    "readonly": true,
                    "type": "array"
                },
                "SupportedDeviceProtocols": {
                    "description": "The protocols that the storage controller can use to communicate with attached devices.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/v1/Protocol.json#/definitions/Protocol"
                    },
                    "longDescription": "This property shall contain the set of protocols this storage controller can use to communicate with attached devices.",
                    "readonly": true,
                    "type": "array"
                },
                "SupportedRAIDTypes": {
                    "description": "The set of RAID types supported by the storage controller.",
                    "items": {
                        "anyOf": [
                            {
                                "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Volume.json#/definitions/RAIDType"
                            },
                            {
                                "type": "null"
                            }
                        ]
                    },
                    "longDescription": "This property shall contain an array of all the RAID types supported by this controller.",
                    "readonly": true,
                    "type": "array"
                }
            },
            "required": [
                "@odata.id",
                "@odata.type",
                "Id",
                "Name"
            ],
            "type": "object"
        }
    },
    "language": "en",
    "owningEntity": "DMTF",
    "release": "2024.4",
    "title": "#StorageController.v1_9_1.StorageController"
}