GET/PATCH– BMC Ethernet properties
Use the GET/PATCH method to retrieve properties in Ethernet interface resource for a BMC.
Request URL
https://<SMM_IPADDR>/redfish/v1/Managers/bmc/EthernetInterfaces/{eth_name}
Request body
None
Response body
Field | Type | Description | |||
|---|---|---|---|---|---|
AutoNeg | Boolean | Auto negotiate mode of ethernet interface, false. | |||
DHCPv4 | Object | Expanded | |||
DHCPEnabled | Boolean | Fall back to static mode, “None” or “Static”. | |||
FallbackAddress | String | Enable DHCP option 5 or not. | |||
UseDNSServers | Boolean | Enable DHCP option 6 or not. | |||
UseDomainName | Boolean | Enable DHCP option 42 or not. | |||
UseNTPServers | Boolean | Expanded | |||
DHCPv6 | Object | Expanded | |||
OperatingMode | String | Mode of DHCP for IPv6 protocol, “Stateless”, “Stateful”, “Enabled” or “Disabled”. | |||
UseDNSServers | Boolean | Enable DHCP option 5 or not. | |||
Description | String | “Manager network interface” | |||
EthernetInterfaceType | String | The type of interface, “Physical” or “Virtual”. | |||
FQDN | String | Fully qualified domain name that DNS obtains for this interface. | |||
FullDuplex | Boolean | An indication of whether full-duplex mode is enabled on the Ethernet connection for this interface, true or false. | |||
HostName | String | The DNS host name, without any domain information. | |||
IPv4Address | Array | Current IPv4 addresses of this interface. | |||
IPv4Address | Object | Expanded | |||
Address | String | IPv4 address | |||
AddressOrigin | String | This indicates how the address was determined, “Static” or “DHCP”. | |||
Gateway | String | IPv4 gateway address. | |||
SubnetMask | String | IPv4 subnet mask. | |||
IPv4StaticAddresses | Array | The IPv4 static addresses assigned to this interface. | |||
IPv4Address | Object | Expanded | |||
Address | String | IPv4 static address | |||
AddressOrigin | String | “Static” | |||
Gateway | String | Static IPv4 gateway. | |||
SubnetMask | String | Static IPv4 subnet mask. | |||
IPv6Addresses | Array | The IPv6 addresses currently in use by this interface. | |||
IPv6Address | Object | Expanded | |||
Address | String | IPv6 address | |||
AddressOrigin | String | This indicates how the address was determined, “Static”, “DHCPv6”, “LinkLocal” or “SLAAC”. | |||
PrefixLength | Integer | The IPv6 address prefix Length. | |||
IPv6DefaultGateway | String | IPv6 default gateway | |||
IPv6StaticAddresses | Array | The IPv6 static addresses assigned to this interface. | |||
IPv6StaticAddresses | Object | Expanded | |||
Address | String | IPv6 static address | |||
PrefixLength | Integer | Prefix length of this IPv6 staitc address. | |||
IPv6StaticDefaultGateways | Array | IPv6 static default gateway | |||
Address | String | Static Ipv6 default gateway address. | |||
Id | String | {eth_name} | |||
InterfaceEnabled | Boolean | Mode of this interface, true or false. | |||
LinkStatus | String | Link status of this interface “LinkUp”, “NoLink” or “LinkDown” . | |||
Links | Object | Link to other resource, only display in VLAN inteface. | |||
RelatedInterfaces | Object | Related link of this interface, only display in VLAN inteface. | |||
@odate.id | String | Link URL string, only display in VLAN inteface. | |||
MACAddress | String | Mac address of this interface. | |||
MTUSize | Integer | Maximum transfer unit size. | |||
MaxIPv6StaticAddresses | Integer | Maximum IPv6 static address. | |||
Name | String | “Manager Ethernet Interface” | |||
NameServers | Array | List of name servers. | |||
OEM | Object | Expanded | |||
Lenovo | Object | Expanded | |||
DDns | Boolean | Dynamic DNS mode | |||
IP6StaticNameServers | Array | IPv6 static name server list | |||
PermanentMACAddress | String | Permanent mac address. | |||
StatelessAddressAutoConfig | Object | SLAAC parameters for this interface. | |||
IPv6AutoConfigEnabled | Boolean | Indication of whether IPv6 SLAAC is enabled for this interface. | |||
StaticNameServers | Array | IPv4 static name server list | |||
Status | Object | The status and health of the resource and its subordinate or dependent resources. | |||
Health | String | “OK” / “Warning” / “Critical” | |||
State | String | “Enabled” | |||
VLAN | Object | VLAN property, only display in VLAN inteface | |||
Tagged | Boolean | VLAN tagged mode, true | |||
VLANEnable | Boolean | VLAN mode | |||
VLANId | Integer | VLAN ID | |||
REST operation — PATCH
| Operation | Properties | Comment |
| PATCH | DHCPv4/DHCPEnabled | IPv4 DHCP mode |
DHCPv4/FallbackAddress | The value only allows “Static” and “None” | |
DHCPv4/UseDNSServers | ||
DHCPv4/UseDomainName | ||
DHCPv4/ UseNTPServers | ||
DHCPv6/OperatingMode | The value only allows “Enabled” and “Disabled” | |
DHCPv6/UseDNSServers | ||
FQDN | ||
HostName | ||
Ipv4StaticAddresses | The Ipv4Addresses object could not be pacthed anymore. User should use Ipv4StaticAddresses object to change the IP address setting. | |
Ipv6StaticAddresses | ||
Ipv6StaticDefaultGateways | ||
InterfaceEnabled | ||
MACAddress | Mac address for this interface, need to reboot SMM. | |
MTUSize | ||
StatelessAddressAutoConfig/ IPv6AutoConfigEnabled | SLLAC mode allow true or false . | |
StaticNameServers | The string array for IPv4 static name server. | |
Oem/Lenovo/DDns | Dynamic DDNS mode and allow true and false. | |
Oem/Lenovo/ StaticIPv6NameServers | The string array for IPv6 static name server. |