Vcenter Vm Guest Operations get

Vcenter Vm Guest Operations get

Get information about the guest operation status.

This operation was added in vSphere API 7.0.2.0.

Returns an authorization error if you do not have all of the privileges described as follows:

  • The resource VirtualMachine referenced by the parameter vm requires System.Read.
Request
URI
GET
https://{api_host}/api/vcenter/vm/{vm}/guest/operations
COPY
Path Parameters
string
vm
Required

Identifier of the virtual machine.

The parameter must be an identifier for the resource type: VirtualMachine.

Authentication
This operation uses the following authentication methods.
Responses
200

guest operations readiness.

Returns Vcenter Vm Guest Operations Info of type(s) application/json 
{
    "guest_operations_ready": false,
    "interactive_guest_operations_ready": false
}
boolean
guest_operations_ready
Required

Guest operations availability. Whether or not the virtual machine is ready to process guest operations.

This property was added in vSphere API 7.0.2.0.

boolean
interactive_guest_operations_ready
Required

Interactive guest operations availability. Whether or not the virtual machine is ready to process interactive guest operations.

This property was added in vSphere API 7.0.2.0.


404

if the virtual machine is not found.

Returns Vapi Std Errors NotFound of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors NotFound0 
"Vapi Std Errors NotFound Object"

503

if the state of VMware Tools is unknown.

Returns Vapi Std Errors ServiceUnavailable of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors ServiceUnavailable0 
"Vapi Std Errors ServiceUnavailable Object"

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/vcenter/vm/{vm}/guest/operations
On This Page
Vcenter Operations
GET
Vcenter Vm Guest Operations get