List Guest Networking Interfaces
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
Returns information about the networking interfaces in the guest operating system.
Request
URLURL
https://{api_host}/rest/vcenter/vm/{vm}/guest/networking/interfaces
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Virtual machine ID The parameter must be an identifier for the resource type: VirtualMachine. |
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Response
Response
Response BodyResponse Body
200 OK returns
VmGuestNetworkingInterfacesListResponseBody
of type application/json
Information about the interfaces configured in the guest operating system. Interfaces are ordered in a guest operating system specific determined order.
{
"value": [
{
"dns": {
"ip_addresses": [
"string"
],
"search_domains": [
"string"
]
},
"dns_values": {
"domain_name": "string",
"host_name": "string"
},
"ip": {
"dhcp": {
"ipv4_enabled": false,
"ipv6_enabled": false
},
"ip_addresses": [
{
"ip_address": "string",
"origin": "enum",
"prefix_length": 0,
"state": "enum"
}
]
},
"mac_address": "string",
"nic": "string",
"wins_servers": [
"string"
]
}
]
}| Property Name | Type | Description |
|---|---|---|
| value | array of VmGuestNetworkingInterfacesInfo |
Information about the interfaces configured in the guest operating system. Interfaces are ordered in a guest operating system specific determined order. |
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/vcenter/vm/{vm}/guest/networking/interfaces
Errors
| Code | Returns | Description |
|---|---|---|
| 503 | ErrorRest | com.vmware.vapi.std.errors.service_unavailable : if VMware Tools is not running. |
| default | ErrorRest | Not available |
| 404 | ErrorRest | com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. | com.vmware.vapi.std.errors.not_found : if the virtual machine is not found. |
