Vcenter Guest CustomizationSpecs list

Vcenter Guest CustomizationSpecs list

Returns information about at most 1000 visible (subject to permission checks) guest customization specifications in vCenter matching the Vcenter Guest CustomizationSpecs FilterSpec.

This operation was added in vSphere API 6.7.1.

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
COPY
Query Parameters
Vcenter Guest CustomizationSpecs FilterSpec
filter
Optional

Specification of matching guest customization specifications for which information should be returned.

If missing or null, the behavior is equivalent to a Vcenter Guest CustomizationSpecs FilterSpec with all properties missing or null which means all guest customization specifications match the filter.

string of array
names
Optional

Names that guest customization specifications must have to match the filter (see Vcenter Guest CustomizationSpecs Summary.name).

This property was added in vSphere API 6.7.1.

If missing or null or empty, guest customization specifications with any name match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.vcenter.guest.CustomizationSpec. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.vcenter.guest.CustomizationSpec.

Authentication
This operation uses the following authentication methods.
Responses
200

Commonly used information about the guest customization specifications matching the Vcenter Guest CustomizationSpecs FilterSpec.

[
    "Vcenter Guest CustomizationSpecs Summary Object"
]
array of Vcenter Guest CustomizationSpecs Summary
Optional

400

if the Vcenter Guest CustomizationSpecs FilterSpec.OS_type property contains a value that is not supported by the server.

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

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"

500

if more than 1000 guest customization specifications match the Vcenter Guest CustomizationSpecs FilterSpec.

Returns Vapi Std Errors UnableToAllocateResource of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors UnableToAllocateResource0 
"Vapi Std Errors UnableToAllocateResource 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
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