Set Guest Customization

Released in v7.0.0

Applies a customization specification in spec on the virtual machine in vm. This operation only sets the specification settings for the virtual machine. The actual customization happens inside the guest when the virtual machine is powered on. If spec has unset values, then any pending customization settings for the virtual machine are cleared. If there is a pending customization for the virtual machine and spec has valid content, then the existing customization setting will be overwritten with the new settings.

Request

URL

PUT

https://{api_host}/rest/vcenter/vm/{vm}/guest/customization

Path Parameters

Required	Parameter Name	Type	Description
required	vm	string	The unique identifier of the virtual machine that needs to be customized. The parameter must be an identifier for the resource type: VirtualMachine.

Request Body

Contains SetRequestBody of type application/json (required)

{
    "spec": {
        "name": "string",
        "spec": {
            "configuration_spec": {
                "linux_config": {
                    "domain": "string",
                    "hostname": {
                        "Guest_HostnameGenerator": "Too large to render past this point..."
                    },
                    "script_text": "string",
                    "time_zone": "string"
                },
                "windows_config": {
                    "reboot": "enum",
                    "sysprep": {
                        "Guest_WindowsSysprep": "Too large to render past this point..."
                    },
                    "sysprep_xml": "string"
                }
            },
            "global_DNS_settings": {
                "dns_servers": [
                    "string"
                ],
                "dns_suffix_list": [
                    "string"
                ]
            },
            "interfaces": [
                {
                    "adapter": {
                        "ipv4": {
                            "Guest_Ipv4": "Too large to render past this point..."
                        },
                        "ipv6": {
                            "Guest_Ipv6": "Too large to render past this point..."
                        },
                        "windows": {
                            "Guest_WindowsNetworkAdapterSettings": "Too large to render past this point..."
                        }
                    },
                    "mac_address": "string"
                }
            ]
        }
    }
}

Required	Property Name	Type	Description
required	spec	CustomizationSetSpec	The customization settings to be applied to the guest operating system.

Response

200 OK

Operation doesn't return any data structure.

Errors

Code	Returns	Description
400	Error	com.vmware.vapi.std.errors.invalid_argument : if the customization settings in spec are not valid.
401	Error	com.vmware.vapi.std.errors.unauthenticated : if the user can not be authenticated. \| com.vmware.vapi.std.errors.unauthorized : if the user doesn't have the required privileges.
404	Error	com.vmware.vapi.std.errors.not_found : if a customization specification is not found with the unique name in spec. If the virtual machine vm is not found.
409	Error	com.vmware.vapi.std.errors.not_allowed_in_current_state : if the virtual machine vm is not in a powered off state.
503	Error	com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request.
default	Error	Not available