List Customization Specs Deprecated
Returns information about at most 1000 visible (subject to permission checks) guest customization specifications in vCenter matching the CustomizationSpecs.FilterSpec.
Request
URLURL
https://{api_host}/rest/vcenter/guest/customization-specs
Query Parameters
Query Parameters
filter.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
filter.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
GuestCustomizationSpecsListResponseBody of type application/json
Commonly used information about the guest customization specifications matching the CustomizationSpecs.FilterSpec.
{
"value": [
{
"OS_type": "WINDOWS",
"description": "string",
"last_modified": "string",
"name": "string"
}
]
}
array of
GuestCustomizationSpecsSummary
value
Optional
Commonly used information about the guest customization specifications matching the CustomizationSpecs.FilterSpec.
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.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/vcenter/guest/customization-specs
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-new-method: get
x-vmw-doc-new-path: /api/vcenter/guest/customization-specs
x-vmw-doc-operation: list
Availability
Added in 6.7.1
