VLanNetworkInterface

Schema Definition

This resource describes the attributes of a Virtual LAN.

Properties

PropertyTypeNullableRequiredPermissionDescription
@odata.contextStringread-onlyThe OData description of a payload.
Format: uri
@odata.idStringread-onlyThe unique identifier for a resource.
Format: uri
@odata.typeStringread-onlyThe type of a resource.
Actions {Objectread-writeThe available actions for this resource.
    Oem { }Objectread-writeThe available OEM specific actions for this resource.
}
DescriptionStringYesread-onlyProvides a description of this resource and is used for commonality in the schema definitions.
IdStringGETread-onlyUniquely identifies the resource within the collection of like resources.
NameStringGETread-onlyThe name of the resource or array element.
Oem {Objectread-writeThis is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.
    EID_47597 {Objectread-writeRECS|Box VLanNetworkInterface extension
        Provider {Referenceread-onlyThe provider of this VLAN. This can either be a Port of an (Ethernet-)Switch or a EthernetInterface.
            @odata.idStringread-onlyThe unique identifier for a resource.
Format: uri
        }
        VLANNameStringYesread-writeAn optional name for the VLAN.
    }
}
VLANIdInt64YesPOSTread-writeThis indicates the VLAN identifier for this VLAN.
Minimum: 1
Maximum: 4080

Operations

GET

Request

GET /redfish/v1/Chassis/Chassis1/Switch1/VLANs/VLanNetworkInterface1
Content-Type: application/json

Response

{
    "@odata.context": "uri",
    "@odata.id": "/redfish/v1/Chassis/Chassis1/Switch1/VLANs/VLanNetworkInterface1",
    "@odata.type": "String",
    "Actions": {
        "Oem": { }
    }
    "Description": "String",
    "Id": "String",
    "Name": "String",
    "Oem": {
        "EID_47597": {
            "Provider": {
                "@odata.id": "uri"
            },
            "VLANName": "String"
        }
    }
    "VLANId": 1
}

POST

This operation is not supported on this resource and will result in the following response:

HTTP/1.1 405 Method Not Allowed

PATCH

Request

PATCH /redfish/v1/Chassis/Chassis1/Switch1/VLANs/VLanNetworkInterface1
Content-Type: application/json
{
    "Oem": {
        "EID_47597": {
            "VLANName": "String"
        }
    }
    "VLANId": 1
}

Response

HTTP/1.1 204 No Content

DELETE

Request

DELETE /redfish/v1/Chassis/Chassis1/Switch1/VLANs/VLanNetworkInterface1

Response

HTTP/1.1 204 No Content