xref: /openbmc/bmcweb/features/redfish/schema/dmtf/json-schema/ThermalSubsystem.v1_5_0.json (revision 5ecf7b4e1bb6988dd3403fa80b723afbe2be30ae)

{
    "$id": "http://redfish.dmtf.org/schemas/v1/ThermalSubsystem.v1_5_0.json",
    "$ref": "#/definitions/ThermalSubsystem",
    "$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": {
        "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": {
                "Oem": {
                    "$ref": "#/definitions/OemActions",
                    "description": "This property contains the available OEM-specific actions for this resource.",
                    "longDescription": "This property shall contain any additional OEM actions for this resource."
                }
            },
            "type": "object"
        },
        "OemActions": {
            "additionalProperties": true,
            "description": "The available OEM-specific actions for this resource.",
            "longDescription": "This type shall contain any additional OEM 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"
        },
        "ThermalSubsystem": {
            "additionalProperties": false,
            "description": "The `ThermalSubsystem` schema contains the definition for the thermal subsystem of a chassis.",
            "longDescription": "This resource shall represent a thermal subsystem 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.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."
                },
                "CoolantConnectorRedundancy": {
                    "description": "The redundancy information for the coolant connectors in this subsystem.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/v1/Redundancy.json#/definitions/RedundantGroup"
                    },
                    "longDescription": "This property shall contain redundancy information for the set of coolant connectors attached to this equipment.  The values of the `RedundancyGroup` array shall reference resources of type `CoolantConnector`.",
                    "type": "array",
                    "versionAdded": "v1_3_0"
                },
                "CoolantConnectors": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/CoolantConnectorCollection.json#/definitions/CoolantConnectorCollection",
                    "description": "A link to the coolant connectors for this equipment.",
                    "longDescription": "This property shall contain a link to a resource collection of type `CoolantConnectorCollection` that contains the coolant connectors for this equipment.",
                    "readonly": true,
                    "versionAdded": "v1_2_0"
                },
                "Description": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "readonly": true
                },
                "FanRedundancy": {
                    "description": "The redundancy information for the groups of fans in this subsystem.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/v1/Redundancy.json#/definitions/RedundantGroup"
                    },
                    "longDescription": "This property shall contain redundancy information for the groups of fans in this subsystem.",
                    "type": "array"
                },
                "Fans": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/FanCollection.json#/definitions/FanCollection",
                    "description": "The link to the collection of fans within this subsystem.",
                    "longDescription": "This property shall contain a link to a resource collection of type `FanCollection`.",
                    "readonly": true
                },
                "FansFullSpeedOverrideEnable": {
                    "description": "An indication of whether the fans in this equipment are overridden to operate at full speed.",
                    "longDescription": "This property shall indicate whether the fans in this equipment are overridden to operate at full speed.",
                    "readonly": false,
                    "type": [
                        "boolean",
                        "null"
                    ],
                    "versionAdded": "v1_5_0"
                },
                "Filters": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/FilterCollection.json#/definitions/FilterCollection",
                    "description": "A link to the filters for this equipment.",
                    "longDescription": "This property shall contain a link to a resource collection of type `FilterCollection` that contains the filters for this equipment.",
                    "readonly": true,
                    "versionAdded": "v1_4_0"
                },
                "Heaters": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/HeaterCollection.json#/definitions/HeaterCollection",
                    "description": "The link to the collection of heaters within this subsystem.",
                    "longDescription": "This property shall contain a link to a resource collection of type `HeaterCollection`.",
                    "readonly": true,
                    "versionAdded": "v1_1_0"
                },
                "Id": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
                    "readonly": true
                },
                "LeakDetection": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/LeakDetection.json#/definitions/LeakDetection",
                    "description": "The link to the leak detection system within this chassis.",
                    "longDescription": "This property shall contain a link to a resource of type `LeakDetection`.  This link should be used when the leak detection capabilities are tied to, or are internal to, a particular `Chassis`.  For detection capabilities that are tied to a `CoolingUnit` resource, which may span multiple `Chassis` resources, populating the `LeakDetection` resource under `CoolingUnit` for the relevant equipment is the preferred approach.",
                    "readonly": true,
                    "versionAdded": "v1_3_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": "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."
                },
                "Pumps": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/PumpCollection.json#/definitions/PumpCollection",
                    "description": "A link to the pumps for this equipment.",
                    "longDescription": "This property shall contain a link to a resource collection of type `PumpCollection` that contains details for the pumps included in this equipment.",
                    "readonly": true,
                    "versionAdded": "v1_3_0"
                },
                "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."
                },
                "ThermalMetrics": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/ThermalMetrics.json#/definitions/ThermalMetrics",
                    "description": "The link to the summary of thermal metrics for this subsystem.",
                    "longDescription": "This property shall contain a link to a resource of type `ThermalMetrics`.",
                    "readonly": true
                }
            },
            "required": [
                "@odata.id",
                "@odata.type",
                "Id",
                "Name"
            ],
            "type": "object"
        }
    },
    "language": "en",
    "owningEntity": "DMTF",
    "release": "2025.3",
    "title": "#ThermalSubsystem.v1_5_0.ThermalSubsystem"
}