List Trust Authority Clusters Attestation OS ESX Base Images Task
Return a list of trusted ESX base images.
Request
URLURL
https://{api_host}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/os/esx/base-images?vmw-task=true
Path Parameters
Path Parameters
string
cluster
Required
The id of the cluster on which the operation will be executed. The parameter must be an identifier for the resource type: ClusterComputeResource.
Query Parameters
Query Parameters
array of
string
display_name
Optional
Search criteria by ESX base image version version numbers. displayName if {@term.unset} return all ESX display version numbers.
health
Optional
Search criteria by health indicator. health if {@term.unset} return all health indicators.
array of
string
version
Optional
Search criteria by ESX base image version numbers. version if {@term.unset} return all ESX version numbers. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx.BaseImage. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx.BaseImage.
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
202 Accepted returns
string
of type application/json
An identifier for the task created by this API invocation will be returned. If the non-async version of the operation returns a value, this id can be used with the CIS Get Task operation to fetch that value. The normal description of this operation’s return value will follow if one exists. A list of configured trusted ESX base images.
Errors
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-GetClusterBaseImagesAsync -Cluster "MyCluster" -Version "MyVersion" -DisplayName "MyDisplayName" -Health "NONE"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/os/esx/base-images?vmw-task=true
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: list_task
Availability
Added in 7.0.0.0
