Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 683f7276576dbf0bf7770570190f6b5b4e84d4c9 / . / static / redfish / v1 / JsonSchemas / IPAddresses / index.json
blob: e595ae43eea7e3107d29f71577f0b4ab71613003 [file] [log] [blame]
Ed Tanous683f7272018-07-26 12:47:19 -0700[diff] [blame^]1{
2 "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema.v1_3_0.json",
3 "copyright": "Copyright 2014-2017 Distributed Management Task Force, Inc. (DMTF). For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
4 "definitions": {
5 "AddressState": {
6 "enum": [
7 "Preferred",
8 "Deprecated",
9 "Tentative",
10 "Failed"
11 ],
12 "enumDescriptions": {
13 "Deprecated": "This address is currently within it's valid lifetime, but is now outside of it's preferred lifetime as defined in RFC 4862.",
14 "Failed": "This address has failed Duplicate Address Detection testing as defined in RFC 4862 section 5.4 and is not currently in use.",
15 "Preferred": "This address is currently within both it's valid and preferred lifetimes as defined in RFC 4862.",
16 "Tentative": "This address is currently undergoing Duplicate Address Detection testing as defined in RFC 4862 section 5.4."
17 },
18 "type": "string"
19 },
20 "IPv4Address": {
21 "additionalProperties": false,
22 "description": "This type describes an IPv4 Address.",
23 "longDescription": "This type shall describe an IPv4 address assigned to an interface.",
24 "patternProperties": {
25 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
26 "description": "This property shall specify a valid odata or Redfish property.",
27 "type": [
28 "array",
29 "boolean",
30 "number",
31 "null",
32 "object",
33 "string"
34 ]
35 }
36 },
37 "properties": {
38 "Address": {
39 "description": "This is the IPv4 Address.",
40 "longDescription": "The value of this property shall be an IPv4 address assigned to this interface. If DHCPv4 is enabled on the interface, this property becomes read-only.",
41 "pattern": "^(?:[0-9]{1,3}\\.){3}[0-9]{1,3}$",
42 "readonly": false,
43 "type": [
44 "string",
45 "null"
46 ]
47 },
48 "AddressOrigin": {
49 "anyOf": [
50 {
51 "$ref": "#/definitions/IPv4AddressOrigin"
52 },
53 {
54 "type": "null"
55 }
56 ],
57 "description": "This indicates how the address was determined.",
58 "longDescription": "The value of this property shall be the IP address origin for this network interface.",
59 "readonly": true
60 },
61 "Gateway": {
62 "description": "This is the IPv4 gateway for this address.",
63 "longDescription": "The value of this property shall be 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.",
64 "pattern": "^(?:[0-9]{1,3}\\.){3}[0-9]{1,3}$",
65 "readonly": false,
66 "type": [
67 "string",
68 "null"
69 ]
70 },
71 "Oem": {
72 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem"
73 },
74 "SubnetMask": {
75 "anyOf": [
76 {
77 "$ref": "#/definitions/SubnetMask"
78 },
79 {
80 "type": "null"
81 }
82 ],
83 "description": "This is the IPv4 Subnet mask.",
84 "longDescription": "The value of this property shall be the IPv4 subnet mask for this address. If DHCPv4 is enabled on the interface, this property becomes read-only.",
85 "readonly": false
86 }
87 },
88 "type": "object"
89 },
90 "IPv4AddressOrigin": {
91 "enum": [
92 "Static",
93 "DHCP",
94 "BOOTP",
95 "IPv4LinkLocal"
96 ],
97 "enumDescriptions": {
98 "BOOTP": "Address is provided by a BOOTP service.",
99 "DHCP": "Address is provided by a DHCPv4 service.",
100 "IPv4LinkLocal": "Address is valid only for this network segment (link).",
101 "Static": "A static address as configured by the user."
102 },
103 "type": "string"
104 },
105 "IPv6Address": {
106 "additionalProperties": false,
107 "description": "This type describes an IPv6 Address.",
108 "longDescription": "This type shall describe an IPv6 address assigned to an interface.",
109 "patternProperties": {
110 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
111 "description": "This property shall specify a valid odata or Redfish property.",
112 "type": [
113 "array",
114 "boolean",
115 "number",
116 "null",
117 "object",
118 "string"
119 ]
120 }
121 },
122 "properties": {
123 "Address": {
124 "description": "This is the IPv6 Address.",
125 "longDescription": "This property lists an IPv6 address that is currently assigned on this interface.",
126 "readonly": false,
127 "type": [
128 "string",
129 "null"
130 ]
131 },
132 "AddressOrigin": {
133 "anyOf": [
134 {
135 "$ref": "#/definitions/IPv6AddressOrigin"
136 },
137 {
138 "type": "null"
139 }
140 ],
141 "description": "This indicates how the address was determined.",
142 "longDescription": "The value of this property shall be the IPv6 address origin for this interface.",
143 "readonly": true
144 },
145 "AddressState": {
146 "anyOf": [
147 {
148 "$ref": "#/definitions/AddressState"
149 },
150 {
151 "type": "null"
152 }
153 ],
154 "description": "The current state of this address as defined in RFC 4862.",
155 "longDescription": "Preferred and Deprecated states follow the definitions given RFC4862 Section 5.5.4. An address is in the Tentative state while undergoing Duplicate Address Detection (DAD) per RFC4862 Section 5.4. The Failed state indicates a Static addresses which did not pass DAD. A Static address in the Failed state is not in use on the network stack, and corrective action will be needed to remedy this condition.",
156 "readonly": true
157 },
158 "Oem": {
159 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem"
160 },
161 "PrefixLength": {
162 "anyOf": [
163 {
164 "$ref": "#/definitions/PrefixLength"
165 },
166 {
167 "type": "null"
168 }
169 ],
170 "description": "This is the IPv6 Address Prefix Length.",
171 "longDescription": "The value of this property shall be the IPv6 address prefix length for this interface.",
172 "readonly": true
173 }
174 },
175 "type": "object"
176 },
177 "IPv6AddressOrigin": {
178 "enum": [
179 "Static",
180 "DHCPv6",
181 "LinkLocal",
182 "SLAAC"
183 ],
184 "enumDescriptions": {
185 "DHCPv6": "Address is provided by a DHCPv6 service.",
186 "LinkLocal": "Address is valid only for this network segment (link).",
187 "SLAAC": "Address is provided by a Stateless Address AutoConfiguration (SLAAC) service.",
188 "Static": "A static address as configured by the user."
189 },
190 "type": "string"
191 },
192 "IPv6StaticAddress": {
193 "additionalProperties": false,
194 "description": "This object represents a single IPv6 static address to be assigned on a network interface.",
195 "longDescription": "This type shall represent a single IPv6 static address to be assigned on a network interface.",
196 "patternProperties": {
197 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
198 "description": "This property shall specify a valid odata or Redfish property.",
199 "type": [
200 "array",
201 "boolean",
202 "number",
203 "null",
204 "object",
205 "string"
206 ]
207 }
208 },
209 "properties": {
210 "Address": {
211 "description": "A valid IPv6 address.",
212 "longDescription": "This property provides access to a static IPv6 address that is currently assigned on a network interface.",
213 "readonly": false,
214 "type": [
215 "string",
216 "null"
217 ]
218 },
219 "Oem": {
220 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem"
221 },
222 "PrefixLength": {
223 "anyOf": [
224 {
225 "$ref": "#/definitions/PrefixLength"
226 },
227 {
228 "type": "null"
229 }
230 ],
231 "description": "The Prefix Length of this IPv6 address.",
232 "longDescription": "Provides the IPv6 network prefix length in bits for this address.",
233 "readonly": false
234 }
235 },
236 "required": [
237 "Address",
238 "PrefixLength"
239 ],
240 "type": "object"
241 },
242 "PrefixLength": {
243 "maximum": 128,
244 "minimum": 1,
245 "type": "number"
246 },
247 "SubnetMask": {
248 "pattern": "^(?:[0-9]{1,3}\\.){3}[0-9]{1,3}$",
249 "type": "string"
250 }
251 },
252 "title": "#IPAddresses.v1_0_6"
253}