REST API - list

vcenter guest customization specs: list

Returns information about at most 1000 visible (subject to permission checks) guest customization specifications in vCenter matching the vcenter.guest.customization_specs.filter_spec. This operation was added in vSphere API 6.7.1.

Request:

HTTP request

GET https://{server}/rest/vcenter/guest/customization-specs

?filter.names.1=obj-103
&filter.names.2=obj-103
&filter.OS_type=WINDOWS

Request Query Parameters:

Name	Type	Description
bold = required
filter	filter_spec	Optional. Specification of matching guest customization specifications for which information should be returned.
filter.names	string[]	Names that guest customization specifications must have to match the filter (see vcenter.guest.customization_specs.summary.name). This attribute was added in vSphere API 6.7.1. Optional. 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`.
filter.OS_type	string	Guest operating system type that guest customization specifications must have to match the filter (see vcenter.guest.customization_specs.summary.OS_type). This attribute was added in vSphere API 6.7.1. Optional. If unset, guest customization specifications with any guest operating system type match the filter.

Response:

HTTP Status Code: 200

Representation:

{
    "value" : [
        {
            "name" : "obj-103",
            "description" : "string",
            "OS_type" : "WINDOWS",
            "last_modified" : "2015-01-01T22:13:05.651Z"
        },
        {
            "name" : "obj-103",
            "description" : "string",
            "OS_type" : "WINDOWS",
            "last_modified" : "2015-01-01T22:13:05.651Z"
        }
    ]
}

Response Type:

Name	Type	Description
bold = required
value	summary[]	Commonly used information about the guest customization specifications matching the vcenter.guest.customization_specs.filter_spec.
value[].name	string	Name of the guest customization specification. This attribute was added in vSphere API 6.7.1. 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`.
value[].description	string	Description of the guest customization specification. This attribute was added in vSphere API 6.7.1.
value[].OS_type	string	Guest operating system type for which that this guest customization specification applies. This attribute was added in vSphere API 6.7.1. Defines the types of guest operating systems for which guest customization is supported. This enumeration was added in vSphere API 6.7.1. Value is one of: WINDOWS: A customization specification for a Windows guest operating system. This constant was added in vSphere API 6.7.1. LINUX: A customization specification for a Linux guest operating system. This constant was added in vSphere API 6.7.1.
value[].last_modified	date_time	Date and tme when this guest customization specification was last modified. This attribute was added in vSphere API 6.7.1.

Errors:

HTTP Status Code	Type	Description
400	invalid_argument	if the vcenter.guest.customization_specs.filter_spec.OS_type field contains a value that is not supported by the server.
500	unable_to_allocate_resource	if more than 1000 guest customization specifications match the vcenter.guest.customization_specs.filter_spec.
503	service_unavailable	if the system is unable to communicate with a service to complete the request.
401	unauthenticated	if the user can not be authenticated.
403	unauthorized	if the user doesn't have the required privileges.