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

{
    "$id": "http://redfish.dmtf.org/schemas/v1/CoolingUnit.v1_4_0.json",
    "$ref": "#/definitions/CoolingUnit",
    "$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": {
                "#CoolingUnit.ExportConfiguration": {
                    "$ref": "#/definitions/ExportConfiguration"
                },
                "#CoolingUnit.SetMode": {
                    "$ref": "#/definitions/SetMode"
                },
                "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"
        },
        "Component": {
            "enum": [
                "All",
                "Manager",
                "ManagerAccounts",
                "CoolingUnit"
            ],
            "enumDescriptions": {
                "All": "Export all configuration data for this equipment including OEM components.",
                "CoolingUnit": "Export configuration data associated with the cooling unit functions and subsystems of this equipment.",
                "Manager": "Export configuration data associated with the manager of the equipment.",
                "ManagerAccounts": "Export configuration data associated with the user accounts and external account services of the manager for this equipment."
            },
            "enumLongDescriptions": {
                "All": "The service shall export all available configuration data from the equipment including OEM components.",
                "CoolingUnit": "The service shall export configuration data associated with the cooling unit functions and subsystems of this equipment.",
                "Manager": "The service shall export configuration data associated with any managers of this equipment.",
                "ManagerAccounts": "The service shall export configuration data associated with any managers for the equipment."
            },
            "type": "string"
        },
        "CoolingEquipmentType": {
            "enum": [
                "CDU",
                "HeatExchanger",
                "ImmersionUnit",
                "RPU"
            ],
            "enumDescriptions": {
                "CDU": "A coolant distribution unit (CDU).",
                "HeatExchanger": "A heat exchanger.",
                "ImmersionUnit": "An immersion cooling unit.",
                "RPU": "A reservoir and pumping unit (RPU)."
            },
            "enumVersionAdded": {
                "RPU": "v1_3_0"
            },
            "type": "string"
        },
        "CoolingUnit": {
            "additionalProperties": false,
            "description": "The `CoolingUnit` schema contains the definition for a cooling system component or unit, such as a coolant distribution unit (CDU) or a heat exchanger.",
            "longDescription": "This resource shall represent a cooling system component or unit 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."
                },
                "Assembly": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Assembly.json#/definitions/Assembly",
                    "description": "The link to the assembly associated with this cooling unit.",
                    "longDescription": "This property shall contain a link to a resource of type `Assembly`.",
                    "readonly": true
                },
                "AssetTag": {
                    "description": "The user-assigned asset tag for this equipment.",
                    "longDescription": "This property shall contain the user-assigned asset tag, which is an identifying string that tracks the equipment for inventory purposes.",
                    "readonly": false,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "Coolant": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/CoolingLoop.json#/definitions/Coolant",
                    "description": "Details about the coolant used in this unit.",
                    "longDescription": "This property shall contain details regarding the coolant contained or used by this unit."
                },
                "CoolantConnectorRedundancy": {
                    "description": "The redundancy information for the coolant connectors in this cooling unit.",
                    "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_1_0"
                },
                "CoolingCapacityWatts": {
                    "description": "The cooling capacity (W) of this equipment.",
                    "longDescription": "This property shall contain the manufacturer-provided cooling capacity, in watt units, of this equipment.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ]
                },
                "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 equipment.",
                    "longDescription": "This property shall contain a link to a resource of type `EnvironmentMetrics` that specifies the environment metrics for this equipment.",
                    "readonly": true
                },
                "EquipmentType": {
                    "$ref": "#/definitions/CoolingEquipmentType",
                    "description": "The type of equipment this resource represents.",
                    "longDescription": "This property shall contain the type of equipment this resource represents.",
                    "readonly": true
                },
                "FilterRedundancy": {
                    "description": "The redundancy information for the groups of filters in this unit.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/v1/Redundancy.json#/definitions/RedundantGroup"
                    },
                    "longDescription": "This property shall contain redundancy information for the groups of filters in this unit.",
                    "type": "array"
                },
                "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 filter information for this equipment.",
                    "readonly": true
                },
                "FirmwareVersion": {
                    "description": "The firmware version of this equipment.",
                    "longDescription": "This property shall contain a string describing the firmware version of this equipment as provided by the manufacturer.",
                    "readonly": true,
                    "type": "string"
                },
                "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": "A link to the leak detection components associated with this equipment.",
                    "longDescription": "This property shall contain a link to a resource of type `LeakDetection` that contains the leak detection component information for this equipment.  This link should be used when the leak detection capabilities are tied to a particular cooling unit or system which may span multiple `Chassis` resources.  For equipment represented with a single `Chassis` resource or detection inside a particular `Chassis` resource, populating the `LeakDetection` resource under `ThermalSubsystem` for the relevant `Chassis` is the preferred approach.",
                    "readonly": true
                },
                "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 equipment.",
                    "longDescription": "This property shall contain the location information of the associated equipment."
                },
                "Manufacturer": {
                    "description": "The manufacturer of this equipment.",
                    "longDescription": "This property shall contain the name of the organization responsible for producing the equipment.  This organization may be the entity from which the equipment is purchased, but this is not necessarily true.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "Model": {
                    "description": "The product model number of this equipment.",
                    "longDescription": "This property shall contain the manufacturer-provided model information of this equipment.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "MultipartImportConfigurationPushURI": {
                    "description": "The URI used to perform a Redfish Specification-defined multipart HTTP or HTTPS push import of a vendor-specific configuration file.",
                    "format": "uri-reference",
                    "longDescription": "This property shall contain a URI used to perform a multipart HTTP or HTTPS `POST` of a vendor-specific configuration file for the purpose of importing the configuration contained within the file as defined by the 'Import configuration data' clause of the Redfish Specification.  The value of this property should not contain a URI of a Redfish resource.  See the 'Redfish-defined URIs and relative reference rules' clause in the Redfish Specification.",
                    "readonly": true,
                    "type": "string",
                    "versionAdded": "v1_4_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."
                },
                "PartNumber": {
                    "description": "The part number for this equipment.",
                    "longDescription": "This property shall contain the manufacturer-provided part number for the equipment.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "PrimaryCoolantConnectors": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/CoolantConnectorCollection.json#/definitions/CoolantConnectorCollection",
                    "description": "A link to the primary coolant connectors for this equipment.",
                    "longDescription": "This property shall contain a link to a resource collection of type `CoolantConnectorCollection` that contains the primary coolant connectors for this equipment.",
                    "readonly": true
                },
                "ProductionDate": {
                    "description": "The production or manufacturing date of this equipment.",
                    "format": "date-time",
                    "longDescription": "This property shall contain the date of production or manufacture for this equipment.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "PumpRedundancy": {
                    "description": "The redundancy information for the groups of pumps in this unit.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/v1/Redundancy.json#/definitions/RedundantGroup"
                    },
                    "longDescription": "This property shall contain redundancy information for the groups of pumps in this unit.",
                    "type": "array"
                },
                "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 the pump information for this equipment.",
                    "readonly": true
                },
                "RatedThermalLossToAirWatts": {
                    "description": "The rated maximum amount of heat, in watt units, lost to the surrounding environment during normal operation.",
                    "longDescription": "This property shall contain the rated maximum amount of heat, in watt units, lost to the surrounding environment during normal operation.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "versionAdded": "v1_4_0"
                },
                "Reservoirs": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/ReservoirCollection.json#/definitions/ReservoirCollection",
                    "description": "A link to the reservoirs for this equipment.",
                    "longDescription": "This property shall contain a link to a resource collection of type `ReservoirCollection` that contains the reservoir information for this equipment.",
                    "readonly": true
                },
                "SecondaryCoolantConnectors": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/CoolantConnectorCollection.json#/definitions/CoolantConnectorCollection",
                    "description": "A link to the secondary coolant connectors for this equipment.",
                    "longDescription": "This property shall contain a link to a resource collection of type `CoolantConnectorCollection` that contains the secondary coolant connectors for this equipment.",
                    "readonly": true
                },
                "SerialNumber": {
                    "description": "The serial number for this equipment.",
                    "longDescription": "This property shall contain a manufacturer-allocated number that identifies the equipment.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "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."
                },
                "UserLabel": {
                    "description": "A user-assigned label.",
                    "longDescription": "This property shall contain a user-assigned label used to identify this resource.  If a value has not been assigned by a user, the value of this property shall be an empty string.",
                    "readonly": false,
                    "type": "string"
                },
                "Version": {
                    "description": "The hardware version of this equipment.",
                    "longDescription": "This property shall contain the hardware version of this equipment as determined by the vendor or supplier.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ]
                }
            },
            "required": [
                "EquipmentType",
                "@odata.id",
                "@odata.type",
                "Id",
                "Name"
            ],
            "type": "object"
        },
        "CoolingUnitMode": {
            "enum": [
                "Enabled",
                "Disabled"
            ],
            "enumDescriptions": {
                "Disabled": "Disable the cooling unit.",
                "Enabled": "Enable the cooling unit."
            },
            "enumLongDescriptions": {
                "Disabled": "This value shall indicate a request to disable the cooling unit.  When disabled, primary functions of the cooling unit, such as pump activity, are also disabled.  When disabled, the cooling unit may perform administrative functions, such as monitoring sensors, controlling valves, and accepting new firmware.  Upon successful completion, the `State` property within `Status`, shall contain the value `Disabled`.",
                "Enabled": "This value shall indicate a request to enable the cooling unit.  Upon successful completion, the `State` property within `Status`, shall contain the value `Enabled`."
            },
            "type": "string"
        },
        "ExportConfiguration": {
            "additionalProperties": false,
            "description": "This action exports the configuration of the equipment in a vendor-specific format.",
            "longDescription": "This action shall export the specified configuration of the equipment in a vendor-specific format.  Upon successful completion of the action and any asynchronous processing, the `Location` header in the response shall contain a URI to a file that contains the configuration data.",
            "parameters": {
                "Components": {
                    "description": "The components of the equipment for which to export configuration data.",
                    "items": {
                        "$ref": "#/definitions/Component"
                    },
                    "longDescription": "This parameter shall contain an array of components of the equipment for which to export configuration data.",
                    "requiredParameter": true,
                    "type": "array"
                },
                "EncryptionPassphrase": {
                    "description": "The encryption passphrase for the exported file.",
                    "longDescription": "This parameter shall contain the encryption passphrase for the exported file.  If this parameter is specified and has a non-zero length, the service shall encrypt the exported file with the passphrase.  Otherwise, the service shall not encrypt the exported file.",
                    "type": "string"
                },
                "ExportType": {
                    "$ref": "#/definitions/ExportType",
                    "description": "The types of export to perform.",
                    "longDescription": "This parameter shall contain the type of export to perform.",
                    "requiredParameter": true
                },
                "OEMComponents": {
                    "description": "The OEM-specific components of the equipment for which to export configuration data.",
                    "items": {
                        "type": "string"
                    },
                    "longDescription": "This parameter shall contain an array of OEM-specific components of the equipment for which to export configuration data.",
                    "type": "array"
                },
                "Security": {
                    "$ref": "#/definitions/ExportSecurity",
                    "description": "The policy to apply when exporting secure information.",
                    "longDescription": "This parameter shall contain the policy to apply when exporting secure information."
                }
            },
            "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_4_0"
        },
        "ExportSecurity": {
            "enum": [
                "IncludeSensitiveData",
                "HashedDataOnly",
                "ExcludeSensitiveData"
            ],
            "enumDescriptions": {
                "ExcludeSensitiveData": "Export only non-sensitive data.",
                "HashedDataOnly": "Export hashed passwords, but exclude other sensitive data.",
                "IncludeSensitiveData": "Export all data regardless of the sensitivity."
            },
            "enumLongDescriptions": {
                "ExcludeSensitiveData": "The service shall export only non-sensitive data.",
                "HashedDataOnly": "The service shall export requested data including hashed passwords, but shall exclude other sensitive data.",
                "IncludeSensitiveData": "The service shall export all requested data regardless of the sensitivity."
            },
            "type": "string"
        },
        "ExportType": {
            "enum": [
                "Clone",
                "Replacement"
            ],
            "enumDescriptions": {
                "Clone": "Export configuration data for this equipment to duplicate the configuration on another instance of this equipment.",
                "Replacement": "Export all configuration data required to replace this equipment."
            },
            "enumLongDescriptions": {
                "Clone": "The service shall export configuration data for this equipment that allows for configuration to be duplicated on other equipment as defined by the vendor.  The service shall export only data which would not result in problems if applied to another instance of this equipment.  For example, identifiers such as MAC Addresses and UUIDs will be excluded under this option.  Consult the vendor documentation for this equipment for more information about which equipment is able to accept the resulting configuration data.",
                "Replacement": "The service shall export all configuration data required to replace this equipment.  Consult the vendor documentation for this equipment for more information about the hardware and software requirements for the replacement equipment."
            },
            "type": "string"
        },
        "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": {
                "Chassis": {
                    "description": "An array of links to the chassis that contain this equipment.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/v1/Chassis.json#/definitions/Chassis"
                    },
                    "longDescription": "This property shall contain an array of links to resources of type `Chassis` that represent the physical containers that contain this equipment.",
                    "readonly": true,
                    "type": "array"
                },
                "Chassis@odata.count": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
                },
                "Facility": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Facility.json#/definitions/Facility",
                    "description": "A link to the facility that contains this equipment.",
                    "longDescription": "This property shall contain a link to a resource of type `Facility` that represents the facility that contains this equipment.",
                    "readonly": true
                },
                "ManagedBy": {
                    "description": "An array of links to the managers responsible for managing this equipment.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/v1/Manager.json#/definitions/Manager"
                    },
                    "longDescription": "This property shall contain an array of links to resources of type `Manager` that represent the managers that manage this equipment.",
                    "readonly": true,
                    "type": "array"
                },
                "ManagedBy@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."
                }
            },
            "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"
        },
        "SetMode": {
            "additionalProperties": false,
            "description": "This action sets the operating mode of the cooling unit.",
            "longDescription": "This action shall set the operating mode of the cooling unit.",
            "parameters": {
                "Mode": {
                    "$ref": "#/definitions/CoolingUnitMode",
                    "description": "The desired operating mode of the cooling unit.",
                    "longDescription": "This parameter shall contain the desired operating mode of the cooling unit."
                }
            },
            "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_2_0"
        }
    },
    "language": "en",
    "owningEntity": "DMTF",
    "release": "2025.3",
    "title": "#CoolingUnit.v1_4_0.CoolingUnit"
}