1{
2    "$id": "http://redfish.dmtf.org/schemas/v1/Aggregate.v1_0_3.json",
3    "$ref": "#/definitions/Aggregate",
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                "#Aggregate.AddElements": {
27                    "$ref": "#/definitions/AddElements"
28                },
29                "#Aggregate.RemoveElements": {
30                    "$ref": "#/definitions/RemoveElements"
31                },
32                "#Aggregate.Reset": {
33                    "$ref": "#/definitions/Reset"
34                },
35                "#Aggregate.SetDefaultBootOrder": {
36                    "$ref": "#/definitions/SetDefaultBootOrder"
37                },
38                "Oem": {
39                    "$ref": "#/definitions/OemActions",
40                    "description": "The available OEM-specific actions for this resource.",
41                    "longDescription": "This property shall contain the available OEM-specific actions for this resource."
42                }
43            },
44            "type": "object"
45        },
46        "AddElements": {
47            "additionalProperties": false,
48            "description": "This action is used to add one or more resources to the aggregate.",
49            "longDescription": "This action shall add one or more resources to the aggregate, with the result that the resources are included in the `Elements` array of the aggregate.",
50            "parameters": {
51                "Elements": {
52                    "description": "An array of resource links to add to the `Elements` array.",
53                    "items": {
54                        "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Resource"
55                    },
56                    "longDescription": "This parameter shall contain an array of links to the specified resources to add to the aggregate's `Elements` array.",
57                    "requiredParameter": true,
58                    "type": "array"
59                }
60            },
61            "patternProperties": {
62                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
63                    "description": "This property shall specify a valid odata or Redfish property.",
64                    "type": [
65                        "array",
66                        "boolean",
67                        "integer",
68                        "number",
69                        "null",
70                        "object",
71                        "string"
72                    ]
73                }
74            },
75            "properties": {
76                "target": {
77                    "description": "Link to invoke action",
78                    "format": "uri-reference",
79                    "type": "string"
80                },
81                "title": {
82                    "description": "Friendly action name",
83                    "type": "string"
84                }
85            },
86            "type": "object"
87        },
88        "Aggregate": {
89            "additionalProperties": false,
90            "description": "The `Aggregate` schema describes a grouping method for an aggregation service.  Aggregates are formal groups of resources that are more persistent than ad hoc groupings.",
91            "longDescription": "This resource shall represent an aggregation service grouping method for a Redfish implementation.",
92            "patternProperties": {
93                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
94                    "description": "This property shall specify a valid odata or Redfish property.",
95                    "type": [
96                        "array",
97                        "boolean",
98                        "integer",
99                        "number",
100                        "null",
101                        "object",
102                        "string"
103                    ]
104                }
105            },
106            "properties": {
107                "@odata.context": {
108                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
109                },
110                "@odata.etag": {
111                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
112                },
113                "@odata.id": {
114                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
115                },
116                "@odata.type": {
117                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
118                },
119                "Actions": {
120                    "$ref": "#/definitions/Actions",
121                    "description": "The available actions for this resource.",
122                    "longDescription": "This property shall contain the available actions for this resource."
123                },
124                "Description": {
125                    "anyOf": [
126                        {
127                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
128                        },
129                        {
130                            "type": "null"
131                        }
132                    ],
133                    "readonly": true
134                },
135                "Elements": {
136                    "description": "The elements of this aggregate.",
137                    "items": {
138                        "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Resource"
139                    },
140                    "longDescription": "This property shall contain an array of links to the elements of this aggregate.",
141                    "readonly": true,
142                    "type": "array"
143                },
144                "Elements@odata.count": {
145                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
146                },
147                "ElementsCount": {
148                    "description": "The number of entries in the `Elements` array.",
149                    "longDescription": "This property shall contain the number of entries in the `Elements` array.",
150                    "minimum": 0,
151                    "readonly": true,
152                    "type": [
153                        "integer",
154                        "null"
155                    ]
156                },
157                "Id": {
158                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
159                    "readonly": true
160                },
161                "Name": {
162                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
163                    "readonly": true
164                },
165                "Oem": {
166                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
167                    "description": "The OEM extension property.",
168                    "longDescription": "This property shall contain the OEM extensions.  All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
169                }
170            },
171            "required": [
172                "Elements",
173                "@odata.id",
174                "@odata.type",
175                "Id",
176                "Name"
177            ],
178            "requiredOnCreate": [
179                "Elements"
180            ],
181            "type": "object"
182        },
183        "OemActions": {
184            "additionalProperties": true,
185            "description": "The available OEM-specific actions for this resource.",
186            "longDescription": "This type shall contain the available OEM-specific actions for this resource.",
187            "patternProperties": {
188                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
189                    "description": "This property shall specify a valid odata or Redfish property.",
190                    "type": [
191                        "array",
192                        "boolean",
193                        "integer",
194                        "number",
195                        "null",
196                        "object",
197                        "string"
198                    ]
199                }
200            },
201            "properties": {},
202            "type": "object"
203        },
204        "RemoveElements": {
205            "additionalProperties": false,
206            "description": "This action is used to remove one or more resources from the aggregate.",
207            "longDescription": "This action shall remove one or more resources from the aggregate, with the result that the resources are removed from the `Elements` array of the aggregate.",
208            "parameters": {
209                "Elements": {
210                    "description": "An array of resource links to remove from the `Elements` array.",
211                    "items": {
212                        "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Resource"
213                    },
214                    "longDescription": "This parameter shall contain an array of links to the specified resources to remove from the aggregate's `Elements` array.",
215                    "requiredParameter": true,
216                    "type": "array"
217                }
218            },
219            "patternProperties": {
220                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
221                    "description": "This property shall specify a valid odata or Redfish property.",
222                    "type": [
223                        "array",
224                        "boolean",
225                        "integer",
226                        "number",
227                        "null",
228                        "object",
229                        "string"
230                    ]
231                }
232            },
233            "properties": {
234                "target": {
235                    "description": "Link to invoke action",
236                    "format": "uri-reference",
237                    "type": "string"
238                },
239                "title": {
240                    "description": "Friendly action name",
241                    "type": "string"
242                }
243            },
244            "type": "object"
245        },
246        "Reset": {
247            "additionalProperties": false,
248            "description": "This action is used to reset a collection of resources.  For example, this could be an aggregate or a list of computer systems.",
249            "longDescription": "This action shall perform a reset of a collection of resources.",
250            "parameters": {
251                "BatchSize": {
252                    "description": "The number of elements in each batch being reset.",
253                    "longDescription": "This parameter shall contain the number of elements in each batch simultaneously being issued a reset.",
254                    "minimum": 0,
255                    "type": "integer"
256                },
257                "DelayBetweenBatchesInSeconds": {
258                    "description": "The delay of the batches of elements being reset in seconds.",
259                    "longDescription": "This parameter shall contain the delay of the batches of elements being reset in seconds.",
260                    "minimum": 0,
261                    "type": "integer",
262                    "units": "s"
263                },
264                "ResetType": {
265                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/ResetType",
266                    "description": "The type of reset.",
267                    "longDescription": "This parameter shall contain the type of reset.  The service can accept a request without the parameter and perform an implementation-specific default reset."
268                }
269            },
270            "patternProperties": {
271                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
272                    "description": "This property shall specify a valid odata or Redfish property.",
273                    "type": [
274                        "array",
275                        "boolean",
276                        "integer",
277                        "number",
278                        "null",
279                        "object",
280                        "string"
281                    ]
282                }
283            },
284            "properties": {
285                "target": {
286                    "description": "Link to invoke action",
287                    "format": "uri-reference",
288                    "type": "string"
289                },
290                "title": {
291                    "description": "Friendly action name",
292                    "type": "string"
293                }
294            },
295            "type": "object"
296        },
297        "SetDefaultBootOrder": {
298            "additionalProperties": false,
299            "description": "This action is used to restore the boot order to the default state for the computer systems that are members of this aggregate.",
300            "longDescription": "This action shall restore the boot order to the default state for the computer systems that are members of this aggregate.",
301            "parameters": {},
302            "patternProperties": {
303                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
304                    "description": "This property shall specify a valid odata or Redfish property.",
305                    "type": [
306                        "array",
307                        "boolean",
308                        "integer",
309                        "number",
310                        "null",
311                        "object",
312                        "string"
313                    ]
314                }
315            },
316            "properties": {
317                "target": {
318                    "description": "Link to invoke action",
319                    "format": "uri-reference",
320                    "type": "string"
321                },
322                "title": {
323                    "description": "Friendly action name",
324                    "type": "string"
325                }
326            },
327            "type": "object"
328        }
329    },
330    "language": "en",
331    "owningEntity": "DMTF",
332    "release": "2020.2",
333    "title": "#Aggregate.v1_0_3.Aggregate"
334}