Set Customization Specs Deprecated
Sets an existing specification, possibly after retrieving (by using CustomizationSpecs.get) and editing it.
Request
URLURL
https://{api_host}/rest/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
GuestCustomizationSpecsSetRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"spec": {
"description": "string",
"fingerprint": "string",
"name": "string",
"spec": {
"configuration_spec": {},
"global_DNS_settings": {},
"interfaces": [
{
"adapter": {}
}
]
}
}
}
spec
Required
The new specification that will overwrite the existing 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
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"spec":{"description":"string","fingerprint":"string","name":"string","spec":{"configuration_spec":{"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}/rest/vcenter/guest/customization-specs/{name}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-new-method: put
x-vmw-doc-new-path: /api/vcenter/guest/customization-specs/{name}
x-vmw-doc-operation: set
Availability
Added in 7.0.0
