This API has a deprecated equivalent from v7.0U1.
Get Customization Specs
Returns the guest customization specification from vCenter with the specified identifier. if you do not have all of the privileges described as follows: - Operation execution requires VirtualMachine.Provisioning.ReadCustSpecs.
Request
URLURL
https://{api_host}/api/vcenter/guest/customization-specs/{name}
Path Parameters
Path Parameters
string
name
Required
The name of the customization specification. 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"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
GuestCustomizationSpecsInfo of type application/json
A customization spec with the specified identifier.
{
"last_modified": "string",
"spec": {
"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"
}
]
}
}
}
string
last_modified
Required
Time when the specification was last modified.
spec
Required
The Spec object including specification and metadata information.
Errors
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.
Code Samples
PowerCLI Client SDK Example
Invoke-GetNameGuestCustomizationSpecs -Name "MyName"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" 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-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/vcenter/guest/customization-specs/{name}
x-vmw-doc-operation: get
Availability
Added in 7.0U2
