List Guest Networking Routes
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.
Returns information about network routing in the guest operating system.
Request
URLURL
https://{api_host}/rest/vcenter/vm/{vm}/guest/networking/routes
Parameters
Parameters
string
vm
Required
Virtual machine ID
The parameter must be an identifier for the resource type: VirtualMachine.
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
VmGuestNetworkingRoutesListResponseBody
of type application/json
Information about the network routes configured in the guest operating system.
{
"value": [
{
"gateway_address": "string",
"interface_index": 0,
"network": "string",
"prefix_length": 0
}
]
}
array of
VmGuestNetworkingRoutesInfo
value
Optional
Information about the network routes configured in the guest operating system.
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/vcenter/vm/{vm}/guest/networking/routes
Errors
404
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.
