VLAN attribute in EthernetInterface schema | Redfish Specification Forum

AMI_Mani
Tuna

AMI

Posts: 175

VLAN attribute in EthernetInterface schema Feb 3, 2020 8:51:03 GMT

Quote

Post by AMI_Mani on Feb 3, 2020 8:51:03 GMT

Hi,
As per redfish.dmtf.org/schemas/v1/EthernetInterface.v1_5_1.json, we can provide Vlan attribute in any one of form as mentioned below

VLAN: {
$ref: "http://redfish.dmtf.org/schemas/v1/VLanNetworkInterface.json#/definitions/VLAN",
description: "If this network interface supports more than one VLAN, this property is absent. VLAN collections appear in the Link section of this Resource.",
longDescription: "This property shall contain the VLAN for this interface. If this interface supports more than one VLAN, the VLAN property shall be absent and, instead, the VLAN collection link shall be present.",
},
VLANs: {
$ref: "http://redfish.dmtf.org/schemas/v1/VLanNetworkInterfaceCollection.json#/definitions/VLanNetworkInterfaceCollection",
description: "The link to a collection of VLANs, which applies only if the interface supports more than one VLAN. If this property applies, the VLANEnabled and VLANId properties do not apply.",
longDescription: "This property shall contain a link to a collection of VLAN Resources, which applies only if the interface supports more than one VLAN. If this property is present, the VLANEnabled and VLANId properties shall not be present.",
readonly: true,
}

If there is no VLAN, which form we need to use?
Do we need to show Vlanid as null, vlanenable as false if VLAN is absent for the interface?
VLAN attribute is becoming complex due to this and please explain to understand better

Thanks,
Mani

jautor
Administrator

Posts: 502

VLAN attribute in EthernetInterface schema Feb 5, 2020 23:43:27 GMT

Quote

Post by jautor on Feb 5, 2020 23:43:27 GMT

Feb 3, 2020 8:51:03 GMT AMI_Mani said:

If there is no VLAN, which form we need to use?
Do we need to show Vlanid as null, vlanenable as false if VLAN is absent for the interface?
VLAN attribute is becoming complex due to this and please explain to understand better

Thanks,
Mani

There are very few "required" properties in Redfish, as we wanted to broadly cover any product implementation. So if your product doesn't support a particular feature or option that is described by a property, you simply don't include that property in your payload. You should NOT include properties with null values - as that is reserved for error conditions or other "data temporarily unavailable" situations.

So your answer is likely that you don't include either property, if your product does not contain VLAN support.

However, if your question is about which of the two possible VLAN options in Redfish should you support - the answer is you use the individual "VLANId" and "VLANEnabled" if your product supports one VLAN, or the VLAN Resource Collection (the "VLANs" link) if your product supports multiple VLANs. And whichever of those you support, you do NOT populate the other...

Jeff

AMI_Mani
Tuna

AMI

Posts: 175

VLAN attribute in EthernetInterface schema Feb 6, 2020 18:53:41 GMT

Quote

Post by AMI_Mani on Feb 6, 2020 18:53:41 GMT

Hi Jeff,
Thanks for the details. In our implementation VLAN is supported and initially it won't be available, if user patches/Post then we will add accordingly
So first time how we can show this attribute, if we show as VLAN and user can patch only one VLAN
If we show as VLANs, user can post any number of VLAN, but for first time there won't be any VLAN available

Thanks,
Mani

jautor
Administrator

Posts: 502

VLAN attribute in EthernetInterface schema Feb 7, 2020 6:05:09 GMT

Quote

Post by jautor on Feb 7, 2020 6:05:09 GMT

Feb 6, 2020 18:53:41 GMT AMI_Mani said:

Hi Jeff,
Thanks for the details. In our implementation VLAN is supported and initially it won't be available, if user patches/Post then we will add accordingly
So first time how we can show this attribute, if we show as VLAN and user can patch only one VLAN
If we show as VLANs, user can post any number of VLAN, but for first time there won't be any VLAN available

Thanks,
Mani

If the product supports multiple VLANs, you populate the VLANs link to a VlanNetworkInterfaceCollection. If there are none configured by the user, there will be zero Members in that Resource Collection. User would POST to that Resource Collection to add/create a new VLAN configuration instance.

Jeff