GET – Network Interface Instance
Dependence
A NetworkInterface contains references linking NetworkAdapter, NetworkPort, and NetworkDeviceFunction resources and represents the functionality available to the containing system.
These resources are populated by Host Interface, and Extra AMI BIOS Support is needed.
Request
GET https://{{ip}}/redfish/v1/Systems/Self/NetworkInterfaces/{{NetworkInterface_instance}}
Content-Type: application/json
Response
The response of the request will be in JSON format. The properties are mentioned in the following tables.
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 | ||||
Status | Object | True | Refer to Resource Complex Types. | |||
Links | Object | True | Links for this controller. | |||
Name | Type | Read Only | Description | |||
NetworkAdapter(N) | Object | True | A reference to the collection of NetworkAdapter associated with this NetworkInterface. | |||
| NetworkDeviceFunctions(N) | Object | True | Refer to NetworkDeviceFunction | |||
| NetworkPorts(N) | Object | True | Refer to Network Port Instance Properties. | |||
| Actions | Object | True | This object will contain the actions for this resource under Oem property if any. | |||
Response example
{
"@odata.context": "/redfish/v1/$metadata#NetworkInterface.NetworkInterface",
"@odata.etag": "\"1619171738\"",
"@odata.id": "/redfish/v1/Systems/Self/NetworkInterfaces/DevType7_NIC0",
"@odata.type": "#NetworkInterface.v1_1_2.NetworkInterface",
"Description": "NetworkInterface instance",
"Id": "DevType7_NIC0",
"Links": {
"NetworkAdapter": {
"@odata.id": "/redfish/v1/Chassis/Self/NetworkAdapters/DevType7_NIC0"
}
},
"Name": "DevType7_NIC0",
"NetworkDeviceFunctions": {
"@odata.id": "/redfish/v1/Chassis/Self/NetworkAdapters/DevType7_NIC0/NetworkDeviceFunctions"
},
"NetworkPorts": {
"@odata.id": "/redfish/v1/Chassis/Self/NetworkAdapters/DevType7_NIC0/NetworkPorts"
},
"Status": {
"Health": "OK",
"State": "Disabled"
}
}