List Depot Content Base Images
Returns a list of currently available base images in the depot. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Read.
Request
URLURL
https://{api_host}/api/esx/settings/depot-content/base-images
Query Parameters
Query Parameters
string
min_version
Optional
Minimum version of a base image that can match the filter. If set, only base images with version greater than or equal to this version will be returned.
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
SettingsDepotContentBaseImagesSummary
of type application/json
List of base images in the depot. These will be sorted by the version of the base image.
[
{
"category": "SECURITY",
"display_name": "string",
"display_version": "string",
"kb": "string",
"release_date": "string",
"summary": "string",
"version": "string"
}
]
category
Required
The BaseImages.CategoryType enumerated type defines possible values of categories for a base image.
SECURITY : Security
ENHANCEMENT : Enhancement
BUGFIX : Bugfix
Possible values are: SECURITY , ENHANCEMENT , BUGFIX
string
display_name
Required
Display name of the base image.
string
display_version
Required
Human readable version of the base image.
string
kb
Required
Link to kb article related to this the base image.
string
release_date
Required
Release date of the base image.
string
summary
Required
Summary of the base image.
string
version
Required
Version of the base image. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.esx.settings.base_image. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.esx.settings.base_image.
Errors
500
com.vmware.vapi.std.errors.error : If there is unknown internal error. The accompanying error message will give more details about the failure.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-ListDepotContentBaseImages -MinVersion "MyMinVersion"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/depot-content/base-images
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: list
Availability
Added in 7.0.0.0
