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. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
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
?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). Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. 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). Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. If unset, guest customization specifications with any guest operating system type match the filter. |
Response:
HTTP Status Code: 200
Representation:
{
"value": [
{
"OS_type": "WINDOWS",
"description": "string",
"last_modified": "2015-01-01T22:13:05.651Z",
"name": "obj-103"
},
{
"OS_type": "WINDOWS",
"description": "string",
"last_modified": "2015-01-01T22:13:05.651Z",
"name": "obj-103"
}
]
}
"value": [
{
"OS_type": "WINDOWS",
"description": "string",
"last_modified": "2015-01-01T22:13:05.651Z",
"name": "obj-103"
},
{
"OS_type": "WINDOWS",
"description": "string",
"last_modified": "2015-01-01T22:13:05.651Z",
"name": "obj-103"
}
]
}
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. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. 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. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| value[].OS_type | string | Guest operating system type for which that this guest customization specification applies. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Defines the types of guest operating systems for which guest customization is supported. Warning: This enumeration is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Value is one of: WINDOWS: A customization specification for a Windows guest operating system. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. LINUX: A customization specification for a Linux guest operating system. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| value[].last_modified | date_time | Date and tme when this guest customization specification was last modified. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
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. |
| 400 | 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. |