This API has a deprecated equivalent from v7.0U1.
List Customization Specs
Returns information about at most 1000 visible (subject to permission checks) guest customization specifications in vCenter matching the CustomizationSpecs.FilterSpec. 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
Query Parameters
Query Parameters
OS_type
Optional
Guest operating system type that guest customization specifications must have to match the filter (see CustomizationSpecs.Summary.os-type). If unset, guest customization specifications with any guest operating system type match the filter.
array of
string
names
Optional
Names that guest customization specifications must have to match the filter (see CustomizationSpecs.Summary.name). If unset or empty, guest customization specifications with any name match the filter. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.vcenter.guest.CustomizationSpec. When operations return a value of this structure as a result, the field will contain identifiers 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
array of
GuestCustomizationSpecsSummary of type application/json
Commonly used information about the guest customization specifications matching the CustomizationSpecs.FilterSpec.
[
{
"OS_type": "WINDOWS",
"description": "string",
"last_modified": "string",
"name": "string"
}
]
OS_type
Required
The CustomizationSpecs.OsType enumerated type defines the types of guest operating systems for which guest customization is supported.
WINDOWS : A customization specification for a Windows guest operating system
LINUX : A customization specification for a Linux guest operating system
Possible values are: WINDOWS , LINUX
string
description
Required
Description of the guest customization specification.
string
last_modified
Required
Date and tme when this guest customization specification was last modified.
string
name
Required
Name of the guest customization specification. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.guest.CustomizationSpec. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.guest.CustomizationSpec.
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if the CustomizationSpecs.FilterSpec.os-type field contains a value that is not supported by the server.
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn’t have the required privileges.
500
com.vmware.vapi.std.errors.unable_to_allocate_resource : if more than 1000 guest customization specifications match the CustomizationSpecs.FilterSpec.
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-ListGuestCustomizationSpecs -Names "MyNames" -OSType "WINDOWS"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/guest/customization-specs
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
x-vmw-doc-operation: list
Availability
Added in 7.0U2
