Set Guest Customization
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. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Provisioning.Customize.
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 customized. 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"
Request Body
Request Body
VmGuestCustomizationSetSpec of mimetype application/json
Required
The customization settings to be applied to the guest operating system.
{
"name": "string",
"spec": {
"configuration_spec": {
"cloud_config": {
"cloudinit": {
"metadata": "string",
"userdata": "string"
},
"type": "CLOUDINIT"
},
"linux_config": {
"domain": "string",
"hostname": {
"fixed_name": "string",
"prefix": "string",
"type": "FIXED"
},
"script_text": "string",
"time_zone": "string"
},
"windows_config": {
"reboot": "REBOOT",
"sysprep": {
"domain": {
"domain": "string",
"domain_password": "string",
"domain_username": "string",
"type": "WORKGROUP",
"workgroup": "string"
},
"gui_run_once_commands": [
"string"
],
"gui_unattended": {
"auto_logon": false,
"auto_logon_count": 0,
"password": "string",
"time_zone": 0
},
"user_data": {
"computer_name": {
"fixed_name": "string",
"prefix": "string",
"type": "FIXED"
},
"full_name": "string",
"organization": "string",
"product_key": "string"
}
},
"sysprep_xml": "string"
}
},
"global_DNS_settings": {
"dns_servers": [
"string"
],
"dns_suffix_list": [
"string"
]
},
"interfaces": [
{
"adapter": {
"ipv4": {
"gateways": [
"string"
],
"ip_address": "string",
"prefix": 0,
"type": "DHCP"
},
"ipv6": {
"gateways": [
"string"
],
"ipv6": [
{
"ip_address": "string",
"prefix": 0
}
],
"type": "DHCP"
},
"windows": {
"dns_domain": "string",
"dns_servers": [
"string"
],
"net_BIOS_mode": "USE_DHCP",
"wins_servers": [
"string"
]
}
},
"mac_address": "string"
}
]
}
}
string
name
Optional
The name of the customization specification that has be retrieved from the virtual center inventory and applied for the virtual machine. Either one of Customization.SetSpec.name or Customization.SetSpec.spec or none of them should be specified. If unset and Customization.SetSpec.spec is also unset when executing Customization.set operationg, then any pending customization for the virtual machine will be cleared.
spec
Optional
The customization specification that has to be applied for the virtual machine. Either one of Customization.SetSpec.name or Customization.SetSpec.spec or none of them should be specified. If unset and Customization.SetSpec.name is also unset when executing Customization.set operationg, then any pending customization for the virtual machine will be cleared.
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if the customization settings in spec are not valid. | com.vmware.vapi.std.errors.not_allowed_in_current_state : if the virtual machine vm is not in a powered off state.
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn’t have the required privileges.
404
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.
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
$GuestHostnameGenerator = Initialize-GuestHostnameGenerator -Type "FIXED" -FixedName "MyFixedName" -Prefix "MyPrefix"
$GuestUserData = Initialize-GuestUserData -ComputerName $GuestHostnameGenerator -FullName "MyFullName" -Organization "MyOrganization" -ProductKey "MyProductKey"
$GuestDomain = Initialize-GuestDomain -Type "WORKGROUP" -Workgroup "MyWorkgroup" -Domain "MyDomain" -DomainUsername "MyDomainUsername" -DomainPassword "MyDomainPassword"
$GuestGuiUnattended = Initialize-GuestGuiUnattended -AutoLogon $false -AutoLogonCount 0 -Password "MyPassword" -TimeZone 0
$GuestWindowsSysprep = Initialize-GuestWindowsSysprep -GuiRunOnceCommands "MyGuiRunOnceCommands" -UserData $GuestUserData -Domain $GuestDomain -GuiUnattended $GuestGuiUnattended
$GuestWindowsConfiguration = Initialize-GuestWindowsConfiguration -Reboot "REBOOT" -Sysprep $GuestWindowsSysprep -SysprepXml "MySysprepXml"
$GuestLinuxConfiguration = Initialize-GuestLinuxConfiguration -Hostname $GuestHostnameGenerator -Domain "MyDomain" -TimeZone "MyTimeZone" -ScriptText "MyScriptText"
$GuestCloudinitConfiguration = Initialize-GuestCloudinitConfiguration -Metadata "MyMetadata" -Userdata "MyUserdata"
$GuestCloudConfiguration = Initialize-GuestCloudConfiguration -Type "CLOUDINIT" -Cloudinit $GuestCloudinitConfiguration
$GuestConfigurationSpec = Initialize-GuestConfigurationSpec -WindowsConfig $GuestWindowsConfiguration -LinuxConfig $GuestLinuxConfiguration -CloudConfig $GuestCloudConfiguration
$GuestGlobalDNSSettings = Initialize-GuestGlobalDNSSettings -DnsSuffixList "MyDnsSuffixList" -DnsServers "MyDnsServers"
$GuestIpv4 = Initialize-GuestIpv4 -Type "DHCP" -IpAddress "MyIpAddress" -Prefix 0 -Gateways "MyGateways"
$GuestIpv6Address = Initialize-GuestIpv6Address -IpAddress "MyIpAddress" -Prefix 0
$GuestIpv6 = Initialize-GuestIpv6 -Type "DHCP" -Ipv6 $GuestIpv6Address -Gateways "MyGateways"
$GuestWindowsNetworkAdapterSettings = Initialize-GuestWindowsNetworkAdapterSettings -DnsServers "MyDnsServers" -DnsDomain "MyDnsDomain" -WinsServers "MyWinsServers" -NetBIOSMode "USE_DHCP"
$GuestIPSettings = Initialize-GuestIPSettings -Ipv4 $GuestIpv4 -Ipv6 $GuestIpv6 -Windows $GuestWindowsNetworkAdapterSettings
$GuestAdapterMapping = Initialize-GuestAdapterMapping -MacAddress "MyMacAddress" -Adapter $GuestIPSettings
$GuestCustomizationSpec = Initialize-GuestCustomizationSpec -ConfigurationSpec $GuestConfigurationSpec -GlobalDNSSettings $GuestGlobalDNSSettings -Interfaces $GuestAdapterMapping
$VmGuestCustomizationSetSpec = Initialize-VmGuestCustomizationSetSpec -Name "MyName" -Spec $GuestCustomizationSpec
Invoke-SetVmGuestCustomization -Vm "MyVm" -VmGuestCustomizationSetSpec $VmGuestCustomizationSetSpec
cURL Command
curl -X PUT -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"name":"string","spec":{"configuration_spec":{"cloud_config":{"cloudinit":{"metadata":"string","userdata":"string"},"type":"CLOUDINIT"},"linux_config":{"domain":"string","hostname":{"fixed_name":"string","prefix":"string","type":"FIXED"},"script_text":"string","time_zone":"string"},"windows_config":{"reboot":"REBOOT","sysprep":{"domain":{"domain":"string","domain_password":"string","domain_username":"string","type":"WORKGROUP","workgroup":"string"},"gui_run_once_commands":["string"],"gui_unattended":{"auto_logon":false,"auto_logon_count":0,"password":"string","time_zone":0},"user_data":{"computer_name":{"fixed_name":"string","prefix":"string","type":"FIXED"},"full_name":"string","organization":"string","product_key":"string"}},"sysprep_xml":"string"}},"global_DNS_settings":{"dns_servers":["string"],"dns_suffix_list":["string"]},"interfaces":[{"adapter":{"ipv4":{"gateways":["string"],"ip_address":"string","prefix":0,"type":"DHCP"},"ipv6":{"gateways":["string"],"ipv6":[{"ip_address":"string","prefix":0}],"type":"DHCP"},"windows":{"dns_domain":"string","dns_servers":["string"],"net_BIOS_mode":"USE_DHCP","wins_servers":["string"]}},"mac_address":"string"}]}}' 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: set
Availability
Added in 7.0.0
