Esx. Settings. Depot Content. Components List

Esx. Settings. Depot Content. Components List

Returns a list of currently available components in the depot.

This operation was added in vSphere API 7.0.0.0.

Returns an authorization error if you do not have all of the privileges described as follows:

  • Operation execution requires VcIntegrity.lifecycleSettings.Read.
Request
URI
GET
https://{api_host}/esx/settings/depot-content/components
COPY
Query Parameters
Esx.Settings.DepotContent.Components.FilterSpec
filter
Optional

The specification of matching components.

If missing or null, the behavior is equivalent to a Esx.Settings.DepotContent.Components.FilterSpec with all properties missing or null, which means ALL components match the filter.

string of array
vendors
Optional

Vendors that a component must have to match the filter.

This property was added in vSphere API 7.0.0.0.

If missing or null or empty, components with any vendor name match the filter.

string of array
names
Optional

Names that a component must have to match the filter.

This property was added in vSphere API 7.0.0.0.

If missing or null or empty, components with any name will 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.esx.settings.component. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.esx.settings.component.

string of array
versions
Optional

Versions that a component must have to match the filter.

This property was added in vSphere API 7.0.0.0.

If missing or null or empty, components with any version will match the filter.

string of array
bundle_types
Optional

Component bundle types that a component must have to match the filter.

Possible values:

  • INDEPENDENT: Components not bundled in base-images or add-ons
  • BASE_IMAGE: Components bundled in base-images
  • ADD_ON: Components bundled in add-ons

For more information see: Esx.Settings.DepotContent.Components.ComponentBundleType.

This property was added in vSphere API 7.0.0.0.

If missing or null or empty, all components will match the filter.

Authentication
This operation uses the following authentication methods.
Responses
200

List of components in the depot.

Returns Array of Esx.Settings.DepotContent.Components.Summary of type(s) application/json 
[
    "Esx.Settings.DepotContent.Components.Summary Object"
]

401

if the caller is not authenticated.

Returns Vapi.Std.Errors.Unauthenticated of type(s) application/json 
"Vapi.Std.Errors.Unauthenticated Object"

500

If there is unknown internal error. The accompanying error message will give more details about the failure.

Returns Vapi.Std.Errors.Error of type(s) application/json 
"Vapi.Std.Errors.Error Object"

503

If the service is not available.

Returns Vapi.Std.Errors.ServiceUnavailable of type(s) application/json 
"Vapi.Std.Errors.ServiceUnavailable Object"

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/esx/settings/depot-content/components
On This Page
Esx.settings.depot Content.components Operations
GET
Esx. Settings. Depot Content. Components List