GET – BMC Ethernet properties

Use the GET method to retrieve properties in Ethernet interface resource for a BMC.

Request URL

GET https://<BMC_IPADDR>/redfish/v1/Managers/1/EthernetInterfaces/{NIC, ToHost, NIC2}

Request body

None

Response body

Field			Type	Description
Id			String	The value is “NIC” or “NIC2” in resource for BMC Ethernet interface. The value is “ToHost” in BMC Ethernet over USB interface.
Name			String	The name of the resource
Description			String	Manager Ethernet Interface
Links			Object	Expanded.
	Chassis		Link	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.
	HostInterface		Link	The value of this property shall be a reference to a resource of type HostInterface which represents the interface used by a host to communicate with a Manager. Only “ToHost” has this property.
AutoNeg			Boolean	Indicates if the speed and duplex are automatically negotiated and configured on this XCC3 interface: True. Auto negotiation of speed and duplex is enabled. False. Auto negotiation of speed and duplex is disabled.
FullDuplex			Boolean	The duplex status of the Ethernet connection on this XCC3 interface. This value is null when “AutoNeg” is true.
SpeedMbps			String	The current speed in Mbps of this XCC3 interface (units: Mbit/s). This value is null when “AutoNeg” is true.
EthernetInterfaceType			String	Physical
FQDN			String	The complete, fully qualified domain name for this XCC3 interface. It is an empty string in ToHost.
MTUSize			Number	The currently configured Maximum Transmission Unit (MTU) in bytes on this XCC3 interface
HostName			String	The host name for this XCC3 interface, without any domain information. It is an empty string in ToHost.
InterfaceEnabled			Boolean	A boolean indicating whether this interface is enabled
LinkStatus			String	The value of this property represents the current status of link. 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.
MACAddress			String	The currently configured MAC address of the (logical port) interface.
PermanentMACAddress			String	The permanent MAC address assigned to this interface (port).
MaxIPv6StaticAddresses			Number	The maximum number of IPv6 static address. Fixed value “0” in ToHost.
Status			Object	Expanded.
	State		String	“Enabled” if this Ethernet interface is enabled.
	Health		String	OK
DHCPv4			Object	Expanded.
	DHCPEnabled		Boolean	The DHCP is Enabled or not.
	FallbackAddress		String	DHCPv4 fallback address method for this interface. Valid values: None, Static
	UseDNSServers		Boolean	Use DNS servers or not.
	UseDomainName		Boolean	Use Domain Name or not.
DHCPv6			Object	Expanded.
	OperatingMode		String	The operating mode is “Enabled” or “Disabled”.
	UseDNSServers		Boolean	Use DNS servers or not.
	UseDomainName		Boolean	Use Domain Name or not.
IPv4Address			Array	An array of objects used to represent the IPv4 connection characteristics for this XCC3 interface.
	IPv4Address[N]		String	Expanded.
		Address	String	the IPv4 Address
		AddressOrigin	String	This indicates how the address was determined: 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	the IPv4 gateway for this address
		SubnetMask	String	the IPv4 Subnet mask.
IPv4StaticAddresses			Array	An array of objects used to represent the IPv4 connection characteristics for this XCC3 interface.
	IPv4StaticAddress[0]		Object	Array element
		Address	String	The IPv4 Address
		AddressOrigin	String	Static.
		Gateway	String	The IPv4 gateway for this address
		SubnetMask	String	The IPv4 Subnet mask.
IPv6Addresses			Array	An array of objects used to represent the IPv6 connection characteristics for this XCC3 interface
	IPv6Address[N]		Object	Array element
		Address	String	The IPv6 Address
		AddressOrigin	String	The type of the IPv6 address origin for this XCC3 interface: 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.
		AddressState	String	The current state of this address as defined in RFC 4862: Preferred. This address is currently within both it's valid and preferred lifetimes as defined in RFC 4862. Deprecated. This address is currently within it's valid lifetime, but is now outside of it's preferred lifetime as defined in RFC 4862. Tentative. This address is currently undergoing Duplicate Address Detection testing as defined in RFC 4862 section 5.4. Failed. This address has failed Duplicate Address Detection testing as defined in RFC 4862 section 5.4 and is not currently in use."
		PrefixLength	Number	The IPv6 Address Prefix Length
IPv6StaticAddresses			Array	An array of objects used to represent the IPv6 static connection characteristics for this XCC3 interface. This property is not available in ToHost.
	IPv6StaticAddresses[0]		Object	Expanded.
		Address	String	A valid IPv6 address
		PrefixLength	Number	The Prefix Length of this IPv6 address
IPv6DefaultGateway			String	The current IPv6 default gateway address that is in use on this XCC3 interface. This property is not available in ToHost.
IPv6StaticDefaultGateways			Array	An array of objects used to represent the IPv6 static default gateway for this XCC3 interface.
	IPv6StaticDefaultGateways[0]		Object	Expanded.
		Address	String	A valid IPv6 address
		PrefixLength	Number	0
