Developer Documentation
Get Interfaces IPv4
Released in v6.7Get IPv4 network configuration for specific NIC.
Request
URLURL
https://{api_host}/rest/appliance/networking/interfaces/{interface_name}/ipv4
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | The Network interface to query, for example, "nic0". The parameter must be an identifier for the resource type: com.vmware.appliance.networking.interfaces. |
Response
Response
Response BodyResponse Body
200 OK returns
GetResponseBody
of type application/json
This structure was autogenerated to hold a response body. It contains: The IPv4 configuration for the queried NIC.
{
"value": {
"address": "string",
"configurable": false,
"default_gateway": "string",
"mode": "enum",
"prefix": 0
}
}| Property Name | Type | Description |
|---|---|---|
| value | Ipv4Info |
The IPv4 configuration for the queried NIC. |
Errors
| Code | Returns | Description |
|---|---|---|
| default | Error | Not available |
| 404 | Error | com.vmware.vapi.std.errors.not_found : if the specified NIC is not found. | com.vmware.vapi.std.errors.error : Generic error. |
