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

{
    "$id": "http://redfish.dmtf.org/schemas/v1/AutomationInstrumentation.v1_0_0.json",
    "$ref": "#/definitions/AutomationInstrumentation",
    "$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"
        },
        "AutomationInstrumentation": {
            "additionalProperties": false,
            "description": "The `AutomationInstrumentation` schema contains measurements and set points for an automation node.",
            "longDescription": "This resource shall represent automation node instrumentation 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."
                },
                "CurrentAmps": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorCurrentExcerpt"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The current (A) for this node.",
                    "excerptCopy": "SensorCurrentExcerpt",
                    "longDescription": "This property shall contain the current, in ampere units, for this automation node.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Current`."
                },
                "Description": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "readonly": true
                },
                "Id": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
                    "readonly": true
                },
                "Name": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
                    "readonly": true
                },
                "NodeControl": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Control.json#/definitions/ControlNodeExcerpt"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The control for this node.",
                    "excerptCopy": "ControlNodeExcerpt",
                    "longDescription": "This property shall contain the control for this resource.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Control`."
                },
                "NodeState": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/AutomationNode.json#/definitions/NodeState",
                    "description": "The current state of the node.",
                    "longDescription": "This parameter shall specify the current state of the automation node.",
                    "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."
                },
                "PID": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Control.json#/definitions/ControlSingleLoopExcerpt"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "A PID control loop.",
                    "excerptCopy": "ControlSingleLoopExcerpt",
                    "longDescription": "This property shall contain a PID-based control loop for this resource.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Control`."
                },
                "Status": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
                    "description": "The status and health of a resource and its children.",
                    "longDescription": "This type shall contain any status or health properties of a resource."
                },
                "TemperatureCelsius": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorExcerpt"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "Temperature (Celsius).",
                    "excerptCopy": "SensorExcerpt",
                    "longDescription": "This property shall contain the temperature, in degree Celsius units, for this resource.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Temperature`."
                },
                "Voltage": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorVoltageExcerpt"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The voltage (V) for this node.",
                    "excerptCopy": "SensorVoltageExcerpt",
                    "longDescription": "This property shall contain the voltage, in volt units, for this automation node.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Voltage`."
                }
            },
            "required": [
                "@odata.id",
                "@odata.type",
                "Id",
                "Name"
            ],
            "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"
        }
    },
    "owningEntity": "DMTF",
    "release": "2025.2",
    "title": "#AutomationInstrumentation.v1_0_0.AutomationInstrumentation"
}