1{
2    "$id": "http://redfish.dmtf.org/schemas/v1/Facility.v1_4_2.json",
3    "$ref": "#/definitions/Facility",
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                "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        "Facility": {
35            "additionalProperties": false,
36            "description": "The `Facility` schema represents the physical location containing equipment, such as a room, building, or campus.",
37            "longDescription": "This resource shall be used to represent a location containing equipment, such as a room, building, or campus, 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                "AmbientMetrics": {
71                    "$ref": "http://redfish.dmtf.org/schemas/v1/EnvironmentMetrics.json#/definitions/EnvironmentMetrics",
72                    "description": "The link to the ambient environment metrics for this facility.",
73                    "longDescription": "This property shall contain a link to a resource of type `EnvironmentMetrics` that specifies the outdoor environment metrics for this facility.",
74                    "readonly": true,
75                    "versionAdded": "v1_1_0"
76                },
77                "Description": {
78                    "anyOf": [
79                        {
80                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
81                        },
82                        {
83                            "type": "null"
84                        }
85                    ],
86                    "readonly": true
87                },
88                "EnvironmentMetrics": {
89                    "$ref": "http://redfish.dmtf.org/schemas/v1/EnvironmentMetrics.json#/definitions/EnvironmentMetrics",
90                    "description": "The link to the environment metrics for this facility.",
91                    "longDescription": "This property shall contain a link to a resource of type `EnvironmentMetrics` that specifies the environment metrics for this facility.",
92                    "readonly": true,
93                    "versionAdded": "v1_1_0"
94                },
95                "FacilityType": {
96                    "$ref": "#/definitions/FacilityType",
97                    "description": "The type of location this resource represents.",
98                    "longDescription": "This property shall contain the type of location this resource represents.",
99                    "readonly": true
100                },
101                "Id": {
102                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
103                    "readonly": true
104                },
105                "Links": {
106                    "$ref": "#/definitions/Links",
107                    "description": "The links to other resources that are related to this resource.",
108                    "longDescription": "This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource."
109                },
110                "Location": {
111                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Location",
112                    "description": "The location of the facility.",
113                    "longDescription": "This property shall contain the location information of the associated facility."
114                },
115                "Name": {
116                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
117                    "readonly": true
118                },
119                "Oem": {
120                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
121                    "description": "The OEM extension property.",
122                    "longDescription": "This property shall contain the OEM extensions.  All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
123                },
124                "PowerDomains": {
125                    "$ref": "http://redfish.dmtf.org/schemas/v1/PowerDomainCollection.json#/definitions/PowerDomainCollection",
126                    "description": "Link to the power domains in this facility.",
127                    "longDescription": "This property shall contain a link to a resource collection of type `PowerDomainCollection` that contains the power domains associated with this facility.",
128                    "readonly": true
129                },
130                "Status": {
131                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
132                    "description": "The status and health of the resource and its subordinate or dependent resources.",
133                    "longDescription": "This property shall contain any status or health properties of the resource."
134                }
135            },
136            "required": [
137                "FacilityType",
138                "@odata.id",
139                "@odata.type",
140                "Id",
141                "Name"
142            ],
143            "type": "object"
144        },
145        "FacilityType": {
146            "enum": [
147                "Room",
148                "Floor",
149                "Building",
150                "Site"
151            ],
152            "enumDescriptions": {
153                "Building": "A structure with a roof and walls.",
154                "Floor": "A floor inside of a building.",
155                "Room": "A room inside of a building or floor.",
156                "Site": "A small area consisting of several buildings."
157            },
158            "type": "string"
159        },
160        "Links": {
161            "additionalProperties": false,
162            "description": "The links to other resources that are related to this resource.",
163            "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.",
164            "patternProperties": {
165                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
166                    "description": "This property shall specify a valid odata or Redfish property.",
167                    "type": [
168                        "array",
169                        "boolean",
170                        "integer",
171                        "number",
172                        "null",
173                        "object",
174                        "string"
175                    ]
176                }
177            },
178            "properties": {
179                "CDUs": {
180                    "description": "An array of links to the coolant distribution units in this facility.",
181                    "items": {
182                        "$ref": "http://redfish.dmtf.org/schemas/v1/CoolingUnit.json#/definitions/CoolingUnit"
183                    },
184                    "longDescription": "The value of this property shall contain an array of links to resources of type `CoolingUnit` that represent the coolant distribution units in this facility.",
185                    "readonly": false,
186                    "type": "array",
187                    "versionAdded": "v1_4_0"
188                },
189                "CDUs@odata.count": {
190                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
191                },
192                "ContainedByFacility": {
193                    "$ref": "http://redfish.dmtf.org/schemas/v1/Facility.json#/definitions/Facility",
194                    "description": "The link to the facility that contains this facility.",
195                    "longDescription": "This property shall contain a link to a resource of type `Facility` that represents the facility that contains this facility.",
196                    "readonly": false
197                },
198                "ContainsChassis": {
199                    "description": "An array of links to the outermost chassis contained within this facility.",
200                    "items": {
201                        "$ref": "http://redfish.dmtf.org/schemas/v1/Chassis.json#/definitions/Chassis"
202                    },
203                    "longDescription": "The value of this property shall be an array of links to resources of type `Chassis` that represent the outermost chassis that this facility contains.  This array shall only contain chassis instances that do not include a `ContainedBy` property within the `Links` property.  That is, only chassis instances that are not contained by another chassis.",
204                    "readonly": false,
205                    "type": "array"
206                },
207                "ContainsChassis@odata.count": {
208                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
209                },
210                "ContainsFacilities": {
211                    "description": "An array of links to other facilities contained within this facility.",
212                    "items": {
213                        "$ref": "http://redfish.dmtf.org/schemas/v1/Facility.json#/definitions/Facility"
214                    },
215                    "longDescription": "The value of this property shall be an array of links to resources of type `Facility` that represent the facilities that this facility contains.",
216                    "readonly": false,
217                    "type": "array"
218                },
219                "ContainsFacilities@odata.count": {
220                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
221                },
222                "CoolingLoops": {
223                    "description": "An array of links to the cooling loops in this facility.",
224                    "items": {
225                        "$ref": "http://redfish.dmtf.org/schemas/v1/CoolingLoop.json#/definitions/CoolingLoop"
226                    },
227                    "longDescription": "The value of this property shall contain an array of links to resources of type `CoolingLoop` that represent the cooling loops in this facility.",
228                    "readonly": false,
229                    "type": "array",
230                    "versionAdded": "v1_4_0"
231                },
232                "CoolingLoops@odata.count": {
233                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
234                },
235                "ElectricalBuses": {
236                    "description": "An array of links to the electrical buses in this facility.",
237                    "items": {
238                        "$ref": "http://redfish.dmtf.org/schemas/v1/PowerDistribution.json#/definitions/PowerDistribution"
239                    },
240                    "longDescription": "The value of this property shall contain an array of links to resources of type `PowerDistribution` that represent the electrical buses in this facility.",
241                    "readonly": false,
242                    "type": "array",
243                    "versionAdded": "v1_3_0"
244                },
245                "ElectricalBuses@odata.count": {
246                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
247                },
248                "FloorPDUs": {
249                    "description": "An array of links to the floor power distribution units in this facility.",
250                    "items": {
251                        "$ref": "http://redfish.dmtf.org/schemas/v1/PowerDistribution.json#/definitions/PowerDistribution"
252                    },
253                    "longDescription": "The value of this property shall be an array of links to resources of type `PowerDistribution` that represent the floor power distribution units in this facility.",
254                    "readonly": false,
255                    "type": "array"
256                },
257                "FloorPDUs@odata.count": {
258                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
259                },
260                "ImmersionUnits": {
261                    "description": "An array of links to the immersion cooling units in this facility.",
262                    "items": {
263                        "$ref": "http://redfish.dmtf.org/schemas/v1/CoolingUnit.json#/definitions/CoolingUnit"
264                    },
265                    "longDescription": "The value of this property shall contain an array of links to resources of type `CoolingUnit` that represent the immersion cooling units in this facility.",
266                    "readonly": false,
267                    "type": "array",
268                    "versionAdded": "v1_4_0"
269                },
270                "ImmersionUnits@odata.count": {
271                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
272                },
273                "ManagedBy": {
274                    "description": "An array of links to the managers responsible for managing this facility.",
275                    "items": {
276                        "$ref": "http://redfish.dmtf.org/schemas/v1/Manager.json#/definitions/Manager"
277                    },
278                    "longDescription": "The value of this property shall be an array of links to resources of type `Manager` that represent the managers that manager this facility.",
279                    "readonly": true,
280                    "type": "array"
281                },
282                "ManagedBy@odata.count": {
283                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
284                },
285                "Oem": {
286                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
287                    "description": "The OEM extension property.",
288                    "longDescription": "This property shall contain the OEM extensions.  All values for properties contained in this object shall conform to the Redfish Specification-described requirements."
289                },
290                "PowerShelves": {
291                    "description": "An array of links to the power shelves in this facility.",
292                    "items": {
293                        "$ref": "http://redfish.dmtf.org/schemas/v1/PowerDistribution.json#/definitions/PowerDistribution"
294                    },
295                    "longDescription": "The value of this property shall be an array of links to resources of type `PowerDistribution` that represent the power shelves in this facility.",
296                    "readonly": false,
297                    "type": "array",
298                    "versionAdded": "v1_2_0"
299                },
300                "PowerShelves@odata.count": {
301                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
302                },
303                "RackPDUs": {
304                    "description": "An array of links to the rack-level power distribution units in this facility.",
305                    "items": {
306                        "$ref": "http://redfish.dmtf.org/schemas/v1/PowerDistribution.json#/definitions/PowerDistribution"
307                    },
308                    "longDescription": "The value of this property shall be an array of links to resources of type `PowerDistribution` that represent the rack-level power distribution units in this facility.",
309                    "readonly": false,
310                    "type": "array"
311                },
312                "RackPDUs@odata.count": {
313                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
314                },
315                "Switchgear": {
316                    "description": "An array of links to the switchgear in this facility.",
317                    "items": {
318                        "$ref": "http://redfish.dmtf.org/schemas/v1/PowerDistribution.json#/definitions/PowerDistribution"
319                    },
320                    "longDescription": "The value of this property shall be an array of links to resources of type `PowerDistribution` that represent the switchgear in this facility.",
321                    "readonly": false,
322                    "type": "array"
323                },
324                "Switchgear@odata.count": {
325                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
326                },
327                "TransferSwitches": {
328                    "description": "An array of links to the transfer switches in this facility.",
329                    "items": {
330                        "$ref": "http://redfish.dmtf.org/schemas/v1/PowerDistribution.json#/definitions/PowerDistribution"
331                    },
332                    "longDescription": "The value of this property shall be an array of links to resources of type `PowerDistribution` that represent the transfer switches in this facility.",
333                    "readonly": false,
334                    "type": "array"
335                },
336                "TransferSwitches@odata.count": {
337                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
338                }
339            },
340            "type": "object"
341        },
342        "OemActions": {
343            "additionalProperties": true,
344            "description": "The available OEM-specific actions for this resource.",
345            "longDescription": "This type shall contain the available OEM-specific actions for this resource.",
346            "patternProperties": {
347                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
348                    "description": "This property shall specify a valid odata or Redfish property.",
349                    "type": [
350                        "array",
351                        "boolean",
352                        "integer",
353                        "number",
354                        "null",
355                        "object",
356                        "string"
357                    ]
358                }
359            },
360            "properties": {},
361            "type": "object"
362        }
363    },
364    "language": "en",
365    "owningEntity": "DMTF",
366    "release": "2023.1",
367    "title": "#Facility.v1_4_2.Facility"
368}