Skip to main content

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}

Request body​

None

Response body​

FieldTypeDescription

FQDN

String

The complete, fully qualified domain name for this XCC interface

EthernetInterfaceType

String

String “Physical”.

IPv6DefaultGateway

String

The current IPv6 default gateway address that is in use on this XCC interface

Id

String

The value is “NIC” in resource for BMC Ethernet interface.

The value is “ToHost" in BMC Ethernet over USB interface.

IPv6StaticAddresses

Array

An array of objects used to represent the IPv6 static connection characteristics for this XCC interface

 

IPv6StaticAddresses

Object

Array element

  

PrefixLength

Number

The Prefix Length of this IPv6 address

  

Address

String

A valid IPv6 address

AutoNeg

Boolean

Indicates if the speed and duplex are automatically negotiated and configured on this XCC interface:

  • True. Auto negotiation of speed and duplex is enabled.

  • False. Auto negotiation of speed and duplex is disabled.

IPv6AddressPolicyTable

Array

An array of objects used to represent the Address Selection Policy Table as defined in RFC 6724

 

IPv6AddressPolicyEntry

Object

Array element

  

Prefix

String

The prefix of IPv6 address.

  

Precedence

Number

Fix value “10”.

  

Label

Number

The label of IPv6 address.

SpeedMbps

String

The current speed in Mbps of this XCC interface (units: Mbit/s). This value is null when “AutoNeg” is true.

Status

Object

Expanded.

 

State

String

“Enabled” if this Ethernet interface is enabled.

 

Health

String

Null

HostName

String

The host name for this XCC interface, without any domain information.

IPv6Addresses

Array

An array of objects used to represent the IPv6 connection characteristics for this XCC interface

 

IPv6Address

Object

Array element

  

Address

String

The IPv6 Address

  

PrefixLength

Number

The IPv6 Address Prefix Length

  

AddressOrigin

String

The type of the IPv6 address origin for this XCC 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."

FullDuplex

Boolean

The duplex status of the Ethernet connection on this XCC interface. This value is null when “AutoNeg” is true.

IPv4StaticAddresses

Array

An array of objects used to represent the IPv4 connection characteristics for this XCC interface.

 

IPv4StaticAddress

Object

Array element

  

Address

String

The IPv4 Address

  

SubnetMask

String

The IPv4 Subnet mask.

  

AddressOrigin

String

Static.

  

Gateway

String

The IPv4 gateway for this address

IPv4Address

Array

An array of objects used to represent the IPv4 connection characteristics for this XCC interface

 

IPv4Address

Object

Array element

  

Address

String

the IPv4 Address

  

SubnetMask

String

the IPv4 Subnet mask.

  

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

IPv4 gateway for this address

NameServers

Array

DNS name servers that are currently in use on this XCC interface (IPv4 1st,2nd, 3rd ip address, IPv6 1st,2nd, 3rd ip address)

InterfaceEnabled

Boolean

A boolean indicating whether this interface is enabled

LinkStatus

String

The value of this property represents the current status of link.

Valid values:

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

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 in ToHost has this property.

MACAddress

String

The currently configured MAC address of the (logical port) interface.

PermanentMACAddress

String

The permanent MAC address assigned to this interface (port).

Name

String

The name of the resource

MTUSize

Number

The currently configured Maximum Transmission Unit (MTU) in bytes on this XCC interface

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.

 

VLANEnable

Boolean

The property of VLAN is Enable or not.

 

VLANId

Number

The Id of VLAN.

MaxIPv6StaticAddresses

Number

The maximum number of IPv6 static address.

DHCPv4

Object

Expanded.

 

UseDNSServers

Boolean

Use DNS servers or not.

 

UseDomainName

Boolean

Use Domain Name or not.

 

DHCPEnabled

Boolean

The DHCP is Enabled or not.

 

UseNTPServers

Boolean

Not used, always null.

 

UseGateway

Boolean

Not used, always null.

 

UseStaticRoutes

Boolean

Not used, always null.

 

FallbackAddress

String

DHCPv4 fallback address method for this interface.

Valid values: None, Static

DHCPv6

Object

Expanded

 

UseDNSServers

Boolean

Use DNS servers or not.

 

UseDomainName

Boolean

Use Domain Name or not.

 

OperatingMode

String

The operating mode is Stateful or Disabled.

 

UseNTPServers

Boolean

Not used, always null.

 

UseRapidCommit

Boolean

Not used, always null.

IPv6StaticDefaultGateways

Array

An array of objects used to represent the IPv6 static default gateway for this XCC interface.

 

Address

String

Static IPv6 default gateway address

 

PrefixLength

Integer

Fixed value “0”

StaticNameServers

Array

Items: string

Items count: 6

StatelessAddressAutoConfig

Object

Expanded

 

IPv4AutoConfigEnabled

Boolean

Not used, always null.

 

IPv6AutoConfigEnabled

Boolean

Enable IPv6 Auto Config or not.

Description

String

Manager Ethernet Interface

Status code​

HTTP Status CodeError Message ID
500InternalError

Example​

The following example JSON response is returned:

