This API has a deprecated equivalent from v7.0U1.
Get Guest Identity
Return information about the guest.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/guest/identity
Path Parameters
Path 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, 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
VmGuestIdentityInfo of type application/json
guest identification information.
{
"family": "WINDOWS",
"full_name": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"host_name": "string",
"ip_address": "string",
"name": "enum"
}
family
Required
The GuestOSFamily enumerated type defines the valid guest operating system family types reported by a virtual machine.
WINDOWS : Windows operating system
LINUX : Linux operating system
NETWARE : Novell Netware
SOLARIS : Solaris operating system
DARWIN : Mac OS operating system
OTHER : Other operating systems
Possible values are: WINDOWS , LINUX , NETWARE , SOLARIS , DARWIN
string
host_name
Required
Hostname of the guest operating system.
name
Required
Guest operating system identifier (short name).
Possible values are: DOS , WIN_31 , WIN_95 , WIN_98 , WIN_ME , more...
string
ip_address
Optional
IP address assigned by the guest operating system. If unset the guest does not have an IP address.
Code Samples
PowerCLI Client SDK Example
Invoke-GetVmGuestIdentity -Vm "MyVm"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/vm/{vm}/guest/identity
Errors
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
503
com.vmware.vapi.std.errors.service_unavailable : if VMware Tools is not running. if VMware Tools has not provided any data.
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/identity
x-vmw-doc-operation: get
Availability
Added in 7.0U2
