GET /aicc/network/interfaces/`{id}`

Use the method to retrieve the information about a specific Lenovo XClarity Administrator network interface.

Authentication

Authentication with username and password is required.

Request URL

GET https://{management_server_IP}/aicc/network/interfaces/{id}

where {id} is the network interface ID, such as eth0 or eth1.

Query parameters

None

Request body

None

Response codes

Code	Description
200	OK
404	Not found

Code	Description	Comments
200	OK	The request completed successfully.
404	Not found	A specified resource cannot be found. A descriptive error message is returned in the response body.
500	Internal Server Error	An internal error occurred. A descriptive error message is returned in the response body.

Response body

Attributes		Type	Description
id		String	Network interface ID (such as eth0 or eth1)
ip_addresses		Array of objects	Information about the IP addresses
	assign_method	String	Assignment method used for this IP address. This can be one of the following values. static dhcp auto
	ip	String	IPv4 or IPv6 address
	ip_linklocal	String	Identifies whether this address is an IPv6 link local address. This can be one of the following values. true. This address is an IPv6 link local address false. This address is not an IPv6 link local address
	prefix_length	Integer	Prefix length (in bits) for this IP address
	version	Integer	Type of IP address. This can be one of the following values. 4. IPv4 addresses 6. IPv6 addresses
mac_address		String	MAC address
role		Array of strings	Roles that are performed by this network interface. This can be one or more of the following values. none management osdeployment Note The first network interface (for example, eth0), is always set to management. If a second network interface (for example, eth1) is added, you can use it for OS deployment.
rpf		String	Reverse path forwarding settings on the network interface. This can be one of the following values. Disabled. Reverse path forwarding is disabled. RFC3704Strict. Checks the source address of the incoming packet against the Forwarding Information Base (FIB). If packet is received on the interface that would be use to forward the traffic to the source of the packet, then the packets are allowed to pass through. Otherwise, the packages are discarded. RFC3704Loose. Checks the source address of the incoming packet against the Forwarding Information Base (FIB). If the source address is reachable from any interface on that route, the packets are allowed to pass through. Otherwise, the packages are discarded.

The following example is returned if the request is successful.

[{
   "id": "eth0",
   "ip_addresses": [{
      "assign_method": "static",
      "ip": "fe80:0:0:0:5054:ff:fe03:4da9%2",
      "ip_linklocal": "true",
      "prefix_length": 64,
      "version": 6
   },
   {
      "assign_method": "static",
      "ip": "10.243.2.189",
      "ip_linklocal": "false",
      "prefix_length": 20,
      "version": 4
   },
   {
      "assign_method": "dhcp",
      "ip": "0::0%0",
      "ip_linklocal": "false",
      "prefix_length": 64,
      "version": 6
   }],
   "mac_address": "52:54:00:03:4D:A9",
   "role": ["management"],
   "rpf": "RFC3704Strict"
}]

Give documentation feedback

GET /aicc/network/interfaces/{id}

Authentication​

Request URL​

Query parameters​

Request body​

Response codes​

Response body​