xref: /openbmc/bmcweb/redfish-core/schema/dmtf/json-schema/AutomationInstrumentation.v1_0_0.json (revision c6d7a45d427f9a6d9e761afcf305761dca60d7cf)
1{
2    "$id": "http://redfish.dmtf.org/schemas/v1/AutomationInstrumentation.v1_0_0.json",
3    "$ref": "#/definitions/AutomationInstrumentation",
4    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
5    "copyright": "Copyright 2014-2025 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
6    "definitions": {
7        "Actions": {
8            "additionalProperties": false,
9            "description": "The available actions for this resource.",
10            "longDescription": "This type shall contain the available actions for this resource.",
11            "patternProperties": {
12                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
13                    "description": "This property shall specify a valid odata or Redfish property.",
14                    "type": [
15                        "array",
16                        "boolean",
17                        "integer",
18                        "number",
19                        "null",
20                        "object",
21                        "string"
22                    ]
23                }
24            },
25            "properties": {
26                "Oem": {
27                    "$ref": "#/definitions/OemActions",
28                    "description": "The available OEM-specific actions for this resource.",
29                    "longDescription": "This property shall contain the available OEM-specific actions for this resource."
30                }
31            },
32            "type": "object"
33        },
34        "AutomationInstrumentation": {
35            "additionalProperties": false,
36            "description": "The `AutomationInstrumentation` schema contains measurements and set points for an automation node.",
37            "longDescription": "This resource shall represent automation node instrumentation for a Redfish implementation.",
38            "patternProperties": {
39                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
40                    "description": "This property shall specify a valid odata or Redfish property.",
41                    "type": [
42                        "array",
43                        "boolean",
44                        "integer",
45                        "number",
46                        "null",
47                        "object",
48                        "string"
49                    ]
50                }
51            },
52            "properties": {
53                "@odata.context": {
54                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
55                },
56                "@odata.etag": {
57                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
58                },
59                "@odata.id": {
60                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
61                },
62                "@odata.type": {
63                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
64                },
65                "Actions": {
66                    "$ref": "#/definitions/Actions",
67                    "description": "The available actions for this resource.",
68                    "longDescription": "This property shall contain the available actions for this resource."
69                },
70                "CurrentAmps": {
71                    "anyOf": [
72                        {
73                            "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorCurrentExcerpt"
74                        },
75                        {
76                            "type": "null"
77                        }
78                    ],
79                    "description": "The current (A) for this node.",
80                    "excerptCopy": "SensorCurrentExcerpt",
81                    "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`."
82                },
83                "Description": {
84                    "anyOf": [
85                        {
86                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
87                        },
88                        {
89                            "type": "null"
90                        }
91                    ],
92                    "readonly": true
93                },
94                "Id": {
95                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
96                    "readonly": true
97                },
98                "Name": {
99                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
100                    "readonly": true
101                },
102                "NodeControl": {
103                    "anyOf": [
104                        {
105                            "$ref": "http://redfish.dmtf.org/schemas/v1/Control.json#/definitions/ControlNodeExcerpt"
106                        },
107                        {
108                            "type": "null"
109                        }
110                    ],
111                    "description": "The control for this node.",
112                    "excerptCopy": "ControlNodeExcerpt",
113                    "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`."
114                },
115                "NodeState": {
116                    "$ref": "http://redfish.dmtf.org/schemas/v1/AutomationNode.json#/definitions/NodeState",
117                    "description": "The current state of the node.",
118                    "longDescription": "This parameter shall specify the current state of the automation node.",
119                    "readonly": true
120                },
121                "Oem": {
122                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
123                    "description": "The OEM extension property.",
124                    "longDescription": "This property shall contain the OEM extensions.  All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
125                },
126                "PID": {
127                    "anyOf": [
128                        {
129                            "$ref": "http://redfish.dmtf.org/schemas/v1/Control.json#/definitions/ControlSingleLoopExcerpt"
130                        },
131                        {
132                            "type": "null"
133                        }
134                    ],
135                    "description": "A PID control loop.",
136                    "excerptCopy": "ControlSingleLoopExcerpt",
137                    "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`."
138                },
139                "Status": {
140                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
141                    "description": "The status and health of a resource and its children.",
142                    "longDescription": "This type shall contain any status or health properties of a resource."
143                },
144                "TemperatureCelsius": {
145                    "anyOf": [
146                        {
147                            "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorExcerpt"
148                        },
149                        {
150                            "type": "null"
151                        }
152                    ],
153                    "description": "Temperature (Celsius).",
154                    "excerptCopy": "SensorExcerpt",
155                    "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`."
156                },
157                "Voltage": {
158                    "anyOf": [
159                        {
160                            "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorVoltageExcerpt"
161                        },
162                        {
163                            "type": "null"
164                        }
165                    ],
166                    "description": "The voltage (V) for this node.",
167                    "excerptCopy": "SensorVoltageExcerpt",
168                    "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`."
169                }
170            },
171            "required": [
172                "@odata.id",
173                "@odata.type",
174                "Id",
175                "Name"
176            ],
177            "type": "object"
178        },
179        "OemActions": {
180            "additionalProperties": true,
181            "description": "The available OEM-specific actions for this resource.",
182            "longDescription": "This type shall contain the available OEM-specific actions for this resource.",
183            "patternProperties": {
184                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
185                    "description": "This property shall specify a valid odata or Redfish property.",
186                    "type": [
187                        "array",
188                        "boolean",
189                        "integer",
190                        "number",
191                        "null",
192                        "object",
193                        "string"
194                    ]
195                }
196            },
197            "properties": {},
198            "type": "object"
199        }
200    },
201    "owningEntity": "DMTF",
202    "release": "2025.2",
203    "title": "#AutomationInstrumentation.v1_0_0.AutomationInstrumentation"
204}