1{
2    "$id": "http://redfish.dmtf.org/schemas/v1/OutletGroup.v1_2_0.json",
3    "$ref": "#/definitions/OutletGroup",
4    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
5    "copyright": "Copyright 2014-2024 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                "#OutletGroup.PowerControl": {
27                    "$ref": "#/definitions/PowerControl"
28                },
29                "#OutletGroup.ResetMetrics": {
30                    "$ref": "#/definitions/ResetMetrics"
31                },
32                "Oem": {
33                    "$ref": "#/definitions/OemActions",
34                    "description": "The available OEM-specific actions for this resource.",
35                    "longDescription": "This property shall contain the available OEM-specific actions for this resource."
36                }
37            },
38            "type": "object"
39        },
40        "Links": {
41            "additionalProperties": false,
42            "description": "The links to other resources that are related to this resource.",
43            "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.",
44            "patternProperties": {
45                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
46                    "description": "This property shall specify a valid odata or Redfish property.",
47                    "type": [
48                        "array",
49                        "boolean",
50                        "integer",
51                        "number",
52                        "null",
53                        "object",
54                        "string"
55                    ]
56                }
57            },
58            "properties": {
59                "Oem": {
60                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
61                    "description": "The OEM extension property.",
62                    "longDescription": "This property shall contain the OEM extensions.  All values for properties contained in this object shall conform to the Redfish Specification-described requirements."
63                },
64                "OutletGroups": {
65                    "description": "The set of outlet groups in this outlet group.",
66                    "items": {
67                        "$ref": "http://redfish.dmtf.org/schemas/v1/OutletGroup.json#/definitions/OutletGroup"
68                    },
69                    "longDescription": "This property shall be an array of links to resources of type `OutletGroup` that represent the outlet groups in this outlet group.  This allows representation of a group of outlet groups.  The outlet groups referenced by this property shall not contain other outlet groups.  Services shall only populate either the link for `Outlets` or `OutletGroups`, but not both.",
70                    "readonly": false,
71                    "type": "array",
72                    "versionAdded": "v1_2_0"
73                },
74                "OutletGroups@odata.count": {
75                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
76                },
77                "Outlets": {
78                    "description": "The set of outlets in this outlet group.",
79                    "items": {
80                        "$ref": "http://redfish.dmtf.org/schemas/v1/Outlet.json#/definitions/Outlet"
81                    },
82                    "longDescription": "This property shall be an array of links to resources of type `Outlet` that represent the outlets in this outlet group.",
83                    "readonly": false,
84                    "type": "array"
85                },
86                "Outlets@odata.count": {
87                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
88                }
89            },
90            "type": "object"
91        },
92        "OemActions": {
93            "additionalProperties": true,
94            "description": "The available OEM-specific actions for this resource.",
95            "longDescription": "This type shall contain the available OEM-specific actions for this resource.",
96            "patternProperties": {
97                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
98                    "description": "This property shall specify a valid odata or Redfish property.",
99                    "type": [
100                        "array",
101                        "boolean",
102                        "integer",
103                        "number",
104                        "null",
105                        "object",
106                        "string"
107                    ]
108                }
109            },
110            "properties": {},
111            "type": "object"
112        },
113        "OutletGroup": {
114            "additionalProperties": false,
115            "description": "The `OutletGroup` schema contains definitions for an electrical outlet group.",
116            "longDescription": "This resource shall be used to represent an electrical outlet group for a Redfish implementation.",
117            "patternProperties": {
118                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
119                    "description": "This property shall specify a valid odata or Redfish property.",
120                    "type": [
121                        "array",
122                        "boolean",
123                        "integer",
124                        "number",
125                        "null",
126                        "object",
127                        "string"
128                    ]
129                }
130            },
131            "properties": {
132                "@odata.context": {
133                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
134                },
135                "@odata.etag": {
136                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
137                },
138                "@odata.id": {
139                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
140                },
141                "@odata.type": {
142                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
143                },
144                "Actions": {
145                    "$ref": "#/definitions/Actions",
146                    "description": "The available actions for this resource.",
147                    "longDescription": "This property shall contain the available actions for this resource."
148                },
149                "ConfigurationLocked": {
150                    "description": "Indicates whether the configuration is locked.",
151                    "longDescription": "This property shall indicate whether modification requests to this resource are not permitted.  If `true`, services shall reject modification requests to other properties in this resource.",
152                    "readonly": false,
153                    "type": "boolean",
154                    "versionAdded": "v1_1_0"
155                },
156                "CreatedBy": {
157                    "description": "The creator of this outlet group.",
158                    "longDescription": "This property shall contain the name of the person or application that created this outlet group.",
159                    "readonly": false,
160                    "type": [
161                        "string",
162                        "null"
163                    ]
164                },
165                "Description": {
166                    "anyOf": [
167                        {
168                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
169                        },
170                        {
171                            "type": "null"
172                        }
173                    ],
174                    "readonly": true
175                },
176                "EnergykWh": {
177                    "anyOf": [
178                        {
179                            "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorEnergykWhExcerpt"
180                        },
181                        {
182                            "type": "null"
183                        }
184                    ],
185                    "description": "The energy (kWh) for this outlet group.",
186                    "excerptCopy": "SensorEnergykWhExcerpt",
187                    "longDescription": "This property shall contain the total energy, in kilowatt-hour units, for this outlet group that represents the `Total` `ElectricalContext` sensor when multiple energy sensors exist for this outlet group.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `EnergykWh`."
188                },
189                "Id": {
190                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
191                    "readonly": true
192                },
193                "Links": {
194                    "$ref": "#/definitions/Links",
195                    "description": "The links to other resources that are related to this resource.",
196                    "longDescription": "This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource."
197                },
198                "Name": {
199                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
200                    "readonly": true
201                },
202                "Oem": {
203                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
204                    "description": "The OEM extension property.",
205                    "longDescription": "This property shall contain the OEM extensions.  All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
206                },
207                "OutletGroupType": {
208                    "$ref": "#/definitions/OutletGroupType",
209                    "description": "The type of outlet group that this resource represents.",
210                    "longDescription": "This property shall describe the type of this outlet group.",
211                    "readonly": true,
212                    "versionAdded": "v1_2_0"
213                },
214                "PowerControlLocked": {
215                    "description": "Indicates whether power control requests are locked.",
216                    "longDescription": "This property shall indicate whether requests to the `PowerControl` action are locked.  If `true`, services shall reject requests to the `PowerControl` action.",
217                    "readonly": false,
218                    "type": "boolean",
219                    "versionAdded": "v1_1_0"
220                },
221                "PowerCycleDelaySeconds": {
222                    "description": "The number of seconds to delay power on after a `PowerControl` action to cycle power.  Zero seconds indicates no delay.",
223                    "longDescription": "This property shall contain the number of seconds to delay power on after a `PowerControl` action to cycle power.  The value `0` shall indicate no delay to power on.",
224                    "readonly": false,
225                    "type": [
226                        "number",
227                        "null"
228                    ]
229                },
230                "PowerEnabled": {
231                    "description": "Indicates if the outlet group can be powered.",
232                    "longDescription": "This property shall contain the power enable state of the outlet group.  The value `true` shall indicate that the group can be powered on, and the value `false` shall indicate that the group cannot be powered.",
233                    "readonly": true,
234                    "type": [
235                        "boolean",
236                        "null"
237                    ]
238                },
239                "PowerOffDelaySeconds": {
240                    "description": "The number of seconds to delay power off after a `PowerControl` action.  Zero seconds indicates no delay to power off.",
241                    "longDescription": "This property shall contain the number of seconds to delay power off after a `PowerControl` action.  The value `0` shall indicate no delay to power off.",
242                    "readonly": false,
243                    "type": [
244                        "number",
245                        "null"
246                    ]
247                },
248                "PowerOnDelaySeconds": {
249                    "description": "The number of seconds to delay power up after a power cycle or a `PowerControl` action.  Zero seconds indicates no delay to power up.",
250                    "longDescription": "This property shall contain the number of seconds to delay power up after a power cycle or a `PowerControl` action.  The value `0` shall indicate no delay to power up.",
251                    "readonly": false,
252                    "type": [
253                        "number",
254                        "null"
255                    ]
256                },
257                "PowerRestoreDelaySeconds": {
258                    "description": "The number of seconds to delay power on after power has been restored.  Zero seconds indicates no delay.",
259                    "longDescription": "This property shall contain the number of seconds to delay power on after a power fault.  The value `0` shall indicate no delay to power on.",
260                    "readonly": false,
261                    "type": [
262                        "number",
263                        "null"
264                    ]
265                },
266                "PowerRestorePolicy": {
267                    "$ref": "http://redfish.dmtf.org/schemas/v1/Circuit.json#/definitions/PowerRestorePolicyTypes",
268                    "description": "The desired power state of the outlet group when power is restored after a power loss.",
269                    "longDescription": "This property shall contain the desired `PowerState` of the outlet group when power is applied.  The value `LastState` shall return the outlet group to the `PowerState` it was in when power was lost.",
270                    "readonly": false
271                },
272                "PowerState": {
273                    "anyOf": [
274                        {
275                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/PowerState"
276                        },
277                        {
278                            "type": "null"
279                        }
280                    ],
281                    "description": "The power state of the outlet group.",
282                    "longDescription": "This property shall contain the power state of the outlet group.",
283                    "readonly": true
284                },
285                "PowerStateInTransition": {
286                    "description": "Indicates whether the power state is undergoing a delayed transition.",
287                    "longDescription": "This property shall indicate whether the `PowerState` property will undergo a transition between on and off states due to a configured delay.  The transition may be due to the configuration of the power on, off, or restore delay properties.  If `true`, the `PowerState` property will transition at the conclusion of a configured delay.",
288                    "readonly": true,
289                    "type": "boolean",
290                    "versionAdded": "v1_1_0"
291                },
292                "PowerWatts": {
293                    "anyOf": [
294                        {
295                            "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorPowerExcerpt"
296                        },
297                        {
298                            "type": "null"
299                        }
300                    ],
301                    "description": "The power (W) for this outlet group.",
302                    "excerptCopy": "SensorPowerExcerpt",
303                    "longDescription": "This property shall contain the total power, in watt units, for this outlet group that represents the `Total` `ElectricalContext` sensor when multiple power sensors exist for this outlet group.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Power`."
304                },
305                "Status": {
306                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
307                    "description": "The status and health of the resource and its subordinate or dependent resources.",
308                    "longDescription": "This property shall contain any status or health properties of the resource."
309                }
310            },
311            "required": [
312                "@odata.id",
313                "@odata.type",
314                "Id",
315                "Name"
316            ],
317            "type": "object"
318        },
319        "OutletGroupType": {
320            "enum": [
321                "HardwareDefined",
322                "UserDefined"
323            ],
324            "enumDescriptions": {
325                "HardwareDefined": "A group that is hardware-defined.",
326                "UserDefined": "A group that is user-defined."
327            },
328            "enumLongDescriptions": {
329                "HardwareDefined": "This value shall represent an outlet group that is hardware-defined.",
330                "UserDefined": "This value shall represent an outlet group that is user-defined."
331            },
332            "type": "string"
333        },
334        "PowerControl": {
335            "additionalProperties": false,
336            "description": "This action turns the outlet group on or off.",
337            "longDescription": "This action shall control the power state of the outlet group.",
338            "parameters": {
339                "PowerState": {
340                    "$ref": "http://redfish.dmtf.org/schemas/v1/Circuit.json#/definitions/PowerState",
341                    "description": "The desired power state of the outlet group.",
342                    "longDescription": "This parameter shall contain the desired power state of the outlet group."
343                }
344            },
345            "patternProperties": {
346                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
347                    "description": "This property shall specify a valid odata or Redfish property.",
348                    "type": [
349                        "array",
350                        "boolean",
351                        "integer",
352                        "number",
353                        "null",
354                        "object",
355                        "string"
356                    ]
357                }
358            },
359            "properties": {
360                "target": {
361                    "description": "Link to invoke action",
362                    "format": "uri-reference",
363                    "type": "string"
364                },
365                "title": {
366                    "description": "Friendly action name",
367                    "type": "string"
368                }
369            },
370            "type": "object"
371        },
372        "ResetMetrics": {
373            "additionalProperties": false,
374            "description": "This action resets metrics related to this outlet group.",
375            "longDescription": "This action shall reset any time intervals or counted values for this outlet group.",
376            "parameters": {},
377            "patternProperties": {
378                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
379                    "description": "This property shall specify a valid odata or Redfish property.",
380                    "type": [
381                        "array",
382                        "boolean",
383                        "integer",
384                        "number",
385                        "null",
386                        "object",
387                        "string"
388                    ]
389                }
390            },
391            "properties": {
392                "target": {
393                    "description": "Link to invoke action",
394                    "format": "uri-reference",
395                    "type": "string"
396                },
397                "title": {
398                    "description": "Friendly action name",
399                    "type": "string"
400                }
401            },
402            "type": "object"
403        }
404    },
405    "language": "en",
406    "owningEntity": "DMTF",
407    "release": "2024.1",
408    "title": "#OutletGroup.v1_2_0.OutletGroup"
409}