Obtaining Network Ports and IP Address List
Function
This interface is used to obtain the mapping between network port names and IP addresses.
Syntax
Operation type: GET
URL: https://device_ip/redfish/v1/Systems/EthIpList
Request header:
X-Auth-Token: auth_value Content-Type: header_type
Request message body: None
Usage Guidelines
None
Example
Request:
GET https://10.10.10.10/redfish/v1/Systems/EthIpList
Request header:
X-Auth-Token: auth_value Content-Type: application/json
Request message body: None
Response:
{
"@odata.context": "/redfish/v1/$metadata#Systems/EthIpList",
"@odata.id": "/redfish/v1/Systems/EthIpList",
"@odata.type": "#MindXEdgeEthIpList.v1_0_0.MindXEdgeEthIpList",
"Id": "Ethernet Ip List",
"Name": "Ethernet Ip List",
"ip_addr_list":
{
"eth0: 1": "xx.xx.xx.xx",
"eth1": "xx.xx.xx.xx"
},
"noGatewayIP": ["xx.xx.xx.xx"]
}
Response code: 200
Output Description
Field |
Type |
Description |
|---|---|---|
@odata.context |
Character string |
OData description of the network ports and IP address list. |
@odata.id |
Character string |
Access path of the network ports and IP address list. |
@odata.type |
Character string |
Resource type for network ports and IP address list. |
Id |
Character string |
Unique identifier of the network port and IP address list. |
Name |
Character string |
Names of network ports and IP address list. |
ip_addr_list |
Object |
Mapping between network device names and IP addresses |
noGatewayIP |
List |
IP addresses that do not match the default gateway and are used to restore factory settings |