Import Specification Customization Specs
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
Converts a well formatted string to a CustomizationSpecs.CreateSpec. The resulting object can be passed to CustomizationSpecs.create operation.
Request
URLURL
https://{api_host}/rest/vcenter/guest/customization-specs?action=import
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Request Body
Request Body
Contains GuestCustomizationSpecsImportSpecificationRequestBody
of type application/json
(required)
{
"customization_spec": "string"
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | customization_spec | string |
content to be converted to the spec. |
Response
Response
Response BodyResponse Body
200 OK returns
GuestCustomizationSpecsImportSpecificationResponseBody
of type application/json
A proper specification of type CustomizationSpecs.CreateSpec
{
"value": {
"description": "string",
"name": "string",
"spec": {
"configuration_spec": {
"linux_config": {
"domain": "string",
"hostname": {
"fixed_name": "string",
"prefix": "string",
"type": "enum"
},
"script_text": "string",
"time_zone": "string"
},
"windows_config": {
"reboot": "enum",
"sysprep": {
"domain": {
"domain": "string",
"domain_password": "string",
"domain_username": "string",
"type": "enum",
"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": "enum"
},
"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": "enum"
},
"ipv6": {
"gateways": [
"string"
],
"ipv6": [
{
"ip_address": "string",
"prefix": 0
}
],
"type": "enum"
},
"windows": {
"dns_domain": "string",
"dns_servers": [
"string"
],
"net_BIOS_mode": "enum",
"wins_servers": [
"string"
]
}
},
"mac_address": "string"
}
]
}
}
}| Property Name | Type | Description |
|---|---|---|
| value | GuestCustomizationSpecsCreateSpec |
A proper specification of type CustomizationSpecs.CreateSpec |
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"customization_spec":"string"}' https://{api_host}/rest/vcenter/guest/customization-specs?action=import
Errors
| Code | Returns | Description |
|---|---|---|
| 503 | ErrorRest | com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request. |
| default | ErrorRest | Not available |
| 400 | ErrorRest | com.vmware.vapi.std.errors.invalid_argument : if the specified content cannot be properly converted into a proper valid CustomizationSpecs.CreateSpec object. |
| 401 | ErrorRest | 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. |