IPv6AddressPolicyTable			Array	An array of objects used to represent the Address Selection Policy Table as defined in RFC 6724
	IPv6AddressPolicyTable[N]		Object	Array element
		Label	Number	The label of IPv6 address.
		Precedence	Number	The IPv6 precedence, as defined in RFC6724, section 2.1.
		Prefix	String	The prefix of IPv6 address.
NameServers			Array	DNS name servers that are currently in use on this XCC3 interface (IPv4 1st,2nd, 3rd ip address, IPv6 1st,2nd, 3rd ip address). It is an empty array in ToHost.
StaticNameServers			Array	The statically-defined set of DNS server IPv4 and IPv6 addresses. Items: string Items count: 6
StatelessAddressAutoConfig			Object	Expanded.
	IPv6AutoConfigEnabled		Boolean	Enable IPv6 Auto Config or not.
VLAN			Link	The value of this property shall be the VLAN for this interface. If this interface supports more than one VLAN, the VLAN property shall not be present and the VLANS collection link shall be present instead. This property is not available in ToHost.
	VLANEnable		Boolean	The property of VLAN is Enable or not.
	VLANId		Number	The Id of VLAN.

Status code

HTTP Status Code	Error Message ID
500	InternalError

Example

The following example JSON response is returned:

{
    "@odata.context": "/redfish/v1/$metadata#EthernetInterface.EthernetInterface",
    "@odata.etag": "\"49BD5FDF\"",
    "@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces/NIC",
    "@odata.type": "#EthernetInterface.v1_8_0.EthernetInterface",
    "AutoNeg": true,
    "DHCPv4": {
        "DHCPEnabled": true,
        "FallbackAddress": "Static",
        "UseDNSServers": true,
        "UseDomainName": true
    },
    "DHCPv6": {
        "OperatingMode": "Enabled",
        "UseDNSServers": true,
        "UseDomainName": true
    },
    "Description": "Manager Ethernet Interface",
    "EthernetInterfaceType": "Physical",
    "FQDN": "XCC-7DGC-BHSFW2U005.labs.lenovo.com",
    "FullDuplex": true,
    "HostName": "XCC-7DGC-BHSFW2U005",
    "IPv4Addresses": [
        {
            "Address": "10.245.22.181",
            "AddressOrigin": "DHCP",
            "Gateway": "10.245.20.1",
            "SubnetMask": "255.255.252.0"
        }
    ],
    "IPv4StaticAddresses": [
        {
            "Address": "192.168.70.125",
            "AddressOrigin": "Static",
            "Gateway": "0.0.0.0",
            "SubnetMask": "255.255.255.0"
        }
    ],
    "IPv6AddressPolicyTable": [
        {
            "Label": 0,
            "Precedence": 50,
            "Prefix": "::1/128"
        },
        {
            "Label": 3,
            "Precedence": 1,
            "Prefix": "::/96"
        }
    ],
    "IPv6Addresses": [
        {
            "Address": "fec0:bd02::c6c6:e6ff:fe88:bfb6",
            "AddressOrigin": "SLAAC",
            "AddressState": "Preferred",
            "PrefixLength": 64
        },
        {
            "Address": "fe80::c6c6:e6ff:fe88:bfb6",
            "AddressOrigin": "LinkLocal",
            "AddressState": "Preferred",
            "PrefixLength": 64
        }
    ],
    "IPv6DefaultGateway": "fe80::5eb1:2eff:fe93:4953",
    "IPv6StaticAddresses": [
        {
            "Address": "::",
            "PrefixLength": 64
        }
    ],
    "IPv6StaticDefaultGateways": [
        {
            "Address": "::",
            "PrefixLength": 0
        }
    ],
    "Id": "NIC",
    "InterfaceEnabled": true,
    "LinkStatus": "LinkUp",
    "Links": {
        "Chassis": {
            "@odata.id": "/redfish/v1/Chassis/1"
        }
    },
    "MACAddress": "c4:c6:e6:88:bf:b6",
    "MTUSize": 1500,
    "MaxIPv6StaticAddresses": 1,
    "Name": "Manager Ethernet Interface",
    "NameServers": [
        "10.245.255.223",
        "10.245.255.224"
    ],
    "Oem": {
        ...
        }
    },
    "PermanentMACAddress": "c4:c6:e6:88:bf:b6",
    "SpeedMbps": 10,
    "StatelessAddressAutoConfig": {
        "IPv6AutoConfigEnabled": true
    },
    "StaticNameServers": [
        "0.0.0.0",
        "0.0.0.0",
        "0.0.0.0",
        "::",
        "::",
        "::"
    ],
    "Status": {
        "Health": "OK",
        "State": "Enabled"
    },
    "VLAN": {
        "VLANEnable": false,
        "VLANId": 1
    }
}

Give documentation feedback

GET – BMC Ethernet properties

Request URL​

Request body​

Response body​

Status code​

Example​

Request URL

Request body

Response body

Status code

Example