EthernetInterface
Schema Definition
The EthernetInterface schema represents a single, logical ethernet interface or network interface controller (NIC).Properties
| Property | Type | Nullable | Required | Permission | Description |
|---|---|---|---|---|---|
| @odata.context | String | read-only | The OData description of a payload. Format: uri | ||
| @odata.id | String | read-only | The unique identifier for a resource. Format: uri | ||
| @odata.type | String | read-only | The type of a resource. | ||
| Actions { | Object | read-write | The available actions for this resource. | ||
| Oem { } | Object | read-write | The available OEM specific actions for this resource. | ||
| } | |||||
| Description | String | Yes | read-only | Provides a description of this resource and is used for commonality in the schema definitions. | |
| Id | String | GET | read-only | Uniquely identifies the resource within the collection of like resources. | |
| Links { | Object | read-write | Contains references to other resources that are related to this resource. | ||
| Oem { } | Object | read-write | Oem extension object. | ||
| } | |||||
| Name | String | GET | read-only | The name of the resource or array element. | |
| Oem { | Object | read-write | This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections. | ||
| EID_47597 { | Object | read-write | RECS|Box EthernetInterface extension | ||
| ConnectedPort { | Reference(Port) | read-only | The Port of the EthernetSwitch this interface is connected to. | ||
| @odata.id | String | read-only | The unique identifier for a resource. Format: uri | ||
| } | |||||
| MaxSpeedMbps | Int64 | Yes | read-only | This is the maximum speed in Mbps of this interface. Unit: Mbit/s | |
| Provider { | Reference(ComputerSystem) | read-only | The ComputerSystem providing this EthernetInterface. | ||
| @odata.id | String | read-only | The unique identifier for a resource. Format: uri | ||
| } | |||||
| } | |||||
| } | |||||
| PermanentMACAddress | String | Yes | read-only | This is the permanent MAC address assigned to this interface (port). Pattern: ^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$ | |
| UefiDevicePath | String | Yes | read-only | The UEFI device path for this interface. |
Operations
GET
Request
GET /redfish/v1/Chassis/Chassis1/Baseboards/Baseboard1/ComputerSystems/ComputerSystem1/EthernetInterfaces/EthernetInterface1
Content-Type: application/json
Content-Type: application/json
Response
{
"@odata.context": "uri",
"@odata.id": "/redfish/v1/Chassis/Chassis1/Baseboards/Baseboard1/ComputerSystems/ComputerSystem1/EthernetInterfaces/EthernetInterface1",
"@odata.type": "String",
"Actions": {
"Oem": { }
}
"Description": "String",
"Id": "String",
"Links": {
"Oem": { }
}
"Name": "String",
"Oem": {
"EID_47597": {
"ConnectedPort": {
"@odata.id": "/redfish/v1/Chassis/Chassis1/Switch1/Ports/Port1"
},
"MaxSpeedMbps": 0,
"Provider": {
"@odata.id": "/redfish/v1/Chassis/Chassis1/Baseboards/Baseboard1/ComputerSystems/ComputerSystem1"
}
}
}
"PermanentMACAddress": "String",
"UefiDevicePath": "String"
}
"@odata.context": "uri",
"@odata.id": "/redfish/v1/Chassis/Chassis1/Baseboards/Baseboard1/ComputerSystems/ComputerSystem1/EthernetInterfaces/EthernetInterface1",
"@odata.type": "String",
"Actions": {
"Oem": { }
}
"Description": "String",
"Id": "String",
"Links": {
"Oem": { }
}
"Name": "String",
"Oem": {
"EID_47597": {
"ConnectedPort": {
"@odata.id": "/redfish/v1/Chassis/Chassis1/Switch1/Ports/Port1"
},
"MaxSpeedMbps": 0,
"Provider": {
"@odata.id": "/redfish/v1/Chassis/Chassis1/Baseboards/Baseboard1/ComputerSystems/ComputerSystem1"
}
}
}
"PermanentMACAddress": "String",
"UefiDevicePath": "String"
}
POST
This operation is not supported on this resource and will result in the following response:
HTTP/1.1 405 Method Not Allowed
PATCH
This operation is not supported on this resource and will result in the following response:
HTTP/1.1 405 Method Not Allowed
DELETE
This operation is not supported on this resource and will result in the following response:
HTTP/1.1 405 Method Not Allowed