Set Customization Specs
Sets an existing specification, possibly after retrieving (by using CustomizationSpecs.get) and editing it. if you do not have all of the privileges described as follows: - Operation execution requires VirtualMachine.Provisioning.ModifyCustSpecs.
Request
URLURL
https://{api_host}/api/vcenter/guest/customization-specs/{name}
Path Parameters
Path Parameters
string
name
Required
The name of the customization specification that needs to be set. The parameter must be an identifier for the resource type: com.vmware.vcenter.guest.CustomizationSpec.
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
GuestCustomizationSpecsSpec of mimetype application/json
Required
The new specification that will overwrite the existing specification.
{
"description": "string",
"fingerprint": "string",
"name": "string",
"spec": {
"configuration_spec": {},
"global_DNS_settings": {},
"interfaces": [
{
"adapter": {}
}
]
}
}
string
description
Required
Description of the specification.
string
fingerprint
Required
The fingerprint is a unique identifier for a given version of the configuration. Each change to the configuration will update this value. A client cannot change this value. If specified when updating a specification, the changes will only be applied if the current fingerprint matches the specified fingerprint. This field can be used to guard against updates that has happened between the specification content was read and until it is applied.
string
name
Required
Name of the specification.
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.invalid_argument : If, based on the item’s fingerprint value, the set process detects that the specification has changed since its retrieval, then the operation throws InvalidArgument exception to warn the client that he might overwrite another client’s change. If the settings in spec are not valid.
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
$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
$GuestCustomizationSpecsSpec = Initialize-GuestCustomizationSpecsSpec -Fingerprint "MyFingerprint" -Spec $GuestCustomizationSpec -Description "MyDescription" -Name "MyName"
Invoke-SetNameGuestCustomizationSpecs -Name "MyName" -GuestCustomizationSpecsSpec $GuestCustomizationSpecsSpec
cURL Command
curl -X PUT -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"description":"string","fingerprint":"string","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/guest/customization-specs/{name}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: set
Availability
Added in 7.0.0
