Get Guest Identity
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.
Return information about the guest.
Request
URLURL
https://{api_host}/rest/vcenter/vm/{vm}/guest/identity
Parameters
Parameters
string
vm
Required
Identifier of the virtual machine.
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
VmGuestIdentityGetResponseBody
of type application/json
guest identification information.
{
"value": {
"family": "enum",
"host_name": "string",
"ip_address": "string",
"name": "enum"
}
}cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/vcenter/vm/{vm}/guest/identity
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.
503
com.vmware.vapi.std.errors.service_unavailable : if VMware Tools is not running.
if VMware Tools has not provided any data.
