1{
2    "$id": "http://redfish.dmtf.org/schemas/v1/VLanNetworkInterface.v1_3_1.json",
3    "$ref": "#/definitions/VLanNetworkInterface",
4    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
5    "copyright": "Copyright 2014-2024 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                    "versionAdded": "v1_1_0"
31                }
32            },
33            "type": "object"
34        },
35        "OemActions": {
36            "additionalProperties": true,
37            "description": "The available OEM-specific actions for this resource.",
38            "longDescription": "This type shall contain the available OEM-specific actions for this resource.",
39            "patternProperties": {
40                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
41                    "description": "This property shall specify a valid odata or Redfish property.",
42                    "type": [
43                        "array",
44                        "boolean",
45                        "integer",
46                        "number",
47                        "null",
48                        "object",
49                        "string"
50                    ]
51                }
52            },
53            "properties": {},
54            "type": "object"
55        },
56        "VLAN": {
57            "additionalProperties": false,
58            "description": "The attributes of a VLAN.",
59            "longDescription": "This type shall contain any attributes of a VLAN.",
60            "patternProperties": {
61                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
62                    "description": "This property shall specify a valid odata or Redfish property.",
63                    "type": [
64                        "array",
65                        "boolean",
66                        "integer",
67                        "number",
68                        "null",
69                        "object",
70                        "string"
71                    ]
72                }
73            },
74            "properties": {
75                "Tagged": {
76                    "description": "An indication of whether this VLAN is tagged or untagged for this interface.",
77                    "longDescription": "This property shall indicate whether this VLAN is tagged or untagged for this interface.",
78                    "readonly": false,
79                    "type": [
80                        "boolean",
81                        "null"
82                    ],
83                    "versionAdded": "v1_3_0"
84                },
85                "VLANEnable": {
86                    "description": "An indication of whether this VLAN is enabled for this VLAN network interface.",
87                    "longDescription": "This property shall indicate whether this VLAN is enabled for this VLAN network interface.",
88                    "readonly": false,
89                    "type": [
90                        "boolean",
91                        "null"
92                    ]
93                },
94                "VLANId": {
95                    "anyOf": [
96                        {
97                            "$ref": "#/definitions/VLANId"
98                        },
99                        {
100                            "type": "null"
101                        }
102                    ],
103                    "description": "The ID for this VLAN.",
104                    "longDescription": "This property shall contain the ID for this VLAN.",
105                    "readonly": false
106                },
107                "VLANPriority": {
108                    "anyOf": [
109                        {
110                            "$ref": "#/definitions/VLANPriority"
111                        },
112                        {
113                            "type": "null"
114                        }
115                    ],
116                    "description": "The priority for this VLAN.",
117                    "longDescription": "This property shall contain the priority for this VLAN.",
118                    "readonly": false,
119                    "versionAdded": "v1_2_0"
120                }
121            },
122            "requiredOnCreate": [
123                "VLANEnable",
124                "VLANId"
125            ],
126            "type": "object"
127        },
128        "VLANId": {
129            "maximum": 4094,
130            "minimum": 0,
131            "type": "integer"
132        },
133        "VLANPriority": {
134            "maximum": 7,
135            "minimum": 0,
136            "type": "integer"
137        },
138        "VLanNetworkInterface": {
139            "additionalProperties": false,
140            "deprecated": "This schema has been deprecated in favor of using individual `EthernetInterface` resources to show VLAN information.",
141            "description": "The `VLanNetworkInterface` schema describes a VLAN network instance that is available on a manager, system, or other device.",
142            "longDescription": "This resource contains information for a VLAN network instance that is available on a manager, system, or other device for a Redfish implementation.",
143            "patternProperties": {
144                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
145                    "description": "This property shall specify a valid odata or Redfish property.",
146                    "type": [
147                        "array",
148                        "boolean",
149                        "integer",
150                        "number",
151                        "null",
152                        "object",
153                        "string"
154                    ]
155                }
156            },
157            "properties": {
158                "@odata.context": {
159                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
160                },
161                "@odata.etag": {
162                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
163                },
164                "@odata.id": {
165                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
166                },
167                "@odata.type": {
168                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
169                },
170                "Actions": {
171                    "$ref": "#/definitions/Actions",
172                    "description": "The available actions for this resource.",
173                    "longDescription": "This property shall contain the available actions for this resource.",
174                    "versionAdded": "v1_1_0"
175                },
176                "Description": {
177                    "anyOf": [
178                        {
179                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
180                        },
181                        {
182                            "type": "null"
183                        }
184                    ],
185                    "readonly": true
186                },
187                "Id": {
188                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
189                    "readonly": true
190                },
191                "Name": {
192                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
193                    "readonly": true
194                },
195                "Oem": {
196                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
197                    "description": "The OEM extension property.",
198                    "longDescription": "This property shall contain the OEM extensions.  All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
199                },
200                "VLANEnable": {
201                    "description": "An indication of whether this VLAN is enabled for this interface.",
202                    "longDescription": "This property shall indicate whether this VLAN is enabled for this interface.",
203                    "readonly": false,
204                    "type": [
205                        "boolean",
206                        "null"
207                    ]
208                },
209                "VLANId": {
210                    "anyOf": [
211                        {
212                            "$ref": "#/definitions/VLANId"
213                        },
214                        {
215                            "type": "null"
216                        }
217                    ],
218                    "description": "The ID for this VLAN.",
219                    "longDescription": "This property shall contain the ID for this VLAN.",
220                    "readonly": false
221                },
222                "VLANPriority": {
223                    "anyOf": [
224                        {
225                            "$ref": "#/definitions/VLANPriority"
226                        },
227                        {
228                            "type": "null"
229                        }
230                    ],
231                    "description": "The priority for this VLAN.",
232                    "longDescription": "This property shall contain the priority for this VLAN.",
233                    "readonly": false,
234                    "versionAdded": "v1_2_0"
235                }
236            },
237            "required": [
238                "@odata.id",
239                "@odata.type",
240                "Id",
241                "Name"
242            ],
243            "requiredOnCreate": [
244                "VLANEnable",
245                "VLANId"
246            ],
247            "type": "object",
248            "versionDeprecated": "v1_3_0"
249        }
250    },
251    "language": "en",
252    "owningEntity": "DMTF",
253    "release": "2021.2",
254    "title": "#VLanNetworkInterface.v1_3_1.VLanNetworkInterface"
255}