blob: 29c220c57000f0a9d6bf2850291ccc3d502395f5 [file] [log] [blame]
{
"$id": "http://redfish.dmtf.org/schemas/v1/VLanNetworkInterface.v1_3_0.json",
"$ref": "#/definitions/VLanNetworkInterface",
"$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
"copyright": "Copyright 2014-2021 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
"definitions": {
"Actions": {
"additionalProperties": false,
"description": "The available actions for this resource.",
"longDescription": "This type shall contain the available actions for this resource.",
"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": {
"Oem": {
"$ref": "#/definitions/OemActions",
"description": "The available OEM-specific actions for this resource.",
"longDescription": "This property shall contain the available OEM-specific actions for this resource.",
"versionAdded": "v1_1_0"
}
},
"type": "object"
},
"OemActions": {
"additionalProperties": true,
"description": "The available OEM-specific actions for this resource.",
"longDescription": "This type shall contain the available OEM-specific actions for this resource.",
"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": {},
"type": "object"
},
"VLAN": {
"additionalProperties": false,
"description": "The attributes of a VLAN.",
"longDescription": "This type shall contain any attributes of a VLAN.",
"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": {
"Tagged": {
"description": "An indication of whether this VLAN is tagged or untagged for this interface.",
"longDescription": "This property shall indicate whether this VLAN is tagged or untagged for this interface.",
"readonly": false,
"type": [
"boolean",
"null"
],
"versionAdded": "v1_3_0"
},
"VLANEnable": {
"description": "An indication of whether this VLAN is enabled for this VLAN network interface.",
"longDescription": "This property shall indicate whether this VLAN is enabled for this VLAN network interface.",
"readonly": false,
"type": [
"boolean",
"null"
]
},
"VLANId": {
"anyOf": [
{
"$ref": "#/definitions/VLANId"
},
{
"type": "null"
}
],
"description": "The ID for this VLAN.",
"longDescription": "This property shall contain the ID for this VLAN.",
"readonly": false
},
"VLANPriority": {
"anyOf": [
{
"$ref": "#/definitions/VLANPriority"
},
{
"type": "null"
}
],
"description": "The priority for this VLAN.",
"longDescription": "This property shall contain the priority for this VLAN.",
"readonly": false,
"versionAdded": "v1_2_0"
}
},
"requiredOnCreate": [
"VLANEnable",
"VLANId"
],
"type": "object"
},
"VLANId": {
"maximum": 4094,
"minimum": 0,
"type": "integer"
},
"VLANPriority": {
"maximum": 7,
"minimum": 0,
"type": "integer"
},
"VLanNetworkInterface": {
"additionalProperties": false,
"deprecated": "This schema has been deprecated in favor of using individual EthernetInterface resources to show VLAN information.",
"description": "The VLanNetworkInterface schema describes a VLAN network instance that is available on a manager, system, or other device.",
"longDescription": "This resource contains information for a VLAN network instance that is available on a manager, system, or other device for a Redfish implementation.",
"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": {
"@odata.context": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
},
"@odata.etag": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
},
"@odata.id": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
},
"@odata.type": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
},
"Actions": {
"$ref": "#/definitions/Actions",
"description": "The available actions for this resource.",
"longDescription": "This property shall contain the available actions for this resource.",
"versionAdded": "v1_1_0"
},
"Description": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
},
{
"type": "null"
}
],
"readonly": true
},
"Id": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
"readonly": true
},
"Name": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
"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 that this object contains shall conform to the Redfish Specification-described requirements."
},
"VLANEnable": {
"description": "An indication of whether this VLAN is enabled for this interface.",
"longDescription": "This property shall indicate whether this VLAN is enabled for this interface.",
"readonly": false,
"type": [
"boolean",
"null"
]
},
"VLANId": {
"anyOf": [
{
"$ref": "#/definitions/VLANId"
},
{
"type": "null"
}
],
"description": "The ID for this VLAN.",
"longDescription": "This property shall contain the ID for this VLAN.",
"readonly": false
},
"VLANPriority": {
"anyOf": [
{
"$ref": "#/definitions/VLANPriority"
},
{
"type": "null"
}
],
"description": "The priority for this VLAN.",
"longDescription": "This property shall contain the priority for this VLAN.",
"readonly": false,
"versionAdded": "v1_2_0"
}
},
"required": [
"@odata.id",
"@odata.type",
"Id",
"Name"
],
"requiredOnCreate": [
"VLANEnable",
"VLANId"
],
"type": "object",
"versionDeprecated": "v1_3_0"
}
},
"owningEntity": "DMTF",
"release": "2021.2",
"title": "#VLanNetworkInterface.v1_3_0.VLanNetworkInterface"
}