Vcenter Guest CustomizationSpecs importSpecification
Converts a well formatted string to a Vcenter Guest CustomizationSpecs CreateSpec. The resulting object can be passed to POST /vcenter/guest/customization-specs operation.
This operation was added in vSphere API 7.0.0.0.
Returns an authorization error if you do not have all of the privileges described as follows:
- Operation execution requires
VirtualMachine.Provisioning.ModifyCustSpecs.
Request body for invoking operation: importSpecification
{
"customization_spec": "string"
}content to be converted to the spec.
A proper specification of type Vcenter Guest CustomizationSpecs CreateSpec
{
"spec": {
"configuration_spec": {
"windows_config": {
"reboot": "string",
"sysprep": {
"gui_run_once_commands": [
"string"
],
"user_data": {
"computer_name": {
"type": "string",
"fixed_name": "string",
"prefix": "string"
},
"full_name": "string",
"organization": "string",
"product_key": "string"
},
"domain": {
"type": "string",
"workgroup": "string",
"domain": "string",
"domain_username": "string",
"domain_password": "string",
"domain_ou": "string"
},
"gui_unattended": {
"auto_logon": false,
"auto_logon_count": 0,
"password": "string",
"time_zone": 0
}
},
"sysprep_xml": "string"
},
"linux_config": {
"hostname": {
"type": "string",
"fixed_name": "string",
"prefix": "string"
},
"domain": "string",
"time_zone": "string",
"script_text": "string",
"compatible_customization_method": "string"
},
"cloud_config": {
"type": "string",
"cloudinit": {
"metadata": "string",
"userdata": "string"
}
}
},
"global_dns_settings": {
"dns_suffix_list": [
"string"
],
"dns_servers": [
"string"
]
},
"interfaces": [
{
"mac_address": "string",
"adapter": {
"ipv4": {
"type": "string",
"ip_address": "string",
"prefix": 0,
"gateways": [
"string"
]
},
"ipv6": {
"type": "string",
"ipv6": [
{
"ip_address": "string",
"prefix": 0
}
],
"gateways": [
"string"
]
},
"windows": {
"dns_servers": [
"string"
],
"dns_domain": "string",
"wins_servers": [
"string"
],
"net_bios_mode": "string"
}
}
}
]
},
"description": "string",
"name": "string"
}The specification object.
This property was added in vSphere API 7.0.0.0.
Description of the specification.
This property was added in vSphere API 7.0.0.0.
Name of the specification.
This property was added in vSphere API 7.0.0.0.
if the specified content cannot be properly converted into a proper valid Vcenter Guest CustomizationSpecs CreateSpec object.
"Vapi Std Errors InvalidArgument Object"if the user can not be authenticated.
"Vapi Std Errors Unauthenticated Object"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.
if the user doesn't have the required privileges.
"Vapi Std Errors Unauthorized Object"if the system is unable to communicate with a service to complete the request.
"Vapi Std Errors ServiceUnavailable Object" curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"customization_spec:"string"}' https://{api_host}/api/vcenter/guest/customization-specs?action=import