Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / bdd1c8360a29d18178297e580bbde4af9e2e60a5 / . / static / redfish / v1 / JsonSchemas / VLanNetworkInterface / index.json
blob: e51a9ca6c05d6fcbde5283b43995f907981a37b9 [file] [log] [blame]
Ed Tanous683f7272018-07-26 12:47:19 -0700[diff] [blame]1{
2 "$ref": "#/definitions/VLanNetworkInterface",
3 "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema.v1_3_0.json",
4 "copyright": "Copyright 2014-2017 Distributed Management Task Force, Inc. (DMTF). For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
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": {
11 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
12 "description": "This property shall specify a valid odata or Redfish property.",
13 "type": [
14 "array",
15 "boolean",
16 "number",
17 "null",
18 "object",
19 "string"
20 ]
21 }
22 },
23 "properties": {
24 "Oem": {
25 "$ref": "#/definitions/OemActions"
26 }
27 },
28 "type": "object"
29 },
30 "OemActions": {
31 "additionalProperties": true,
32 "description": "The available OEM specific actions for this resource.",
33 "longDescription": "This type shall contain any additional OEM actions for this resource.",
34 "patternProperties": {
35 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
36 "description": "This property shall specify a valid odata or Redfish property.",
37 "type": [
38 "array",
39 "boolean",
40 "number",
41 "null",
42 "object",
43 "string"
44 ]
45 }
46 },
47 "properties": {},
48 "type": "object"
49 },
50 "VLAN": {
51 "additionalProperties": false,
52 "description": "This type describes the attributes of a Virtual LAN.",
53 "longDescription": "This type shall contain any attributes of a Virtual LAN.",
54 "patternProperties": {
55 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
56 "description": "This property shall specify a valid odata or Redfish property.",
57 "type": [
58 "array",
59 "boolean",
60 "number",
61 "null",
62 "object",
63 "string"
64 ]
65 }
66 },
67 "properties": {
68 "VLANEnable": {
69 "description": "This indicates if this VLAN is enabled.",
70 "longDescription": "The value of this property shall be used to indicate if this VLAN is enabled for this interface.",
71 "readonly": false,
72 "type": [
73 "boolean",
74 "null"
75 ]
76 },
77 "VLANId": {
78 "anyOf": [
79 {
80 "$ref": "#/definitions/VLANId"
81 },
82 {
83 "type": "null"
84 }
85 ],
86 "description": "This indicates the VLAN identifier for this VLAN.",
87 "longDescription": "The value of this property shall be used to indicate the VLAN identifier for this VLAN.",
88 "readonly": false
89 }
90 },
91 "requiredOnCreate": [
92 "VLANEnable",
93 "VLANId"
94 ],
95 "type": "object"
96 },
97 "VLANId": {
98 "maximum": 4094,
99 "minimum": 0,
100 "type": "number"
101 },
102 "VLanNetworkInterface": {
103 "additionalProperties": false,
104 "description": "This resource describes the attributes of a Virtual LAN.",
105 "longDescription": "This resource shall contain any attributes of a Virtual LAN.",
106 "patternProperties": {
107 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
108 "description": "This property shall specify a valid odata or Redfish property.",
109 "type": [
110 "array",
111 "boolean",
112 "number",
113 "null",
114 "object",
115 "string"
116 ]
117 }
118 },
119 "properties": {
120 "@odata.context": {
121 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/context"
122 },
123 "@odata.id": {
124 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/id"
125 },
126 "@odata.type": {
127 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/type"
128 },
129 "Actions": {
130 "$ref": "#/definitions/Actions",
131 "description": "The available actions for this resource.",
132 "longDescription": "The Actions property shall contain the available actions for this resource."
133 },
134 "Description": {
135 "anyOf": [
136 {
137 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
138 },
139 {
140 "type": "null"
141 }
142 ],
143 "readonly": true
144 },
145 "Id": {
146 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
147 "readonly": true
148 },
149 "Name": {
150 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
151 "readonly": true
152 },
153 "Oem": {
154 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
155 "description": "This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.",
156 "longDescription": "The value of this string shall be of the format for the reserved word *Oem*."
157 },
158 "VLANEnable": {
159 "description": "This indicates if this VLAN is enabled.",
160 "longDescription": "The value of this property shall be used to indicate if this VLAN is enabled for this interface.",
161 "readonly": false,
162 "type": [
163 "boolean",
164 "null"
165 ]
166 },
167 "VLANId": {
168 "anyOf": [
169 {
170 "$ref": "#/definitions/VLANId"
171 },
172 {
173 "type": "null"
174 }
175 ],
176 "description": "This indicates the VLAN identifier for this VLAN.",
177 "longDescription": "The value of this property shall be used to indicate the VLAN identifier for this VLAN.",
178 "readonly": false
179 }
180 },
181 "required": [
182 "Id",
183 "Name"
184 ],
185 "requiredOnCreate": [
186 "VLANEnable",
187 "VLANId"
188 ],
189 "type": "object"
190 }
191 },
192 "title": "#VLanNetworkInterface.v1_1_1.VLanNetworkInterface"
193}