Get Guest Operations
Get information about the guest operation status. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires System.Read.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/guest/operations
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
VmGuestOperationsInfo
of type application/json
guest operations readiness.
{
"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.
boolean
interactive_guest_operations_ready
Required
Interactive guest operations availability. Whether or not the virtual machine is ready to process interactive guest operations.
Errors
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-GetVmGuestOperations -Vm "MyVm"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/vm/{vm}/guest/operations
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get
Availability
Added in 7.0.2.0
