GET – Ethernet Interface Instance
Request
GET https://{{ip}}/redfish/v1/Managers/{{manager_instance}}/EthernetInterfaces/{{manager_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.
Manager Ethernet Interface typically supports at max one VLAN per interface for a single BMC.
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 | The UEFI devicepath for this interface (port). Platform specific porting needs. | ||||
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 not supported, this is a read only alias of the PermanentMACAddress. Note Eventhough 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 an issue in obtaining new IP address and also change in MACAddress could result mac address collision if there is a device on the local network with the same mac address. | ||||
SpeedMbps | Number | False | The current link speed of the interface in Mbps. Note Platform specific porting needed; require specific platform libraries support and hook between the specific libraries and gami module should be added.; require specific platform libraries support and hook between the specific libraries and gami module should be added, Please refer Manager EthernetInterface under Platform specific Properties in "How to Add OEM extensions" document. | ||||
StatelessAddressAutoConfig | Object | False | This object shall contain the IPv4 and IPv6 Stateless Address Automatic Configuration (SLAAC) properties for this interface. | ||||
Name | Type | Read Only | Description | ||||
IPv4AutoConfigEnabled | Boolean | True | This property shall indicate whether IPv4 Stateless Address Au-to Configuration (SLAAC) is enabled for this interface. | ||||
IPv6AutoConfigEnabled | Boolean | True | This property shall indicate whether IPv6 Stateless Address Au-to Configuration (SLAAC) is enabled for this interface. | ||||
AutoNeg | Boolean | False | The value of this property shall be true if auto negotiation of speed and duplex is enabled on this interface and false if it is disabled. | ||||
FullDuplex | Boolean | False | The value of this property shall represent the duplex status of the Ethernet connection on this interface. | ||||
MTUSize | Number | False | The value of this property shall be the size in bytes of largest Protocol Data Unit (PDU) that can be passed in an Ethernet (MAC) frame on this interface.. MTU (Maximum Transmission Unit.) Maximum size limit is 1500 Minimum size limit is 576 | ||||
HostName | String | False | DNS Hostname without any domain information. Maximum string size limit is 64 Minimum string size limit is 2 | ||||
FQDN | String | False | This is the complete, fully qualified domain name obtained by DNS for this interface. Note DomainName should contain minimum two words with "." seperated. | ||||
MaxIPv6StaticAddresses | Number | True | This indicates the number of array items supported by Ipv6StaticAddresses. | ||||
VLAN | Object | False | If this Network Interface supports more than one VLAN, this property will not be present and the client should look for VLAN collection in the link Section of this resource. | ||||
Name | Type | Read Only | Description | ||||
VLANEnable | Boolean | False | This indicates if this VLAN is enabled. | ||||
VLANId | Number | False | This indicates the VLAN identifier for this VLAN. Minium value : 0 and Maximum value: 4094. | ||||
Ipv4Addresses | Array of Objects | True | This array of objects represents all of the Ipv4 static addresses to be assigned on this interface. Refer to Ipv4 Addresses Properties. | ||||
Ipv6Addresses | Array of Objects | True | This array of objects enumerates all of the currently assigned Ipv6 addresses on this interface. Refer to Ipv6 Addresses Properties. | ||||
Ipv6DefaultGateway | String | True | This is the Ipv6 default gateway address that is currently in use on this interface. | ||||
NameServers | Array [Items of type String] | True | This represents DNS name servers that are currently in use on this interface. | ||||
StaticNameServers | Array [Items of type String] | False | Statically-defined set of DNS server IPv4 and IPv6 addresses. | ||||
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. | ||||||
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 as given in DHCPv4 properties. | ||||
DHCPv6 | Object | False | This property shall contain the configuration of DHCP v6 as given in DHCPv6 properties. | ||||
IPv6StaticDefaultGateways | Array | False | The values in this array shall represent the IPv6 static default gateway addresses for this interface. | ||||
IPv6StaticAddresses | Array of Objects | False | The value of this property shall be an array of objects used to represent the IPv6 static connection characteristics for this interface. Refer to IPv6 Static Addresses Properties. | ||||
IPv4StaticAddresses | Array of Objects | False | The value of this property shall be an array of objects used to represent all IPv4 static addresses assigned (but not necessarily use) to this interface. Addresses in use by this interface shall also appear in the IPv4Addresses property. Refer to IPv6 Static Addresses Properties. Note Only one set of IPv4StaticAddresses can be patched multiple IPv4StaticAddresses patch is not supported. | ||||
| IPv6AddressPolicyTable | Array of Objects | False |
| ||||
Name | Type | Read Only | Description | |
Address | String | True | This is the Ipv4 address. If DHCPv4 is enabled on the interface, this property becomes read-only. | |
SubnetMask | Object | True | This is the Ipv4 address. If DHCPv4 is enabled on the interface, this property becomes read-only. String with pattern"^(?:[0-9]{1,3}\\.){3}[0-9]{1,3}$" | |
AddressOrigin | String | True | This is the Ipv4 gateway for this address. | |
Enum | Description | |||
Static | A static address as configured by the user. | |||
DHCP | Address is provided by a DHCPv4 service | |||
BOOTP | Address is provided by a BOOTP service. | |||
Ipv4LinkLocal | Address is valid only for this network segment (link). | |||
Gateway | String | True | This is the Ipv4 default gateway address for this interface. If DHCPv4 is enabled on the interface and is configured to set the Ipv4 default gateway address, this property becomes read-only. | |
Name | Type | Read Only | Description | |
Address | String | False | A static Ipv6 address that is currently assigned on a network interface. | |
PrefixLength | Number | True | Provides the Ipv6 network prefix length in bits for this address. , Max:128 Note Due to constraint of schema IPAddresses.v1_0_0.json, PrefixLength = 0 will be reported as ValidationError. | |
AddressOrigin | String | True | This is the Ipv6 address origin for this interface. | |
Enum | Description | |||
Static | A static address as configured by the user | |||
DHCPv6 | Address is provided by a DHCPv6 service. | |||
LinkLocal | Address is valid only for this network segment (link). | |||
SLAAC | Address is provided by a Stateless Address AutoConfiguration (SLAAC) service. | |||
Name | Type | Read Only | Description |
DHCPEnabled | Boolean | False | Determines whether DHCPv4 is enabled on this interface |
UseDNSServers | Boolean | True | Determines whether to use DHCPv4-supplied DNS servers. Note Only supports Northbound. |
UseGateway | Boolean | True | Determines whether to use a DHCPv4-supplied gateway. Note Only supports Northbound. |
UseDomainName | boolean | True | Determines whether to use a DHCPv4-supplied domain name. Note Only supports Northbound. |
UseNTPServers | boolean | True | Determines whether to use DHCPv4-supplied NTP servers. Note Only supports Northbound. |
UseStaticRoutes | boolean | True | Determines whether to use DHCPv4-supplied static routes. Note Only supports Northbound. |
Name | Type | Read Only | Description |
OperatingMode | boolean | False | This property shall control the operating mode of DHCPv6 on this interface. DHCPv6 stateful mode is used to configure addresses, and when it is enabled, stateless mode is also implicitly enabled. |
UseDNSServer | Boolean | True | When enabled, DNS server addresses supplied through DHCPv6 stateless mode will be used. Note Only supports Northbound. |
UseDomainName | Boolean | True | When enabled, the domain name supplied through DHCPv6 stateless mode will be used. Note Only supports Northbound. |
UseNTPServers | Boolean | True | When enabled, NTP server addresses supplied through DHCPv6 stateless mode will be used. Note Only supports Northbound. |
UseRapidCommit | Boolean | True | Determines whether to use DHCPv6 rapid commit mode for stateful mode address assignments. Do not enable in networks where more than one DHCPv6 server is configured to provide address assignments. Note Only supports Northbound. |
Name | Type | Read Only | Description |
Address | String | False | A static Ipv6 address that is currently assigned on a network interface. |
PrefixLength | Number | False | Provides the Ipv6 network prefix length in bits for this address. Min:1,Max:128 Note Due to constraint of schema IPAddresses.v1_0_0.json, PrefixLength = 0 will be reported as ValidationError. |
Oem | Object | True | StaticIPAddressIndex under Spec. |
Name | Type | Read Only | Description | ||||||||||
Address | String | False | This is the Ipv4 address. If DHCPv4 is enabled on the interface, this property becomes read-only. | ||||||||||
SubnetMask | Object | False |
| ||||||||||
| AddressOrigin | String | True | This is the Ipv4 gateway for this address.
| ||||||||||
Gateway | String | False | This is the Ipv4 default gateway address for this interface. If DHCPv4 is enabled on the interface and is configured to set the Ipv4 default gateway address, this property becomes read-only. |
Name | Type | Read Only | Description |
Address | Integer | False | This property shall contain the IPv6 label value for this table entry, as defined in RFC6724. Note Northbound only support. |
Precedence | Integer | False | This property shall contain the IPv6 precedence value for this table entry, as defined in RFC6724. Note Northbound only support. |
Prefix | Integer | False | This property shall contain the IPv6 address prefix for this table entry, as defined in RFC6724. Note Northbound only support. |