This API has a deprecated equivalent from v7.0U1.
Get Guest Networking
Returns information about the network configuration in the guest operating system.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/guest/networking
Path Parameters
Path 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, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
VmGuestNetworkingInfo
of type application/json
Information about the networking configuration in the guest operating system.
{
"dns": {
"ip_addresses": [
"string"
],
"search_domains": [
"string"
]
},
"dns_values": {
"domain_name": "string",
"host_name": "string"
}
}
dns
Optional
Client DNS configuration. How DNS queries are resolved. If unset no DNS assigned value exists.
dns_values
Optional
Client DNS values. Data assigned by DNS. If unset no DNS assigned value exists.
Errors
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-GetVmGuestNetworking -Vm "MyVm"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/vm/{vm}/guest/networking
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/vcenter/vm/{vm}/guest/networking
x-vmw-doc-operation: get
Availability
Added in 7.0U2