{
    "IPv6Addresses": [
        {
            "AddressState": "Preferred",
            "AddressOrigin": "SLAAC",
            "Address": "fda4:254b:323a:70:a94:efff:feaf:4d2f",
            "PrefixLength": 64
        },
        {
            "AddressState": "Preferred",
            "AddressOrigin": "LinkLocal",
            "Address": "fe80::a94:efff:feaf:4d2f",
            "PrefixLength": 64
        }
    ],
    "InterfaceEnabled": true,
    "FullDuplex": null,
    "SpeedMbps": null,
    "MaxIPv6StaticAddresses": 1,
    "IPv6DefaultGateway": "::",
    "StatelessAddressAutoConfig": {
        "IPv6AutoConfigEnabled": true,
        "IPv4AutoConfigEnabled": null
    },
    "HostName": "XCC-7Z60-1325476891",
    "AutoNeg": true,
    "StaticNameServers": [
        "0.0.0.0",
        "0.0.0.0",
        "0.0.0.0",
        "::",
        "::",
        "::"
    ],
    "Oem": {
        "Lenovo": {
            "NetworkSettingSync": true,
            "DomainName": "lenovo.com",
            "IPv6AddressAssignedby": [
                "LinkLocal",
                "DHCPv6",
                "SLAAC"
            ],
            "IPv4Enabled": true,
            "IPv6Enabled": true,
            "IPv4AddressAssignedby": "DHCPFirstThenStatic",
            "InterfaceFailoverMode": {
                "NicValue": 1,
                "FailoverMode": "None"
            },
            "InterfaceNicMode": {
                "NicMode": "Dedicated",
                "NicValue": 1
            },
            "@odata.type": "#LenovoEthernetInterface.v1_0_0.LenovoEthernetInterfaceProperties"
        }
    },
    "VLAN": {
        "VLANEnable": false,
        "VLANId": 1
    },
    "MACAddress": "08:94:ef:af:4d:2f",
    "DHCPv4": {
        "UseDNSServers": true,
        "FallbackAddress": "Static",
        "UseGateway": null,
        "UseStaticRoutes": null,
        "UseNTPServers": null,
        "DHCPEnabled": true,
        "UseDomainName": true
    },
    "Description": "Manager Ethernet Interface",
    "IPv6AddressPolicyTable": [
        {
            "Prefix": "::1/128",
            "Label": 0,
            "Precedence": 50
        },
        {
            "Prefix": "::/96",
            "Label": 3,
            "Precedence": 11
        },
        {
            "Prefix": "::ffff:0.0.0.0/96",
            "Label": 4,
            "Precedence": 35
        },
        {
            "Prefix": "2001::/32",
            "Label": 6,
            "Precedence": 10
        },
        {
            "Prefix": "2001:10::/28",
            "Label": 7,
            "Precedence": 10
        },
        {
            "Prefix": "3ffe::/16",
            "Label": 12,
            "Precedence": 1
        },
        {
            "Prefix": "2002::/16",
            "Label": 2,
            "Precedence": 30
        },
        {
            "Prefix": "fec0::/10",
            "Label": 11,
            "Precedence": 1
        },
        {
            "Prefix": "fc00::/7",
            "Label": 5,
            "Precedence": 5
        },
        {
            "Prefix": "::/0",
            "Label": 1,
            "Precedence": 40
        }
    ],
    "Name": "Manager Ethernet Interface",
    "@odata.type": "#EthernetInterface.v1_6_0.EthernetInterface",
    "@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces/NIC",
    "DHCPv6": {
        "UseDNSServers": true,
        "UseDomainName": true,
        "UseNTPServers": null,
        "UseRapidCommit": null,
        "OperatingMode": "Stateful"
    },
    "IPv6StaticAddresses": [
        {
            "Address": "::",
            "PrefixLength": 64
        }
    ],
    "Status": {
        "State": "Enabled",
        "Health": null
    },
    "LinkStatus": "LinkUp",
    "EthernetInterfaceType": "Physical",
    "@odata.etag": "\"1190210c0722731d50cf6a\"",
    "PermanentMACAddress": "08:94:ef:af:4d:2f",
    "NameServers": [
        "0.0.0.0",
        "0.0.0.0",
        "0.0.0.0",
        "::",
        "::",
        "::"
    ],
    "IPv6StaticDefaultGateways": [
        {
            "Address": "::",
            "PrefixLength": 0
        }
    ],
    "FQDN": "",
    "Id": "NIC",
    "IPv4StaticAddresses": [
        {
            "Gateway": "0.0.0.0",
            "AddressOrigin": "Static",
            "Address": "192.168.70.125",
            "SubnetMask": "255.255.255.0"
        }
    ],
    "Links": {
        "Chassis": {
            "@odata.id": "/redfish/v1/Chassis/1"
        }
    },
    "MTUSize": 1500,
    "IPv4Addresses": [
        {
            "Gateway": "192.168.1.1",
            "AddressOrigin": "DHCP",
            "Address": "192.168.1.2",
            "SubnetMask": "255.255.254.0"
        }
    ]
}