1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
|
{
"$id": "http://redfish.dmtf.org/schemas/v1/IPAddresses.v1_1_1.json",
"$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
"copyright": "Copyright 2014-2019 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
"definitions": {
"AddressState": {
"enum": [
"Preferred",
"Deprecated",
"Tentative",
"Failed"
],
"enumDescriptions": {
"Deprecated": "This address is currently within its valid lifetime but is now outside its RFC4862-defined preferred lifetime.",
"Failed": "This address has failed Duplicate Address Detection (DAD) testing, as defined in RFC4862, section 5.4, and is not currently in use.",
"Preferred": "This address is currently within both its RFC4862-defined valid and preferred lifetimes.",
"Tentative": "This address is currently undergoing Duplicate Address Detection (DAD) testing, as defined in RFC4862, section 5.4."
},
"type": "string"
},
"IPv4Address": {
"additionalProperties": false,
"description": "This type describes an IPv4 address.",
"longDescription": "This type shall describe an IPv4 address assigned to an interface.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"Address": {
"description": "The IPv4 address.",
"longDescription": "This property shall contain an IPv4 address assigned to this interface. If DHCPv4 is enabled on the interface, this property becomes read-only.",
"pattern": "^(?:[0-9]{1,3}\\.){3}[0-9]{1,3}$",
"readonly": false,
"type": [
"string",
"null"
]
},
"AddressOrigin": {
"anyOf": [
{
"$ref": "#/definitions/IPv4AddressOrigin"
},
{
"type": "null"
}
],
"description": "This indicates how the address was determined.",
"longDescription": "This property shall contain the IP address origin for this network interface.",
"readonly": true
},
"Gateway": {
"description": "The IPv4 gateway for this address.",
"longDescription": "This property shall contain the IPv4 default gateway address for this interface. If DHCPv4 is enabled on the interface and is configured to set the IPv4 default gateway address, this property becomes read-only.",
"pattern": "^(?:[0-9]{1,3}\\.){3}[0-9]{1,3}$",
"readonly": false,
"type": [
"string",
"null"
]
},
"Oem": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
"description": "The OEM extension property.",
"longDescription": "This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements."
},
"SubnetMask": {
"anyOf": [
{
"$ref": "#/definitions/SubnetMask"
},
{
"type": "null"
}
],
"description": "The IPv4 subnet mask.",
"longDescription": "This property shall contain the IPv4 subnet mask for this address. If DHCPv4 is enabled on the interface, this property becomes read-only.",
"readonly": false
}
},
"type": "object"
},
"IPv4AddressOrigin": {
"enum": [
"Static",
"DHCP",
"BOOTP",
"IPv4LinkLocal"
],
"enumDescriptions": {
"BOOTP": "A BOOTP service-provided address.",
"DHCP": "A DHCPv4 service-provided address.",
"IPv4LinkLocal": "The address is valid for only this network segment, or link.",
"Static": "A user-configured static address."
},
"type": "string"
},
"IPv6Address": {
"additionalProperties": false,
"description": "This type describes an IPv6 address.",
"longDescription": "This type shall describe an IPv6 address assigned to an interface.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"Address": {
"description": "The IPv6 address.",
"longDescription": "This property lists an IPv6 address that is currently assigned on this interface.",
"readonly": false,
"type": [
"string",
"null"
]
},
"AddressOrigin": {
"anyOf": [
{
"$ref": "#/definitions/IPv6AddressOrigin"
},
{
"type": "null"
}
],
"description": "This indicates how the address was determined.",
"longDescription": "This property shall contain the IPv6 address origin for this interface.",
"readonly": true
},
"AddressState": {
"anyOf": [
{
"$ref": "#/definitions/AddressState"
},
{
"type": "null"
}
],
"description": "The current RFC4862-defined state of this address.",
"longDescription": "This property shall contain the current RFC4862-defined state of this address. Preferred and Deprecated states follow the definitions in RFC4862, section 5.5.4. The Tentative state indicates that the address is undergoing Duplicate Address Detection (DAD), as defined in RFC4862, section 5.4. The Failed state indicates a static address that did not pass DAD. A static address in the Failed state is not in use on the network stack, and corrective action is required to remedy this condition.",
"readonly": true
},
"Oem": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
"description": "The OEM extension property.",
"longDescription": "This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements."
},
"PrefixLength": {
"anyOf": [
{
"$ref": "#/definitions/PrefixLength"
},
{
"type": "null"
}
],
"description": "The IPv6 address prefix Length.",
"longDescription": "This property shall contain the IPv6 address prefix length for this interface.",
"readonly": true
}
},
"type": "object"
},
"IPv6AddressOrigin": {
"enum": [
"Static",
"DHCPv6",
"LinkLocal",
"SLAAC"
],
"enumDescriptions": {
"DHCPv6": "A DHCPv6 service-provided address.",
"LinkLocal": "The address is valid for only this network segment, or link.",
"SLAAC": "A stateless autoconfiguration (SLAAC) service-provided address.",
"Static": "A static user-configured address."
},
"type": "string"
},
"IPv6GatewayStaticAddress": {
"additionalProperties": false,
"description": "This type represents a single IPv6 static address to be assigned on a network interface.",
"longDescription": "This type shall represent a single IPv6 static address to be assigned on a network interface.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"Address": {
"description": "A valid IPv6 address.",
"longDescription": "This property provides access to a static IPv6 address that is currently assigned on a network interface.",
"readonly": false,
"type": [
"string",
"null"
],
"versionAdded": "v1_1_0"
},
"Oem": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
"description": "The OEM extension property.",
"longDescription": "This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements.",
"versionAdded": "v1_1_0"
},
"PrefixLength": {
"anyOf": [
{
"$ref": "#/definitions/PrefixLength"
},
{
"type": "null"
}
],
"description": "The IPv6 network prefix length, in bits, for this address.",
"longDescription": "Provides the IPv6 network prefix length, in bits, for this address.",
"readonly": false,
"versionAdded": "v1_1_0"
}
},
"required": [
"Address"
],
"type": "object"
},
"IPv6StaticAddress": {
"additionalProperties": false,
"description": "This type represents a single IPv6 static address to be assigned on a network interface.",
"longDescription": "This type shall represent a single IPv6 static address to be assigned on a network interface.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"Address": {
"description": "A valid IPv6 address.",
"longDescription": "This property provides access to a static IPv6 address that is currently assigned on a network interface.",
"readonly": false,
"type": [
"string",
"null"
]
},
"Oem": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
"description": "The OEM extension property.",
"longDescription": "This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements."
},
"PrefixLength": {
"anyOf": [
{
"$ref": "#/definitions/PrefixLength"
},
{
"type": "null"
}
],
"description": "The prefix length, in bits, of this IPv6 address.",
"longDescription": "This property shall contain the IPv6 network prefix length, in bits, for this address.",
"readonly": false
}
},
"required": [
"Address",
"PrefixLength"
],
"type": "object"
},
"PrefixLength": {
"maximum": 128,
"minimum": 1,
"type": "integer"
},
"SubnetMask": {
"pattern": "^(?:[0-9]{1,3}\\.){3}[0-9]{1,3}$",
"type": "string"
}
},
"owningEntity": "DMTF",
"release": "2018.2",
"title": "#IPAddresses.v1_1_1"
}
|
