REST API - get
  1. Operations
  2. vcenter
  3. vm
  4. guest
  5. customization

vcenter vm guest customization: get

Returns the status of the customization operation that has been applied for the virtual machine in vm. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request:

HTTP request

GET https://{server}/rest/vcenter/vm/{vm}/guest/customization

Path Parameters

Name Type Description
Required
vm string The unique identifier of the virtual machine that needs to be queried.

Response:

HTTP Status Code: 200

Representation:

{
    "value" : {
        "start_time" : "2015-01-01T22:13:05.651Z",
        "end_time" : "2015-01-01T22:13:05.651Z",
        "error" : "string",
        "status" : "PENDING"
    }
}

Response Type:

Name Type Description
bold = required
value info The status of the customization operation applied for the virtual machine.
value.status string The status of the customization operation. This attribute was added in vSphere API 7.0.0.0.

Defines the status values that can be reported for the customization operation. This enumeration was added in vSphere API 7.0.0.0. Value is one of:
PENDING: The customization process has not yet started inside the guest operating system. This constant was added in vSphere API 7.0.0.0.
RUNNING: The customization process is currently running inside the guest operating system. This constant was added in vSphere API 7.0.0.0.
SUCCEEDED: The customization process has completed successfully inside the guest operating system. This constant was added in vSphere API 7.0.0.0.
FAILED: The customizatio process has failed inside the guest operating system. This constant was added in vSphere API 7.0.0.0.
value.error string Description of the error if the vcenter.vm.guest.customization.info.status of customization operation is FAILED. This attribute was added in vSphere API 7.0.0.0.

Optional. It is only relevant when status has value [FAILED]. This field will be unset if the status is not FAILED or there is no information available for the error.
value.start_time date_time Time when the customization process has started inside the guest operating system. This attribute was added in vSphere API 7.0.0.0.

Optional. It is only relevant when status has value [RUNNING, SUCCEEDED, FAILED]. This field will be unset if the status is PENDING.
value.end_time date_time Time when the customization process has completed inside the guest operating system. This attribute was added in vSphere API 7.0.0.0.

Optional. It is only relevant when status has value [SUCCEEDED, FAILED]. This field will be unset if the status is not SUCCEEDED or FAILED.

Errors:

HTTP Status Code Type Description
404 not_found If the virtual machine vm is not found.
503 service_unavailable if the system is unable to communicate with a service to complete the request.
401 unauthenticated if the user can not be authenticated.
403 unauthorized if the user doesn't have the required privileges.