Update Trust Authority Clusters KMS Providers Task
Update an existing Key Provider.
Request
URLURL
https://{api_host}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers/{provider}?vmw-task=true
Path Parameters
Path Parameters
string
cluster
Required
Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.
string
provider
Required
Identifier of the provider. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider.
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
TrustedInfrastructureTrustAuthorityClustersKmsProvidersUpdateSpec of mimetype application/json
Required
Provider information.
{
"key_server": {
"connection_timeout": 0,
"description": "string",
"kmip_server": {
"servers": [
{
"address": {
"hostname": "string",
"port": 0
},
"name": "string"
}
],
"username": "string"
},
"proxy_server": {
"hostname": "string",
"port": 0
},
"type": "KMIP"
},
"master_key_id": "string"
}
key_server
Optional
Key server associated with this provider.
If unset, key server configuration will remain unchanged.
string
master_key_id
Optional
Master key identifier created for the provider. A unique Key identifier.
If unset, masterKeyId 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 cluster or provider id is empty, or the spec is invalid.
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
$TrustedInfrastructureNetworkAddress = Initialize-TrustedInfrastructureNetworkAddress -Hostname "MyHostname" -Port 0
$TrustedInfrastructureTrustAuthorityClustersKmsProvidersServer = Initialize-TrustedInfrastructureTrustAuthorityClustersKmsProvidersServer -Name "MyName" -Address $TrustedInfrastructureNetworkAddress
$TrustedInfrastructureTrustAuthorityClustersKmsProvidersKmipServerUpdateSpec = Initialize-TrustedInfrastructureTrustAuthorityClustersKmsProvidersKmipServerUpdateSpec -Servers $TrustedInfrastructureTrustAuthorityClustersKmsProvidersServer -Username "MyUsername"
$TrustedInfrastructureTrustAuthorityClustersKmsProvidersKeyServerUpdateSpec = Initialize-TrustedInfrastructureTrustAuthorityClustersKmsProvidersKeyServerUpdateSpec -Type "KMIP" -Description "MyDescription" -ProxyServer $TrustedInfrastructureNetworkAddress -ConnectionTimeout 0 -KmipServer $TrustedInfrastructureTrustAuthorityClustersKmsProvidersKmipServerUpdateSpec
$TrustedInfrastructureTrustAuthorityClustersKmsProvidersUpdateSpec = Initialize-TrustedInfrastructureTrustAuthorityClustersKmsProvidersUpdateSpec -MasterKeyId "MyMasterKeyId" -KeyServer $TrustedInfrastructureTrustAuthorityClustersKmsProvidersKeyServerUpdateSpec
Invoke-UpdateClusterProviderAsync -Cluster "MyCluster" -Provider "MyProvider" -TrustedInfrastructureTrustAuthorityClustersKmsProvidersUpdateSpec $TrustedInfrastructureTrustAuthorityClustersKmsProvidersUpdateSpec
cURL Command
curl -X PATCH -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"key_server":{"connection_timeout":0,"description":"string","kmip_server":{"servers":[{"address":{"hostname":"string","port":0},"name":"string"}],"username":"string"},"proxy_server":{"hostname":"string","port":0},"type":"KMIP"},"master_key_id":"string"}' https://{api_host}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers/{provider}?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
