Update Trust Authority Clusters Attestation TPM2 Settings Task
Set the TPM 2.0 protocol settings.
Request
URLURL
https://{api_host}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/tpm2/settings?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.
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"
Request Body
Request Body
TrustedInfrastructureTrustAuthorityClustersAttestationTpm2SettingsUpdateSpec of mimetype application/json
Required
The settings.
{
"require_certificate_validation": false,
"require_endorsement_keys": false
}
boolean
require_certificate_validation
Optional
Require TPM endorsement key certificate validation. If unset the current state will remain unchanged.
boolean
require_endorsement_keys
Optional
Require registered TPM endorsement keys. If unset the current state will remain unchanged.
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.
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if the spec is invalid or cluster id is empty.
404
com.vmware.vapi.std.errors.not_found : if cluster doesn’t match to any cluster in the vCenter.
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
$TrustedInfrastructureTrustAuthorityClustersAttestationTpm2SettingsUpdateSpec = Initialize-TrustedInfrastructureTrustAuthorityClustersAttestationTpm2SettingsUpdateSpec -RequireEndorsementKeys $false -RequireCertificateValidation $false
Invoke-UpdateClusterTpm2SettingsAsync -Cluster "MyCluster" -TrustedInfrastructureTrustAuthorityClustersAttestationTpm2SettingsUpdateSpec $TrustedInfrastructureTrustAuthorityClustersAttestationTpm2SettingsUpdateSpec
cURL Command
curl -X PATCH -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"require_certificate_validation":false,"require_endorsement_keys":false}' https://{api_host}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/tpm2/settings?vmw-task=true
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: update_task
Availability
Added in 7.0.0.0
