Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 3602e232fda4a6ddac4dcf6d3a024bd5ff6e7835 / . / static / redfish / v1 / JsonSchemas / Switch / Switch.json
blob: 77838309b512959706dbceff7517f3bcaf52ed23 [file] [log] [blame]
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]1{
2 "$ref": "#/definitions/Switch",
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]3 "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
4 "copyright": "Copyright 2014-2018 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]5 "definitions": {
6 "Actions": {
7 "additionalProperties": false,
8 "description": "The available actions for this resource.",
9 "longDescription": "This type shall contain the available actions for this resource.",
10 "patternProperties": {
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]11 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]12 "description": "This property shall specify a valid odata or Redfish property.",
13 "type": [
14 "array",
15 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]16 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]17 "number",
18 "null",
19 "object",
20 "string"
21 ]
22 }
23 },
24 "properties": {
25 "#Switch.Reset": {
26 "$ref": "#/definitions/Reset"
27 },
28 "Oem": {
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]29 "$ref": "#/definitions/OemActions",
30 "description": "This property contains the available OEM specific actions for this resource.",
31 "longDescription": "This property shall contain any additional OEM actions for this resource."
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]32 }
33 },
34 "type": "object"
35 },
36 "Links": {
37 "additionalProperties": false,
38 "description": "Contains references to other resources that are related to this resource.",
39 "longDescription": "This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.",
40 "patternProperties": {
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]41 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]42 "description": "This property shall specify a valid odata or Redfish property.",
43 "type": [
44 "array",
45 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]46 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]47 "number",
48 "null",
49 "object",
50 "string"
51 ]
52 }
53 },
54 "properties": {
55 "Chassis": {
56 "$ref": "http://redfish.dmtf.org/schemas/v1/Chassis.json#/definitions/Chassis",
57 "description": "A reference to the chassis which contains this switch.",
58 "longDescription": "The value of this property shall be a reference to the resources that this switch is associated with and shall reference a resource of type Chassis.",
59 "readonly": true
60 },
61 "ManagedBy": {
62 "description": "An array of references to the managers that manage this switch.",
63 "items": {
64 "$ref": "http://redfish.dmtf.org/schemas/v1/Manager.json#/definitions/Manager"
65 },
66 "longDescription": "The value of this property shall be a reference to the resources that this switch is associated with and shall reference a resource of type Manager.",
67 "readonly": true,
68 "type": "array"
69 },
70 "ManagedBy@odata.count": {
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]71 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count"
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]72 },
73 "Oem": {
74 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
75 "description": "Oem extension object.",
76 "longDescription": "This object represents the Oem property. All values for resources described by this schema shall comply to the requirements as described in the Redfish specification."
77 }
78 },
79 "type": "object"
80 },
81 "OemActions": {
82 "additionalProperties": true,
83 "description": "The available OEM specific actions for this resource.",
84 "longDescription": "This type shall contain any additional OEM actions for this resource.",
85 "patternProperties": {
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]86 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]87 "description": "This property shall specify a valid odata or Redfish property.",
88 "type": [
89 "array",
90 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]91 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]92 "number",
93 "null",
94 "object",
95 "string"
96 ]
97 }
98 },
99 "properties": {},
100 "type": "object"
101 },
102 "Reset": {
103 "additionalProperties": false,
104 "description": "This action is used to reset this switch.",
105 "longDescription": "This action shall perform a reset of this switch.",
106 "parameters": {
107 "ResetType": {
108 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/ResetType",
109 "description": "The type of reset to be performed.",
110 "longDescription": "This parameter shall define the type of reset to be performed. The service may accept a request without the parameter and perform an implementation specific default reset."
111 }
112 },
113 "patternProperties": {
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]114 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]115 "description": "This property shall specify a valid odata or Redfish property.",
116 "type": [
117 "array",
118 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]119 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]120 "number",
121 "null",
122 "object",
123 "string"
124 ]
125 }
126 },
127 "properties": {
128 "target": {
129 "description": "Link to invoke action",
130 "format": "uri",
131 "type": "string"
132 },
133 "title": {
134 "description": "Friendly action name",
135 "type": "string"
136 }
137 },
138 "type": "object"
139 },
140 "Switch": {
141 "additionalProperties": false,
142 "description": "Switch contains properties describing a simple fabric switch.",
143 "longDescription": "This resource shall be used to represent a simple switch for a Redfish implementation.",
144 "patternProperties": {
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]145 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]146 "description": "This property shall specify a valid odata or Redfish property.",
147 "type": [
148 "array",
149 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]150 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]151 "number",
152 "null",
153 "object",
154 "string"
155 ]
156 }
157 },
158 "properties": {
159 "@odata.context": {
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]160 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context"
161 },
162 "@odata.etag": {
163 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag"
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]164 },
165 "@odata.id": {
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]166 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id"
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]167 },
168 "@odata.type": {
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]169 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/type"
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]170 },
171 "Actions": {
172 "$ref": "#/definitions/Actions",
173 "description": "The available actions for this resource.",
174 "longDescription": "The Actions property shall contain the available actions for this resource."
175 },
176 "AssetTag": {
177 "description": "The user assigned asset tag for this switch.",
178 "longDescription": "The value of this property shall be an identifying string used to track the drive for inventory purposes.",
179 "readonly": false,
180 "type": [
181 "string",
182 "null"
183 ]
184 },
185 "Description": {
186 "anyOf": [
187 {
188 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
189 },
190 {
191 "type": "null"
192 }
193 ],
194 "readonly": true
195 },
196 "DomainID": {
197 "description": "The Domain ID for this switch.",
198 "longDescription": "The value of this property shall have a scope of uniqueness within the fabric of which the switch is a member.",
199 "readonly": true,
200 "type": [
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]201 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]202 "null"
203 ]
204 },
205 "Id": {
206 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
207 "readonly": true
208 },
209 "IndicatorLED": {
210 "anyOf": [
211 {
212 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/IndicatorLED"
213 },
214 {
215 "type": "null"
216 }
217 ],
218 "description": "The state of the indicator LED, used to identify the switch.",
219 "longDescription": "This value of this property shall contain the indicator light state for the indicator light associated with this switch.",
220 "readonly": false
221 },
222 "IsManaged": {
223 "description": "This indicates whether the switch is in a managed or unmanaged state.",
224 "longDescription": "The value of this property shall be a boolean indicating whether this switch is in a managed or unmanaged state.",
225 "readonly": false,
226 "type": [
227 "boolean",
228 "null"
229 ]
230 },
231 "Links": {
232 "$ref": "#/definitions/Links",
233 "description": "Contains references to other resources that are related to this resource.",
234 "longDescription": "The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource."
235 },
236 "Location": {
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]237 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Location",
238 "description": "The Location of the switch.",
239 "longDescription": "This property shall contain location information of the associated switch."
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]240 },
241 "LogServices": {
242 "anyOf": [
243 {
244 "$ref": "http://redfish.dmtf.org/schemas/v1/LogServiceCollection.json#/definitions/LogServiceCollection"
245 },
246 {
247 "type": "null"
248 }
249 ],
250 "description": "A reference to the collection of Log Services associated with this system.",
251 "longDescription": "The value of this property shall be a link to a collection of type LogServiceCollection.",
252 "readonly": true
253 },
254 "Manufacturer": {
255 "description": "This is the manufacturer of this switch.",
256 "longDescription": "The value of this property shall be the name of the organization responsible for producing the switch. This organization might be the entity from whom the switch is purchased, but this is not necessarily true.",
257 "readonly": true,
258 "type": [
259 "string",
260 "null"
261 ]
262 },
263 "Model": {
264 "description": "The product model number of this switch.",
265 "longDescription": "This property shall indicate the model information as provided by the manufacturer of this switch.",
266 "readonly": true,
267 "type": [
268 "string",
269 "null"
270 ]
271 },
272 "Name": {
273 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
274 "readonly": true
275 },
276 "Oem": {
277 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
278 "description": "This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.",
279 "longDescription": "The value of this string shall be of the format for the reserved word *Oem*."
280 },
281 "PartNumber": {
282 "description": "The part number for this switch.",
283 "longDescription": "The value of this property shall be a part number assigned by the organization that is responsible for producing or manufacturing the switch.",
284 "readonly": true,
285 "type": [
286 "string",
287 "null"
288 ]
289 },
290 "Ports": {
291 "$ref": "http://redfish.dmtf.org/schemas/v1/PortCollection.json#/definitions/PortCollection",
292 "description": "A collection of references to the ports for this switch.",
293 "longDescription": "The value of this property shall be a reference to the resources that this switch contains and shall reference a resource of type Port.",
294 "readonly": true
295 },
296 "PowerState": {
297 "anyOf": [
298 {
299 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/PowerState"
300 },
301 {
302 "type": "null"
303 }
304 ],
305 "description": "This is the current power state of the switch.",
306 "longDescription": "The value of this property shall contain the power state of the switch.",
307 "readonly": true
308 },
309 "Redundancy": {
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]310 "autoExpand": true,
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]311 "description": "Redundancy information for the switches.",
312 "items": {
313 "$ref": "http://redfish.dmtf.org/schemas/v1/Redundancy.json#/definitions/Redundancy"
314 },
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]315 "longDescription": "The values of the properties in this array shall be used to show how this switch is grouped with other switches for form redundancy sets.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]316 "type": "array"
317 },
318 "Redundancy@odata.count": {
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]319 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count"
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]320 },
321 "SKU": {
322 "description": "This is the SKU for this switch.",
323 "longDescription": "The value of this property shall be the stock-keeping unit number for this switch.",
324 "readonly": true,
325 "type": [
326 "string",
327 "null"
328 ]
329 },
330 "SerialNumber": {
331 "description": "The serial number for this switch.",
332 "longDescription": "The value of this property shall be a manufacturer-allocated number used to identify the switch.",
333 "readonly": true,
334 "type": [
335 "string",
336 "null"
337 ]
338 },
339 "Status": {
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]340 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
341 "description": "This property describes the status and health of the resource and its children.",
342 "longDescription": "This property shall contain any status or health properties of the resource."
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]343 },
344 "SwitchType": {
345 "anyOf": [
346 {
347 "$ref": "http://redfish.dmtf.org/schemas/v1/Protocol.json#/definitions/Protocol"
348 },
349 {
350 "type": "null"
351 }
352 ],
353 "description": "The protocol being sent over this switch.",
354 "longDescription": "The value of this property shall contain the type of switch being represented by this simple switch.",
355 "readonly": true
356 },
357 "TotalSwitchWidth": {
358 "description": "The total number of lanes, phys, or other physical transport links that this switch contains.",
359 "longDescription": "The value of this property shall be the number of physical transport lanes, phys, or other physical transport links that this switch contains. For PCIe, this shall be lane count.",
360 "readonly": true,
361 "type": [
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]362 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]363 "null"
364 ]
365 }
366 },
367 "required": [
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]368 "@odata.id",
369 "@odata.type",
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]370 "Id",
371 "Name"
372 ],
373 "type": "object"
374 }
375 },
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]376 "owningEntity": "DMTF",
377 "title": "#Switch.v1_1_1.Switch"
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]378}