The iLO Redfish Host Interface ("Virtual NIC")

iLO implements the Redfish Host Interface specification to access iLO's HTTPS resources (including the Redfish API and the Web GUI) from the host. This interface (aka Virtual NIC) is disabled by default.

When accessing iLO from the operating system through the virtual network interface, authentication is enforced even if you logged as a privileged user in the server operating system.

Managing the Virtual NIC

The status of the iLO Virtual NIC can be retrieved from Hpe Oem extension of Manager resource:

GET VNIC statusResponse body
Copy
Copied
GET /redfish/v1/Managers/1/?$select=Oem/Hpe/VirtualNICEnabled
Copy
Copied
{
    "@odata.context": "/redfish/v1/$metadata#Manager.Manager",
    "@odata.etag": "W/\"FDCF48B4\"",
    "@odata.id": "/redfish/v1/Managers/1/",
    "@odata.type": "#Manager.v1_5_1.Manager",
    "Oem": {
        "Hpe": {
            "VirtualNICEnabled": false
        }
    }
}

The Virtual NIC may be enabled in iLO either though the iLO Web GUI or by a Redfish operation. An iLO reset is required for this change to take effect.

PATCHRequest bodyResponse body
Copy
Copied
PATCH /redfish/v1/Managers/{managerId}/
Copy
Copied
{
    "Oem": {
        "Hpe": {
            "VirtualNICEnabled": true
        }
    }
}
Copy
Copied
{
    "error": {
        "code": "iLO.0.10.ExtendedInfo",
        "message": "See @Message.ExtendedInfo for more information.",
        "@Message.ExtendedInfo": [
            {
                "MessageId": "iLO.2.15.ResetRequired"
            }
        ]
    }
}
TIP

Read the User Guide to enable the Virtual NIC in the server operating system.

Using the Virtual NIC

When enabled in both the server operating system and in iLO, software running on the server operating system may access the iLO Web GUI or Redfish API using IP address 16.1.15.1. Normal authentication is required.

The configuration of the iLO virtual NIC can be retrieved with GET operation from the EthernetInterfaceCollection resource type:

GET VNIC configurationjson
Copy
Copied
GET /redfish/v1/Managers/1/EthernetInterfaces/?$filter=Name 
eq 'Manager Virtual Network Interface'
Copy
Copied
{
    "@odata.context": "/redfish/v1/$metadata#EthernetInterfaceCollection.EthernetInterfaceCollection",
    "@odata.etag": "W/\"02BD3E02\"",
    "@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces/",
    "@odata.type": "#EthernetInterfaceCollection.EthernetInterfaceCollection",
    "Description": "Configuration of Manager Network Interfaces",
    "Name": "Manager Network Interfaces",
    "Members": [
        {
            "@odata.context": "/redfish/v1/$metadata#EthernetInterface.EthernetInterface",
            "@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces/3/",
            "@odata.type": "#EthernetInterface.v1_4_1.EthernetInterface",
            "Id": "3",
            "Description": "Configuration of this Manager USB Ethernet Interface available for access from Host.",
            "IPv4Addresses": [
                {
                    "Address": "16.1.15.1",
                    "AddressOrigin": "DHCP",
                    "SubnetMask": "255.255.255.252"
                }
            ],
            "IPv4StaticAddresses": [],
            "IPv6AddressPolicyTable": [],
            "IPv6Addresses": [],
            "IPv6StaticAddresses": [],
            "IPv6StaticDefaultGateways": [],
            "InterfaceEnabled": true,
            "LinkStatus": "LinkUp",
            "Links": {
                "HostInterface": {
                    "@odata.id": "/redfish/v1/Managers/1/HostInterfaces/1/"
                }
            },
            "MACAddress": "0A:CA:FE:F0:0D:04",
            "Name": "Manager Virtual Network Interface",
            "NameServers": [],
            "Oem": {
                "Hpe": {
                    "@odata.context": "/redfish/v1/$metadata#HpeiLOEthernetNetworkInterface.HpeiLOEthernetNetworkInterface",
                    "@odata.type": "#HpeiLOEthernetNetworkInterface.v2_2_1.HpeiLOEthernetNetworkInterface",
                    "ConfigurationSettings": "Current",
                    "InterfaceType": "HostInterface",
                    "NICSupportsIPv6": false
                }
            },
            "PermanentMACAddress": "0A:CA:FE:F0:0D:04",
            "StaticNameServers": [],
            "Status": {
                "Health": "OK",
                "State": "Enabled"
            }
        }
    ],
    "Members@odata.count": 1
}
NOTE

The Virtual NIC does NOT act as a passthrough to traffic to the iLO physical network connection (iLO dedicated or shared network port). It is a separate network connection into iLO's resources.

Disabling the Virtual NIC

The Virtual NIC may be disabled either though the Web GUI or by a Redfish operation. An iLO reset is required for this change to take effect.

PATCHRequest bodyResponse body
Copy
Copied
PATCH /redfish/v1/Managers/{managerId}/
Copy
Copied
{
    "Oem": {
        "Hpe": {
            "VirtualNICEnabled": false
        }
    }
}
Copy
Copied
{
    "error": {
        "code": "iLO.0.10.ExtendedInfo",
        "message": "See @Message.ExtendedInfo for more information.",
        "@Message.ExtendedInfo": [
            {
                "MessageId": "iLO.2.15.ResetRequired"
            }
        ]
    }
}