Vcenter TrustedInfrastructure TrustAuthorityClusters Attestation Tpm2 Settings update$Task

Vcenter TrustedInfrastructure TrustAuthorityClusters Attestation Tpm2 Settings update$Task

This operation is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.

Set the TPM 2.0 protocol settings.

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 TrustedAdmin.ConfigureHostCertificates.
  • The resource ClusterComputeResource referenced by the parameter cluster requires System.View.
Request
URI
PATCH
https://{api_host}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/tpm2/settings?vmw-task=true
COPY
Path Parameters
string
cluster
Required Deprecated

The id of the cluster on which the operation will be executed.

The parameter must be an identifier for the resource type: ClusterComputeResource.


Request Body

The settings.

{
    "require_endorsement_keys": false,
    "require_certificate_validation": false
}
boolean
require_endorsement_keys
Optional

This property is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.

Require registered TPM endorsement keys.

This property was added in vSphere API 7.0.0.0.

If missing or null the current state will remain unchanged.

boolean
require_certificate_validation
Optional

This property is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.

Require TPM endorsement key certificate validation.

This property was added in vSphere API 7.0.0.0.

If missing or null the current state will remain unchanged.

Authentication
This operation uses the following authentication methods.
Responses
202

Success!

Returns string of type(s) application/json
Operation doesn't return any data structure

400

if the spec is invalid or cluster id is empty.

Returns Vapi Std Errors InvalidArgument of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors InvalidArgument0
"Vapi Std Errors InvalidArgument Object"

401

if the caller is not authenticated.

Returns Vapi Std Errors Unauthenticated of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthenticated0
"Vapi Std Errors Unauthenticated Object"
string
challenge
Optional

Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.

For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"

This property was added in vSphere API 7.0.0.0.

This property is optional because it was added in a newer version than its parent node.


404

if cluster doesn't match to any cluster in the vCenter.

Returns Vapi Std Errors NotFound of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors NotFound0
"Vapi Std Errors NotFound Object"

500

if there is a generic error.

Returns Vapi Std Errors Error of type(s) application/json
"Vapi Std Errors Error Object"
array of object
messages
Required

Stack of one or more localizable messages for human error consumers.

The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object
data
Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.

Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.

The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.

Some operations will not set this property when reporting errors.

string
error_type
Required

Discriminator field to help API consumers identify the structure type.

For more information see: Vapi Std Errors Error Type.

This property was added in vSphere API 6.7.2.

Can be missing or null for compatibility with preceding implementations.


Code Samples
COPY
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}'