Vcenter Vm Guest CustomizationLive get

Vcenter Vm Guest CustomizationLive get

Returns the status of the last customization operation that has been applied for the virtual machine in vm.

This operation was added in vSphere API 9.0.0.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.View.
Request
URI
GET
https://{api_host}/api/vcenter/vm/{vm}/guest/customization-live
COPY
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.

Authentication
This operation uses the following authentication methods.
Responses
200

The status of the customization operation applied for the virtual machine.

Returns Vcenter Vm Guest CustomizationLive Info of type(s) application/json 
{
    "status": "string",
    "error": {
        "id": "string",
        "default_message": "string",
        "args": [
            "string"
        ],
        "params": {
            "params": {
                "s": "string",
                "dt": "string",
                "i": 0,
                "d": "number",
                "l": "Vapi Std NestedLocalizableMessage Object",
                "format": "string",
                "precision": 0
            }
        },
        "localized": "string"
    },
    "start_time": "string",
    "end_time": "string"
}
string
status
Required

The status of the customization operation.

For more information see: Vcenter Vm Guest CustomizationLive Info Status.

This property was added in vSphere API 9.0.0.0.

error
Optional

Description of the error if the Vcenter Vm Guest CustomizationLive Info.status of customization operation is Vcenter Vm Guest CustomizationLive Info Status.FAILED.

This property was added in vSphere API 9.0.0.0.

This property will be missing or null if the status is not FAILED or there is no information available for the error.

string As date-time As date-time
start_time
Optional

Time when the customization process has started inside the guest operating system.

This property was added in vSphere API 9.0.0.0.

This property will be missing or null if the status is NOT_AVAILABLE .

string As date-time As date-time
end_time
Optional

Time when the customization process has completed inside the guest operating system.

This property was added in vSphere API 9.0.0.0.

This property will be missing or null if the status is not SUCCEEDED or FAILED.


401

if the user can not be authenticated.

Returns Vapi Std Errors Unauthenticated of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthenticated0 
"Vapi Std Errors Unauthenticated Object"
string
challenge
Optional

Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.

For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"

This property was added in vSphere API 7.0.0.0.

This property is optional because it was added in a newer version than its parent node.


403

if the user doesn't have the required privileges.

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

404

If the virtual machine vm 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 system is unable to communicate with a service to complete the request.

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/customization-live
On This Page
Vcenter Operations
GET
Vcenter Vm Guest CustomizationLive get
POST
Vcenter Vm Guest CustomizationLive run$Task