GET – Ethernet Interface Instance
Dependence
This resource shall be used to represent host side NIC resources. This requires host agent support from OS and in-band communication channel.
These resources are populated by Host Interface, and Extra AMI BIOS Support is needed.
Request
GET https://{{ip}}/redfish/v1/Systems/{{system_instance}}/EthernetInterfaces/{{system_ethifc_instance}}
Content-Type: application/json
Response
The response of the request will be in JSON format. The properties are mentioned in the following table.
| Name | Type | Read Only | Description | |||
|---|---|---|---|---|---|---|
| (OData Attributes) | Refer to OData Support. | |||||
Oem | Object | OEM Extension (Optional), Refer to Resource Complex Types. | ||||
Id(M) | String | True | Refer to Resource Type Definitions | |||
Name(M) | String | True | ||||
Description | String | True | ||||
UefiDevicePath | String | True |
| |||
Status | Object | True | Refer to Resource Complex Types. | |||
InterfaceEnabled | Boolean | False | This indicates whether this interface is enabled. | |||
PermanentMACAddress | String | True | The value of this property shall be the Permanent MAC Address of this interface (port). This value is typically programmed during the manufacturing time. This address is not assignable. | |||
MACAddress | String | True | The value of this property shall be the effective current MAC Address of this interface. If an assignable MAC address is no supported, this is a read only alias of the PermanentMACAddress. Note Even though the ReadOnly attribute in Redfish schema for managers is specified as "False", In Redfish API, patching MACAddress is not allowed. Changing MACAddress will change the IP address and if user is using redfish in remote with no access to host/BMC, it will be issue in obtaining new IP address and also change in MACAddress could result in mac address collision if the a device on the local network with the same mac address. | |||
Ipv4Addresses | Array of Objects | True | This array of objects represents all the Ipv4 static addresses to be assigned on this interface. Refer to IPv4AddressesProperties. | |||
Ipv6Addresses | Array of Objects | True | This array of objects enumerates all the currently assigned Ipv6 addresses on this interface. Refer to IPv6AddressesProperties. | |||
Ipv6DefaultGateway | String | True | This is the Ipv6 default gateway address that is currently in use on this interface. | |||
VLANs(N) | Object | True | This is a reference to a collection of VLANs and is only used if the interface supports more than one VLANs. | |||
LinkStatus | String | True | The value of this property shall be the link status of this interface (port). | |||
| Enum | Description | |||||
| LinkUp | The link is available for communication on this interface. | |||||
| NoLink | There is no link or connection detected on this interface. | |||||
| LinkDown | There is no link on this interface, but the interface is connected. | |||||
Links | Object | True | The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource. | |||
| Name | Type | Read Only | Description | |||
Oem | Object | True | Refer to Resource Complex Types. | |||
Chassis(N) | Array | True | The value of this property shall be a reference to a resource of type Chassis that represent the physical container associated with this Ethernet Interface. | |||
Endpoints@odata.count | Number | True | An integer representing the number of items in a collection. | |||
Endpoints(N) | Array | True | The value of this property shall be a reference to the resources that this ethernet interface is associated with and shall reference a resource of type Endpoint. Note These will be available only as a part of FPX Product. | |||
Actions | Object | True | This object will contain the actions for this resource under Oem property if any. | |||
DHCPv4 | Object | False | This property shall contain the configuration of DHCP v4. Refer to DHCPv4Properties. | |||
DHCPv6 | Object | False | This property shall contain the configuration of DHCP v6. Refer to DHCPv6Properties. | |||