Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 4841191fed358da53d4c00c9866151dce54bd6a2 / . / static / redfish / v1 / JsonSchemas / AddressPool / AddressPool.json
blob: 9e3e327d2fc68f5c3f263f070de3dacbf1afa643 [file] [log] [blame]
Gunnar Mills09b9d452020-02-11 13:27:39 -0600[diff] [blame]1{
2 "$id": "http://redfish.dmtf.org/schemas/v1/AddressPool.v1_0_0.json",
3 "$ref": "#/definitions/AddressPool",
4 "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
5 "copyright": "Copyright 2014-2019 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 "AddressPool": {
35 "additionalProperties": false,
36 "description": "The schema definition of an address pool and its configuration.",
37 "longDescription": "This Resource shall represent an address pool in 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 "Description": {
71 "anyOf": [
72 {
73 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
74 },
75 {
76 "type": "null"
77 }
78 ],
79 "readonly": true
80 },
81 "GenZ": {
82 "$ref": "#/definitions/GenZ",
83 "description": "The Gen-Z related properties for this address pool.",
84 "longDescription": "This property shall contain the Gen-Z related properties to this address pool."
85 },
86 "Id": {
87 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
88 "readonly": true
89 },
90 "Links": {
91 "$ref": "#/definitions/Links",
92 "description": "The links to other Resources that are related to this Resource.",
93 "longDescription": "The Redfish Specification-described Links Property shall contain links to Resources related to but not subordinate to this Resource."
94 },
95 "Name": {
96 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
97 "readonly": true
98 },
99 "Oem": {
100 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
101 "description": "The OEM extension property.",
102 "longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
103 },
104 "Status": {
105 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
106 "description": "The status and health of the Resource and its subordinate or dependent Resources.",
107 "longDescription": "This property shall contain any status or health properties of the Resource."
108 }
109 },
110 "required": [
111 "@odata.id",
112 "@odata.type",
113 "Id",
114 "Name"
115 ],
116 "type": "object"
117 },
118 "GenZ": {
119 "additionalProperties": false,
120 "description": "Gen-Z related properties for an addres pool.",
121 "longDescription": "This type shall contain Gen-Z related properties for an addres pool.",
122 "patternProperties": {
123 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
124 "description": "This property shall specify a valid odata or Redfish property.",
125 "type": [
126 "array",
127 "boolean",
128 "integer",
129 "number",
130 "null",
131 "object",
132 "string"
133 ]
134 }
135 },
136 "properties": {
137 "AccessKey": {
138 "description": "The Access Key required for this address pool.",
139 "longDescription": "This property shall contain the Gen-Z Core Specification-defined Access Key required for this address pool.",
140 "pattern": "^0[xX]([a-fA-F]|[0-9]){2}$",
141 "readonly": false,
142 "type": [
143 "string",
144 "null"
145 ]
146 },
147 "MaxCID": {
148 "description": "The maximum value for the Component Identifier (CID).",
149 "longDescription": "This property shall contain the maximum value for the Gen-Z Core Specification-defined Component Identifier (CID).",
150 "readonly": false,
151 "type": [
152 "integer",
153 "null"
154 ]
155 },
156 "MaxSID": {
157 "description": "The maximum value for the Subnet Identifier (SID).",
158 "longDescription": "This property shall contain the maximum value for the Gen-Z Core Specification-defined Subnet Identifier (SID).",
159 "readonly": false,
160 "type": [
161 "integer",
162 "null"
163 ]
164 },
165 "MinCID": {
166 "description": "The minimum value for the Component Identifier (CID).",
167 "longDescription": "This property shall contain the minimum value for the Gen-Z Core Specification-defined Component Identifier (CID).",
168 "readonly": false,
169 "type": [
170 "integer",
171 "null"
172 ]
173 },
174 "MinSID": {
175 "description": "The minimum value for the Subnet Identifier (SID).",
176 "longDescription": "This property shall contain the minimum value for the Gen-Z Core Specification-defined Subnet Identifier (SID).",
177 "readonly": false,
178 "type": [
179 "integer",
180 "null"
181 ]
182 }
183 },
184 "type": "object"
185 },
186 "Links": {
187 "additionalProperties": false,
188 "description": "The links to other Resources that are related to this Resource.",
189 "longDescription": "The Redfish Specification-described type shall contain links to Resources related to but not subordinate to this Resource.",
190 "patternProperties": {
191 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
192 "description": "This property shall specify a valid odata or Redfish property.",
193 "type": [
194 "array",
195 "boolean",
196 "integer",
197 "number",
198 "null",
199 "object",
200 "string"
201 ]
202 }
203 },
204 "properties": {
205 "Endpoints": {
206 "description": "An array of links to the endpoints that this address pool contains.",
207 "items": {
208 "$ref": "http://redfish.dmtf.org/schemas/v1/Endpoint.json#/definitions/Endpoint"
209 },
210 "longDescription": "This property shall contain an array of links to Resources of type Endpoint that this address pool contains.",
211 "readonly": true,
212 "type": "array"
213 },
214 "Endpoints@odata.count": {
215 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
216 },
217 "Oem": {
218 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
219 "description": "The OEM extension property.",
220 "longDescription": "This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements."
221 },
222 "Zones": {
223 "description": "An array of links to the zones that this address pool contains.",
224 "items": {
225 "$ref": "http://redfish.dmtf.org/schemas/v1/Zone.json#/definitions/Zone"
226 },
227 "longDescription": "This property shall contain an array of links to Resources of type Zone that this address pool contains.",
228 "readonly": true,
229 "type": "array"
230 },
231 "Zones@odata.count": {
232 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
233 }
234 },
235 "type": "object"
236 },
237 "OemActions": {
238 "additionalProperties": true,
239 "description": "The available OEM-specific actions for this Resource.",
240 "longDescription": "This type shall contain the available OEM-specific actions for this Resource.",
241 "patternProperties": {
242 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
243 "description": "This property shall specify a valid odata or Redfish property.",
244 "type": [
245 "array",
246 "boolean",
247 "integer",
248 "number",
249 "null",
250 "object",
251 "string"
252 ]
253 }
254 },
255 "properties": {},
256 "type": "object"
257 }
258 },
259 "owningEntity": "DMTF",
260 "release": "2019.4",
261 "title": "#AddressPool.v1_0_0.AddressPool"
262}