xref: /openbmc/bmcweb/features/redfish/schema/dmtf/json-schema/CoolantConnector.v1_2_0.json (revision c6d7a45d427f9a6d9e761afcf305761dca60d7cf)

{
    "$id": "http://redfish.dmtf.org/schemas/v1/CoolantConnector.v1_2_0.json",
    "$ref": "#/definitions/CoolantConnector",
    "$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": "The available OEM-specific actions for this resource.",
                    "longDescription": "This property shall contain the available OEM-specific actions for this resource."
                }
            },
            "type": "object"
        },
        "CoolantConnector": {
            "additionalProperties": false,
            "description": "The `CoolantConnector` schema describes a liquid coolant connector, including any associated instrumentation.",
            "longDescription": "This resource shall represent a coolant connector 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."
                },
                "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."
                },
                "CoolantConnectorType": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/CoolantConnectorType"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The type of coolant connector.",
                    "longDescription": "This property shall contain the type of coolant connector.",
                    "readonly": true
                },
                "CoolingLoopName": {
                    "description": "The name of the cooling loop attached to this interface.",
                    "longDescription": "This property shall contain the name of the cooling loop attached to this interface.  If the `CoolingLoop` link property is present, this property shall contain the value of the `Id` property in the resource referenced by that link.",
                    "readonly": false,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "CoolingManagerURI": {
                    "description": "The link to the application that manages the cooling loop.",
                    "format": "uri-reference",
                    "longDescription": "This property shall contain a URI to the application or device that provides administration or management of the cooling loop associated with this interface.",
                    "readonly": false,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "DeltaPressureControlkPa": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Control.json#/definitions/ControlSingleLoopExcerpt"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The desired differential pressure (kPa).",
                    "excerptCopy": "ControlSingleLoopExcerpt",
                    "longDescription": "This property shall contain the desired differential pressure, in kilopascal units, of this coolant connector.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Control` with the `ControlType` property containing the value `PressurekPa`.  This property shall only be present for secondary coolant connectors.  Services may automatically change other controls if a client attempts to enable this control to prevent conflicts.",
                    "readonly": true,
                    "versionAdded": "v1_1_0"
                },
                "DeltaPressurekPa": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorExcerpt"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The differential pressure (kPa).",
                    "excerptCopy": "SensorExcerpt",
                    "longDescription": "This property shall contain the pressure, in kilopascal units, for the difference in pressure between the supply and outflow or return connection to the cooling loop.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `PressurekPa`.",
                    "readonly": true
                },
                "DeltaTemperatureCelsius": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorExcerpt"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The differential temperature (C).",
                    "excerptCopy": "SensorExcerpt",
                    "longDescription": "This property shall contain the change in temperature, in degree Celsius units, between the supply connection and the outflow or return connection to the cooling loop.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Temperature`.",
                    "readonly": true
                },
                "DeltaTemperatureControlCelsius": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Control.json#/definitions/ControlSingleLoopExcerpt"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The desired differential temperature (C).",
                    "excerptCopy": "ControlSingleLoopExcerpt",
                    "longDescription": "This property shall contain the desired differential temperature, in degree Celsius units, of this coolant connector.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Control` with the `ControlType` property containing the value `Temperature`.  This property shall only be present for secondary coolant connectors.  Services may automatically change other controls if a client attempts to enable this control to prevent conflicts.",
                    "readonly": true,
                    "versionAdded": "v1_1_0"
                },
                "Description": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "readonly": true
                },
                "FlowControlLitersPerMinute": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Control.json#/definitions/ControlSingleLoopExcerpt"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The desired liquid flow rate (L/min).",
                    "excerptCopy": "ControlSingleLoopExcerpt",
                    "longDescription": "This property shall contain the desired liquid flow rate, in liters per minute units, of this coolant connector.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Control` with the `ControlType` property containing the value `LiquidFlowLPM`.  This property shall only be present for secondary coolant connectors.  Services may automatically change other controls if a client attempts to enable this control to prevent conflicts.",
                    "readonly": true,
                    "versionAdded": "v1_1_0"
                },
                "FlowLitersPerMinute": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorExcerpt"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The liquid flow (L/min).",
                    "excerptCopy": "SensorExcerpt",
                    "longDescription": "This property shall contain the liquid flow rate, in liters per minute units, for this coolant connector.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `LiquidFlowLPM`.",
                    "readonly": true
                },
                "HeatRemovedkW": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorExcerpt"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The heat removed (kW) through this connector.",
                    "excerptCopy": "SensorExcerpt",
                    "longDescription": "This property shall contain the amount of heat removed, in kilowatt units, by the coolant flow through this connector.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Heat`.",
                    "readonly": true
                },
                "Id": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
                    "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."
                },
                "LocationIndicatorActive": {
                    "description": "An indicator allowing an operator to physically locate this resource.",
                    "longDescription": "This property shall contain the state of the indicator used to physically identify or locate this resource.",
                    "readonly": false,
                    "type": [
                        "boolean",
                        "null"
                    ]
                },
                "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."
                },
                "RatedFlowLitersPerMinute": {
                    "description": "The rated liquid flow (L/min) for this loop interface.",
                    "longDescription": "This property shall contain the rated liquid flow, in liters per minute units, for this loop interface.",
                    "minimum": 0,
                    "readonly": true,
                    "type": [
                        "number",
                        "null"
                    ],
                    "units": "L/min"
                },
                "RatedFlowPressurekPa": {
                    "description": "The pressure (kPa) at which the rated liquid flow is valid.",
                    "longDescription": "This property shall contain the pressure, in kilopascal units, that the rated liquid flow is valid for this connector.",
                    "minimum": 0,
                    "readonly": true,
                    "type": [
                        "number",
                        "null"
                    ],
                    "units": "kPa"
                },
                "RatedPressurekPa": {
                    "description": "The rated pressure (kPa) for this connector.",
                    "longDescription": "This property shall contain the rated maximum pressure, in kilopascal units, for this connector.",
                    "minimum": 0,
                    "readonly": true,
                    "type": [
                        "number",
                        "null"
                    ],
                    "units": "kPa"
                },
                "ReturnPressurekPa": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorExcerpt"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The return pressure (kPa).",
                    "excerptCopy": "SensorExcerpt",
                    "longDescription": "This property shall contain the pressure, in kilopascal units, for the outflow or return connection to the cooling loop.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `PressurekPa`.",
                    "readonly": true
                },
                "ReturnTemperatureCelsius": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorExcerpt"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The return temperature (C).",
                    "excerptCopy": "SensorExcerpt",
                    "longDescription": "This property shall contain the temperature, in degree Celsius units, for the outflow or return connection to the cooling loop.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Temperature`.",
                    "readonly": true
                },
                "ReturnTemperatureControlCelsius": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Control.json#/definitions/ControlSingleLoopExcerpt"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The desired return temperature (C).",
                    "excerptCopy": "ControlSingleLoopExcerpt",
                    "longDescription": "This property shall contain the desired return temperature, in degree Celsius units, of this coolant connector.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Control` with the `ControlType` property containing the value `Temperature`.  This property shall only be present for secondary coolant connectors.  Services may automatically change other controls if a client attempts to enable this control to prevent conflicts.",
                    "readonly": true,
                    "versionAdded": "v1_1_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."
                },
                "SupplyPressurekPa": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorExcerpt"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The supply pressure (kPa).",
                    "excerptCopy": "SensorExcerpt",
                    "longDescription": "This property shall contain the pressure, in kilopascal units, for the intake or supply connection to the cooling loop.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `PressurekPa`.",
                    "readonly": true
                },
                "SupplyTemperatureCelsius": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorExcerpt"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The supply temperature (C).",
                    "excerptCopy": "SensorExcerpt",
                    "longDescription": "This property shall contain the temperature, in degree Celsius units, for the intake or supply connection to the cooling loop.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Temperature`.",
                    "readonly": true
                },
                "SupplyTemperatureControlCelsius": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Control.json#/definitions/ControlSingleLoopExcerpt"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The desired supply temperature (C).",
                    "excerptCopy": "ControlSingleLoopExcerpt",
                    "longDescription": "This property shall contain the desired supply temperature, in degree Celsius units, of this coolant connector.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Control` with the `ControlType` property containing the value `Temperature`.  This property shall only be present for secondary coolant connectors.  Services may automatically change other controls if a client attempts to enable this control to prevent conflicts.",
                    "readonly": true,
                    "versionAdded": "v1_1_0"
                },
                "ValvePositionControlPercent": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Control.json#/definitions/ControlSingleLoopExcerpt"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The desired valve position (% open).",
                    "excerptCopy": "ControlSingleLoopExcerpt",
                    "longDescription": "This property shall contain the desired valve position, in percent units, of this coolant connector.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Control` with the `ControlType` property containing the value `Valve`.  Services may automatically change other controls if a client attempts to enable this control to prevent conflicts.",
                    "readonly": true,
                    "versionAdded": "v1_2_0"
                },
                "ValvePositionPercent": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorExcerpt"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The valve position (% open) of this connector.",
                    "excerptCopy": "SensorExcerpt",
                    "longDescription": "This property shall contain the valve position, in percent units, of this connector.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Valve`.",
                    "readonly": true,
                    "versionAdded": "v1_2_0"
                }
            },
            "required": [
                "@odata.id",
                "@odata.type",
                "Id",
                "Name"
            ],
            "type": "object"
        },
        "CoolantConnectorType": {
            "enum": [
                "Pair",
                "Supply",
                "Return",
                "Inline",
                "Closed"
            ],
            "enumDescriptions": {
                "Closed": "A closed or self-contained loop.",
                "Inline": "An inline connection or measurement point.",
                "Pair": "A connection pair.",
                "Return": "A return or outflow connection.",
                "Supply": "A supply or intake connection."
            },
            "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": {
                "ConnectedChassis": {
                    "description": "Any array of links to chassis at the other end of the connection.",
                    "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 chassis at the other end of the connection.",
                    "readonly": false,
                    "type": "array"
                },
                "ConnectedChassis@odata.count": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
                },
                "ConnectedCoolingLoop": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/CoolingLoop.json#/definitions/CoolingLoop"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "A link to the cooling loop at the other end of the connection.",
                    "longDescription": "This property shall contain a link to a resource of type `CoolingLoop` that represents the cooling loop at the other end of the connection.",
                    "readonly": false
                },
                "ConnectedCoolingUnit": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/CoolingUnit.json#/definitions/CoolingUnit"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "A link to the cooling unit at the other end of the connection.",
                    "longDescription": "This property shall contain a link to a resource of type `CoolingUnit` that represents the cooling unit at the other end of the connection.",
                    "readonly": false
                },
                "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"
        }
    },
    "language": "en",
    "owningEntity": "DMTF",
    "release": "2025.2",
    "title": "#CoolantConnector.v1_2_0.CoolantConnector"
}