Get Guest Customization
Returns the status of the customization operation that has been applied for the virtual machine in vm. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires System.View.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/guest/customization
Path Parameters
Path Parameters
string
vm
Required
The unique identifier of the virtual machine that needs to be queried. 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
VmGuestCustomizationInfo
of type application/json
The status of the customization operation applied for the virtual machine.
{
"end_time": "string",
"error": "string",
"start_time": "string",
"status": "IDLE"
}
status
Required
The Customization.Info.Status enumerated type defines the status values that can be reported for the customization operation.
IDLE : No customization spec is applied to the guest operating system.
PENDING : The customization process has not yet started inside the guest operating system.
RUNNING : The customization process is currently running inside the guest operating system.
SUCCEEDED : The customization process has completed successfully inside the guest operating system.
FAILED : The customizatio process has failed inside the guest operating system.
Possible values are: IDLE , PENDING , RUNNING , SUCCEEDED , FAILED
string
end_time
Optional
Time when the customization process has completed inside the guest operating system. This field will be unset if the status is not SUCCEEDED or FAILED.
string
error
Optional
Description of the error if the Customization.Info.status of customization operation is FAILED. This field will be unset if the status is not FAILED or there is no information available for the error.
string
start_time
Optional
Time when the customization process has started inside the guest operating system. This field will be unset if the status is PENDING.
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn’t have the required privileges.
503
com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete 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-GetVmGuestCustomization -Vm "MyVm"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/vm/{vm}/guest/customization
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get
Availability
Added in 7.0.3.0
