Get Interfaces
If vSphere APIs begin with /rest (vs /api), any maps are consumed/returned instead as arrays of objects, each containing a key and a value property field.
Get information about a particular network interface.
Request
URLURL
https://{api_host}/rest/appliance/networking/interfaces/{interface_name}
Parameters
Parameters
string
interface_name
Required
Network interface, for example, "nic0".
The parameter must be an identifier for the resource type: com.vmware.appliance.networking.interfaces.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
Example: b00db39f948d13ea1e59b4d6fce56389
Response
Response
Response BodyResponse Body
200 OK returns
NetworkingInterfacesGetResponseBody
of type application/json
Network interface information.
{
"value": {
"ipv4": {
"address": "string",
"configurable": false,
"default_gateway": "string",
"mode": "enum",
"prefix": 0
},
"ipv6": {
"addresses": [
{
"address": "string",
"origin": "enum",
"prefix": 0,
"status": "enum"
}
],
"autoconf": false,
"configurable": false,
"default_gateway": "string",
"dhcp": false
},
"mac": "string",
"name": "string",
"status": "enum"
}
}cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/appliance/networking/interfaces/{interface_name}
Errors
404
com.vmware.vapi.std.errors.not_found : if the specified interface is not found. | com.vmware.vapi.std.errors.error : Generic error
Interfaces Operations
get
get
