Vcenter Guest CustomizationSpecs get

Vcenter Guest CustomizationSpecs get

Returns the guest customization specification from vCenter with the specified identifier.

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.ReadCustSpecs.
Request
URI
GET
https://{api_host}/api/vcenter/guest/customization-specs/{name}
COPY
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.

Authentication
This operation uses the following authentication methods.
Responses
200

A customization spec with the specified identifier.

Returns Vcenter Guest CustomizationSpecs Info of type(s) application/json 
{
    "last_modified": "string",
    "spec": {
        "fingerprint": "string",
        "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"
    }
}
string As date-time As date-time
last_modified
Required

Time when the specification was last modified.

This property was added in vSphere API 7.0.0.0.

spec
Required

The Spec object including specification and metadata information.

This property was added in vSphere API 7.0.0.0.


401

if the user can not be authenticated.

Returns Vapi Std Errors Unauthenticated of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthenticated0 
"Vapi Std Errors Unauthenticated Object"
string
challenge
Optional

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.


403

if the user doesn't have the required privileges.

Returns Vapi Std Errors Unauthorized of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthorized0 
"Vapi Std Errors Unauthorized Object"

404

if a customization specification is not found.

Returns Vapi Std Errors NotFound of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors NotFound0 
"Vapi Std Errors NotFound Object"

503

if the system is unable to communicate with a service to complete the request.

Returns Vapi Std Errors ServiceUnavailable of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors ServiceUnavailable0 
"Vapi Std Errors ServiceUnavailable Object"

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/vcenter/guest/customization-specs/{name}
On This Page
Vcenter Operations
GET
Vcenter Guest CustomizationSpecs list
POST
Vcenter Guest CustomizationSpecs create
GET
Vcenter Guest CustomizationSpecs get
PUT
Vcenter Guest CustomizationSpecs set
DELETE
Vcenter Guest CustomizationSpecs delete
POST
Vcenter Guest CustomizationSpecs export
POST
Vcenter Guest CustomizationSpecs importSpecification